GoogleApi.WalletObjects.V1.Api.Giftcardobject (google_api_wallet_objects v0.12.0)

View Source

API calls for all endpoints tagged Giftcardobject.

Summary

Functions

walletobjects_giftcardobject_addmessage(connection, resource_id, optional_params \\ [], opts \\ [])

Adds a message to the gift card object referenced by the given object ID.

walletobjects_giftcardobject_get(connection, resource_id, optional_params \\ [], opts \\ [])

Returns the gift card object with the given object ID.

walletobjects_giftcardobject_insert(connection, optional_params \\ [], opts \\ [])

Inserts an gift card object with the given ID and properties.

walletobjects_giftcardobject_list(connection, optional_params \\ [], opts \\ [])

Returns a list of all gift card objects for a given issuer ID.

walletobjects_giftcardobject_patch(connection, resource_id, optional_params \\ [], opts \\ [])

Updates the gift card object referenced by the given object ID. This method supports patch semantics.

walletobjects_giftcardobject_update(connection, resource_id, optional_params \\ [], opts \\ [])

Updates the gift card object referenced by the given object ID.

Functions

walletobjects_giftcardobject_addmessage(connection, resource_id, optional_params \\ [], opts \\ [])

@spec walletobjects_giftcardobject_addmessage(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WalletObjects.V1.Model.GiftCardObjectAddMessageResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Adds a message to the gift card object referenced by the given object ID.

Parameters

  • connection (type: GoogleApi.WalletObjects.V1.Connection.t) - Connection to server
  • resource_id (type: String.t) - The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.WalletObjects.V1.Model.AddMessageRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WalletObjects.V1.Model.GiftCardObjectAddMessageResponse{}} on success
  • {:error, info} on failure

walletobjects_giftcardobject_get(connection, resource_id, optional_params \\ [], opts \\ [])

@spec walletobjects_giftcardobject_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WalletObjects.V1.Model.GiftCardObject.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the gift card object with the given object ID.

Parameters

  • connection (type: GoogleApi.WalletObjects.V1.Connection.t) - Connection to server
  • resource_id (type: String.t) - The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WalletObjects.V1.Model.GiftCardObject{}} on success
  • {:error, info} on failure

walletobjects_giftcardobject_insert(connection, optional_params \\ [], opts \\ [])

@spec walletobjects_giftcardobject_insert(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.WalletObjects.V1.Model.GiftCardObject.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Inserts an gift card object with the given ID and properties.

Parameters

  • connection (type: GoogleApi.WalletObjects.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.WalletObjects.V1.Model.GiftCardObject.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WalletObjects.V1.Model.GiftCardObject{}} on success
  • {:error, info} on failure

walletobjects_giftcardobject_list(connection, optional_params \\ [], opts \\ [])

@spec walletobjects_giftcardobject_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.WalletObjects.V1.Model.GiftCardObjectListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns a list of all gift card objects for a given issuer ID.

Parameters

  • connection (type: GoogleApi.WalletObjects.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :classId (type: String.t) - The ID of the class whose objects will be listed.
    • :maxResults (type: integer()) - Identifies the max number of results returned by a list. All results are returned if maxResults isn't defined.
    • :token (type: String.t) - Used to get the next set of results if maxResults is specified, but more than maxResults objects are available in a list. For example, if you have a list of 200 objects and you call list with maxResults set to 20, list will return the first 20 objects and a token. Call list again with maxResults set to 20 and the token to get the next 20 objects.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WalletObjects.V1.Model.GiftCardObjectListResponse{}} on success
  • {:error, info} on failure

walletobjects_giftcardobject_patch(connection, resource_id, optional_params \\ [], opts \\ [])

@spec walletobjects_giftcardobject_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WalletObjects.V1.Model.GiftCardObject.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the gift card object referenced by the given object ID. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.WalletObjects.V1.Connection.t) - Connection to server
  • resource_id (type: String.t) - The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.WalletObjects.V1.Model.GiftCardObject.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WalletObjects.V1.Model.GiftCardObject{}} on success
  • {:error, info} on failure

walletobjects_giftcardobject_update(connection, resource_id, optional_params \\ [], opts \\ [])

@spec walletobjects_giftcardobject_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WalletObjects.V1.Model.GiftCardObject.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the gift card object referenced by the given object ID.

Parameters

  • connection (type: GoogleApi.WalletObjects.V1.Connection.t) - Connection to server
  • resource_id (type: String.t) - The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.WalletObjects.V1.Model.GiftCardObject.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WalletObjects.V1.Model.GiftCardObject{}} on success
  • {:error, info} on failure