google_api_admin

v0.18.0

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

API calls for all endpoints tagged Mobiledevices.

Link to this section Summary

Functions

directory_mobiledevices_action(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])

Take action on Mobile Device

directory_mobiledevices_delete(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])

Delete Mobile Device

directory_mobiledevices_get(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])

Retrieve Mobile Device

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

Retrieve all Mobile Devices of a customer (paginated)

Link to this section Functions

Link to this function

directory_mobiledevices_action(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Take action on Mobile Device

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer_id (type: String.t) - Immutable ID of the G Suite account
  • resource_id (type: String.t) - Immutable ID of Mobile Device
  • 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.MobileDeviceAction.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

directory_mobiledevices_delete(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Delete Mobile Device

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer_id (type: String.t) - Immutable ID of the G Suite account
  • resource_id (type: String.t) - Immutable ID of Mobile Device
  • 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_mobiledevices_get(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Retrieve Mobile Device

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer_id (type: String.t) - Immutable ID of the G Suite account
  • resource_id (type: String.t) - Immutable ID of Mobile Device
  • 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.
    • :projection (type: String.t) - Restrict information returned to a set of selected fields.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

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

Retrieve all Mobile Devices of a customer (paginated)

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.
    • :maxResults (type: integer()) - Maximum number of results to return.
    • :orderBy (type: String.t) - Column to use for sorting results
    • :pageToken (type: String.t) - Token to specify next page in the list
    • :projection (type: String.t) - Restrict information returned to a set of selected fields.
    • :query (type: String.t) - Search string in the format provided by this Help Center article.
    • :sortOrder (type: String.t) - Whether to return results in ascending or descending order. Only of use when orderBy is also used
  • opts (type: keyword()) - Call options

Returns

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