View Source GoogleApi.AndroidEnterprise.V1.Api.Entitlements (google_api_android_enterprise v0.26.0)

API calls for all endpoints tagged Entitlements.

Summary

Functions

androidenterprise_entitlements_delete(connection, enterprise_id, user_id, entitlement_id, optional_params \\ [], opts \\ [])

Removes an entitlement to an app for a user. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

androidenterprise_entitlements_get(connection, enterprise_id, user_id, entitlement_id, optional_params \\ [], opts \\ [])

Retrieves details of an entitlement. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

androidenterprise_entitlements_list(connection, enterprise_id, user_id, optional_params \\ [], opts \\ [])

Lists all entitlements for the specified user. Only the ID is set. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

androidenterprise_entitlements_update(connection, enterprise_id, user_id, entitlement_id, optional_params \\ [], opts \\ [])

Adds or updates an entitlement to an app for a user. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Functions

Link to this function

androidenterprise_entitlements_delete(connection, enterprise_id, user_id, entitlement_id, optional_params \\ [], opts \\ [])

View Source 
@spec androidenterprise_entitlements_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Removes an entitlement to an app for a user. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • user_id (type: String.t) - The ID of the user.
  • entitlement_id (type: String.t) - The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".
  • 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, %{}} on success
  • {:error, info} on failure
Link to this function

androidenterprise_entitlements_get(connection, enterprise_id, user_id, entitlement_id, optional_params \\ [], opts \\ [])

View Source 
@spec androidenterprise_entitlements_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.Entitlement.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves details of an entitlement. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • user_id (type: String.t) - The ID of the user.
  • entitlement_id (type: String.t) - The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".
  • 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.AndroidEnterprise.V1.Model.Entitlement{}} on success
  • {:error, info} on failure
Link to this function

androidenterprise_entitlements_list(connection, enterprise_id, user_id, optional_params \\ [], opts \\ [])

View Source 
@spec androidenterprise_entitlements_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.EntitlementsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all entitlements for the specified user. Only the ID is set. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • user_id (type: String.t) - The ID of the user.
  • 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.AndroidEnterprise.V1.Model.EntitlementsListResponse{}} on success
  • {:error, info} on failure
Link to this function

androidenterprise_entitlements_update(connection, enterprise_id, user_id, entitlement_id, optional_params \\ [], opts \\ [])

View Source 
@spec androidenterprise_entitlements_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.Entitlement.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Adds or updates an entitlement to an app for a user. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • user_id (type: String.t) - The ID of the user.
  • entitlement_id (type: String.t) - The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".
  • 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").
    • :install (type: boolean()) - Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.
    • :body (type: GoogleApi.AndroidEnterprise.V1.Model.Entitlement.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AndroidEnterprise.V1.Model.Entitlement{}} on success
  • {:error, info} on failure