CloudChannel

import { CloudChannel } from "https://googleapis.deno.dev/v1/cloudchannel:v1.ts";

The Cloud Channel API enables Google Cloud partners to have a single unified resale platform and APIs across all of Google Cloud including GCP, Workspace, Maps and Chrome.

class CloudChannel {

constructor(client?: CredentialsClient, baseUrl?: string);

async accountsChannelPartnerLinksChannelPartnerRepricingConfigsCreate(parent: string, req: GoogleCloudChannelV1ChannelPartnerRepricingConfig): Promise<GoogleCloudChannelV1ChannelPartnerRepricingConfig>;

async accountsChannelPartnerLinksChannelPartnerRepricingConfigsDelete(name: string): Promise<GoogleProtobufEmpty>;

async accountsChannelPartnerLinksChannelPartnerRepricingConfigsGet(name: string): Promise<GoogleCloudChannelV1ChannelPartnerRepricingConfig>;

async accountsChannelPartnerLinksChannelPartnerRepricingConfigsList(parent: string, opts?: AccountsChannelPartnerLinksChannelPartnerRepricingConfigsListOptions): Promise<GoogleCloudChannelV1ListChannelPartnerRepricingConfigsResponse>;

async accountsChannelPartnerLinksChannelPartnerRepricingConfigsPatch(name: string, req: GoogleCloudChannelV1ChannelPartnerRepricingConfig): Promise<GoogleCloudChannelV1ChannelPartnerRepricingConfig>;

async accountsChannelPartnerLinksCreate(parent: string, req: GoogleCloudChannelV1ChannelPartnerLink): Promise<GoogleCloudChannelV1ChannelPartnerLink>;

async accountsChannelPartnerLinksCustomersCreate(parent: string, req: GoogleCloudChannelV1Customer): Promise<GoogleCloudChannelV1Customer>;

async accountsChannelPartnerLinksCustomersDelete(name: string): Promise<GoogleProtobufEmpty>;

async accountsChannelPartnerLinksCustomersGet(name: string): Promise<GoogleCloudChannelV1Customer>;

async accountsChannelPartnerLinksCustomersImport(parent: string, req: GoogleCloudChannelV1ImportCustomerRequest): Promise<GoogleCloudChannelV1Customer>;

async accountsChannelPartnerLinksCustomersList(parent: string, opts?: AccountsChannelPartnerLinksCustomersListOptions): Promise<GoogleCloudChannelV1ListCustomersResponse>;

async accountsChannelPartnerLinksCustomersPatch(

name: string,

req: GoogleCloudChannelV1Customer,

opts?: AccountsChannelPartnerLinksCustomersPatchOptions,

): Promise<GoogleCloudChannelV1Customer>;

async accountsChannelPartnerLinksGet(name: string, opts?: AccountsChannelPartnerLinksGetOptions): Promise<GoogleCloudChannelV1ChannelPartnerLink>;

async accountsChannelPartnerLinksList(parent: string, opts?: AccountsChannelPartnerLinksListOptions): Promise<GoogleCloudChannelV1ListChannelPartnerLinksResponse>;

async accountsChannelPartnerLinksPatch(name: string, req: GoogleCloudChannelV1UpdateChannelPartnerLinkRequest): Promise<GoogleCloudChannelV1ChannelPartnerLink>;

async accountsCheckCloudIdentityAccountsExist(parent: string, req: GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest): Promise<GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse>;

async accountsCustomersCreate(parent: string, req: GoogleCloudChannelV1Customer): Promise<GoogleCloudChannelV1Customer>;

async accountsCustomersCustomerRepricingConfigsCreate(parent: string, req: GoogleCloudChannelV1CustomerRepricingConfig): Promise<GoogleCloudChannelV1CustomerRepricingConfig>;

async accountsCustomersCustomerRepricingConfigsDelete(name: string): Promise<GoogleProtobufEmpty>;

async accountsCustomersCustomerRepricingConfigsGet(name: string): Promise<GoogleCloudChannelV1CustomerRepricingConfig>;

async accountsCustomersCustomerRepricingConfigsList(parent: string, opts?: AccountsCustomersCustomerRepricingConfigsListOptions): Promise<GoogleCloudChannelV1ListCustomerRepricingConfigsResponse>;

async accountsCustomersCustomerRepricingConfigsPatch(name: string, req: GoogleCloudChannelV1CustomerRepricingConfig): Promise<GoogleCloudChannelV1CustomerRepricingConfig>;

async accountsCustomersDelete(name: string): Promise<GoogleProtobufEmpty>;

async accountsCustomersEntitlementsActivate(name: string, req: GoogleCloudChannelV1ActivateEntitlementRequest): Promise<GoogleLongrunningOperation>;

async accountsCustomersEntitlementsCancel(name: string, req: GoogleCloudChannelV1CancelEntitlementRequest): Promise<GoogleLongrunningOperation>;

async accountsCustomersEntitlementsChangeOffer(name: string, req: GoogleCloudChannelV1ChangeOfferRequest): Promise<GoogleLongrunningOperation>;

async accountsCustomersEntitlementsChangeParameters(name: string, req: GoogleCloudChannelV1ChangeParametersRequest): Promise<GoogleLongrunningOperation>;

async accountsCustomersEntitlementsChangeRenewalSettings(name: string, req: GoogleCloudChannelV1ChangeRenewalSettingsRequest): Promise<GoogleLongrunningOperation>;

async accountsCustomersEntitlementsCreate(parent: string, req: GoogleCloudChannelV1CreateEntitlementRequest): Promise<GoogleLongrunningOperation>;

async accountsCustomersEntitlementsGet(name: string): Promise<GoogleCloudChannelV1Entitlement>;

async accountsCustomersEntitlementsList(parent: string, opts?: AccountsCustomersEntitlementsListOptions): Promise<GoogleCloudChannelV1ListEntitlementsResponse>;

async accountsCustomersEntitlementsListEntitlementChanges(parent: string, opts?: AccountsCustomersEntitlementsListEntitlementChangesOptions): Promise<GoogleCloudChannelV1ListEntitlementChangesResponse>;

async accountsCustomersEntitlementsLookupOffer(entitlement: string): Promise<GoogleCloudChannelV1Offer>;

async accountsCustomersEntitlementsStartPaidService(name: string, req: GoogleCloudChannelV1StartPaidServiceRequest): Promise<GoogleLongrunningOperation>;

async accountsCustomersEntitlementsSuspend(name: string, req: GoogleCloudChannelV1SuspendEntitlementRequest): Promise<GoogleLongrunningOperation>;

async accountsCustomersGet(name: string): Promise<GoogleCloudChannelV1Customer>;

async accountsCustomersImport(parent: string, req: GoogleCloudChannelV1ImportCustomerRequest): Promise<GoogleCloudChannelV1Customer>;

async accountsCustomersList(parent: string, opts?: AccountsCustomersListOptions): Promise<GoogleCloudChannelV1ListCustomersResponse>;

async accountsCustomersListPurchasableOffers(customer: string, opts?: AccountsCustomersListPurchasableOffersOptions): Promise<GoogleCloudChannelV1ListPurchasableOffersResponse>;

async accountsCustomersListPurchasableSkus(customer: string, opts?: AccountsCustomersListPurchasableSkusOptions): Promise<GoogleCloudChannelV1ListPurchasableSkusResponse>;

async accountsCustomersPatch(

name: string,

req: GoogleCloudChannelV1Customer,

opts?: AccountsCustomersPatchOptions,

): Promise<GoogleCloudChannelV1Customer>;

async accountsCustomersProvisionCloudIdentity(customer: string, req: GoogleCloudChannelV1ProvisionCloudIdentityRequest): Promise<GoogleLongrunningOperation>;

async accountsCustomersQueryEligibleBillingAccounts(customer: string, opts?: AccountsCustomersQueryEligibleBillingAccountsOptions): Promise<GoogleCloudChannelV1QueryEligibleBillingAccountsResponse>;

async accountsCustomersTransferEntitlements(parent: string, req: GoogleCloudChannelV1TransferEntitlementsRequest): Promise<GoogleLongrunningOperation>;

async accountsCustomersTransferEntitlementsToGoogle(parent: string, req: GoogleCloudChannelV1TransferEntitlementsToGoogleRequest): Promise<GoogleLongrunningOperation>;

async accountsListSubscribers(account: string, opts?: AccountsListSubscribersOptions): Promise<GoogleCloudChannelV1ListSubscribersResponse>;

async accountsListTransferableOffers(parent: string, req: GoogleCloudChannelV1ListTransferableOffersRequest): Promise<GoogleCloudChannelV1ListTransferableOffersResponse>;

async accountsListTransferableSkus(parent: string, req: GoogleCloudChannelV1ListTransferableSkusRequest): Promise<GoogleCloudChannelV1ListTransferableSkusResponse>;

async accountsOffersList(parent: string, opts?: AccountsOffersListOptions): Promise<GoogleCloudChannelV1ListOffersResponse>;

async accountsRegister(account: string, req: GoogleCloudChannelV1RegisterSubscriberRequest): Promise<GoogleCloudChannelV1RegisterSubscriberResponse>;

async accountsReportJobsFetchReportResults(reportJob: string, req: GoogleCloudChannelV1FetchReportResultsRequest): Promise<GoogleCloudChannelV1FetchReportResultsResponse>;

async accountsReportsList(parent: string, opts?: AccountsReportsListOptions): Promise<GoogleCloudChannelV1ListReportsResponse>;

async accountsReportsRun(name: string, req: GoogleCloudChannelV1RunReportJobRequest): Promise<GoogleLongrunningOperation>;

async accountsSkuGroupsBillableSkusList(parent: string, opts?: AccountsSkuGroupsBillableSkusListOptions): Promise<GoogleCloudChannelV1ListSkuGroupBillableSkusResponse>;

async accountsSkuGroupsList(parent: string, opts?: AccountsSkuGroupsListOptions): Promise<GoogleCloudChannelV1ListSkuGroupsResponse>;

async accountsUnregister(account: string, req: GoogleCloudChannelV1UnregisterSubscriberRequest): Promise<GoogleCloudChannelV1UnregisterSubscriberResponse>;

async operationsCancel(name: string, req: GoogleLongrunningCancelOperationRequest): Promise<GoogleProtobufEmpty>;

async operationsDelete(name: string): Promise<GoogleProtobufEmpty>;

async operationsGet(name: string): Promise<GoogleLongrunningOperation>;

async operationsList(name: string, opts?: OperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;

async productsList(opts?: ProductsListOptions): Promise<GoogleCloudChannelV1ListProductsResponse>;

async productsSkusList(parent: string, opts?: ProductsSkusListOptions): Promise<GoogleCloudChannelV1ListSkusResponse>;

}

§Constructors

new CloudChannel(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

accountsChannelPartnerLinksChannelPartnerRepricingConfigsCreate(parent: string, req: GoogleCloudChannelV1ChannelPartnerRepricingConfig): Promise<GoogleCloudChannelV1ChannelPartnerRepricingConfig>

[src]

Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions. When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month. The following restrictions are for creating configs in the current month. * This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases. * The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours. * There is a limit of ten configs for any ChannelPartner or RepricingConfig.EntitlementGranularity.entitlement, for any RepricingConfig.effective_invoice_month. * The contained ChannelPartnerRepricingConfig.repricing_config value must be different from the value used in the current config for a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error.

@param parent

Required. The resource name of the ChannelPartner that will receive the repricing config. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}

accountsChannelPartnerLinksChannelPartnerRepricingConfigsDelete(name: string): Promise<GoogleProtobufEmpty>

[src]

Deletes the given ChannelPartnerRepricingConfig permanently. You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month. 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 ChannelPartnerRepricingConfig is active or in the past. * NOT_FOUND: No ChannelPartnerRepricingConfig found for the name in the request.

@param name

Required. The resource name of the channel partner repricing config rule to delete.

accountsChannelPartnerLinksChannelPartnerRepricingConfigsGet(name: string): Promise<GoogleCloudChannelV1ChannelPartnerRepricingConfig>

[src]

Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The ChannelPartnerRepricingConfig was not found. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the ChannelPartnerRepricingConfig resource, otherwise returns an error.

@param name

Required. The resource name of the ChannelPartnerRepricingConfig Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.

accountsChannelPartnerLinksChannelPartnerRepricingConfigsList(parent: string, opts?: AccountsChannelPartnerLinksChannelPartnerRepricingConfigsListOptions): Promise<GoogleCloudChannelV1ListChannelPartnerRepricingConfigsResponse>

[src]

Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the ChannelPartnerRepricingConfig resources. The data for each resource is displayed in the ascending order of: * Channel Partner ID * RepricingConfig.effective_invoice_month * ChannelPartnerRepricingConfig.update_time If unsuccessful, returns an error.

@param parent

Required. The resource name of the account's ChannelPartnerLink. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs for all channel partners.

accountsChannelPartnerLinksChannelPartnerRepricingConfigsPatch(name: string, req: GoogleCloudChannelV1ChannelPartnerRepricingConfig): Promise<GoogleCloudChannelV1ChannelPartnerRepricingConfig>

[src]

Updates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateChannelPartnerRepricingConfig, taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month. When updating a config in the future: * This config must already exist. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error.

@param name

Output only. Resource name of the ChannelPartnerRepricingConfig. Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.

accountsChannelPartnerLinksCreate(parent: string, req: GoogleCloudChannelV1ChannelPartnerLink): Promise<GoogleCloudChannelV1ChannelPartnerLink>

[src]

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.

@param parent

Required. Create a channel partner link for the provided reseller account's resource name. Parent uses the format: accounts/{account_id}

accountsChannelPartnerLinksCustomersCreate(parent: string, req: GoogleCloudChannelV1Customer): Promise<GoogleCloudChannelV1Customer>

[src]

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. * You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265 * 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.

@param parent

Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id}

