google-cloud-channel-v1 0.1.0

data/proto_docs/google/cloud/channel/v1/service.rb

@@ -0,0 +1,1013 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Channel
+      module V1
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#check_cloud_identity_accounts_exist CloudChannelService.CheckCloudIdentityAccountsExist}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the reseller account.
+        #     The parent takes the format: accounts/\\{account_id}
+        # @!attribute [rw] domain
+        #   @return [::String]
+        #     Required. Domain for which the Cloud Identity account customer is fetched.
+        class CheckCloudIdentityAccountsExistRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Entity representing a Cloud Identity account which may or may not be
+        # associated with a Channel Services API partner.
+        # @!attribute [rw] existing
+        #   @return [::Boolean]
+        #     True if a Cloud Identity account exists for a specific domain.
+        # @!attribute [rw] owned
+        #   @return [::Boolean]
+        #     True if the Cloud Identity account is associated with a customer
+        #     belonging to the Channel Services partner making the API call.
+        # @!attribute [rw] customer_name
+        #   @return [::String]
+        #     Name of the customer that owns the Cloud Identity account. This field is
+        #     populated ONLY if owned = true.
+        #     The customer_name takes the format:
+        #     accounts/\\{account_id}/customers/\\{customer_id}
+        # @!attribute [rw] customer_cloud_identity_id
+        #   @return [::String]
+        #     Cloud Identity ID of the customer. This field is populated ONLY if
+        #     existing = true.
+        class CloudIdentityCustomerAccount
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::Channel::V1::CloudChannelService::Client#check_cloud_identity_accounts_exist CloudChannelService.CheckCloudIdentityAccountsExist}.
+        # @!attribute [rw] cloud_identity_accounts
+        #   @return [::Array<::Google::Cloud::Channel::V1::CloudIdentityCustomerAccount>]
+        #     The Cloud Identity accounts associated with the domain.
+        class CheckCloudIdentityAccountsExistResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_customers CloudChannelService.ListCustomers}
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the reseller account from which to list customers.
+        #     The parent takes the format: accounts/\\{account_id}.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of customers to return. The service may return fewer
+        #     than this value. If unspecified, at most 10 customers will be returned. The
+        #     maximum value is 50; values about 50 will be coerced to 50.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A token identifying a page of results, if other than the first one.
+        #     Typically obtained via
+        #     {::Google::Cloud::Channel::V1::ListCustomersResponse#next_page_token ListCustomersResponse.next_page_token} of the previous
+        #     {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_customers CloudChannelService.ListCustomers} call.
+        class ListCustomersRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_customers CloudChannelService.ListCustomers}.
+        # @!attribute [rw] customers
+        #   @return [::Array<::Google::Cloud::Channel::V1::Customer>]
+        #     The customers belonging to the reseller or distributor.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results.
+        #     Pass to {::Google::Cloud::Channel::V1::ListCustomersRequest#page_token ListCustomersRequest.page_token} to obtain that page.
+        class ListCustomersResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#get_customer CloudChannelService.GetCustomer}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the customer to retrieve.
+        #     The name takes the format: accounts/\\{account_id}/customers/\\{customer_id}
+        class GetCustomerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#create_customer CloudChannelService.CreateCustomer}
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of reseller account in which to create the customer.
+        #     The parent takes the format: accounts/\\{account_id}
+        # @!attribute [rw] customer
+        #   @return [::Google::Cloud::Channel::V1::Customer]
+        #     Required. The customer to create.
+        class CreateCustomerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#update_customer CloudChannelService.UpdateCustomer}.
+        # @!attribute [rw] customer
+        #   @return [::Google::Cloud::Channel::V1::Customer]
+        #     Required. New contents of the customer.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     The update mask that applies to the resource.
+        #     Optional.
+        class UpdateCustomerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#delete_customer CloudChannelService.DeleteCustomer}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the customer to delete.
+        class DeleteCustomerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#provision_cloud_identity CloudChannelService.ProvisionCloudIdentity}
+        # @!attribute [rw] customer
+        #   @return [::String]
+        #     Required. Resource name of the customer.
+        #     Format: accounts/\\{account_id}/customers/\\{customer_id}
+        # @!attribute [rw] cloud_identity_info
+        #   @return [::Google::Cloud::Channel::V1::CloudIdentityInfo]
+        #     CloudIdentity-specific customer information.
+        # @!attribute [rw] user
+        #   @return [::Google::Cloud::Channel::V1::AdminUser]
+        #     Admin user information.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     If set, validate the request and preview the review, but do not actually
+        #     post it.
+        class ProvisionCloudIdentityRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlements CloudChannelService.ListEntitlements}
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the reseller's customer account for which to list
+        #     entitlements.
+        #     The parent takes the format: accounts/\\{account_id}/customers/\\{customer_id}
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Requested page size. Server might return fewer results than requested.
+        #     If unspecified, at most 50 entitlements will be returned.
+        #     The maximum value is 100; values above 100 will be coerced to 100.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A token identifying a page of results, if other than the first one.
+        #     Typically obtained via
+        #     {::Google::Cloud::Channel::V1::ListEntitlementsResponse#next_page_token ListEntitlementsResponse.next_page_token} of the previous
+        #     {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlements CloudChannelService.ListEntitlements} call.
+        class ListEntitlementsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlements CloudChannelService.ListEntitlements}.
+        # @!attribute [rw] entitlements
+        #   @return [::Array<::Google::Cloud::Channel::V1::Entitlement>]
+        #     The entitlements belonging to the reseller's customer.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to List next page of results.
+        #     Pass to {::Google::Cloud::Channel::V1::ListEntitlementsRequest#page_token ListEntitlementsRequest.page_token} to obtain that page.
+        class ListEntitlementsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_skus CloudChannelService.ListTransferableSkus}
+        # @!attribute [rw] cloud_identity_id
+        #   @return [::String]
+        #     Customer's Cloud Identity ID
+        # @!attribute [rw] customer_name
+        #   @return [::String]
+        #     A reseller is required to create a customer and use the resource name of
+        #     the created customer here.
+        #     The customer_name takes the format:
+        #     accounts/\\{account_id}/customers/\\{customer_id}
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the reseller's account.
+        #     The parent takes the format: accounts/\\{account_id}
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Requested page size. Server might return fewer results than requested.
+        #     If unspecified, at most 100 SKUs will be returned.
+        #     The maximum value is 1000; values above 1000 will be coerced to 1000.
+        #     Optional.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying a page of results, if other than the first one.
+        #     Typically obtained via
+        #     {::Google::Cloud::Channel::V1::ListTransferableSkusResponse#next_page_token ListTransferableSkusResponse.next_page_token} of the previous
+        #     {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_skus CloudChannelService.ListTransferableSkus} call.
+        #     Optional.
+        # @!attribute [rw] auth_token
+        #   @return [::String]
+        #     This token is generated by the Super Admin of the resold customer to
+        #     authorize a reseller to access their Cloud Identity and purchase
+        #     entitlements on their behalf. This token can be omitted once the
+        #     authorization is generated. See https://support.google.com/a/answer/7643790
+        #     for more details.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     The BCP-47 language code, such as "en-US".  If specified, the
+        #     response will be localized to the corresponding language code. Default is
+        #     "en-US".
+        #     Optional.
+        class ListTransferableSkusRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_skus CloudChannelService.ListTransferableSkus}.
+        # @!attribute [rw] transferable_skus
+        #   @return [::Array<::Google::Cloud::Channel::V1::TransferableSku>]
+        #     Information about existing SKUs for a customer that would need to be
+        #     transferred.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results.
+        #     Pass to {::Google::Cloud::Channel::V1::ListTransferableSkusRequest#page_token ListTransferableSkusRequest.page_token} to obtain
+        #     that page.
+        class ListTransferableSkusResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_offers CloudChannelService.ListTransferableOffers}
+        # @!attribute [rw] cloud_identity_id
+        #   @return [::String]
+        #     Customer's Cloud Identity ID
+        # @!attribute [rw] customer_name
+        #   @return [::String]
+        #     A reseller should create a customer and use the resource name of
+        #     the created customer here.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the reseller's account.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Requested page size. Server might return fewer results than requested.
+        #     If unspecified, at most 100 Offers will be returned.
+        #     The maximum value is 1000; values above 1000 will be coerced to 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying a page of results, if other than the first one.
+        #     Typically obtained via
+        #     {::Google::Cloud::Channel::V1::ListTransferableOffersResponse#next_page_token ListTransferableOffersResponse.next_page_token} of the previous
+        #     {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_offers CloudChannelService.ListTransferableOffers} call.
+        # @!attribute [rw] sku
+        #   @return [::String]
+        #     Required. SKU for which the Offers are being looked up.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     The BCP-47 language code, such as "en-US".  If specified, the
+        #     response will be localized to the corresponding language code. Default is
+        #     "en-US".
+        class ListTransferableOffersRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_offers CloudChannelService.ListTransferableOffers}.
+        # @!attribute [rw] transferable_offers
+        #   @return [::Array<::Google::Cloud::Channel::V1::TransferableOffer>]
+        #     Information about Offers for a customer that can be used for
+        #     transfer.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results.
+        #     Pass to {::Google::Cloud::Channel::V1::ListTransferableOffersRequest#page_token ListTransferableOffersRequest.page_token} to obtain
+        #     that page.
+        class ListTransferableOffersResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # TransferableOffer represents an Offer that can be used in Transfer.
+        # Read-only.
+        # @!attribute [rw] offer
+        #   @return [::Google::Cloud::Channel::V1::Offer]
+        #     Offer with parameter constraints updated to allow the Transfer.
+        class TransferableOffer
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#get_entitlement CloudChannelService.GetEntitlement}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the entitlement to retrieve.
+        #     The name takes the format:
+        #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{id}
+        class GetEntitlementRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_channel_partner_links CloudChannelService.ListChannelPartnerLinks}
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the reseller account for listing channel partner
+        #     links.
+        #     The parent takes the format: accounts/\\{account_id}
+        # @!attribute [rw] page_size
+        #   @return [::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, values above 200 will be coerced to 200.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A token identifying a page of results, if other than the first one.
+        #     Typically obtained via
+        #     {::Google::Cloud::Channel::V1::ListChannelPartnerLinksResponse#next_page_token ListChannelPartnerLinksResponse.next_page_token} of the previous
+        #     {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_channel_partner_links CloudChannelService.ListChannelPartnerLinks} call.
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::Channel::V1::ChannelPartnerLinkView]
+        #     Optional. The level of granularity the ChannelPartnerLink will display.
+        class ListChannelPartnerLinksRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_channel_partner_links CloudChannelService.ListChannelPartnerLinks}.
+        # @!attribute [rw] channel_partner_links
+        #   @return [::Array<::Google::Cloud::Channel::V1::ChannelPartnerLink>]
+        #     The Channel partner links for a reseller.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results.
+        #     Pass to {::Google::Cloud::Channel::V1::ListChannelPartnerLinksRequest#page_token ListChannelPartnerLinksRequest.page_token} to obtain that page.
+        class ListChannelPartnerLinksResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#get_channel_partner_link CloudChannelService.GetChannelPartnerLink}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the channel partner link to retrieve.
+        #     The name takes the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
+        #     where \\{id} is the Cloud Identity ID of the partner.
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::Channel::V1::ChannelPartnerLinkView]
+        #     Optional. The level of granularity the ChannelPartnerLink will display.
+        class GetChannelPartnerLinkRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#create_channel_partner_link CloudChannelService.CreateChannelPartnerLink}
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of reseller's account for which to create a channel
+        #     partner link.
+        #     The parent takes the format: accounts/\\{account_id}
+        # @!attribute [rw] channel_partner_link
+        #   @return [::Google::Cloud::Channel::V1::ChannelPartnerLink]
+        #     Required. The channel partner link to create.
+        #     Either channel_partner_link.reseller_cloud_identity_id or domain can be
+        #     used to create a link.
+        # @!attribute [rw] domain
+        #   @return [::String]
+        #     Optional. The invited partner's domain. Either domain or
+        #     channel_partner_link.reseller_cloud_identity_id can be used to create a
+        #     link.
+        class CreateChannelPartnerLinkRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#update_channel_partner_link CloudChannelService.UpdateChannelPartnerLink}
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the channel partner link to cancel.
+        #     The name takes the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
+        #     where \\{id} is the Cloud Identity ID of the partner.
+        # @!attribute [rw] channel_partner_link
+        #   @return [::Google::Cloud::Channel::V1::ChannelPartnerLink]
+        #     Required. The channel partner link to update. Only field
+        #     channel_partner_link.link_state is allowed to be updated.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. The update mask that applies to the resource.
+        #     The only allowable value for update mask is
+        #     channel_partner_link.link_state.
+        class UpdateChannelPartnerLinkRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#create_entitlement CloudChannelService.CreateEntitlement}
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of reseller's customer account in which to create the
+        #     entitlement.
+        #     The parent takes the format: accounts/\\{account_id}/customers/\\{customer_id}
+        # @!attribute [rw] entitlement
+        #   @return [::Google::Cloud::Channel::V1::Entitlement]
+        #     Required. The entitlement to create.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique request ID so
+        #     that if you must retry your request, the server will know to ignore the
+        #     request if it has already been completed.
+        #
+        #     For example, consider a situation where you make an initial request and
+        #     the request times out. If you make the request again with the same
+        #     request ID, the server can check if the original operation with the same
+        #     request ID was received, and if so, will ignore the second request.
+        #
+        #     The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
+        #     with the exception that zero UUID is not supported
+        #     (`00000000-0000-0000-0000-000000000000`).
+        class CreateEntitlementRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#transfer_entitlements CloudChannelService.TransferEntitlements}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of reseller's customer account where the entitlements
+        #     transfer to.
+        #     The parent takes the format: accounts/\\{account_id}/customers/\\{customer_id}
+        # @!attribute [rw] entitlements
+        #   @return [::Array<::Google::Cloud::Channel::V1::Entitlement>]
+        #     Required. The new entitlements to be created or transferred.
+        # @!attribute [rw] auth_token
+        #   @return [::String]
+        #     This token is generated by the Super Admin of the resold customer to
+        #     authorize a reseller to access their Cloud Identity and purchase
+        #     entitlements on their behalf. This token can be omitted once the
+        #     authorization is generated. See https://support.google.com/a/answer/7643790
+        #     for more details.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique request ID so
+        #     that if you must retry your request, the server will know to ignore the
+        #     request if it has already been completed.
+        #
+        #     For example, consider a situation where you make an initial request and
+        #     the request times out. If you make the request again with the same
+        #     request ID, the server can check if the original operation with the same
+        #     request ID was received, and if so, will ignore the second request.
+        #
+        #     The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
+        #     with the exception that zero UUID is not supported
+        #     (`00000000-0000-0000-0000-000000000000`).
+        class TransferEntitlementsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#transfer_entitlements CloudChannelService.TransferEntitlements}.
+        # This will be put into the response field of google.longrunning.Operation.
+        # @!attribute [rw] entitlements
+        #   @return [::Array<::Google::Cloud::Channel::V1::Entitlement>]
+        #     The entitlements that have been transferred.
+        class TransferEntitlementsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#transfer_entitlements_to_google CloudChannelService.TransferEntitlementsToGoogle}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of reseller's customer account where the entitlements
+        #     transfer from.
+        #     The parent takes the format: accounts/\\{account_id}/customers/\\{customer_id}
+        # @!attribute [rw] entitlements
+        #   @return [::Array<::Google::Cloud::Channel::V1::Entitlement>]
+        #     Required. The entitlements to be transferred to Google.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique request ID so
+        #     that if you must retry your request, the server will know to ignore the
+        #     request if it has already been completed.
+        #
+        #     For example, consider a situation where you make an initial request and
+        #     the request times out. If you make the request again with the same
+        #     request ID, the server can check if the original operation with the same
+        #     request ID was received, and if so, will ignore the second request.
+        #
+        #     The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
+        #     with the exception that zero UUID is not supported
+        #     (`00000000-0000-0000-0000-000000000000`).
+        class TransferEntitlementsToGoogleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for [CloudChannelService.ChangeParametersRequest][].
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the entitlement to update.
+        #     The name takes the format:
+        #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
+        # @!attribute [rw] parameters
+        #   @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
+        #     Required. Entitlement parameters to update. Only editable parameters are allowed to
+        #     be changed.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique request ID so
+        #     that if you must retry your request, the server will know to ignore the
+        #     request if it has already been completed.
+        #
+        #     For example, consider a situation where you make an initial request and
+        #     the request times out. If you make the request again with the same
+        #     request ID, the server can check if the original operation with the same
+        #     request ID was received, and if so, will ignore the second request.
+        #
+        #     The request ID must be
+        #     a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that
+        #     zero UUID is not supported
+        #     (`00000000-0000-0000-0000-000000000000`).
+        # @!attribute [rw] purchase_order_id
+        #   @return [::String]
+        #     Optional. Purchase order ID provided by the reseller.
+        class ChangeParametersRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#change_renewal_settings CloudChannelService.ChangeRenewalSettings}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the entitlement to update.
+        #     The name takes the format:
+        #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
+        # @!attribute [rw] renewal_settings
+        #   @return [::Google::Cloud::Channel::V1::RenewalSettings]
+        #     Required. New renewal settings.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. A request ID to identify requests. Specify a unique request ID so
+        #     that if you must retry your request, the server will know to ignore the
+        #     request if it has already been completed.
+        #
+        #     For example, consider a situation where you make an initial request and
+        #     the request times out. If you make the request again with the same
+        #     request ID, the server can check if the original operation with the same
+        #     request ID was received, and if so, will ignore the second request.
+        #
+        #     The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
+        #     with the exception that zero UUID is not supported
+        #     (`00000000-0000-0000-0000-000000000000`).
+        class ChangeRenewalSettingsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#change_offer CloudChannelService.ChangeOffer}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the entitlement to update.
+        #     Format:
+        #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
+        # @!attribute [rw] offer
+        #   @return [::String]
+        #     Required. New Offer.
+        #     Format: accounts/\\{account_id}/offers/\\{offer_id}.
+        # @!attribute [rw] parameters
+        #   @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
+        #     Optional. Parameters needed to purchase the Offer.
+        # @!attribute [rw] purchase_order_id
+        #   @return [::String]
+        #     Optional. Purchase order id provided by the reseller.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique request ID so
+        #     that if you must retry your request, the server will know to ignore the
+        #     request if it has already been completed.
+        #
+        #     For example, consider a situation where you make an initial request and
+        #     the request times out. If you make the request again with the same
+        #     request ID, the server can check if the original operation with the same
+        #     request ID was received, and if so, will ignore the second request.
+        #
+        #     The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
+        #     with the exception that zero UUID is not supported
+        #     (`00000000-0000-0000-0000-000000000000`).
+        class ChangeOfferRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#start_paid_service CloudChannelService.StartPaidService}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the entitlement for which paid service is being started.
+        #     The name takes the format:
+        #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique request ID so
+        #     that if you must retry your request, the server will know to ignore the
+        #     request if it has already been completed.
+        #
+        #     For example, consider a situation where you make an initial request and
+        #     the request times out. If you make the request again with the same
+        #     request ID, the server can check if the original operation with the same
+        #     request ID was received, and if so, will ignore the second request.
+        #
+        #     The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
+        #     with the exception that zero UUID is not supported
+        #     (`00000000-0000-0000-0000-000000000000`).
+        class StartPaidServiceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#cancel_entitlement CloudChannelService.CancelEntitlement}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the entitlement to cancel.
+        #     The name takes the format:
+        #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique request ID so
+        #     that if you must retry your request, the server will know to ignore the
+        #     request if it has already been completed.
+        #
+        #     For example, consider a situation where you make an initial request and
+        #     the request times out. If you make the request again with the same
+        #     request ID, the server can check if the original operation with the same
+        #     request ID was received, and if so, will ignore the second request.
+        #
+        #     The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
+        #     with the exception that zero UUID is not supported
+        #     (`00000000-0000-0000-0000-000000000000`).
+        class CancelEntitlementRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#suspend_entitlement CloudChannelService.SuspendEntitlement}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the entitlement to suspend.
+        #     The name takes the format:
+        #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique request ID so
+        #     that if you must retry your request, the server will know to ignore the
+        #     request if it has already been completed.
+        #
+        #     For example, consider a situation where you make an initial request and
+        #     the request times out. If you make the request again with the same
+        #     request ID, the server can check if the original operation with the same
+        #     request ID was received, and if so, will ignore the second request.
+        #
+        #     The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
+        #     with the exception that zero UUID is not supported
+        #     (`00000000-0000-0000-0000-000000000000`).
+        class SuspendEntitlementRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#activate_entitlement CloudChannelService.ActivateEntitlement}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the entitlement to activate.
+        #     The name takes the format:
+        #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique request ID so
+        #     that if you must retry your request, the server will know to ignore the
+        #     request if it has already been completed.
+        #
+        #     For example, consider a situation where you make an initial request and
+        #     the request times out. If you make the request again with the same
+        #     request ID, the server can check if the original operation with the same
+        #     request ID was received, and if so, will ignore the second request.
+        #
+        #     The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
+        #     with the exception that zero UUID is not supported
+        #     (`00000000-0000-0000-0000-000000000000`).
+        class ActivateEntitlementRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for ListProducts.
+        # @!attribute [rw] account
+        #   @return [::String]
+        #     Required. The resource name of the reseller account.
+        #     Format: accounts/\\{account_id}.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Requested page size. Server might return fewer results than requested.
+        #     If unspecified, at most 100 Products will be returned.
+        #     The maximum value is 1000; values above 1000 will be coerced to 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A token identifying a page of results, if other than the first one.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     Optional. The BCP-47 language code, such as "en-US".  If specified, the
+        #     response will be localized to the corresponding language code. Default is
+        #     "en-US".
+        class ListProductsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for ListProducts.
+        # @!attribute [rw] products
+        #   @return [::Array<::Google::Cloud::Channel::V1::Product>]
+        #     List of Products requested.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results.
+        class ListProductsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for ListSkus.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Product for which to list SKUs.
+        #     The parent takes the format: products/\\{product_id}.
+        #     Supports products/- to retrieve SKUs for all products.
+        # @!attribute [rw] account
+        #   @return [::String]
+        #     Required. Resource name of the reseller.
+        #     Format: accounts/\\{account_id}.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Requested page size. Server might return fewer results than requested.
+        #     If unspecified, at most 100 SKUs will be returned.
+        #     The maximum value is 1000; values above 1000 will be coerced to 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A token identifying a page of results, if other than the first one.
+        #     Optional.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     Optional. The BCP-47 language code, such as "en-US".  If specified, the
+        #     response will be localized to the corresponding language code. Default is
+        #     "en-US".
+        class ListSkusRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for ListSkus.
+        # @!attribute [rw] skus
+        #   @return [::Array<::Google::Cloud::Channel::V1::Sku>]
+        #     The list of SKUs requested.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results.
+        class ListSkusResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for ListOffers.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the reseller account from which to list Offers.
+        #     The parent takes the format: accounts/\\{account_id}.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Requested page size. Server might return fewer results than requested.
+        #     If unspecified, at most 500 Offers will be returned.
+        #     The maximum value is 1000; values above 1000 will be coerced to 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A token identifying a page of results, if other than the first one.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. The expression to filter results by name (name of
+        #     the Offer), sku.name (name of the SKU) or sku.product.name (name of the
+        #     Product).
+        #     Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1
+        #     Example 2: name=accounts/a1/offers/o1
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     Optional. The BCP-47 language code, such as "en-US".  If specified, the
+        #     response will be localized to the corresponding language code. Default is
+        #     "en-US".
+        class ListOffersRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for ListOffers.
+        # @!attribute [rw] offers
+        #   @return [::Array<::Google::Cloud::Channel::V1::Offer>]
+        #     The list of Offers requested.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results.
+        class ListOffersResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for ListPurchasableSkus.
+        # @!attribute [rw] create_entitlement_purchase
+        #   @return [::Google::Cloud::Channel::V1::ListPurchasableSkusRequest::CreateEntitlementPurchase]
+        #     List SKUs for CreateEntitlement purchase.
+        # @!attribute [rw] change_offer_purchase
+        #   @return [::Google::Cloud::Channel::V1::ListPurchasableSkusRequest::ChangeOfferPurchase]
+        #     List SKUs for ChangeOffer purchase with a new SKU.
+        # @!attribute [rw] customer
+        #   @return [::String]
+        #     Required. The resource name of the customer for which to list SKUs.
+        #     Format: accounts/\\{account_id}/customers/\\{customer_id}.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Requested page size. Server might return fewer results than requested.
+        #     If unspecified, at most 100 SKUs will be returned.
+        #     The maximum value is 1000; values above 1000 will be coerced to 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A token identifying a page of results, if other than the first one.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     Optional. The BCP-47 language code, such as "en-US".  If specified, the
+        #     response will be localized to the corresponding language code. Default is
+        #     "en-US".
+        class ListPurchasableSkusRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # List SKUs for a new entitlement. Make the purchase using
+          # {::Google::Cloud::Channel::V1::CloudChannelService::Client#create_entitlement CloudChannelService.CreateEntitlement}.
+          # @!attribute [rw] product
+          #   @return [::String]
+          #     Required. List SKUs belonging to this Product.
+          #     Format: products/\\{product_id}.
+          #     Supports products/- to retrieve SKUs for all products.
+          class CreateEntitlementPurchase
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # List SKUs for upgrading or downgrading an entitlement. Make the purchase
+          # using {::Google::Cloud::Channel::V1::CloudChannelService::Client#change_offer CloudChannelService.ChangeOffer}.
+          # @!attribute [rw] entitlement
+          #   @return [::String]
+          #     Required. Resource name of the entitlement.
+          #     Format:
+          #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
+          # @!attribute [rw] change_type
+          #   @return [::Google::Cloud::Channel::V1::ListPurchasableSkusRequest::ChangeOfferPurchase::ChangeType]
+          #     Required. Change Type for the entitlement.
+          class ChangeOfferPurchase
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Change Type enum.
+            module ChangeType
+              # Not used.
+              CHANGE_TYPE_UNSPECIFIED = 0
+
+              # SKU is an upgrade on the current entitlement.
+              UPGRADE = 1
+
+              # SKU is a downgrade on the current entitlement.
+              DOWNGRADE = 2
+            end
+          end
+        end
+
+        # Response message for ListPurchasableSkus.
+        # @!attribute [rw] purchasable_skus
+        #   @return [::Array<::Google::Cloud::Channel::V1::PurchasableSku>]
+        #     The list of SKUs requested.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results.
+        class ListPurchasableSkusResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # SKU that can be used for a puchase. This is used in ListPurchasableSku API
+        # response.
+        # @!attribute [rw] sku
+        #   @return [::Google::Cloud::Channel::V1::Sku]
+        #     SKU
+        class PurchasableSku
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for ListPurchasableOffers.
+        # @!attribute [rw] create_entitlement_purchase
+        #   @return [::Google::Cloud::Channel::V1::ListPurchasableOffersRequest::CreateEntitlementPurchase]
+        #     List Offers for CreateEntitlement purchase.
+        # @!attribute [rw] change_offer_purchase
+        #   @return [::Google::Cloud::Channel::V1::ListPurchasableOffersRequest::ChangeOfferPurchase]
+        #     List Offers for ChangeOffer purchase.
+        # @!attribute [rw] customer
+        #   @return [::String]
+        #     Required. The resource name of the customer for which to list Offers.
+        #     Format: accounts/\\{account_id}/customers/\\{customer_id}.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Requested page size. Server might return fewer results than requested.
+        #     If unspecified, at most 100 Offers will be returned.
+        #     The maximum value is 1000; values above 1000 will be coerced to 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A token identifying a page of results, if other than the first one.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     Optional. The BCP-47 language code, such as "en-US".  If specified, the
+        #     response will be localized to the corresponding language code. Default is
+        #     "en-US".
+        class ListPurchasableOffersRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # List Offers for CreateEntitlement purchase.
+          # @!attribute [rw] sku
+          #   @return [::String]
+          #     Required. SKU that the result should be restricted to.
+          #     Format: products/\\{product_id}/skus/\\{sku_id}.
+          class CreateEntitlementPurchase
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # List Offers for ChangeOffer purchase.
+          # @!attribute [rw] entitlement
+          #   @return [::String]
+          #     Required. Resource name of the entitlement.
+          #     Format:
+          #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
+          # @!attribute [rw] new_sku
+          #   @return [::String]
+          #     Optional. Resource name of the SKU that is being changed to. Should be provided if
+          #     upgrading or downgrading an entitlement. Format:
+          #     products/\\{product_id}/skus/\\{sku_id}
+          class ChangeOfferPurchase
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response message for ListPurchasableOffers.
+        # @!attribute [rw] purchasable_offers
+        #   @return [::Array<::Google::Cloud::Channel::V1::PurchasableOffer>]
+        #     The list of Offers requested.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results.
+        class ListPurchasableOffersResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Offer that can be puchased for a customer. This is used in
+        # ListPurchasableOffer API response.
+        # @!attribute [rw] offer
+        #   @return [::Google::Cloud::Channel::V1::Offer]
+        #     Offer.
+        class PurchasableOffer
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end