GoogleApi.CloudChannel.V1.Api.Accounts (google_api_cloud_channel v0.2.0) View Source

API calls for all endpoints tagged Accounts.

Link to this section Summary

Functions

Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists. NOT_FOUND: No Cloud Identity customer exists for provided domain. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The new ChannelPartnerLink resource.

Creates a new Customer resource under the reseller or distributor account. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.

Deletes the given Customer permanently. Possible error codes: PERMISSION_DENIED: The account making the request does not own this customer. INVALID_ARGUMENT: Required request parameters are missing or invalid. FAILED_PRECONDITION: The customer has existing entitlements. NOT_FOUND: No Customer resource found for the name in the request.

Returns the requested Customer resource. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.

Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. NOT_FOUND: Cloud Identity doesn't exist or was deleted. INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.

List Customers. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of Customers, or an empty list if there are no customers.

Updates an existing Customer resource for the reseller or distributor. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: No Customer resource found for the name in the request. Return value: The updated Customer resource.

Returns the requested ChannelPartnerLink resource. You must be a distributor to call this method. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource.

List ChannelPartnerLinks belonging to a distributor. You must be a distributor to call this method. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: The list of the distributor account's ChannelPartnerLink resources.

Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. Link state cannot change from invited to active or suspended. Cannot send reseller_cloud_identity_id, invite_url, or name in update mask. NOT_FOUND: ChannelPartnerLink resource not found. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The updated ChannelPartnerLink resource.

Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. * INVALID_VALUE: Invalid domain value in the request. Return value: A list of CloudIdentityCustomerAccount resources for the domain (may be empty) Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no CloudIdentityCustomerAccount resources match the domain.

Creates a new Customer resource under the reseller or distributor account. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.

Deletes the given Customer permanently. Possible error codes: PERMISSION_DENIED: The account making the request does not own this customer. INVALID_ARGUMENT: Required request parameters are missing or invalid. FAILED_PRECONDITION: The customer has existing entitlements. NOT_FOUND: No Customer resource found for the name in the request.

Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and it updates the state of the customer entitlement. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS. NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons, or entitlements for Google Cloud's development platform. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata.

Updates the Offer for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Offer or Entitlement resource not found. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Change parameters of the entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan. NOT_FOUND: Entitlement resource not found. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Updates the renewal settings for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Creates an entitlement for a customer. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. There is already a customer entitlement for a SKU from the same product family. INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting. NOT_FOUND: The customer or offer resource was not found. ALREADY_EXISTS: The SKU was already purchased for the customer. The customer's primary email already exists. Retry after changing the customer's primary contact email. CONDITION_NOT_MET or FAILED_PRECONDITION: The domain required for purchasing a SKU has not been verified. A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. (Developer accounts only) Reseller and resold domain must meet the following naming requirements: Domain names must start with goog-test. Domain names must include the reseller domain. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Returns the requested Entitlement resource. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested Entitlement resource.

Lists Entitlements belonging to a customer. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's Entitlements.

Returns the requested Offer resource. Possible error codes: PERMISSION_DENIED: The entitlement doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement or offer was not found. Return value: The Offer resource.

Starts paid service for a trial entitlement. Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. NOT_ACTIVE: Entitlement is not active. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Returns the requested Customer resource. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.

Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. NOT_FOUND: Cloud Identity doesn't exist or was deleted. INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.

List Customers. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of Customers, or an empty list if there are no customers.

Lists the following: Offers that you can purchase for a customer. Offers that you can change for an entitlement. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller INVALID_ARGUMENT: Required request parameters are missing or invalid.

Lists the following: SKUs that you can purchase for a customer SKUs that you can upgrade or downgrade for an entitlement. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid.

Updates an existing Customer resource for the reseller or distributor. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: No Customer resource found for the name in the request. Return value: The updated Customer resource.

Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The customer was not found. ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata.