accountsChannelPartnerLinksCustomersDelete(name: string): Promise<GoogleProtobufEmpty>

[src]

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.

@param name

Required. The resource name of the customer to delete.

accountsChannelPartnerLinksCustomersGet(name: string): Promise<GoogleCloudChannelV1Customer>

[src]

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.

@param name

Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}

accountsChannelPartnerLinksCustomersImport(parent: string, req: GoogleCloudChannelV1ImportCustomerRequest): Promise<GoogleCloudChannelV1Customer>

[src]

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. * You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265 * 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.

@param parent

Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}

accountsChannelPartnerLinksCustomersList(parent: string, opts?: AccountsChannelPartnerLinksCustomersListOptions): Promise<GoogleCloudChannelV1ListCustomersResponse>

[src]

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.

@param parent

Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id}.

accountsChannelPartnerLinksCustomersPatch(name: string, req: GoogleCloudChannelV1Customer, opts?: AccountsChannelPartnerLinksCustomersPatchOptions): Promise<GoogleCloudChannelV1Customer>

[src]

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.

@param name

Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}

accountsChannelPartnerLinksGet(name: string, opts?: AccountsChannelPartnerLinksGetOptions): Promise<GoogleCloudChannelV1ChannelPartnerLink>

[src]

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.

@param name

Required. The resource name of the channel partner link to retrieve. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner.

