google-cloud-channel-v1 0.2.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE.md +188 -190
  3. data/README.md +2 -2
  4. data/lib/google/cloud/channel/v1/cloud_channel_service.rb +14 -16
  5. data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb +940 -671
  6. data/lib/google/cloud/channel/v1/cloud_channel_service/operations.rb +7 -7
  7. data/lib/google/cloud/channel/v1/common_pb.rb +1 -0
  8. data/lib/google/cloud/channel/v1/entitlements_pb.rb +1 -2
  9. data/lib/google/cloud/channel/v1/offers_pb.rb +1 -0
  10. data/lib/google/cloud/channel/v1/service_pb.rb +34 -1
  11. data/lib/google/cloud/channel/v1/service_services_pb.rb +424 -437
  12. data/lib/google/cloud/channel/v1/subscriber_event_pb.rb +59 -0
  13. data/lib/google/cloud/channel/v1/version.rb +1 -1
  14. data/proto_docs/google/cloud/channel/v1/common.rb +9 -2
  15. data/proto_docs/google/cloud/channel/v1/customers.rb +23 -26
  16. data/proto_docs/google/cloud/channel/v1/entitlements.rb +3 -6
  17. data/proto_docs/google/cloud/channel/v1/offers.rb +4 -0
  18. data/proto_docs/google/cloud/channel/v1/service.rb +284 -215
  19. data/proto_docs/google/cloud/channel/v1/subscriber_event.rb +122 -0
  20. metadata +18 -10
data/lib/google/cloud/channel/v1/cloud_channel_service/operations.rb CHANGED
@@ -560,7 +560,7 @@ module Google
560
560
  config_attr :scope, nil, ::String, ::Array, nil
561
561
  config_attr :lib_name, nil, ::String, nil
562
562
  config_attr :lib_version, nil, ::String, nil
563
- config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
563
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
564
564
  config_attr :interceptors, nil, ::Array, nil
565
565
  config_attr :timeout, nil, ::Numeric, nil
566
566
  config_attr :metadata, nil, ::Hash, nil
@@ -581,7 +581,7 @@ module Google
581
581
  def rpcs
582
582
  @rpcs ||= begin
583
583
  parent_rpcs = nil
584
- parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
584
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
585
585
  Rpcs.new parent_rpcs
586
586
  end
587
587
  end
@@ -632,15 +632,15 @@ module Google
632
632
 
633
633
  # @private
634
634
  def initialize parent_rpcs = nil
635
- list_operations_config = parent_rpcs&.list_operations if parent_rpcs&.respond_to? :list_operations
635
+ list_operations_config = parent_rpcs.list_operations if parent_rpcs.respond_to? :list_operations
636
636
  @list_operations = ::Gapic::Config::Method.new list_operations_config
637
- get_operation_config = parent_rpcs&.get_operation if parent_rpcs&.respond_to? :get_operation
637
+ get_operation_config = parent_rpcs.get_operation if parent_rpcs.respond_to? :get_operation
638
638
  @get_operation = ::Gapic::Config::Method.new get_operation_config
639
- delete_operation_config = parent_rpcs&.delete_operation if parent_rpcs&.respond_to? :delete_operation
639
+ delete_operation_config = parent_rpcs.delete_operation if parent_rpcs.respond_to? :delete_operation
640
640
  @delete_operation = ::Gapic::Config::Method.new delete_operation_config
641
- cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
641
+ cancel_operation_config = parent_rpcs.cancel_operation if parent_rpcs.respond_to? :cancel_operation
642
642
  @cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
643
- wait_operation_config = parent_rpcs&.wait_operation if parent_rpcs&.respond_to? :wait_operation
643
+ wait_operation_config = parent_rpcs.wait_operation if parent_rpcs.respond_to? :wait_operation
644
644
  @wait_operation = ::Gapic::Config::Method.new wait_operation_config
645
645
 
646
646
  yield self if block_given?
data/lib/google/cloud/channel/v1/common_pb.rb CHANGED
@@ -49,6 +49,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
49
49
  optional :string_value, :string, 2
50
50
  optional :double_value, :double, 3
51
51
  optional :proto_value, :message, 4, "google.protobuf.Any"
52
+ optional :bool_value, :bool, 5
52
53
  end
53
54
  end
54
55
  add_message "google.cloud.channel.v1.AdminUser" do
data/lib/google/cloud/channel/v1/entitlements_pb.rb CHANGED
@@ -69,10 +69,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
69
69
  optional :end_time, :message, 2, "google.protobuf.Timestamp"
70
70
  end
71
71
  add_message "google.cloud.channel.v1.TransferableSku" do
72
- optional :is_commitment, :message, 6, "google.protobuf.BoolValue"
73
- optional :commitment_end_timestamp, :message, 7, "google.protobuf.Timestamp"
74
72
  optional :transfer_eligibility, :message, 9, "google.cloud.channel.v1.TransferEligibility"
75
73
  optional :sku, :message, 11, "google.cloud.channel.v1.Sku"
74
+ optional :legacy_sku, :message, 12, "google.cloud.channel.v1.Sku"
76
75
  end
77
76
  add_message "google.cloud.channel.v1.TransferEligibility" do
78
77
  optional :is_eligible, :bool, 1
data/lib/google/cloud/channel/v1/offers_pb.rb CHANGED
@@ -50,6 +50,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
50
50
  optional :payment_type, :enum, 2, "google.cloud.channel.v1.PaymentType"
51
51
  optional :payment_cycle, :message, 3, "google.cloud.channel.v1.Period"
52
52
  optional :trial_period, :message, 4, "google.cloud.channel.v1.Period"
53
+ optional :billing_account, :string, 5
53
54
  end
54
55
  add_message "google.cloud.channel.v1.PriceByResource" do
55
56
  optional :resource_type, :enum, 1, "google.cloud.channel.v1.ResourceType"
data/lib/google/cloud/channel/v1/service_pb.rb CHANGED
@@ -122,7 +122,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
122
122
  add_message "google.cloud.channel.v1.CreateChannelPartnerLinkRequest" do
123
123
  optional :parent, :string, 1
124
124
  optional :channel_partner_link, :message, 2, "google.cloud.channel.v1.ChannelPartnerLink"
125
- optional :domain, :string, 3
126
125
  end
127
126
  add_message "google.cloud.channel.v1.UpdateChannelPartnerLinkRequest" do
128
127
  optional :name, :string, 1
@@ -182,6 +181,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
182
181
  optional :name, :string, 1
183
182
  optional :request_id, :string, 3
184
183
  end
184
+ add_message "google.cloud.channel.v1.LookupOfferRequest" do
185
+ optional :entitlement, :string, 1
186
+ end
185
187
  add_message "google.cloud.channel.v1.ListProductsRequest" do
186
188
  optional :account, :string, 1
187
189
  optional :page_size, :int32, 2
@@ -267,6 +269,30 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
267
269
  add_message "google.cloud.channel.v1.PurchasableOffer" do
268
270
  optional :offer, :message, 1, "google.cloud.channel.v1.Offer"
269
271
  end
