class AccountsChannelPartnerLinksCustomers extends Resource (View source)

The "customers" collection of methods.

Typical usage is:

 $cloudchannelService = new Google\Service\Cloudchannel(...);
 $customers = $cloudchannelService->accounts_channelPartnerLinks_customers;

Methods

create(string $parent, GoogleCloudChannelV1Customer $postBody, array $optParams = [])

Creates a new Customer resource under the reseller or distributor account.

delete(string $name, array $optParams = [])

Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer.

get(string $name, array $optParams = [])

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. (customers.get)

import(string $parent, GoogleCloudChannelV1ImportCustomerRequest $postBody, array $optParams = [])

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. (customers.import)

listAccountsChannelPartnerLinksCustomers(string $parent, array $optParams = [])

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. (customers.listAccountsChannelPartnerLinksCustomers)

patch(string $name, GoogleCloudChannelV1Customer $postBody, array $optParams = [])

Updates an existing Customer resource for the reseller or distributor.

Details

GoogleCloudChannelV1Customer create(string $parent, GoogleCloudChannelV1Customer $postBody, array $optParams = [])

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. (customers.create)

Parameters

string $parent

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

GoogleCloudChannelV1Customer $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1Customer

Exceptions

Exception

GoogleProtobufEmpty delete(string $name, array $optParams = [])

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. (customers.delete)

Parameters

string $name

Required. The resource name of the customer to delete.

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudChannelV1Customer get(string $name, array $optParams = [])

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. (customers.get)

Parameters

string $name

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

array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1Customer

Exceptions

Exception

GoogleCloudChannelV1Customer import(string $parent, GoogleCloudChannelV1ImportCustomerRequest $postBody, array $optParams = [])

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. (customers.import)

Parameters

string $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}

GoogleCloudChannelV1ImportCustomerRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1Customer

Exceptions

Exception

GoogleCloudChannelV1ListCustomersResponse listAccountsChannelPartnerLinksCustomers(string $parent, array $optParams = [])

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. (customers.listAccountsChannelPartnerLinksCustomers)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1ListCustomersResponse

Exceptions

Exception

GoogleCloudChannelV1Customer patch(string $name, GoogleCloudChannelV1Customer $postBody, array $optParams = [])

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. (customers.patch)

Parameters

string $name

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

GoogleCloudChannelV1Customer $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1Customer

Exceptions

Exception