accountsChannelPartnerLinksList(parent: string, opts?: AccountsChannelPartnerLinksListOptions): Promise<GoogleCloudChannelV1ListChannelPartnerLinksResponse>

[src]

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.

@param parent

Required. The resource name of the reseller account for listing channel partner links. Parent uses the format: accounts/{account_id}

accountsChannelPartnerLinksPatch(name: string, req: GoogleCloudChannelV1UpdateChannelPartnerLinkRequest): Promise<GoogleCloudChannelV1ChannelPartnerLink>

[src]

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.

@param name

Required. The resource name of the channel partner link to cancel. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner.

accountsCheckCloudIdentityAccountsExist(parent: string, req: GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest): Promise<GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse>

[src]

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.

@param parent

Required. The reseller account's resource name. Parent uses the format: accounts/{account_id}

accountsCustomersCreate(parent: string, req: GoogleCloudChannelV1Customer): Promise<GoogleCloudChannelV1Customer>

[src]

@param parent

Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id}

accountsCustomersCustomerRepricingConfigsCreate(parent: string, req: GoogleCloudChannelV1CustomerRepricingConfig): Promise<GoogleCloudChannelV1CustomerRepricingConfig>

[src]

Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions. When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month. The following restrictions are for creating configs in the current month. * This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases. * The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours. * There is a limit of ten configs for any RepricingConfig.EntitlementGranularity.entitlement, for any RepricingConfig.effective_invoice_month. * The contained CustomerRepricingConfig.repricing_config value must be different from the value used in the current config for a RepricingConfig.EntitlementGranularity.entitlement. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error.