272
+ add_message "google.cloud.channel.v1.RegisterSubscriberRequest" do
273
+ optional :account, :string, 1
274
+ optional :service_account, :string, 2
275
+ end
276
+ add_message "google.cloud.channel.v1.RegisterSubscriberResponse" do
277
+ optional :topic, :string, 1
278
+ end
279
+ add_message "google.cloud.channel.v1.UnregisterSubscriberRequest" do
280
+ optional :account, :string, 1
281
+ optional :service_account, :string, 2
282
+ end
283
+ add_message "google.cloud.channel.v1.UnregisterSubscriberResponse" do
284
+ optional :topic, :string, 1
285
+ end
286
+ add_message "google.cloud.channel.v1.ListSubscribersRequest" do
287
+ optional :account, :string, 1
288
+ optional :page_size, :int32, 2
289
+ optional :page_token, :string, 3
290
+ end
291
+ add_message "google.cloud.channel.v1.ListSubscribersResponse" do
292
+ optional :topic, :string, 1
293
+ repeated :service_accounts, :string, 2
294
+ optional :next_page_token, :string, 3
295
+ end
270
296
  end
271
297
  end
272
298
 
@@ -308,6 +334,7 @@ module Google
308
334
  CancelEntitlementRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.CancelEntitlementRequest").msgclass
309
335
  SuspendEntitlementRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.SuspendEntitlementRequest").msgclass
310
336
  ActivateEntitlementRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ActivateEntitlementRequest").msgclass
337
+ LookupOfferRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.LookupOfferRequest").msgclass
311
338
  ListProductsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListProductsRequest").msgclass
312
339
  ListProductsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListProductsResponse").msgclass
313
340
  ListSkusRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListSkusRequest").msgclass
@@ -325,6 +352,12 @@ module Google
325
352
  ListPurchasableOffersRequest::ChangeOfferPurchase = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListPurchasableOffersRequest.ChangeOfferPurchase").msgclass
326
353
  ListPurchasableOffersResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListPurchasableOffersResponse").msgclass
327
354
  PurchasableOffer = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.PurchasableOffer").msgclass
355
+ RegisterSubscriberRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.RegisterSubscriberRequest").msgclass
356
+ RegisterSubscriberResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.RegisterSubscriberResponse").msgclass
357
+ UnregisterSubscriberRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.UnregisterSubscriberRequest").msgclass
358
+ UnregisterSubscriberResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.UnregisterSubscriberResponse").msgclass
359
+ ListSubscribersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListSubscribersRequest").msgclass
360
+ ListSubscribersResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListSubscribersResponse").msgclass
328
361
  end
329
362
  end
330
363
  end
data/lib/google/cloud/channel/v1/service_services_pb.rb CHANGED
@@ -24,289 +24,248 @@ module Google
24
24
  module Channel
25
25
  module V1
26
26
  module CloudChannelService
27
- # CloudChannelService enables Google cloud resellers and distributors to manage
28
- # their customers, channel partners, entitlements and reports.
27
+ # CloudChannelService lets Google cloud resellers and distributors manage
28
+ # their customers, channel partners, entitlements, and reports.
29
29
  #
30
30
  # Using this service:
31
- # 1. Resellers or distributors can manage a customer entity.
32
- # 2. Distributors can register an authorized reseller in their channel and then
33
- # enable delegated admin access for the reseller.
34
- # 3. Resellers or distributors can manage entitlements for their customers.
31
+ # 1. Resellers and distributors can manage a customer entity.
32
+ # 2. Distributors can register an authorized reseller in their channel and
33
+ # provide them with delegated admin access.
34
+ # 3. Resellers and distributors can manage customer entitlements.
35
35
  #
36
- # The service primarily exposes the following resources:
37
- # - [Customer][google.cloud.channel.v1.Customer]s: A Customer represents an entity managed by a reseller or
38
- # distributor. A customer typically represents an enterprise. In an n-tier
39
- # resale channel hierarchy, customers are generally represented as leaf nodes.
40
- # Customers primarily have an Entitlement sub-resource discussed below.
36
+ # CloudChannelService exposes the following resources:
37
+ # - [Customer][google.cloud.channel.v1.Customer]s: An entity—usually an enterprise—managed by a reseller or
38
+ # distributor.
41
39
  #
42
- # - [Entitlement][google.cloud.channel.v1.Entitlement]s: An Entitlement represents an entity which provides a
43
- # customer means to start using a service. Entitlements are created or updated
44
- # as a result of a successful fulfillment.
40
+ # - [Entitlement][google.cloud.channel.v1.Entitlement]s: An entity that provides a customer with the means to use
41
+ # a service. Entitlements are created or updated as a result of a successful
42
+ # fulfillment.
45
43
  #
46
- # - [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: A ChannelPartnerLink is an entity that identifies
47
- # links between distributors and their indirect resellers in a channel.
44
+ # - [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: An entity that identifies links between
45
+ # distributors and their indirect resellers in a channel.
48
46
  class Service
49
47
 
50
- include GRPC::GenericService
48
+ include ::GRPC::GenericService
51
49
 
52
50
  self.marshal_class_method = :encode
53
51
  self.unmarshal_class_method = :decode
54
52
  self.service_name = 'google.cloud.channel.v1.CloudChannelService'
55
53
 
56
- # List downstream [Customer][google.cloud.channel.v1.Customer]s.
54
+ # List [Customer][google.cloud.channel.v1.Customer]s.
57
55
  #
58
- # Possible Error Codes:
56
+ # Possible error codes:
59
57
  #
60
- # * PERMISSION_DENIED: If the reseller account making the request and the
61
- # reseller account being queried for are different.
62
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
63
- # request.
58
+ # * PERMISSION_DENIED: The reseller account making the request is different
59
+ # from the reseller account in the API request.
60
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
64
61
  #
65
- # Return Value:
66
- # <br/> List of [Customer][google.cloud.channel.v1.Customer]s pertaining to the reseller or empty list if
67
- # there are none.
62
+ # Return value:
63
+ # List of [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers.
68
64
  rpc :ListCustomers, ::Google::Cloud::Channel::V1::ListCustomersRequest, ::Google::Cloud::Channel::V1::ListCustomersResponse
69
- # Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.
65
+ # Returns the requested [Customer][google.cloud.channel.v1.Customer] resource.
70
66
  #
71
- # Possible Error Codes:
67
+ # Possible error codes:
72
68
  #
73
- # * PERMISSION_DENIED: If the reseller account making the request and the
74
- # reseller account being queried for are different.
75
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
76
- # request.
77
- # * NOT_FOUND: If the customer resource doesn't exist. Usually
78
- # the result of an invalid name parameter.
69
+ # * PERMISSION_DENIED: The reseller account making the request is different
70
+ # from the reseller account in the API request.
71
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
72
+ # * NOT_FOUND: The customer resource doesn't exist. Usually the result of an
73
+ # invalid name parameter.
79
74
  #
80
- # Return Value:
81
- # <br/> [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.
75
+ # Return value:
76
+ # The [Customer][google.cloud.channel.v1.Customer] resource.
82
77
  rpc :GetCustomer, ::Google::Cloud::Channel::V1::GetCustomerRequest, ::Google::Cloud::Channel::V1::Customer
83
- # Confirms the existence of Cloud Identity accounts, based on the domain and
84
- # whether the Cloud Identity accounts are owned by the reseller.
78
+ # Confirms the existence of Cloud Identity accounts based on the domain and
79
+ # if the Cloud Identity accounts are owned by the reseller.
85
80
  #
86
- # Possible Error Codes:
81
+ # Possible error codes:
87
82
  #
