google_api_reseller

v0.0.1

google_api_reseller v0.0.1 GoogleApi.Reseller.V1.Api.Customers View Source

API calls for all endpoints tagged Customers.

Link to this section Summary

Functions

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

Get a customer account

reseller_customers_insert(connection, opts \\ [])

Order a new customer's account

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

Update a customer account's settings. This method supports patch semantics

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

Update a customer account's settings

Link to this section Functions

Link to this function reseller_customers_get(connection, customer_id, opts \\ []) View Source 
reseller_customers_get(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.Reseller.V1.Model.Customer.t} |
  {:error, Tesla.Env.t}

Get a customer account.

Parameters

  • connection (GoogleApi.Reseller.V1.Connection): Connection to server
  • customer_id (String): 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.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

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

Link to this function reseller_customers_insert(connection, opts \\ []) View Source 
reseller_customers_insert(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.Reseller.V1.Model.Customer.t} |
  {:error, Tesla.Env.t}

Order a new customer's account.

Parameters

  • connection (GoogleApi.Reseller.V1.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :customer_auth_token (String): 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 (Customer):

Returns

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

Link to this function reseller_customers_patch(connection, customer_id, opts \\ []) View Source 
reseller_customers_patch(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.Reseller.V1.Model.Customer.t} |
  {:error, Tesla.Env.t}

Update a customer account's settings. This method supports patch semantics.

Parameters

  • connection (GoogleApi.Reseller.V1.Connection): Connection to server
  • customer_id (String): 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.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :body (Customer):

Returns

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

Link to this function reseller_customers_update(connection, customer_id, opts \\ []) View Source 
reseller_customers_update(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.Reseller.V1.Model.Customer.t} |
  {:error, Tesla.Env.t}

Update a customer account's settings.

Parameters

  • connection (GoogleApi.Reseller.V1.Connection): Connection to server
  • customer_id (String): 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.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :body (Customer):

Returns

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