View Source GoogleApi.Reseller.V1.Api.Customers (google_api_reseller v0.18.0)
API calls for all endpoints tagged Customers
.
Summary
Functions
Gets a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see retrieving a customer account.
Orders a new customer's account. Before ordering a new customer account, establish whether the customer account already exists using the customers.get
If the customer account exists as a direct Google account or as a resold customer account from another reseller, use the customerAuthToken\
as described in order a resold account for an existing customer. For more information about ordering a new customer account, see order a new customer account. After creating a new customer account, you must provision a user as an administrator. The customer's administrator is required to sign in to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers are prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information, see order a new customer account.
Updates a customer account's settings. This method supports patch semantics. You cannot update customerType
via the Reseller API, but a "team"
customer can verify their domain and become customerType = "domain"
. For more information, see Verify your domain to unlock Essentials features.
Updates a customer account's settings. You cannot update customerType
via the Reseller API, but a "team"
customer can verify their domain and become customerType = "domain"
. For more information, see update a customer's settings.
Functions
reseller_customers_get(connection, customer_id, optional_params \\ [], opts \\ [])
View Source@spec reseller_customers_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Reseller.V1.Model.Customer.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see retrieving a customer account.
Parameters
-
connection
(type:GoogleApi.Reseller.V1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. -
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
reseller_customers_insert(connection, optional_params \\ [], opts \\ [])
View Source@spec reseller_customers_insert(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Reseller.V1.Model.Customer.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Orders a new customer's account. Before ordering a new customer account, establish whether the customer account already exists using the customers.get
If the customer account exists as a direct Google account or as a resold customer account from another reseller, use the customerAuthToken\
as described in order a resold account for an existing customer. For more information about ordering a new customer account, see order a new customer account. After creating a new customer account, you must provision a user as an administrator. The customer's administrator is required to sign in to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers are prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information, see order a new customer 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
) - ThecustomerAuthToken
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
reseller_customers_patch(connection, customer_id, optional_params \\ [], opts \\ [])
View Source@spec reseller_customers_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Reseller.V1.Model.Customer.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a customer account's settings. This method supports patch semantics. You cannot update customerType
via the Reseller API, but a "team"
customer can verify their domain and become customerType = "domain"
. For more information, see Verify your domain to unlock Essentials features.
Parameters
-
connection
(type:GoogleApi.Reseller.V1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. -
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
reseller_customers_update(connection, customer_id, optional_params \\ [], opts \\ [])
View Source@spec reseller_customers_update(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Reseller.V1.Model.Customer.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a customer account's settings. You cannot update customerType
via the Reseller API, but a "team"
customer can verify their domain and become customerType = "domain"
. For more information, see update a customer's settings.
Parameters
-
connection
(type:GoogleApi.Reseller.V1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. -
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