88
- # * PERMISSION_DENIED: If the reseller account making the request and the
89
- # reseller account being queried for are different.
90
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
91
- # request.
83
+ # * PERMISSION_DENIED: The reseller account making the request is different
84
+ # from the reseller account in the API request.
85
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
92
86
  # * INVALID_VALUE: Invalid domain value in the request.
93
- # * NOT_FOUND: If there is no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] customer
94
- # for the domain specified in the request.
95
87
  #
96
- # Return Value:
97
- # <br/> List of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources if any exist for
98
- # the domain, otherwise an error is returned.
88
+ # Return value:
89
+ # A list of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain (may be
90
+ # empty)
91
+ #
92
+ # Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if
93
+ # no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain.
99
94
  rpc :CheckCloudIdentityAccountsExist, ::Google::Cloud::Channel::V1::CheckCloudIdentityAccountsExistRequest, ::Google::Cloud::Channel::V1::CheckCloudIdentityAccountsExistResponse
100
95
  # Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor
101
96
  # account.
102
97
  #
103
- # Possible Error Codes:
104
- # <ul>
105
- # <li>PERMISSION_DENIED: If the reseller account making the request and the
106
- # reseller account being queried for are different.</li>
107
- # <li> INVALID_ARGUMENT:
108
- # <ul>
109
- # <li> Missing or invalid required parameters in the request. </li>
110
- # <li> Domain field value doesn't match the domain specified in primary
111
- # email.</li>
112
- # </ul>
113
- # </li>
114
- # </ul>
115
- #
116
- # Return Value:
117
- # <br/> If successful, the newly created [Customer][google.cloud.channel.v1.Customer] resource, otherwise
118
- # returns an error.
98
+ # Possible error codes:
99
+ #
100
+ # * PERMISSION_DENIED: The reseller account making the request is different
101
+ # from the reseller account in the API request.
102
+ # * INVALID_ARGUMENT:
103
+ # * Required request parameters are missing or invalid.
104
+ # * Domain field value doesn't match the primary email domain.
105
+ #
106
+ # Return value:
107
+ # The newly created [Customer][google.cloud.channel.v1.Customer] resource.
119
108
  rpc :CreateCustomer, ::Google::Cloud::Channel::V1::CreateCustomerRequest, ::Google::Cloud::Channel::V1::Customer
120
- # Updates an existing [Customer][google.cloud.channel.v1.Customer] resource belonging to the reseller or
109
+ # Updates an existing [Customer][google.cloud.channel.v1.Customer] resource for the reseller or
121
110
  # distributor.
122
111
  #
123
- # Possible Error Codes:
112
+ # Possible error codes:
124
113
  #
125
- # * PERMISSION_DENIED: If the reseller account making the request and the
126
- # reseller account being queried for are different.
127
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
128
- # request.
129
- # * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name
130
- # specified in the request.
114
+ # * PERMISSION_DENIED: The reseller account making the request is different
115
+ # from the reseller account in the API request.
116
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
117
+ # * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request.
131
118
  #
132
- # Return Value:
133
- # <br/> If successful, the updated [Customer][google.cloud.channel.v1.Customer] resource, otherwise returns
134
- # an error.
119
+ # Return value:
120
+ # The updated [Customer][google.cloud.channel.v1.Customer] resource.
135
121
  rpc :UpdateCustomer, ::Google::Cloud::Channel::V1::UpdateCustomerRequest, ::Google::Cloud::Channel::V1::Customer
136
- # Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.
122
+ # Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently.
137
123
  #
138
- # Possible Error Codes:
124
+ # Possible error codes:
139
125
  #
140
- # * PERMISSION_DENIED: If the account making the request does not own
126
+ # * PERMISSION_DENIED: The account making the request does not own
141
127
  # this customer.
142
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
143
- # request.
144
- # * FAILED_PRECONDITION: If the customer has existing entitlements.
145
- # * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name
146
- # specified in the request.
128
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
129
+ # * FAILED_PRECONDITION: The customer has existing entitlements.
130
+ # * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request.
147
131
  rpc :DeleteCustomer, ::Google::Cloud::Channel::V1::DeleteCustomerRequest, ::Google::Protobuf::Empty
148
132
  # Creates a Cloud Identity for the given customer using the customer's
149
- # information or the information provided here, if present.
133
+ # information, or the information provided here.
150
134
  #
151
- # Possible Error Codes:
135
+ # Possible error codes:
152
136
  #
153
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
154
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
155
- # * NOT_FOUND: If the customer is not found for the reseller.
156
- # * ALREADY_EXISTS: If the customer's primary email already exists. In this
157
- # case, retry after changing the customer's primary contact email.
158
- # * INTERNAL: Any non-user error related to a technical issue in the
159
- # backend. Contact Cloud Channel support in this case.
160
- # * UNKNOWN: Any non-user error related to a technical issue in the backend.
161
- # Contact Cloud Channel support in this case.
137
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
138
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
139
+ # * NOT_FOUND: The customer was not found.
140
+ # * ALREADY_EXISTS: The customer's primary email already exists. Retry
141
+ # after changing the customer's primary contact email.
142
+ # * INTERNAL: Any non-user error related to a technical issue in the
143
+ # backend. Contact Cloud Channel support.
144
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
145
+ # Contact Cloud Channel support.
162
146
  #
163
- # Return Value:
164
- # <br/> Long Running Operation ID.
147
+ # Return value:
148
+ # The ID of a long-running operation.
165
149
  #
166
150
  # To get the results of the operation, call the GetOperation method of
167
- # CloudChannelOperationsService. The Operation metadata will contain an
151
+ # CloudChannelOperationsService. The Operation metadata contains an
168
152
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
169
153
  rpc :ProvisionCloudIdentity, ::Google::Cloud::Channel::V1::ProvisionCloudIdentityRequest, ::Google::Longrunning::Operation
170
- # List [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.
154
+ # Lists [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.
171
155
  #
172
- # Possible Error Codes:
156
+ # Possible error codes:
173
157
  #
174
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
175
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
158
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
159
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
176
160
  #
177
- # Return Value:
178
- # <br/> List of [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to the customer, or empty list if
179
- # there are none.
161
+ # Return value:
162
+ # A list of the customer's [Entitlement][google.cloud.channel.v1.Entitlement]s.
180
163
  rpc :ListEntitlements, ::Google::Cloud::Channel::V1::ListEntitlementsRequest, ::Google::Cloud::Channel::V1::ListEntitlementsResponse
181
- # List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on Cloud Identity ID or
164
+ # List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on the Cloud Identity ID or
182
165
  # Customer Name in the request.
183
166
  #
