View Source GoogleApi.Admin.Directory_v1.Api.Customer (google_api_admin v0.40.0)

API calls for all endpoints tagged Customer.

Summary

Functions

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

Changes the status of a batch of ChromeOS devices. For more information about changing a ChromeOS device state Repair, repurpose, or retire ChromeOS devices.

admin_customer_devices_chromeos_commands_get(connection, customer_id, device_id, command_id, optional_params \\ [], opts \\ [])

Gets command data a specific command issued to the device.

admin_customer_devices_chromeos_issue_command(connection, customer_id, device_id, optional_params \\ [], opts \\ [])

Issues a command for the device to execute.

Functions

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

@spec admin_customer_devices_chromeos_batch_change_status(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Admin.Directory_v1.Model.BatchChangeChromeOsDeviceStatusResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Changes the status of a batch of ChromeOS devices. For more information about changing a ChromeOS device state Repair, repurpose, or retire ChromeOS devices.

Parameters

connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
customer_id (type: String.t) - Required. Immutable ID of the Google Workspace account.
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.Admin.Directory_v1.Model.BatchChangeChromeOsDeviceStatusRequest.t) -
opts (type: keyword()) - Call options

Returns

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

admin_customer_devices_chromeos_commands_get(connection, customer_id, device_id, command_id, optional_params \\ [], opts \\ [])

@spec admin_customer_devices_chromeos_commands_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.DirectoryChromeosdevicesCommand.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets command data a specific command issued to the device.

Parameters

connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
customer_id (type: String.t) - Immutable. ID of the Google Workspace account.
device_id (type: String.t) - Immutable. ID of Chrome OS Device.
command_id (type: String.t) - Immutable. ID of Chrome OS Device Command.
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.Admin.Directory_v1.Model.DirectoryChromeosdevicesCommand{}} on success
{:error, info} on failure

admin_customer_devices_chromeos_issue_command(connection, customer_id, device_id, optional_params \\ [], opts \\ [])

@spec admin_customer_devices_chromeos_issue_command(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Admin.Directory_v1.Model.DirectoryChromeosdevicesIssueCommandResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Issues a command for the device to execute.

Parameters

connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
customer_id (type: String.t) - Immutable. ID of the Google Workspace account.
device_id (type: String.t) - Immutable. ID of Chrome OS Device.
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.Admin.Directory_v1.Model.DirectoryChromeosdevicesIssueCommandRequest.t) -
opts (type: keyword()) - Call options

Returns

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