Returns the customers Resource.
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
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.
get(name, view=None, x__xgafv=None)
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(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)
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.
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(name, body=None, x__xgafv=None)
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.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
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.
Args:
parent: string, Required. Create a channel partner link for the provided reseller account's resource name. Parent uses the format: accounts/{account_id} (required)
body: object, The request body.
The object takes the form of:
{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).
"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.
"alternateEmail": "A String", # The alternate email.
"customerType": "A String", # CustomerType indicates verification type needed for using services.
"eduData": { # Required Edu Attributes # Edu information about the customer.
"instituteSize": "A String", # Size of the institute.
"instituteType": "A String", # Designated institute type of customer.
"website": "A String", # Web address for the edu customer's institution.
},
"isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
"languageCode": "A String", # Language code.
"phoneNumber": "A String", # Phone number associated with the Cloud Identity.
"primaryDomain": "A String", # Output only. The primary domain name.
},
"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.
"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.
"linkState": "A String", # Required. State of the channel partner link.
"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.
"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).
"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.
"alternateEmail": "A String", # The alternate email.
"customerType": "A String", # CustomerType indicates verification type needed for using services.
"eduData": { # Required Edu Attributes # Edu information about the customer.
"instituteSize": "A String", # Size of the institute.
"instituteType": "A String", # Designated institute type of customer.
"website": "A String", # Web address for the edu customer's institution.
},
"isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
"languageCode": "A String", # Language code.
"phoneNumber": "A String", # Phone number associated with the Cloud Identity.
"primaryDomain": "A String", # Output only. The primary domain name.
},
"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.
"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.
"linkState": "A String", # Required. State of the channel partner link.
"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.
"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.
}
get(name, view=None, x__xgafv=None)
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.
Args:
name: string, 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. (required)
view: string, Optional. The level of granularity the ChannelPartnerLink will display.
Allowed values
UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
BASIC - Includes all fields except the ChannelPartnerLink.channel_partner_cloud_identity_info.
FULL - Includes all fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).
"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.
"alternateEmail": "A String", # The alternate email.
"customerType": "A String", # CustomerType indicates verification type needed for using services.
"eduData": { # Required Edu Attributes # Edu information about the customer.
"instituteSize": "A String", # Size of the institute.
"instituteType": "A String", # Designated institute type of customer.
"website": "A String", # Web address for the edu customer's institution.
},
"isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
"languageCode": "A String", # Language code.
"phoneNumber": "A String", # Phone number associated with the Cloud Identity.
"primaryDomain": "A String", # Output only. The primary domain name.
},
"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.
"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.
"linkState": "A String", # Required. State of the channel partner link.
"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.
"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.
}
list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)
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.
Args:
parent: string, Required. The resource name of the reseller account for listing channel partner links. Parent uses the format: accounts/{account_id} (required)
pageSize: integer, Optional. Requested page size. Server might return fewer results than requested. If unspecified, server will pick a default size (25). The maximum value is 200; the server will coerce values above 200.
pageToken: string, Optional. A token for a page of results other than the first page. Obtained using ListChannelPartnerLinksResponse.next_page_token of the previous CloudChannelService.ListChannelPartnerLinks call.
view: string, Optional. The level of granularity the ChannelPartnerLink will display.
Allowed values
UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
BASIC - Includes all fields except the ChannelPartnerLink.channel_partner_cloud_identity_info.
FULL - Includes all fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for CloudChannelService.ListChannelPartnerLinks.
"channelPartnerLinks": [ # The Channel partner links for a reseller.
{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).
"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.
"alternateEmail": "A String", # The alternate email.
"customerType": "A String", # CustomerType indicates verification type needed for using services.
"eduData": { # Required Edu Attributes # Edu information about the customer.
"instituteSize": "A String", # Size of the institute.
"instituteType": "A String", # Designated institute type of customer.
"website": "A String", # Web address for the edu customer's institution.
},
"isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
"languageCode": "A String", # Language code.
"phoneNumber": "A String", # Phone number associated with the Cloud Identity.
"primaryDomain": "A String", # Output only. The primary domain name.
},
"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.
"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.
"linkState": "A String", # Required. State of the channel partner link.
"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.
"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListChannelPartnerLinksRequest.page_token to obtain that page.
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, x__xgafv=None)
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.
Args:
name: string, 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. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for CloudChannelService.UpdateChannelPartnerLink
"channelPartnerLink": { # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. # Required. The channel partner link to update. Only channel_partner_link.link_state is allowed for updates.
"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).
"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.
"alternateEmail": "A String", # The alternate email.
"customerType": "A String", # CustomerType indicates verification type needed for using services.
"eduData": { # Required Edu Attributes # Edu information about the customer.
"instituteSize": "A String", # Size of the institute.
"instituteType": "A String", # Designated institute type of customer.
"website": "A String", # Web address for the edu customer's institution.
},
"isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
"languageCode": "A String", # Language code.
"phoneNumber": "A String", # Phone number associated with the Cloud Identity.
"primaryDomain": "A String", # Output only. The primary domain name.
},
"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.
"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.
"linkState": "A String", # Required. State of the channel partner link.
"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.
"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.
},
"updateMask": "A String", # Required. The update mask that applies to the resource. The only allowable value for an update mask is channel_partner_link.link_state.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).
"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.
"alternateEmail": "A String", # The alternate email.
"customerType": "A String", # CustomerType indicates verification type needed for using services.
"eduData": { # Required Edu Attributes # Edu information about the customer.
"instituteSize": "A String", # Size of the institute.
"instituteType": "A String", # Designated institute type of customer.
"website": "A String", # Web address for the edu customer's institution.
},
"isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
"languageCode": "A String", # Language code.
"phoneNumber": "A String", # Phone number associated with the Cloud Identity.
"primaryDomain": "A String", # Output only. The primary domain name.
},
"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.
"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.
"linkState": "A String", # Required. State of the channel partner link.
"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.
"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.
}