184
- # This method is used when a reseller lists the entitlements
185
- # information of a customer that is not owned. The reseller should provide
186
- # the customer's Cloud Identity ID or Customer Name.
187
- #
188
- # Possible Error Codes:
189
- # <ul>
190
- # <li>PERMISSION_DENIED, due to one of the following reasons:
191
- # <ul>
192
- # <li> If the customer doesn't belong to the reseller and no auth token,
193
- # or an invalid auth token is supplied. </li> <li> If the reseller account
194
- # making the request and the reseller account being queried for are
195
- # different. </li>
196
- # </ul>
197
- # </li>
198
- # <li> INVALID_ARGUMENT: Missing or invalid required parameters in the
199
- # request.</li>
200
- # </ul>
201
- #
202
- # Return Value:
203
- # <br/> List of [TransferableSku][google.cloud.channel.v1.TransferableSku] for the given customer.
167
+ # Use this method to list the entitlements information of an
168
+ # unowned customer. You should provide the customer's
169
+ # Cloud Identity ID or Customer Name.
170
+ #
171
+ # Possible error codes:
172
+ #
173
+ # * PERMISSION_DENIED:
174
+ # * The customer doesn't belong to the reseller and has no auth token.
175
+ # * The supplied auth token is invalid.
176
+ # * The reseller account making the request is different
177
+ # from the reseller account in the query.
178
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
179
+ #
180
+ # Return value:
181
+ # A list of the customer's [TransferableSku][google.cloud.channel.v1.TransferableSku].
204
182
  rpc :ListTransferableSkus, ::Google::Cloud::Channel::V1::ListTransferableSkusRequest, ::Google::Cloud::Channel::V1::ListTransferableSkusResponse
205
183
  # List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or
206
184
  # Customer Name in the request.
207
185
  #
208
- # This method is used when a reseller gets the entitlement
209
- # information of a customer that is not owned. The reseller should provide
210
- # the customer's Cloud Identity ID or Customer Name.
186
+ # Use this method when a reseller gets the entitlement information of an
187
+ # unowned customer. The reseller should provide the customer's
188
+ # Cloud Identity ID or Customer Name.
211
189
  #
212
- # Possible Error Codes:
190
+ # Possible error codes:
213
191
  #
214
- # * PERMISSION_DENIED, due to one of the following reasons: (a) If the
215
- # customer doesn't belong to the reseller and no auth token or invalid auth
216
- # token is supplied. (b) If the reseller account making the request and the
217
- # reseller account being queried for are different.
218
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
219
- # request.
192
+ # * PERMISSION_DENIED:
193
+ # * The customer doesn't belong to the reseller and has no auth token.
194
+ # * The supplied auth token is invalid.
195
+ # * The reseller account making the request is different
196
+ # from the reseller account in the query.
197
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
220
198
  #
221
- # Return Value:
199
+ # Return value:
222
200
  # List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.
223
201
  rpc :ListTransferableOffers, ::Google::Cloud::Channel::V1::ListTransferableOffersRequest, ::Google::Cloud::Channel::V1::ListTransferableOffersResponse
224
- # Returns a requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.
202
+ # Returns the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.
225
203
  #
226
- # Possible Error Codes:
204
+ # Possible error codes:
227
205
  #
228
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
229
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
230
- # request.
231
- # * NOT_FOUND: If the entitlement is not found for the customer.
206
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
207
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
208
+ # * NOT_FOUND: The customer entitlement was not found.
232
209
  #
233
- # Return Value:
234
- # <br/> If found, the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource, otherwise returns
235
- # an error.
210
+ # Return value:
211
+ # The requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.
236
212
  rpc :GetEntitlement, ::Google::Cloud::Channel::V1::GetEntitlementRequest, ::Google::Cloud::Channel::V1::Entitlement
237
213
  # Creates an entitlement for a customer.
238
214
  #
239
- # Possible Error Codes:
240
- # <ul>
241
- # <li> PERMISSION_DENIED: If the customer doesn't belong to the reseller.
242
- # </li> <li> INVALID_ARGUMENT: <ul>
243
- # <li> Missing or invalid required parameters in the request. </li>
244
- # <li> Cannot purchase an entitlement if there is already an
245
- # entitlement for customer, for a SKU from the same product family. </li>
246
- # <li> INVALID_VALUE: Offer passed in isn't valid. Make sure OfferId is
247
- # valid. If it is valid, then contact Google Channel support for further
248
- # troubleshooting. </li>
249
- # </ul>
250
- # </li>
251
- # <li> NOT_FOUND: If the customer or offer resource is not found for the
252
- # reseller. </li>
253
- # <li> ALREADY_EXISTS: This failure can happen in the following cases:
254
- # <ul>
255
- # <li>If the SKU has been already purchased for the customer.</li>
256
- # <li>If the customer's primary email already exists. In this case retry
257
- # after changing the customer's primary contact email.
258
- # </li>
259
- # </ul>
260
- # </li>
261
- # <li> CONDITION_NOT_MET or FAILED_PRECONDITION: This
262
- # failure can happen in the following cases:
263
- # <ul>
264
- # <li> Purchasing a SKU that requires domain verification and the
265
- # domain has not been verified. </li>
266
- # <li> Purchasing an Add-On SKU like Vault or Drive without purchasing
267
- # the pre-requisite SKU, such as Google Workspace Business Starter. </li>
268
- # <li> Applicable only for developer accounts: reseller and resold
269
- # domain. Must meet the following domain naming requirements:
270
- # <ul>
271
- # <li> Domain names must start with goog-test. </li>
272
- # <li> Resold domain names must include the reseller domain. </li>
273
- # </ul>
274
- # </li>
275
- # </ul>
276
- # </li>
277
- # <li> INTERNAL: Any non-user error related to a technical issue in the
278
- # backend. Contact Cloud Channel Support in this case. </li>
279
- # <li> UNKNOWN: Any non-user error related to a technical issue in the
280
- # backend. Contact Cloud Channel Support in this case. </li>
281
- # </ul>
282
- #
283
- # Return Value:
284
- # <br/> Long Running Operation ID.
215
+ # Possible error codes:
216
+ #
217
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
218
+ # * INVALID_ARGUMENT:
219
+ # * Required request parameters are missing or invalid.
220
+ # * There is already a customer entitlement for a SKU from the same
221
+ # product family.
222
+ # * INVALID_VALUE: Make sure the OfferId is valid. If it is, contact
223
+ # Google Channel support for further troubleshooting.
224
+ # * NOT_FOUND: The customer or offer resource was not found.
225
+ # * ALREADY_EXISTS:
226
+ # * The SKU was already purchased for the customer.
227
+ # * The customer's primary email already exists. Retry
228
+ # after changing the customer's primary contact email.
229
+ # * CONDITION_NOT_MET or FAILED_PRECONDITION:
230
+ # * The domain required for purchasing a SKU has not been verified.
231
+ # * A pre-requisite SKU required to purchase an Add-On SKU is missing.
232
+ # For example, Google Workspace Business Starter is required to purchase
233
+ # Vault or Drive.
234
+ # * (Developer accounts only) Reseller and resold domain must meet the
235
+ # following naming requirements:
236
+ # * Domain names must start with goog-test.
237
+ # * Domain names must include the reseller domain.
238
+ # * INTERNAL: Any non-user error related to a technical issue in the
239
+ # backend. Contact Cloud Channel support.
240
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
241
+ # Contact Cloud Channel support.
242
+ #
243
+ # Return value:
244
+ # The ID of a long-running operation.
285
245
  #
286
246
  # To get the results of the operation, call the GetOperation method of
287
247
  # CloudChannelOperationsService. The Operation metadata will contain an
288
248
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
289
249
  rpc :CreateEntitlement, ::Google::Cloud::Channel::V1::CreateEntitlementRequest, ::Google::Longrunning::Operation
290
- # Change parameters of the entitlement
250
+ # Change parameters of the entitlement.
291
251
  #
292
- # An entitlement parameters update is a long-running operation and results in
293
- # updates to the entitlement as a result of fulfillment.
252
+ # An entitlement update is a long-running operation and it updates the
253
+ # entitlement as a result of fulfillment.
294
254
  #
