AccountsChannelPartnerLinks
class AccountsChannelPartnerLinks extends Resource (View source)
The "channelPartnerLinks" collection of methods.
Typical usage is:
$cloudchannelService = new Google\Service\Cloudchannel(...);
$channelPartnerLinks = $cloudchannelService->accounts_channelPartnerLinks;Methods
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.
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. (channelPartnerLinks.get)
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. (channelPartnerLinks.patch)
Details
GoogleCloudChannelV1ChannelPartnerLink
create(string $parent, GoogleCloudChannelV1ChannelPartnerLink $postBody, array $optParams = [])
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.
(channelPartnerLinks.create)
GoogleCloudChannelV1ChannelPartnerLink
get(string $name, array $optParams = [])
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. (channelPartnerLinks.get)
GoogleCloudChannelV1ListChannelPartnerLinksResponse
listAccountsChannelPartnerLinks(string $parent, array $optParams = [])
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.
(channelPartnerLinks.listAccountsChannelPartnerLinks)
GoogleCloudChannelV1ChannelPartnerLink
patch(string $name, GoogleCloudChannelV1UpdateChannelPartnerLinkRequest $postBody, array $optParams = [])
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. (channelPartnerLinks.patch)