@param parent

Required. The resource name of the customer that will receive this repricing config. Parent uses the format: accounts/{account_id}/customers/{customer_id}

accountsCustomersCustomerRepricingConfigsDelete(name: string): Promise<GoogleProtobufEmpty>

[src]

Deletes the given CustomerRepricingConfig permanently. You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month. 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 CustomerRepricingConfig is active or in the past. * NOT_FOUND: No CustomerRepricingConfig found for the name in the request.

@param name

Required. The resource name of the customer repricing config rule to delete. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.

accountsCustomersCustomerRepricingConfigsGet(name: string): Promise<GoogleCloudChannelV1CustomerRepricingConfig>

[src]

Gets information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The CustomerRepricingConfig was not found. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the CustomerRepricingConfig resource, otherwise returns an error.

@param name

Required. The resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.

accountsCustomersCustomerRepricingConfigsList(parent: string, opts?: AccountsCustomersCustomerRepricingConfigsListOptions): Promise<GoogleCloudChannelV1ListCustomerRepricingConfigsResponse>

[src]

Lists information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the CustomerRepricingConfig resources. The data for each resource is displayed in the ascending order of: * Customer ID * RepricingConfig.EntitlementGranularity.entitlement * RepricingConfig.effective_invoice_month * CustomerRepricingConfig.update_time If unsuccessful, returns an error.