295
- # Possible Error Codes:
255
+ # Possible error codes:
296
256
  #
297
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
298
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
299
- # request. For example, if the number of seats being changed to is greater
300
- # than the allowed number of max seats for the resource. Or decreasing seats
301
- # for a commitment based plan.
257
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
258
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
259
+ # For example, the number of seats being changed is greater than the allowed
260
+ # number of max seats, or decreasing seats for a commitment based plan.
302
261
  # * NOT_FOUND: Entitlement resource not found.
303
- # * INTERNAL: Any non-user error related to a technical issue
304
- # in the backend. In this case, contact Cloud Channel support.
262
+ # * INTERNAL: Any non-user error related to a technical issue in the
263
+ # backend. Contact Cloud Channel support.
305
264
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
306
- # In this case, contact Cloud Channel support.
265
+ # Contact Cloud Channel support.
307
266
  #
308
- # Return Value:
309
- # <br/> Long Running Operation ID.
267
+ # Return value:
268
+ # The ID of a long-running operation.
310
269
  #
311
270
  # To get the results of the operation, call the GetOperation method of
312
271
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -314,24 +273,23 @@ module Google
314
273
  rpc :ChangeParameters, ::Google::Cloud::Channel::V1::ChangeParametersRequest, ::Google::Longrunning::Operation
315
274
  # Updates the renewal settings for an existing customer entitlement.
316
275
  #
317
- # An entitlement update is a long-running operation and results in updates to
318
- # the entitlement as a result of fulfillment.
276
+ # An entitlement update is a long-running operation and it updates the
277
+ # entitlement as a result of fulfillment.
319
278
  #
320
- # Possible Error Codes:
279
+ # Possible error codes:
321
280
  #
322
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
323
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
324
- # request.
281
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
282
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
325
283
  # * NOT_FOUND: Entitlement resource not found.
326
284
  # * NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a
327
- # commitment plan. Can't enable or disable renewal for non-commitment plans.
328
- # * INTERNAL: Any non user error related to a technical issue in the
329
- # backend. In this case, contact Cloud Channel support.
330
- # * UNKNOWN: Any non user error related to a technical issue in the backend.
331
- # In this case, contact Cloud Channel support.
285
+ # commitment plan. Can't enable or disable renewals for non-commitment plans.
286
+ # * INTERNAL: Any non-user error related to a technical issue in the
287
+ # backend. Contact Cloud Channel support.
288
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
289
+ # Contact Cloud Channel support.
332
290
  #
333
- # Return Value:
334
- # <br/> Long Running Operation ID.
291
+ # Return value:
292
+ # The ID of a long-running operation.
335
293
  #
336
294
  # To get the results of the operation, call the GetOperation method of
337
295
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -339,22 +297,21 @@ module Google
339
297
  rpc :ChangeRenewalSettings, ::Google::Cloud::Channel::V1::ChangeRenewalSettingsRequest, ::Google::Longrunning::Operation
340
298
  # Updates the Offer for an existing customer entitlement.
341
299
  #
342
- # An entitlement update is a long-running operation and results in updates to
343
- # the entitlement as a result of fulfillment.
300
+ # An entitlement update is a long-running operation and it updates the
301
+ # entitlement as a result of fulfillment.
344
302
  #
345
- # Possible Error Codes:
303
+ # Possible error codes:
346
304
  #
347
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
348
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
349
- # request.
305
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
306
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
350
307
  # * NOT_FOUND: Offer or Entitlement resource not found.
351
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
352
- # In this case, contact Cloud Channel support.
308
+ # * INTERNAL: Any non-user error related to a technical issue in the
309
+ # backend. Contact Cloud Channel support.
353
310
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
354
- # In this case, contact Cloud Channel support.
311
+ # Contact Cloud Channel support.
355
312
  #
356
- # Return Value:
357
- # <br/> Long Running Operation ID.
313
+ # Return value:
314
+ # The ID of a long-running operation.
358
315
  #
359
316
  # To get the results of the operation, call the GetOperation method of
360
317
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -363,105 +320,100 @@ module Google
363
320
  # Starts paid service for a trial entitlement.
364
321
  #
365
322
  # Starts paid service for a trial entitlement immediately. This method is
366
- # only applicable if a plan has already been set up for a trial entitlement
367
- # but has some trial days remaining.
323
+ # only applicable if a plan is set up for a trial entitlement but has some
324
+ # trial days remaining.
368
325
  #
369
- # Possible Error Codes:
326
+ # Possible error codes:
370
327
  #
371
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
372
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
373
- # request.
328
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
329
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
374
330
  # * NOT_FOUND: Entitlement resource not found.
375
331
  # * FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for
376
332
  # entitlement on trial plans.
377
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
378
- # In this case, contact Cloud Channel support.
379
- # * UNKNOWN: Any non-user error related to a technical issue
380
- # in the backend. In this case, contact Cloud Channel support.
333
+ # * INTERNAL: Any non-user error related to a technical issue in the
334
+ # backend. Contact Cloud Channel support.
335
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
336
+ # Contact Cloud Channel support.
381
337
  #
382
- # Return Value:
383
- # <br/> Long Running Operation ID.
338
+ # Return value:
339
+ # The ID of a long-running operation.
384
340
  #
385
341
  # To get the results of the operation, call the GetOperation method of
386
342
  # CloudChannelOperationsService. The Operation metadata will contain an
387
343
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
388
344
  rpc :StartPaidService, ::Google::Cloud::Channel::V1::StartPaidServiceRequest, ::Google::Longrunning::Operation
389
345
  # Suspends a previously fulfilled entitlement.
346
+ #
390
347
  # An entitlement suspension is a long-running operation.
391
348
  #
392
- # Possible Error Codes:
349
+ # Possible error codes:
393
350
  #
394
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
395
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
396
- # request.
351
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
352
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
397
353
  # * NOT_FOUND: Entitlement resource not found.
398
354
  # * NOT_ACTIVE: Entitlement is not active.
399
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
400
- # In this case, contact Cloud Channel support.
355
+ # * INTERNAL: Any non-user error related to a technical issue in the
356
+ # backend. Contact Cloud Channel support.
401
357
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
402
- # In this case, contact Cloud Channel support.
358
+ # Contact Cloud Channel support.
403
359
  #
404
- # Return Value:
405
- # <br/> Long Running Operation ID.
360
+ # Return value:
361
+ # The ID of a long-running operation.
406
362
  #
407
363
  # To get the results of the operation, call the GetOperation method of
408
364
  # CloudChannelOperationsService. The Operation metadata will contain an
409
365
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
410
366
  rpc :SuspendEntitlement, ::Google::Cloud::Channel::V1::SuspendEntitlementRequest, ::Google::Longrunning::Operation
411
367
  # Cancels a previously fulfilled entitlement.
368
+ #
412
369
  # An entitlement cancellation is a long-running operation.
413
370
  #
414
- # Possible Error Codes:
371
+ # Possible error codes:
415
372
  #
416
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller or
417
- # if the reseller account making the request and reseller account being
418
- # queried for are different.
419
- # * FAILED_PRECONDITION: If there are any Google Cloud projects linked to the
373
+ # * PERMISSION_DENIED: The reseller account making the request is different
374
+ # from the reseller account in the API request.
375
+ # * FAILED_PRECONDITION: There are Google Cloud projects linked to the
420
376
  # Google Cloud entitlement's Cloud Billing subaccount.
