google_api_licensing v0.0.1 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, opts \\ []) View Source
licensing_license_assignments_delete(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, nil} |
  {:error, Tesla.Env.t}

Revoke License.

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String): Name for product
  • sku_id (String): Name for sku
  • user_id (String): email id or unique Id of the user
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function licensing_license_assignments_get(connection, product_id, sku_id, user_id, opts \\ []) View Source
licensing_license_assignments_get(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Licensing.V1.Model.LicenseAssignment.t} |
  {:error, Tesla.Env.t}

Get license assignment of a particular product and sku for a user

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String): Name for product
  • sku_id (String): Name for sku
  • user_id (String): email id or unique Id of the user
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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, opts \\ []) View Source
licensing_license_assignments_insert(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Licensing.V1.Model.LicenseAssignment.t} |
  {:error, Tesla.Env.t}

Assign License.

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String): Name for product
  • sku_id (String): Name for sku
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :body (LicenseAssignmentInsert):

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, opts \\ []) View Source
licensing_license_assignments_list_for_product(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Licensing.V1.Model.LicenseAssignmentList.t} |
  {:error, Tesla.Env.t}

List license assignments for given product of the customer.

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String): Name for product
  • customer_id (String): CustomerId represents the customer for whom licenseassignments are queried
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :max_results (Integer): Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
    • :page_token (String): Token to fetch the next page.Optional. By default server will return first page

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, opts \\ []) View Source
licensing_license_assignments_list_for_product_and_sku(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Licensing.V1.Model.LicenseAssignmentList.t} |
  {:error, Tesla.Env.t}

List license assignments for given product and sku of the customer.

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String): Name for product
  • sku_id (String): Name for sku
  • customer_id (String): CustomerId represents the customer for whom licenseassignments are queried
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :max_results (Integer): Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
    • :page_token (String): Token to fetch the next page.Optional. By default server will return first page

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, opts \\ []) View Source
licensing_license_assignments_patch(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Licensing.V1.Model.LicenseAssignment.t} |
  {:error, Tesla.Env.t}

Assign License. This method supports patch semantics.

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String): Name for product
  • sku_id (String): Name for sku for which license would be revoked
  • user_id (String): email id or unique Id of the user
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :body (LicenseAssignment):

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, opts \\ []) View Source
licensing_license_assignments_update(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Licensing.V1.Model.LicenseAssignment.t} |
  {:error, Tesla.Env.t}

Assign License.

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String): Name for product
  • sku_id (String): Name for sku for which license would be revoked
  • user_id (String): email id or unique Id of the user
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :body (LicenseAssignment):

Returns

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