@param parent

Required. The resource name of the customer. Parent uses the format: accounts/{account_id}/customers/{customer_id}. Supports accounts/{account_id}/customers/- to retrieve configs for all customers.

accountsCustomersCustomerRepricingConfigsPatch(name: string, req: GoogleCloudChannelV1CustomerRepricingConfig): Promise<GoogleCloudChannelV1CustomerRepricingConfig>

[src]

Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateCustomerRepricingConfig, taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month. When updating a config in the future: * This config must already exist. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error.

@param name

Output only. Resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.

accountsCustomersDelete(name: string): Promise<GoogleProtobufEmpty>

[src]

@param name

Required. The resource name of the customer to delete.

accountsCustomersEntitlementsActivate(name: string, req: GoogleCloudChannelV1ActivateEntitlementRequest): Promise<GoogleLongrunningOperation>

[src]

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.

@param name

Required. The resource name of the entitlement to activate. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

accountsCustomersEntitlementsCancel(name: string, req: GoogleCloudChannelV1CancelEntitlementRequest): Promise<GoogleLongrunningOperation>

[src]

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.

@param name

Required. The resource name of the entitlement to cancel. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

accountsCustomersEntitlementsChangeOffer(name: string, req: GoogleCloudChannelV1ChangeOfferRequest): Promise<GoogleLongrunningOperation>

[src]

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.

@param name

Required. The resource name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

accountsCustomersEntitlementsChangeParameters(name: string, req: GoogleCloudChannelV1ChangeParametersRequest): Promise<GoogleLongrunningOperation>

[src]

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.

@param name

Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

accountsCustomersEntitlementsChangeRenewalSettings(name: string, req: GoogleCloudChannelV1ChangeRenewalSettingsRequest): Promise<GoogleLongrunningOperation>

[src]

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.

@param name

Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

accountsCustomersEntitlementsCreate(parent: string, req: GoogleCloudChannelV1CreateEntitlementRequest): Promise<GoogleLongrunningOperation>

[src]

Creates an entitlement for a customer. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 * 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.

@param parent

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}

accountsCustomersEntitlementsGet(name: string): Promise<GoogleCloudChannelV1Entitlement>

[src]

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.

@param name

Required. The resource name of the entitlement to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

accountsCustomersEntitlementsList(parent: string, opts?: AccountsCustomersEntitlementsListOptions): Promise<GoogleCloudChannelV1ListEntitlementsResponse>

[src]

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.

@param parent

Required. The resource name of the reseller's customer account to list entitlements for. Parent uses the format: accounts/{account_id}/customers/{customer_id}

accountsCustomersEntitlementsListEntitlementChanges(parent: string, opts?: AccountsCustomersEntitlementsListEntitlementChangesOptions): Promise<GoogleCloudChannelV1ListEntitlementChangesResponse>

[src]

List entitlement history. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different. * INVALID_ARGUMENT: Missing or invalid required fields in the request. * NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter. * INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel support.

UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support. Return value: List of EntitlementChanges.

@param parent

Required. The resource name of the entitlement for which to list entitlement changes. The - wildcard may be used to match entitlements across a customer. Formats: * accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} * accounts/{account_id}/customers/{customer_id}/entitlements/-

accountsCustomersEntitlementsLookupOffer(entitlement: string): Promise<GoogleCloudChannelV1Offer>