421
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
422
- # request.
377
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
423
378
  # * NOT_FOUND: Entitlement resource not found.
424
379
  # * DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace
425
- # add-ons or entitlements for Google Cloud's development platform.
380
+ # add-ons, or entitlements for Google Cloud's development platform.
426
381
  # * INTERNAL: Any non-user error related to a technical issue in the
427
- # backend. In this case, contact Cloud Channel support.
382
+ # backend. Contact Cloud Channel support.
428
383
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
429
- # In this case, contact Cloud Channel support.
384
+ # Contact Cloud Channel support.
430
385
  #
431
- # Return Value:
432
- # <br/> Long Running Operation ID.
386
+ # Return value:
387
+ # The ID of a long-running operation.
433
388
  #
434
389
  # To get the results of the operation, call the GetOperation method of
435
390
  # CloudChannelOperationsService. The response will contain
436
391
  # google.protobuf.Empty on success. The Operation metadata will contain an
437
392
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
438
393
  rpc :CancelEntitlement, ::Google::Cloud::Channel::V1::CancelEntitlementRequest, ::Google::Longrunning::Operation
439
- # Activates a previously suspended entitlement. The entitlement must be in a
440
- # suspended state for it to be activated. Entitlements suspended for pending
441
- # ToS acceptance can't be activated using this method. An entitlement
442
- # activation is a long-running operation and can result in updates to
394
+ # Activates a previously suspended entitlement. Entitlements suspended for
395
+ # pending ToS acceptance can't be activated using this method.
396
+ #
397
+ # An entitlement activation is a long-running operation and it updates
443
398
  # the state of the customer entitlement.
444
399
  #
445
- # Possible Error Codes:
400
+ # Possible error codes:
446
401
  #
447
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller or
448
- # if the reseller account making the request and reseller account being
449
- # queried for are different.
450
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
451
- # request.
402
+ # * PERMISSION_DENIED: The reseller account making the request is different
403
+ # from the reseller account in the API request.
404
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
452
405
  # * NOT_FOUND: Entitlement resource not found.
453
- # * SUSPENSION_NOT_RESELLER_INITIATED: Can't activate an
454
- # entitlement that is pending TOS acceptance. Only reseller initiated
455
- # suspensions can be activated.
456
- # * NOT_SUSPENDED: Can't activate entitlements that are already in ACTIVE
457
- # state. Can only activate suspended entitlements.
458
- # * INTERNAL: Any non-user error related to a technical issue
459
- # in the backend. In this case, contact Cloud Channel support.
406
+ # * SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated
407
+ # suspensions and entitlements that have accepted the TOS.
408
+ # * NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE
409
+ # state.
410
+ # * INTERNAL: Any non-user error related to a technical issue in the
411
+ # backend. Contact Cloud Channel support.
460
412
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
461
- # In this case, contact Cloud Channel support.
413
+ # Contact Cloud Channel support.
462
414
  #
463
- # Return Value:
464
- # <br/> Long Running Operation ID.
415
+ # Return value:
416
+ # The ID of a long-running operation.
465
417
  #
466
418
  # To get the results of the operation, call the GetOperation method of
467
419
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -469,77 +421,58 @@ module Google
469
421
  rpc :ActivateEntitlement, ::Google::Cloud::Channel::V1::ActivateEntitlementRequest, ::Google::Longrunning::Operation
470
422
  # Transfers customer entitlements to new reseller.
471
423
  #
472
- # Possible Error Codes:
473
- # <ul>
474
- # <li> PERMISSION_DENIED: If the customer doesn't belong to the
475
- # reseller.</li> <li> INVALID_ARGUMENT: Missing or invalid required
476
- # parameters in the request. </li> <li> NOT_FOUND: If the customer or offer
477
- # resource is not found for the reseller. </li> <li> ALREADY_EXISTS: If the
478
- # SKU has been already transferred for the customer. </li> <li>
479
- # CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the
480
- # following cases: <ul>
481
- # <li> Transferring a SKU that requires domain verification and the
482
- # domain has not been verified. </li>
483
- # <li> Transferring an Add-On SKU like Vault or Drive without transferring
484
- # the pre-requisite SKU, such as G Suite Basic </li> <li> Applicable only for
485
- # developer accounts: reseller and resold domain must follow the domain
486
- # naming convention as follows:
487
- # <ul>
488
- # <li> Domain names must start with goog-test. </li>
489
- # <li> Resold domain names must include the reseller domain. </li>
490
- # </ul>
491
- # </li>
492
- # <li> All transferring entitlements must be specified. </li>
493
- # </ul>
494
- # </li>
495
- # <li> INTERNAL: Any non-user error related to a technical issue in the
496
- # backend. Please contact Cloud Channel Support in this case. </li>
497
- # <li> UNKNOWN: Any non-user error related to a technical issue in the
498
- # backend. Please contact Cloud Channel Support in this case. </li>
499
- # </ul>
500
- #
501
- # Return Value:
502
- # <br/> Long Running Operation ID.
424
+ # Possible error codes:
425
+ #
426
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
427
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
428
+ # * NOT_FOUND: The customer or offer resource was not found.
429
+ # * ALREADY_EXISTS: The SKU was already transferred for the customer.
430
+ # * CONDITION_NOT_MET or FAILED_PRECONDITION:
431
+ # * The SKU requires domain verification to transfer, but the domain is
432
+ # not verified.
433
+ # * An Add-On SKU (example, Vault or Drive) is missing the
434
+ # pre-requisite SKU (example, G Suite Basic).
435
+ # * (Developer accounts only) Reseller and resold domain must meet the
436
+ # following naming requirements:
437
+ # * Domain names must start with goog-test.
438
+ # * Domain names must include the reseller domain.
439
+ # * Specify all transferring entitlements.
440
+ # * INTERNAL: Any non-user error related to a technical issue in the
441
+ # backend. Contact Cloud Channel support.
442
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
443
+ # Contact Cloud Channel support.
444
+ #
445
+ # Return value:
446
+ # The ID of a long-running operation.
503
447
  #
504
448
  # To get the results of the operation, call the GetOperation method of
505
449
  # CloudChannelOperationsService. The Operation metadata will contain an
506
450
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
507
451
  rpc :TransferEntitlements, ::Google::Cloud::Channel::V1::TransferEntitlementsRequest, ::Google::Longrunning::Operation