Transfers customer entitlements to new reseller. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The customer or offer resource was not found. ALREADY_EXISTS: The SKU was already transferred for the customer. CONDITION_NOT_MET or FAILED_PRECONDITION: The SKU requires domain verification to transfer, but the domain is not verified. An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). (Developer accounts only) Reseller and resold domain must meet the following naming requirements: Domain names must start with goog-test. Domain names must include the reseller domain. Specify all transferring entitlements. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Transfers customer entitlements from their current reseller to Google. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The customer or offer resource was not found. ALREADY_EXISTS: The SKU was already transferred for the customer. CONDITION_NOT_MET or FAILED_PRECONDITION: The SKU requires domain verification to transfer, but the domain is not verified. An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). (Developer accounts only) Reseller and resold domain must meet the following naming requirements: Domain names must start with goog-test. Domain names must include the reseller domain. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata.

Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The topic resource doesn't exist. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.

List TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request. Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller and has no auth token. The supplied auth token is invalid. The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of TransferableOffer for the given customer and SKU.

List TransferableSkus of a customer based on the Cloud Identity ID or Customer Name in the request. Use this method to list the entitlements information of an unowned customer. You should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller and has no auth token. The supplied auth token is invalid. The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's TransferableSku.

Lists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.

Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. INVALID_ARGUMENT: Required request parameters are missing or invalid. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The topic resource doesn't exist. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.

Link to this section Functions

Link to this function