[src]

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.

@param entitlement

Required. The resource name of the entitlement to retrieve the Offer. Entitlement uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

accountsCustomersEntitlementsStartPaidService(name: string, req: GoogleCloudChannelV1StartPaidServiceRequest): Promise<GoogleLongrunningOperation>

[src]

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.

@param name

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}

accountsCustomersEntitlementsSuspend(name: string, req: GoogleCloudChannelV1SuspendEntitlementRequest): Promise<GoogleLongrunningOperation>

[src]

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.

@param name

Required. The resource name of the entitlement to suspend. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

accountsCustomersGet(name: string): Promise<GoogleCloudChannelV1Customer>

[src]

@param name

Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}

accountsCustomersImport(parent: string, req: GoogleCloudChannelV1ImportCustomerRequest): Promise<GoogleCloudChannelV1Customer>

[src]

@param parent

Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}

accountsCustomersList(parent: string, opts?: AccountsCustomersListOptions): Promise<GoogleCloudChannelV1ListCustomersResponse>

[src]

@param parent

Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id}.

accountsCustomersListPurchasableOffers(customer: string, opts?: AccountsCustomersListPurchasableOffersOptions): Promise<GoogleCloudChannelV1ListPurchasableOffersResponse>

[src]

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 * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: Required request parameters are missing or invalid.

@param customer

Required. The resource name of the customer to list Offers for. Format: accounts/{account_id}/customers/{customer_id}.

accountsCustomersListPurchasableSkus(customer: string, opts?: AccountsCustomersListPurchasableSkusOptions): Promise<GoogleCloudChannelV1ListPurchasableSkusResponse>

[src]

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.

@param customer

Required. The resource name of the customer to list SKUs for. Format: accounts/{account_id}/customers/{customer_id}.

accountsCustomersPatch(name: string, req: GoogleCloudChannelV1Customer, opts?: AccountsCustomersPatchOptions): Promise<GoogleCloudChannelV1Customer>

[src]

@param name

Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}

accountsCustomersProvisionCloudIdentity(customer: string, req: GoogleCloudChannelV1ProvisionCloudIdentityRequest): Promise<GoogleLongrunningOperation>

[src]

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. * You are not authorized to provision cloud identity id. See https://support.google.com/channelservices/answer/9759265 * 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.

@param customer

Required. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}

accountsCustomersQueryEligibleBillingAccounts(customer: string, opts?: AccountsCustomersQueryEligibleBillingAccountsOptions): Promise<GoogleCloudChannelV1QueryEligibleBillingAccountsResponse>

[src]

Lists the billing accounts that are eligible to purchase particular SKUs for a given 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: Based on the provided list of SKUs, returns a list of SKU groups that must be purchased using the same billing account and the billing accounts eligible to purchase each SKU group.

@param customer

Required. The resource name of the customer to list eligible billing accounts for. Format: accounts/{account_id}/customers/{customer_id}.

accountsCustomersTransferEntitlements(parent: string, req: GoogleCloudChannelV1TransferEntitlementsRequest): Promise<GoogleLongrunningOperation>

[src]

Transfers customer entitlements to new reseller. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 * 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.

@param parent

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}

accountsCustomersTransferEntitlementsToGoogle(parent: string, req: GoogleCloudChannelV1TransferEntitlementsToGoogleRequest): Promise<GoogleLongrunningOperation>

[src]

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.

@param parent

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}

accountsListSubscribers(account: string, opts?: AccountsListSubscribersOptions): Promise<GoogleCloudChannelV1ListSubscribersResponse>

[src]

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.

@param account

Required. Resource name of the account.

accountsListTransferableOffers(parent: string, req: GoogleCloudChannelV1ListTransferableOffersRequest): Promise<GoogleCloudChannelV1ListTransferableOffersResponse>

[src]

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 customer provided incorrect reseller information when generating auth token. * The reseller account making the request is different from the reseller account in the query. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of TransferableOffer for the given customer and SKU.

@param parent

Required. The resource name of the reseller's account.

accountsListTransferableSkus(parent: string, req: GoogleCloudChannelV1ListTransferableSkusRequest): Promise<GoogleCloudChannelV1ListTransferableSkusResponse>

[src]

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.

@param parent

Required. The reseller account's resource name. Parent uses the format: accounts/{account_id}

