google_api_content v0.30.0 GoogleApi.Content.V21.Api.Returnpolicy View Source

API calls for all endpoints tagged Returnpolicy.

Link to this section Summary

Functions

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

Batches multiple return policy related calls in a single request.

content_returnpolicy_delete(connection, merchant_id, return_policy_id, optional_params \\ [], opts \\ [])

Deletes a return policy for the given Merchant Center account.

content_returnpolicy_get(connection, merchant_id, return_policy_id, optional_params \\ [], opts \\ [])

Gets a return policy of the Merchant Center account.

content_returnpolicy_insert(connection, merchant_id, optional_params \\ [], opts \\ [])

Inserts a return policy for the Merchant Center account.

content_returnpolicy_list(connection, merchant_id, optional_params \\ [], opts \\ [])

Lists the return policies of the Merchant Center account.

Link to this section Functions

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

content_returnpolicy_custombatch(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V21.Model.ReturnpolicyCustomBatchResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Batches multiple return policy related calls in a single request.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :body (type: GoogleApi.Content.V21.Model.ReturnpolicyCustomBatchRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V21.Model.ReturnpolicyCustomBatchResponse{}} on success
{:error, info} on failure

content_returnpolicy_delete(connection, merchant_id, return_policy_id, optional_params \\ [], opts \\ [])

content_returnpolicy_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}

Deletes a return policy for the given Merchant Center account.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - The Merchant Center account from which to delete the given return policy.
return_policy_id (type: String.t) - Return policy ID generated by Google.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

content_returnpolicy_get(connection, merchant_id, return_policy_id, optional_params \\ [], opts \\ [])

content_returnpolicy_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V21.Model.ReturnPolicy.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Gets a return policy of the Merchant Center account.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - The Merchant Center account to get a return policy for.
return_policy_id (type: String.t) - Return policy ID generated by Google.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V21.Model.ReturnPolicy{}} on success
{:error, info} on failure

content_returnpolicy_insert(connection, merchant_id, optional_params \\ [], opts \\ [])

content_returnpolicy_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V21.Model.ReturnPolicy.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Inserts a return policy for the Merchant Center account.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - The Merchant Center account to insert a return policy for.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :body (type: GoogleApi.Content.V21.Model.ReturnPolicy.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V21.Model.ReturnPolicy{}} on success
{:error, info} on failure

content_returnpolicy_list(connection, merchant_id, optional_params \\ [], opts \\ [])

content_returnpolicy_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Content.V21.Model.ReturnpolicyListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Lists the return policies of the Merchant Center account.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - The Merchant Center account to list return policies for.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V21.Model.ReturnpolicyListResponse{}} on success
{:error, info} on failure