cloudchannel_accounts_check_cloud_identity_accounts_exist(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_check_cloud_identity_accounts_exist(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. * INVALID_VALUE: Invalid domain value in the request. Return value: A list of CloudIdentityCustomerAccount resources for the domain (may be empty) Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no CloudIdentityCustomerAccount resources match the domain.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The reseller account's resource name. Parent uses the format: accounts/{account_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_create(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1Customer.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new Customer resource under the reseller or distributor account. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1Customer.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the given Customer permanently. Possible error codes: PERMISSION_DENIED: The account making the request does not own this customer. INVALID_ARGUMENT: Required request parameters are missing or invalid. FAILED_PRECONDITION: The customer has existing entitlements. NOT_FOUND: No Customer resource found for the name in the request.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the customer to delete.
  • 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.CloudChannel.V1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

cloudchannel_accounts_customers_entitlements_activate(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_entitlements_activate(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and it updates the state of the customer entitlement. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS. NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the entitlement to activate. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ActivateEntitlementRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_entitlements_cancel(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_entitlements_cancel(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons, or entitlements for Google Cloud's development platform. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the entitlement to cancel. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1CancelEntitlementRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_entitlements_change_offer(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_entitlements_change_offer(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the Offer for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Offer or Entitlement resource not found. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ChangeOfferRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_entitlements_change_parameters(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_entitlements_change_parameters(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Change parameters of the entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan. NOT_FOUND: Entitlement resource not found. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ChangeParametersRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_entitlements_change_renewal_settings(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_entitlements_change_renewal_settings(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the renewal settings for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ChangeRenewalSettingsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_entitlements_create(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_entitlements_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an entitlement for a customer. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. There is already a customer entitlement for a SKU from the same product family. INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting. NOT_FOUND: The customer or offer resource was not found. ALREADY_EXISTS: The SKU was already purchased for the customer. The customer's primary email already exists. Retry after changing the customer's primary contact email. CONDITION_NOT_MET or FAILED_PRECONDITION: The domain required for purchasing a SKU has not been verified. A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. (Developer accounts only) Reseller and resold domain must meet the following naming requirements: Domain names must start with goog-test. Domain names must include the reseller domain. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of the reseller's customer account in which to create the entitlement. Parent uses the format: accounts/{account_id}/customers/{customer_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1CreateEntitlementRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_entitlements_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_entitlements_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1Entitlement.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the requested Entitlement resource. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested Entitlement resource.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the entitlement to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
  • 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.CloudChannel.V1.Model.GoogleCloudChannelV1Entitlement{}} on success
  • {:error, info} on failure
Link to this function

cloudchannel_accounts_customers_entitlements_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_entitlements_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListEntitlementsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists Entitlements belonging to a customer. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's Entitlements.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of the reseller's customer account to list entitlements for. Parent uses the format: accounts/{account_id}/customers/{customer_id}
  • 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").
    • :pageSize (type: integer()) - Optional. Requested page size. Server might return fewer results than requested. If unspecified, return at most 50 entitlements. The maximum value is 100; the server will coerce values above 100.
    • :pageToken (type: String.t) - Optional. A token for a page of results other than the first page. Obtained using ListEntitlementsResponse.next_page_token of the previous CloudChannelService.ListEntitlements call.
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_entitlements_lookup_offer(connection, entitlement, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_entitlements_lookup_offer(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1Offer.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the requested Offer resource. Possible error codes: PERMISSION_DENIED: The entitlement doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement or offer was not found. Return value: The Offer resource.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • entitlement (type: String.t) - Required. The resource name of the entitlement to retrieve the Offer. Entitlement uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
  • 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.CloudChannel.V1.Model.GoogleCloudChannelV1Offer{}} on success
  • {:error, info} on failure
Link to this function

cloudchannel_accounts_customers_entitlements_start_paid_service(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_entitlements_start_paid_service(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Starts paid service for a trial entitlement. Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the entitlement to start a paid service for. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1StartPaidServiceRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_entitlements_suspend(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_entitlements_suspend(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: Entitlement resource not found. NOT_ACTIVE: Entitlement is not active. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the entitlement to suspend. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1SuspendEntitlementRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1Customer.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the requested Customer resource. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}
  • 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.CloudChannel.V1.Model.GoogleCloudChannelV1Customer{}} on success
  • {:error, info} on failure
Link to this function

cloudchannel_accounts_customers_import(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_import(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1Customer.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. NOT_FOUND: Cloud Identity doesn't exist or was deleted. INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ImportCustomerRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListCustomersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List Customers. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of Customers, or an empty list if there are no customers.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id}.
  • 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").
    • :pageSize (type: integer()) - Optional. The maximum number of customers to return. The service may return fewer than this value. If unspecified, returns at most 10 customers. The maximum value is 50.
    • :pageToken (type: String.t) - Optional. A token identifying a page of results other than the first page. Obtained through ListCustomersResponse.next_page_token of the previous CloudChannelService.ListCustomers call.
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_list_purchasable_offers(connection, customer, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_list_purchasable_offers(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListPurchasableOffersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the following: Offers that you can purchase for a customer. Offers that you can change for an entitlement. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • customer (type: String.t) - Required. The resource name of the customer to list Offers for. Format: accounts/{account_id}/customers/{customer_id}.
  • 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").
    • :"changeOfferPurchase.entitlement" (type: String.t) - Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
    • :"changeOfferPurchase.newSku" (type: String.t) - Optional. Resource name of the new target SKU. Provide this SKU when upgrading or downgrading an entitlement. Format: products/{product_id}/skus/{sku_id}
    • :"createEntitlementPurchase.sku" (type: String.t) - Required. SKU that the result should be restricted to. Format: products/{product_id}/skus/{sku_id}.
    • :languageCode (type: String.t) - Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".
    • :pageSize (type: integer()) - Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 Offers. The maximum value is 1000; the server will coerce values above 1000.
    • :pageToken (type: String.t) - Optional. A token for a page of results other than the first page.
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_list_purchasable_skus(connection, customer, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_list_purchasable_skus(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListPurchasableSkusResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the following: SKUs that you can purchase for a customer SKUs that you can upgrade or downgrade for an entitlement. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • customer (type: String.t) - Required. The resource name of the customer to list SKUs for. Format: accounts/{account_id}/customers/{customer_id}.
  • 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").
    • :"changeOfferPurchase.changeType" (type: String.t) - Required. Change Type for the entitlement.
    • :"changeOfferPurchase.entitlement" (type: String.t) - Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
    • :"createEntitlementPurchase.product" (type: String.t) - Required. List SKUs belonging to this Product. Format: products/{product_id}. Supports products/- to retrieve SKUs for all products.
    • :languageCode (type: String.t) - Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".
    • :pageSize (type: integer()) - Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000.
    • :pageToken (type: String.t) - Optional. A token for a page of results other than the first page.
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1Customer.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing Customer resource for the reseller or distributor. Possible error codes: PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: No Customer resource found for the name in the request. Return value: The updated Customer resource.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}
  • 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").
    • :updateMask (type: String.t) - The update mask that applies to the resource. Optional.
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1Customer.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_provision_cloud_identity(connection, customer, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_provision_cloud_identity(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The customer was not found. ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • customer (type: String.t) - Required. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ProvisionCloudIdentityRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_transfer_entitlements(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_transfer_entitlements(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Transfers customer entitlements to new reseller. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The customer or offer resource was not found. ALREADY_EXISTS: The SKU was already transferred for the customer. CONDITION_NOT_MET or FAILED_PRECONDITION: The SKU requires domain verification to transfer, but the domain is not verified. An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). (Developer accounts only) Reseller and resold domain must meet the following naming requirements: Domain names must start with goog-test. Domain names must include the reseller domain. Specify all transferring entitlements. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of the reseller's customer account that will receive transferred entitlements. Parent uses the format: accounts/{account_id}/customers/{customer_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1TransferEntitlementsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_customers_transfer_entitlements_to_google(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_customers_transfer_entitlements_to_google(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudChannel.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Transfers customer entitlements from their current reseller to Google. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The customer or offer resource was not found. ALREADY_EXISTS: The SKU was already transferred for the customer. CONDITION_NOT_MET or FAILED_PRECONDITION: The SKU requires domain verification to transfer, but the domain is not verified. An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). (Developer accounts only) Reseller and resold domain must meet the following naming requirements: Domain names must start with goog-test. Domain names must include the reseller domain. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of the reseller's customer account where the entitlements transfer from. Parent uses the format: accounts/{account_id}/customers/{customer_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1TransferEntitlementsToGoogleRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_list_subscribers(connection, account, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_list_subscribers(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListSubscribersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The topic resource doesn't exist. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • account (type: String.t) - Required. Resource name of the account.
  • 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").
    • :pageSize (type: integer()) - Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListSubscribers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscribers must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_list_transferable_offers(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_list_transferable_offers(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListTransferableOffersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request. Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller and has no auth token. The supplied auth token is invalid. The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of TransferableOffer for the given customer and SKU.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of the reseller's account.
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListTransferableOffersRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_list_transferable_skus(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_list_transferable_skus(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListTransferableSkusResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List TransferableSkus of a customer based on the Cloud Identity ID or Customer Name in the request. Use this method to list the entitlements information of an unowned customer. You should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: PERMISSION_DENIED: The customer doesn't belong to the reseller and has no auth token. The supplied auth token is invalid. The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's TransferableSku.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The reseller account's resource name. Parent uses the format: accounts/{account_id}
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListTransferableSkusRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_offers_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_offers_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListOffersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.
  • 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").
    • :filter (type: String.t) - Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1
    • :languageCode (type: String.t) - Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".
    • :pageSize (type: integer()) - Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.
    • :pageToken (type: String.t) - Optional. A token for a page of results other than the first page.
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_register(connection, account, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_register(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1RegisterSubscriberResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. INVALID_ARGUMENT: Required request parameters are missing or invalid. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • account (type: String.t) - Required. Resource name of the account.
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1RegisterSubscriberRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

cloudchannel_accounts_unregister(connection, account, optional_params \\ [], opts \\ [])

View Source

Specs

cloudchannel_accounts_unregister(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1UnregisterSubscriberResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. INVALID_ARGUMENT: Required request parameters are missing or invalid. NOT_FOUND: The topic resource doesn't exist. INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • account (type: String.t) - Required. Resource name of the account.
  • 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").
    • :body (type: GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1UnregisterSubscriberRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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