google_api_admin

v0.18.0

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

API calls for all endpoints tagged DomainAliases.

Link to this section Summary

Functions

directory_domain_aliases_delete(connection, customer, domain_alias_name, optional_params \\ [], opts \\ [])

Deletes a Domain Alias of the customer.

directory_domain_aliases_get(connection, customer, domain_alias_name, optional_params \\ [], opts \\ [])

Retrieves a domain alias of the customer.

directory_domain_aliases_insert(connection, customer, optional_params \\ [], opts \\ [])

Inserts a Domain alias of the customer.

directory_domain_aliases_list(connection, customer, optional_params \\ [], opts \\ [])

Lists the domain aliases of the customer.

Link to this section Functions

Link to this function

directory_domain_aliases_delete(connection, customer, domain_alias_name, optional_params \\ [], opts \\ [])

View Source

Specs

directory_domain_aliases_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

Deletes a Domain Alias of the customer.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer (type: String.t) - Immutable ID of the G Suite account.
  • domain_alias_name (type: String.t) - Name of domain alias 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, %{}} on success
  • {:error, info} on failure
Link to this function

directory_domain_aliases_get(connection, customer, domain_alias_name, optional_params \\ [], opts \\ [])

View Source

Specs

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

Retrieves a domain alias of the customer.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer (type: String.t) - Immutable ID of the G Suite account.
  • domain_alias_name (type: String.t) - Name of domain alias 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.DomainAlias{}} on success
  • {:error, info} on failure
Link to this function

directory_domain_aliases_insert(connection, customer, optional_params \\ [], opts \\ [])

View Source

Specs

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

Inserts a Domain alias of the customer.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer (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.DomainAlias.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.DomainAlias{}} on success
  • {:error, info} on failure
Link to this function

directory_domain_aliases_list(connection, customer, optional_params \\ [], opts \\ [])

View Source

Specs

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

Lists the domain aliases of the customer.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer (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.
    • :parentDomainName (type: String.t) - Name of the parent domain for which domain aliases are to be fetched.
  • opts (type: keyword()) - Call options

Returns

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