google_api_admin

v0.18.0

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

API calls for all endpoints tagged Schemas.

Link to this section Summary

Functions

directory_schemas_delete(connection, customer_id, schema_key, optional_params \\ [], opts \\ [])

Delete schema

directory_schemas_get(connection, customer_id, schema_key, optional_params \\ [], opts \\ [])

Retrieve schema

directory_schemas_insert(connection, customer_id, optional_params \\ [], opts \\ [])

Create schema.

directory_schemas_list(connection, customer_id, optional_params \\ [], opts \\ [])

Retrieve all schemas for a customer

directory_schemas_patch(connection, customer_id, schema_key, optional_params \\ [], opts \\ [])

Update schema. This method supports patch semantics.

directory_schemas_update(connection, customer_id, schema_key, optional_params \\ [], opts \\ [])

Update schema

Link to this section Functions

Link to this function

directory_schemas_delete(connection, customer_id, schema_key, optional_params \\ [], opts \\ [])

View Source

Specs

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

Delete schema

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer_id (type: String.t) - Immutable ID of the G Suite account
  • schema_key (type: String.t) - Name or immutable ID of the schema
  • 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_schemas_get(connection, customer_id, schema_key, optional_params \\ [], opts \\ [])

View Source

Specs

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

Retrieve schema

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer_id (type: String.t) - Immutable ID of the G Suite account
  • schema_key (type: String.t) - Name or immutable ID of the schema
  • 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.Schema{}} on success
  • {:error, info} on failure
Link to this function

directory_schemas_insert(connection, customer_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Create schema.

Parameters

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

Returns

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

directory_schemas_list(connection, customer_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Retrieve all schemas for a customer

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer_id (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.Schemas{}} on success
  • {:error, info} on failure
Link to this function

directory_schemas_patch(connection, customer_id, schema_key, optional_params \\ [], opts \\ [])

View Source

Specs

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

Update schema. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer_id (type: String.t) - Immutable ID of the G Suite account
  • schema_key (type: String.t) - Name or immutable ID of the schema.
  • 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.Schema.t) -
  • opts (type: keyword()) - Call options

Returns

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

directory_schemas_update(connection, customer_id, schema_key, optional_params \\ [], opts \\ [])

View Source

Specs

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

Update schema

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer_id (type: String.t) - Immutable ID of the G Suite account
  • schema_key (type: String.t) - Name or immutable ID of the schema.
  • 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.Schema.t) -
  • opts (type: keyword()) - Call options

Returns

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