google_api_licensing v0.8.0 GoogleApi.Licensing.V1.Api.LicenseAssignments View Source

API calls for all endpoints tagged LicenseAssignments.

Link to this section Summary

Link to this section Functions

Link to this function

licensing_license_assignments_delete(connection, product_id, sku_id, user_id, optional_params \\ [], opts \\ [])

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

Revoke a license.

Parameters

  • connection (type: GoogleApi.Licensing.V1.Connection.t) - Connection to server
  • product_id (type: String.t) - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
  • sku_id (type: String.t) - A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
  • user_id (type: String.t) - The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
  • 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

licensing_license_assignments_get(connection, product_id, sku_id, user_id, optional_params \\ [], opts \\ [])

View Source
licensing_license_assignments_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Licensing.V1.Model.LicenseAssignment.t()}
  | {:error, Tesla.Env.t()}

Get a specific user's license by product SKU.

Parameters

  • connection (type: GoogleApi.Licensing.V1.Connection.t) - Connection to server
  • product_id (type: String.t) - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
  • sku_id (type: String.t) - A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
  • user_id (type: String.t) - The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
  • 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.Licensing.V1.Model.LicenseAssignment{}} on success
  • {:error, info} on failure
Link to this function

licensing_license_assignments_insert(connection, product_id, sku_id, optional_params \\ [], opts \\ [])

View Source
licensing_license_assignments_insert(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Licensing.V1.Model.LicenseAssignment.t()}
  | {:error, Tesla.Env.t()}

Assign a license.

Parameters

  • connection (type: GoogleApi.Licensing.V1.Connection.t) - Connection to server
  • product_id (type: String.t) - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
  • sku_id (type: String.t) - A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
  • 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.Licensing.V1.Model.LicenseAssignmentInsert.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Licensing.V1.Model.LicenseAssignment{}} on success
  • {:error, info} on failure
Link to this function

licensing_license_assignments_list_for_product(connection, product_id, customer_id, optional_params \\ [], opts \\ [])

View Source
licensing_license_assignments_list_for_product(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Licensing.V1.Model.LicenseAssignmentList.t()}
  | {:error, Tesla.Env.t()}

List all users assigned licenses for a specific product SKU.

Parameters

  • connection (type: GoogleApi.Licensing.V1.Connection.t) - Connection to server
  • product_id (type: String.t) - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
  • customer_id (type: String.t) - Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error.
  • 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()) - The maxResults query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.
    • :pageToken (type: String.t) - Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Licensing.V1.Model.LicenseAssignmentList{}} on success
  • {:error, info} on failure
Link to this function

licensing_license_assignments_list_for_product_and_sku(connection, product_id, sku_id, customer_id, optional_params \\ [], opts \\ [])

View Source
licensing_license_assignments_list_for_product_and_sku(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Licensing.V1.Model.LicenseAssignmentList.t()}
  | {:error, Tesla.Env.t()}

List all users assigned licenses for a specific product SKU.

Parameters

  • connection (type: GoogleApi.Licensing.V1.Connection.t) - Connection to server
  • product_id (type: String.t) - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
  • sku_id (type: String.t) - A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
  • customer_id (type: String.t) - Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error.
  • 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()) - The maxResults query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.
    • :pageToken (type: String.t) - Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Licensing.V1.Model.LicenseAssignmentList{}} on success
  • {:error, info} on failure
Link to this function

licensing_license_assignments_patch(connection, product_id, sku_id, user_id, optional_params \\ [], opts \\ [])

View Source
licensing_license_assignments_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Licensing.V1.Model.LicenseAssignment.t()}
  | {:error, Tesla.Env.t()}

Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.Licensing.V1.Connection.t) - Connection to server
  • product_id (type: String.t) - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
  • sku_id (type: String.t) - A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
  • user_id (type: String.t) - The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
  • 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.Licensing.V1.Model.LicenseAssignment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Licensing.V1.Model.LicenseAssignment{}} on success
  • {:error, info} on failure
Link to this function

licensing_license_assignments_update(connection, product_id, sku_id, user_id, optional_params \\ [], opts \\ [])

View Source
licensing_license_assignments_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Licensing.V1.Model.LicenseAssignment.t()}
  | {:error, Tesla.Env.t()}

Reassign a user's product SKU with a different SKU in the same product.

Parameters

  • connection (type: GoogleApi.Licensing.V1.Connection.t) - Connection to server
  • product_id (type: String.t) - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
  • sku_id (type: String.t) - A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
  • user_id (type: String.t) - The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
  • 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.Licensing.V1.Model.LicenseAssignment.t) -
  • opts (type: keyword()) - Call options

Returns

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