google_api_reseller v0.2.0 GoogleApi.Reseller.V1.Api.Customers View Source
API calls for all endpoints tagged Customers.
Link to this section Summary
Functions
Get a customer account
Order a new customer's account
Update a customer account's settings. This method supports patch semantics
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
Get a customer account.
Parameters
- connection (GoogleApi.Reseller.V1.Connection): Connection to server
- customer_id (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 (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
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
Order a new customer's account.
Parameters
- connection (GoogleApi.Reseller.V1.Connection): Connection to server
optional_params (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :customerAuthToken (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 (Customer):
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
Update a customer account's settings. This method supports patch semantics.
Parameters
- connection (GoogleApi.Reseller.V1.Connection): Connection to server
- customer_id (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 (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :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, optional_params \\ [], opts \\ []) View Source
Update a customer account's settings.
Parameters
- connection (GoogleApi.Reseller.V1.Connection): Connection to server
- customer_id (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 (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (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 (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :body (Customer):
Returns
{:ok, %GoogleApi.Reseller.V1.Model.Customer{}} on success {:error, info} on failure