508
- # Transfers customer entitlements from current reseller to Google.
509
- #
510
- # Possible Error Codes:
511
- # <ul>
512
- # <li> PERMISSION_DENIED: If the customer doesn't belong to the reseller.
513
- # </li> <li> INVALID_ARGUMENT: Missing or invalid required parameters in the
514
- # request. </li>
515
- # <li> NOT_FOUND: If the customer or offer resource is not found
516
- # for the reseller. </li>
517
- # <li> ALREADY_EXISTS: If the SKU has been already
518
- # transferred for the customer. </li>
519
- # <li> CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in
520
- # the following cases:
521
- # <ul>
522
- # <li> Transferring a SKU that requires domain verification and the
523
- # domain has not been verified. </li>
524
- # <li> Transferring an Add-On SKU like Vault or Drive without purchasing
525
- # the pre-requisite SKU, such as G Suite Basic </li> <li> Applicable only for
526
- # developer accounts: reseller and resold domain must follow the domain
527
- # naming convention as follows:
528
- # <ul>
529
- # <li> Domain names must start with goog-test. </li>
530
- # <li> Resold domain names must include the reseller domain. </li>
531
- # </ul>
532
- # </li>
533
- # </ul>
534
- # </li>
535
- # <li> INTERNAL: Any non-user error related to a technical issue in the
536
- # backend. Please contact Cloud Channel Support in this case. </li>
537
- # <li> UNKNOWN: Any non-user error related to a technical issue in the
538
- # backend. Please contact Cloud Channel Support in this case.</li>
539
- # </ul>
540
- #
541
- # Return Value:
542
- # <br/> Long Running Operation ID.
452
+ # Transfers customer entitlements from their current reseller to Google.
453
+ #
454
+ # Possible error codes:
455
+ #
456
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
457
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
458
+ # * NOT_FOUND: The customer or offer resource was not found.
459
+ # * ALREADY_EXISTS: The SKU was already transferred for the customer.
460
+ # * CONDITION_NOT_MET or FAILED_PRECONDITION:
461
+ # * The SKU requires domain verification to transfer, but the domain is
462
+ # not verified.
463
+ # * An Add-On SKU (example, Vault or Drive) is missing the
464
+ # pre-requisite SKU (example, G Suite Basic).
465
+ # * (Developer accounts only) Reseller and resold domain must meet the
466
+ # following naming requirements:
467
+ # * Domain names must start with goog-test.
468
+ # * Domain names must include the reseller domain.
469
+ # * INTERNAL: Any non-user error related to a technical issue in the
470
+ # backend. Contact Cloud Channel support.
471
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
472
+ # Contact Cloud Channel support.
473
+ #
474
+ # Return value:
475
+ # The ID of a long-running operation.
543
476
  #
544
477
  # To get the results of the operation, call the GetOperation method of
545
478
  # CloudChannelOperationsService. The response will contain
@@ -547,129 +480,183 @@ module Google
547
480
  # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
548
481
  rpc :TransferEntitlementsToGoogle, ::Google::Cloud::Channel::V1::TransferEntitlementsToGoogleRequest, ::Google::Longrunning::Operation
549
482
  # List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s belonging to a distributor.
550
- # To call this method, you must be a distributor.
483
+ # You must be a distributor to call this method.
551
484
  #
552
- # Possible Error Codes:
485
+ # Possible error codes:
553
486
  #
554
- # * PERMISSION_DENIED: If the reseller account making the request and the
555
- # reseller account being queried for are different.
556
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
557
- # request.
487
+ # * PERMISSION_DENIED: The reseller account making the request is different
488
+ # from the reseller account in the API request.
489
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
558
490
  #
559
- # Return Value:
560
- # <br/> If successful, returns the list of [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources
561
- # for the distributor account, otherwise returns an error.
491
+ # Return value:
492
+ # The list of the distributor account's [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources.
562
493
  rpc :ListChannelPartnerLinks, ::Google::Cloud::Channel::V1::ListChannelPartnerLinksRequest, ::Google::Cloud::Channel::V1::ListChannelPartnerLinksResponse
563
- # Returns a requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
564
- # To call this method, you must be a distributor.
494
+ # Returns the requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
495
+ # You must be a distributor to call this method.
565
496
  #
566
- # Possible Error Codes:
497
+ # Possible error codes:
567
498
  #
568
- # * PERMISSION_DENIED: If the reseller account making the request and the
569
- # reseller account being queried for are different.
570
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
571
- # request.
572
- # * NOT_FOUND: ChannelPartnerLink resource not found. Results
573
- # due invalid channel partner link name.
499
+ # * PERMISSION_DENIED: The reseller account making the request is different
500
+ # from the reseller account in the API request.
501
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
502
+ # * NOT_FOUND: ChannelPartnerLink resource not found because of an
503
+ # invalid channel partner link name.
574
504
  #
575
- # Return Value:
576
- # <br/> [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if found, otherwise returns an error.
505
+ # Return value:
506
+ # The [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
577
507
  rpc :GetChannelPartnerLink, ::Google::Cloud::Channel::V1::GetChannelPartnerLinkRequest, ::Google::Cloud::Channel::V1::ChannelPartnerLink
578
- # Initiates a channel partner link between a distributor and a reseller or
508
+ # Initiates a channel partner link between a distributor and a reseller, or
579
509
  # between resellers in an n-tier reseller channel.
580
- # To accept the invite, the invited partner should follow the invite_link_uri
581
- # provided in the response. If the link creation is accepted, a valid link is
582
- # set up between the two involved parties.
583
- # To call this method, you must be a distributor.
584
- #
585
- # Possible Error Codes:
586
- #
587
- # * PERMISSION_DENIED: If the reseller account making the request and the
588
- # reseller account being queried for are different.
589
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
590
- # request.
591
- # * ALREADY_EXISTS: If the ChannelPartnerLink sent in the request already
510
+ # Invited partners need to follow the invite_link_uri provided in the
511
+ # response to accept. After accepting the invitation, a link is set up
512
+ # between the two parties.
513
+ # You must be a distributor to call this method.
514
+ #
515
+ # Possible error codes:
516
+ #
517
+ # * PERMISSION_DENIED: The reseller account making the request is different
518
+ # from the reseller account in the API request.
519
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
520
+ # * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already
592
521
  # exists.
593
- # * NOT_FOUND: If no Cloud Identity customer exists for domain provided.
522
+ # * NOT_FOUND: No Cloud Identity customer exists for provided domain.
594
523
  # * INTERNAL: Any non-user error related to a technical issue in the
595
- # backend. In this case, contact Cloud Channel support.
596
- # * UNKNOWN: Any non-user error related to a technical issue in
597
- # the backend. In this case, contact Cloud Channel support.
524
+ # backend. Contact Cloud Channel support.
525
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
526
+ # Contact Cloud Channel support.
598
527
  #
599
- # Return Value:
600
- # <br/> Newly created [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if successful,
601
- # otherwise error is returned.
528
+ # Return value:
529
+ # The new [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
602
530
  rpc :CreateChannelPartnerLink, ::Google::Cloud::Channel::V1::CreateChannelPartnerLinkRequest, ::Google::Cloud::Channel::V1::ChannelPartnerLink
