google_api_admin v0.18.0 GoogleApi.Admin.Directory_v1.Api.Customers View Source

API calls for all endpoints tagged Customers.

Link to this section Summary

Functions

directory_customers_get(connection, customer_key, optional_params \\ [], opts \\ [])

Retrieves a customer.

directory_customers_patch(connection, customer_key, optional_params \\ [], opts \\ [])

Updates a customer. This method supports patch semantics.

directory_customers_update(connection, customer_key, optional_params \\ [], opts \\ [])

Updates a customer.

Link to this section Functions

directory_customers_get(connection, customer_key, optional_params \\ [], opts \\ [])

Specs

directory_customers_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Customer.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieves a customer.

Parameters

connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
customer_key (type: String.t) - Id of the customer to be retrieved
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Admin.Directory_v1.Model.Customer{}} on success
{:error, info} on failure

directory_customers_patch(connection, customer_key, optional_params \\ [], opts \\ [])

Specs

directory_customers_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Customer.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates a customer. This method supports patch semantics.

Parameters

connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
customer_key (type: String.t) - Id of the customer to be updated
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :body (type: GoogleApi.Admin.Directory_v1.Model.Customer.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Admin.Directory_v1.Model.Customer{}} on success
{:error, info} on failure

directory_customers_update(connection, customer_key, optional_params \\ [], opts \\ [])

Specs

directory_customers_update(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Customer.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates a customer.

Parameters

connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
customer_key (type: String.t) - Id of the customer to be updated
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :body (type: GoogleApi.Admin.Directory_v1.Model.Customer.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Admin.Directory_v1.Model.Customer{}} on success
{:error, info} on failure