google_api_android_enterprise v0.16.1 GoogleApi.AndroidEnterprise.V1.Api.Entitlements View Source

API calls for all endpoints tagged Entitlements.

Link to this section Summary

Link to this section Functions

Link to this function

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

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

Removes an entitlement to an app for a user.

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

    • :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

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

View Source
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()}
  | {:error, Tesla.Env.t()}

Retrieves details of an entitlement.

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

    • :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.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
androidenterprise_entitlements_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.EntitlementsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Lists all entitlements for the specified user. Only the ID is set.

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

    • :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.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
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()}
  | {:error, Tesla.Env.t()}

Adds or updates an entitlement to an app for a user.

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

    • :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.
    • :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