View Source GoogleApi.Content.V21.Api.Returnpolicyonline (google_api_content v0.70.1)

API calls for all endpoints tagged Returnpolicyonline.

Summary

Functions

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

Creates a new return policy.

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

Deletes an existing return policy.

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

Gets an existing return policy.

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

Lists all existing return policies.

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

Updates an existing return policy.

Functions

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

@spec content_returnpolicyonline_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V21.Model.ReturnPolicyOnline.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new return policy.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - Required. The id of the merchant for which to retrieve the return policy online object.
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.Content.V21.Model.ReturnPolicyOnline.t) -
opts (type: keyword()) - Call options

Returns

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

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

@spec content_returnpolicyonline_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes an existing return policy.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - Required. The id of the merchant for which to retrieve the return policy online object.
return_policy_id (type: String.t) - Required. The id of the return policy to delete.
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, %{}} on success
{:error, info} on failure

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

@spec content_returnpolicyonline_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V21.Model.ReturnPolicyOnline.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an existing return policy.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - Required. The id of the merchant for which to retrieve the return policy online object.
return_policy_id (type: String.t) - Required. The id of the return policy to retrieve.
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.Content.V21.Model.ReturnPolicyOnline{}} on success
{:error, info} on failure

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

@spec content_returnpolicyonline_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V21.Model.ListReturnPolicyOnlineResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all existing return policies.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - Required. The id of the merchant for which to retrieve the return policy online object.
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.Content.V21.Model.ListReturnPolicyOnlineResponse{}} on success
{:error, info} on failure

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

@spec content_returnpolicyonline_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V21.Model.ReturnPolicyOnline.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing return policy.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - Required. The id of the merchant for which to retrieve the return policy online object.
return_policy_id (type: String.t) - Required. The id of the return policy to update.
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.Content.V21.Model.ReturnPolicyOnline.t) -
opts (type: keyword()) - Call options

Returns

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