google_api_admin v0.12.0 GoogleApi.Admin.Directory_v1.Api.Domains View Source
API calls for all endpoints tagged Domains
.
Link to this section Summary
Functions
Deletes a domain of the customer.
Retrieves a domain of the customer.
Inserts a domain of the customer.
Lists the domains of the customer.
Link to this section Functions
Link to this function
directory_domains_delete(connection, customer, domain_name, optional_params \\ [], opts \\ [])
View Sourcedirectory_domains_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes a domain of the customer.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer
(type:String.t
) - Immutable ID of the G Suite account.domain_name
(type:String.t
) - Name of domain to be deletedoptional_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, %{}}
on success{:error, info}
on failure
Link to this function
directory_domains_get(connection, customer, domain_name, optional_params \\ [], opts \\ [])
View Sourcedirectory_domains_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Domains.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves a domain of the customer.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer
(type:String.t
) - Immutable ID of the G Suite account.domain_name
(type:String.t
) - Name of domain to be retrievedoptional_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.Domains{}}
on success{:error, info}
on failure
Link to this function
directory_domains_insert(connection, customer, optional_params \\ [], opts \\ [])
View Sourcedirectory_domains_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Domains.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Inserts a domain of the customer.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer
(type:String.t
) - Immutable ID of the G Suite account.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.Domains.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Admin.Directory_v1.Model.Domains{}}
on success{:error, info}
on failure
Link to this function
directory_domains_list(connection, customer, optional_params \\ [], opts \\ [])
View Sourcedirectory_domains_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Domains2.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists the domains of the customer.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer
(type:String.t
) - Immutable ID of the G Suite account.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.Domains2{}}
on success{:error, info}
on failure