accountsOffersList(parent: string, opts?: AccountsOffersListOptions): Promise<GoogleCloudChannelV1ListOffersResponse>

[src]

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

@param parent

Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.

accountsRegister(account: string, req: GoogleCloudChannelV1RegisterSubscriberRequest): Promise<GoogleCloudChannelV1RegisterSubscriberResponse>

[src]

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.

@param account

Required. Resource name of the account.

accountsReportJobsFetchReportResults(reportJob: string, req: GoogleCloudChannelV1FetchReportResultsRequest): Promise<GoogleCloudChannelV1FetchReportResultsResponse>

[src]

Retrieves data generated by CloudChannelReportsService.RunReportJob. Deprecated: Please use Export Channel Services data to BigQuery instead.

@param reportJob

Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}

accountsReportsList(parent: string, opts?: AccountsReportsListOptions): Promise<GoogleCloudChannelV1ListReportsResponse>

[src]

Lists the reports that RunReportJob can run. These reports include an ID, a description, and the list of columns that will be in the result. Deprecated: Please use Export Channel Services data to BigQuery instead.

@param parent

Required. The resource name of the partner account to list available reports for. Parent uses the format: accounts/{account_id}

accountsReportsRun(name: string, req: GoogleCloudChannelV1RunReportJobRequest): Promise<GoogleLongrunningOperation>

[src]

Begins generation of data for a given report. The report identifier is a UID (for example, 613bf59q). Possible error codes: * PERMISSION_DENIED: The user doesn't have access to this report. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The report identifier was 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 contains an instance of OperationMetadata. To get the results of report generation, call CloudChannelReportsService.FetchReportResults with the RunReportJobResponse.report_job. Deprecated: Please use Export Channel Services data to BigQuery instead.

@param name

Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, 613bf59q). Name uses the format: accounts/{account_id}/reports/{report_id}

accountsSkuGroupsBillableSkusList(parent: string, opts?: AccountsSkuGroupsBillableSkusListOptions): Promise<GoogleCloudChannelV1ListSkuGroupBillableSkusResponse>

[src]

Lists the Billable SKUs in a given SKU group. Possible error codes: PERMISSION_DENIED: If the account making the request and the account being queried for are different, or the account doesn't exist. INVALID_ARGUMENT: Missing or invalid required parameters in the request. INTERNAL: Any non-user error related to technical issue in the backend. In this case, contact cloud channel support. Return Value: If successful, the BillableSku resources. The data for each resource is displayed in the ascending order of: * BillableSku.service_display_name * BillableSku.sku_display_name If unsuccessful, returns an error.

@param parent

Required. Resource name of the SKU group. Format: accounts/{account}/skuGroups/{sku_group}.

accountsSkuGroupsList(parent: string, opts?: AccountsSkuGroupsListOptions): Promise<GoogleCloudChannelV1ListSkuGroupsResponse>

[src]

Lists the Rebilling supported SKU groups the account is authorized to sell. Reference: https://cloud.google.com/skus/sku-groups Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different, or the account doesn't exist. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the SkuGroup resources. The data for each resource is displayed in the alphabetical order of SKU group display name. The data for each resource is displayed in the ascending order of SkuGroup.display_name If unsuccessful, returns an error.

@param parent

Required. The resource name of the account from which to list SKU groups. Parent uses the format: accounts/{account}.

accountsUnregister(account: string, req: GoogleCloudChannelV1UnregisterSubscriberRequest): Promise<GoogleCloudChannelV1UnregisterSubscriberResponse>

[src]

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.

@param account

Required. Resource name of the account.

operationsCancel(name: string, req: GoogleLongrunningCancelOperationRequest): Promise<GoogleProtobufEmpty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

operationsDelete(name: string): Promise<GoogleProtobufEmpty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

operationsGet(name: string): Promise<GoogleLongrunningOperation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

operationsList(name: string, opts?: OperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

productsList(opts?: ProductsListOptions): Promise<GoogleCloudChannelV1ListProductsResponse>

[src]

Lists the Products the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.

productsSkusList(parent: string, opts?: ProductsSkusListOptions): Promise<GoogleCloudChannelV1ListSkusResponse>

[src]

Lists the SKUs for a product the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.

@param parent

Required. The resource name of the Product to list SKUs for. Parent uses the format: products/{product_id}. Supports products/- to retrieve SKUs for all products.