603
- # Updates a channel partner link. A distributor calls this method to change a
604
- # link's status. For example, suspend a partner link.
605
- # To call this method, you must be a distributor.
606
- #
607
- # Possible Error Codes:
608
- # <ul>
609
- # <li> PERMISSION_DENIED: If the reseller account making the request and the
610
- # reseller account being queried for are different. </li>
611
- # <li> INVALID_ARGUMENT:
612
- # <ul>
613
- # <li> Missing or invalid required parameters in the request. </li>
614
- # <li> Updating link state from invited to active or suspended. </li>
615
- # <li> Sending reseller_cloud_identity_id, invite_url or name in update
616
- # mask. </li>
617
- # </ul>
618
- # </li>
619
- # <li> NOT_FOUND: ChannelPartnerLink resource not found.</li>
620
- # <li> INTERNAL: Any non-user error related to a technical issue in the
621
- # backend. In this case, contact Cloud Channel support. </li>
622
- # <li> UNKNOWN: Any non-user error related to a technical issue in the
623
- # backend. In this case, contact Cloud Channel support.</li>
624
- # </ul>
625
- #
626
- # Return Value:
627
- # <br/> If successful, the updated [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource, otherwise
628
- # returns an error.
531
+ # Updates a channel partner link. Distributors call this method to change a
532
+ # link's status. For example, to suspend a partner link.
533
+ # You must be a distributor to call this method.
534
+ #
535
+ # Possible error codes:
536
+ #
537
+ # * PERMISSION_DENIED: The reseller account making the request is different
538
+ # from the reseller account in the API request.
539
+ # * INVALID_ARGUMENT:
540
+ # * Required request parameters are missing or invalid.
541
+ # * Link state cannot change from invited to active or suspended.
542
+ # * Cannot send reseller_cloud_identity_id, invite_url, or name in update
543
+ # mask.
544
+ # * NOT_FOUND: ChannelPartnerLink resource not found.
545
+ # * INTERNAL: Any non-user error related to a technical issue in the
546
+ # backend. Contact Cloud Channel support.
547
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
548
+ # Contact Cloud Channel support.
549
+ #
550
+ # Return value:
551
+ # The updated [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
629
552
  rpc :UpdateChannelPartnerLink, ::Google::Cloud::Channel::V1::UpdateChannelPartnerLinkRequest, ::Google::Cloud::Channel::V1::ChannelPartnerLink
553
+ # Returns the requested [Offer][google.cloud.channel.v1.Offer] resource.
554
+ #
555
+ # Possible error codes:
556
+ #
557
+ # * PERMISSION_DENIED: The entitlement doesn't belong to the reseller.
558
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
559
+ # * NOT_FOUND: Entitlement or offer was not found.
560
+ #
561
+ # Return value:
562
+ # The [Offer][google.cloud.channel.v1.Offer] resource.
563
+ rpc :LookupOffer, ::Google::Cloud::Channel::V1::LookupOfferRequest, ::Google::Cloud::Channel::V1::Offer
630
564
  # Lists the Products the reseller is authorized to sell.
631
565
  #
632
- # Possible Error Codes:
566
+ # Possible error codes:
633
567
  #
634
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
635
- # request.
568
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
636
569
  rpc :ListProducts, ::Google::Cloud::Channel::V1::ListProductsRequest, ::Google::Cloud::Channel::V1::ListProductsResponse
637
570
  # Lists the SKUs for a product the reseller is authorized to sell.
638
571
  #
639
- # Possible Error Codes:
572
+ # Possible error codes:
640
573
  #
641
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
642
- # request.
574
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
643
575
  rpc :ListSkus, ::Google::Cloud::Channel::V1::ListSkusRequest, ::Google::Cloud::Channel::V1::ListSkusResponse
644
576
  # Lists the Offers the reseller can sell.
645
577
  #
646
- # Possible Error Codes:
578
+ # Possible error codes:
647
579
  #
648
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
649
- # request.
580
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
650
581
  rpc :ListOffers, ::Google::Cloud::Channel::V1::ListOffersRequest, ::Google::Cloud::Channel::V1::ListOffersResponse
651
- # Lists the Purchasable SKUs for following cases:
582
+ # Lists the following:
652
583
  #
653
- # * SKUs that can be newly purchased for a customer
654
- # * SKUs that can be upgraded/downgraded to, for an entitlement.
584
+ # * SKUs that you can purchase for a customer
585
+ # * SKUs that you can upgrade or downgrade for an entitlement.
655
586
  #
656
- # Possible Error Codes:
587
+ # Possible error codes:
657
588
  #
658
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller
659
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
660
- # request.
589
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
590
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
661
591
  rpc :ListPurchasableSkus, ::Google::Cloud::Channel::V1::ListPurchasableSkusRequest, ::Google::Cloud::Channel::V1::ListPurchasableSkusResponse
662
- # Lists the Purchasable Offers for the following cases:
592
+ # Lists the following:
663
593
  #
664
- # * Offers that can be newly purchased for a customer
665
- # * Offers that can be changed to, for an entitlement.
594
+ # * Offers that you can purchase for a customer.
595
+ # * Offers that you can change for an entitlement.
666
596
  #
667
- # Possible Error Codes:
597
+ # Possible error codes:
668
598
  #
669
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller
670
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
671
- # request.
599
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller
600
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
672
601
  rpc :ListPurchasableOffers, ::Google::Cloud::Channel::V1::ListPurchasableOffersRequest, ::Google::Cloud::Channel::V1::ListPurchasableOffersResponse
602
+ # Registers a service account with subscriber privileges on the Cloud Pub/Sub
603
+ # topic for this Channel Services account. After you create a
604
+ # subscriber, you get the events through [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent]
605
+ #
606
+ # Possible error codes:
607
+ #
608
+ # * PERMISSION_DENIED: The reseller account making the request and the
609
+ # provided reseller account are different, or the impersonated user
610
+ # is not a super admin.
611
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
612
+ # * INTERNAL: Any non-user error related to a technical issue in the
613
+ # backend. Contact Cloud Channel support.
614
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
615
+ # Contact Cloud Channel support.
616
+ #
617
+ # Return value:
618
+ # The topic name with the registered service email address.
619
+ rpc :RegisterSubscriber, ::Google::Cloud::Channel::V1::RegisterSubscriberRequest, ::Google::Cloud::Channel::V1::RegisterSubscriberResponse
620
+ # Unregisters a service account with subscriber privileges on the Cloud
621
+ # Pub/Sub topic created for this Channel Services account. If there are no
622
+ # service accounts left with subscriber privileges, this deletes the topic.
623
+ # You can call ListSubscribers to check for these accounts.
624
+ #
625
+ # Possible error codes:
626
+ #
627
+ # * PERMISSION_DENIED: The reseller account making the request and the
628
+ # provided reseller account are different, or the impersonated user
629
+ # is not a super admin.
630
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
631
+ # * NOT_FOUND: The topic resource doesn't exist.
632
+ # * INTERNAL: Any non-user error related to a technical issue in the
633
+ # backend. Contact Cloud Channel support.
634
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
635
+ # Contact Cloud Channel support.
636
+ #
637
+ # Return value:
638
+ # The topic name that unregistered the service email address.
639
+ # Returns a success response if the service email address wasn't registered
640
+ # with the topic.
641
+ rpc :UnregisterSubscriber, ::Google::Cloud::Channel::V1::UnregisterSubscriberRequest, ::Google::Cloud::Channel::V1::UnregisterSubscriberResponse
642
+ # Lists service accounts with subscriber privileges on the Cloud Pub/Sub
643
+ # topic created for this Channel Services account.
644
+ #
645
+ # Possible error codes:
646
+ #
647
+ # * PERMISSION_DENIED: The reseller account making the request and the
648
+ # provided reseller account are different, or the impersonated user
649
+ # is not a super admin.
650
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
651
+ # * NOT_FOUND: The topic resource doesn't exist.
652
+ # * INTERNAL: Any non-user error related to a technical issue in the
653
+ # backend. Contact Cloud Channel support.
654
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
655
+ # Contact Cloud Channel support.
656
+ #
657
+ # Return value:
658
+ # A list of service email addresses.
659
+ rpc :ListSubscribers, ::Google::Cloud::Channel::V1::ListSubscribersRequest, ::Google::Cloud::Channel::V1::ListSubscribersResponse
673
660
  end
674
661
 
675
662
  Stub = Service.rpc_stub_class