google_api_reseller v0.14.0

GoogleApi.Reseller.V1.Api.Customers (google_api_reseller v0.14.0) View Source

API calls for all endpoints tagged Customers.

Link to this section Summary

Functions

reseller_customers_get(connection, customer_id, optional_params \\ [], opts \\ [])

Get a customer account.

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

Order a new customer's account.

reseller_customers_patch(connection, customer_id, optional_params \\ [], opts \\ [])

Patch a customer account's settings via Apiary Patch Orchestration

reseller_customers_update(connection, customer_id, optional_params \\ [], opts \\ [])

Update a customer account's settings.

Link to this section Functions

Link to this function

reseller_customers_get(connection, customer_id, optional_params \\ [], opts \\ [])

View Source

Specs

reseller_customers_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Reseller.V1.Model.Customer.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Get a customer account.

Parameters

  • connection (type: GoogleApi.Reseller.V1.Connection.t) - Connection to server
  • customer_id (type: String.t) - Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
  • 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.Reseller.V1.Model.Customer{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

reseller_customers_insert(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Reseller.V1.Model.Customer.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Order a new customer's account.

Parameters

  • connection (type: GoogleApi.Reseller.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").
    • :customerAuthToken (type: String.t) - The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.
    • :body (type: GoogleApi.Reseller.V1.Model.Customer.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Reseller.V1.Model.Customer{}} on success
  • {:error, info} on failure
Link to this function

reseller_customers_patch(connection, customer_id, optional_params \\ [], opts \\ [])

View Source

Specs

reseller_customers_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Reseller.V1.Model.Customer.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Patch a customer account's settings via Apiary Patch Orchestration

Parameters

  • connection (type: GoogleApi.Reseller.V1.Connection.t) - Connection to server
  • customer_id (type: String.t) - Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
  • 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.Reseller.V1.Model.Customer.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Reseller.V1.Model.Customer{}} on success
  • {:error, info} on failure
Link to this function

reseller_customers_update(connection, customer_id, optional_params \\ [], opts \\ [])

View Source

Specs

reseller_customers_update(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Reseller.V1.Model.Customer.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Update a customer account's settings.

Parameters

  • connection (type: GoogleApi.Reseller.V1.Connection.t) - Connection to server
  • customer_id (type: String.t) - Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
  • 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.Reseller.V1.Model.Customer.t) -
  • opts (type: keyword()) - Call options

Returns

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