google-cloud-channel-v1 0.5.0 → 0.7.2

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/AUTHENTICATION.md +8 -8
  3. data/README.md +1 -1
  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 +765 -688
  6. data/lib/google/cloud/channel/v1/cloud_channel_service/operations.rb +34 -25
  7. data/lib/google/cloud/channel/v1/common_pb.rb +1 -0
  8. data/lib/google/cloud/channel/v1/entitlements_pb.rb +1 -0
  9. data/lib/google/cloud/channel/v1/service_pb.rb +4 -0
  10. data/lib/google/cloud/channel/v1/service_services_pb.rb +380 -417
  11. data/lib/google/cloud/channel/v1/subscriber_event_pb.rb +3 -0
  12. data/lib/google/cloud/channel/v1/version.rb +1 -1
  13. data/proto_docs/google/api/field_behavior.rb +7 -1
  14. data/proto_docs/google/cloud/channel/v1/common.rb +9 -2
  15. data/proto_docs/google/cloud/channel/v1/customers.rb +23 -27
  16. data/proto_docs/google/cloud/channel/v1/entitlements.rb +3 -0
  17. data/proto_docs/google/cloud/channel/v1/service.rb +211 -220
  18. data/proto_docs/google/cloud/channel/v1/subscriber_event.rb +9 -0
  19. data/proto_docs/google/type/money.rb +1 -1
  20. metadata +13 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e3260a1de5aa7d4c0fbe7e22d532c7d9ebde5284a9bc097a8a0c944ccbc86e27
4
- data.tar.gz: 7f68f7c8800ee237f407bbc7d5f307071d9d3793ae3a4a281a105bac744123ad
3
+ metadata.gz: 8ec05fd73c6128dd0af7292a7d128d045cf89082e902ca06c81ac415ec589309
4
+ data.tar.gz: 1aa78d199501d1876c868a26f1a7d98b303c8e4e9411a8f717114aa960290b38
5
5
  SHA512:
6
- metadata.gz: 86c20b359847f1a3de48ba140e727ab8f57e5b34cf5b42cf303826ed677cac79118315d2ae48e11cec3feb5eaf68f17ab443b37248eb3ac4c54d04818cc498e2
7
- data.tar.gz: f91916ecc820390663e5e2ec20b4574cda2020d492e1544c871a7b0c8b890437b91284dc47a965a20d142d5da26eb1933f22ce163912393fc60dd338c33174fc
6
+ metadata.gz: 1685d2697475114598e8396704e27edd24e16eb94d065a96deeaeaab851413e51a27dca544ad4c4798343d4e31d52356ca52cfe84cc1dc4e25c8fa0f00de6cae
7
+ data.tar.gz: 53395b7f4d80932af5d4a912cfb84976022e8de758fd9864a3cba0fd509f575d2a25b6b2a233cb0a522000337385a67b856662208811ed9d0776826aece998aa
data/AUTHENTICATION.md CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-channel-v1
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::Channel::V1::CloudChannelService::Credentials}):
68
68
 
69
- 1. `CHANNEL_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `CHANNEL_KEYFILE` - Path to JSON file, or JSON contents
71
- 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
69
+ * `CHANNEL_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `CHANNEL_KEYFILE` - Path to JSON file, or JSON contents
71
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
+ * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
74
74
 
75
75
  ```ruby
76
76
  require "google/cloud/channel/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Channel::V1::CloudChannelService::Client.new
82
82
 
83
83
  ### Configuration
84
84
 
85
- The **Credentials JSON** can be configured instead of placing them in
86
- environment variables. Either on an individual client initialization:
85
+ The path to the **Credentials JSON** file can be configured instead of storing
86
+ it in an environment variable. Either on an individual client initialization:
87
87
 
88
88
  ```ruby
89
89
  require "google/cloud/channel/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Channel::V1::CloudChannelService::Client.new do |confi
93
93
  end
94
94
  ```
95
95
 
96
- Or configured globally for all clients:
96
+ Or globally for all clients:
97
97
 
98
98
  ```ruby
99
99
  require "google/cloud/channel/v1"
data/README.md CHANGED
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
33
33
  require "google/cloud/channel/v1"
34
34
 
35
35
  client = ::Google::Cloud::Channel::V1::CloudChannelService::Client.new
36
- request = my_create_request
36
+ request = ::Google::Cloud::Channel::V1::ListCustomersRequest.new # (request fields as keyword arguments...)
37
37
  response = client.list_customers request
38
38
  ```
39
39
 
data/lib/google/cloud/channel/v1/cloud_channel_service.rb CHANGED
@@ -32,27 +32,25 @@ module Google
32
32
  module Channel
33
33
  module V1
34
34
  ##
35
- # CloudChannelService enables Google cloud resellers and distributors to manage
36
- # their customers, channel partners, entitlements and reports.
35
+ # CloudChannelService lets Google cloud resellers and distributors manage
36
+ # their customers, channel partners, entitlements, and reports.
37
37
  #
38
38
  # Using this service:
39
- # 1. Resellers or distributors can manage a customer entity.
40
- # 2. Distributors can register an authorized reseller in their channel and then
41
- # enable delegated admin access for the reseller.
42
- # 3. Resellers or distributors can manage entitlements for their customers.
39
+ # 1. Resellers and distributors can manage a customer entity.
40
+ # 2. Distributors can register an authorized reseller in their channel and
41
+ # provide them with delegated admin access.
42
+ # 3. Resellers and distributors can manage customer entitlements.
43
43
  #
44
- # The service primarily exposes the following resources:
45
- # - {::Google::Cloud::Channel::V1::Customer Customer}s: A Customer represents an entity managed by a reseller or
46
- # distributor. A customer typically represents an enterprise. In an n-tier
47
- # resale channel hierarchy, customers are generally represented as leaf nodes.
48
- # Customers primarily have an Entitlement sub-resource discussed below.
44
+ # CloudChannelService exposes the following resources:
45
+ # - {::Google::Cloud::Channel::V1::Customer Customer}s: An entity—usually an enterprise—managed by a reseller or
46
+ # distributor.
49
47
  #
50
- # - {::Google::Cloud::Channel::V1::Entitlement Entitlement}s: An Entitlement represents an entity which provides a
51
- # customer means to start using a service. Entitlements are created or updated
52
- # as a result of a successful fulfillment.
48
+ # - {::Google::Cloud::Channel::V1::Entitlement Entitlement}s: An entity that provides a customer with the means to use
49
+ # a service. Entitlements are created or updated as a result of a successful
50
+ # fulfillment.
53
51
  #
54
- # - {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s: A ChannelPartnerLink is an entity that identifies
55
- # links between distributors and their indirect resellers in a channel.
52
+ # - {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s: An entity that identifies links between
53
+ # distributors and their indirect resellers in a channel.
56
54
  #
57
55
  # To load this service and instantiate a client:
58
56
  #
data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb CHANGED
@@ -27,27 +27,25 @@ module Google
27
27
  ##
28
28
  # Client for the CloudChannelService service.
29
29
  #
30
- # CloudChannelService enables Google cloud resellers and distributors to manage
31
- # their customers, channel partners, entitlements and reports.
30
+ # CloudChannelService lets Google cloud resellers and distributors manage
31
+ # their customers, channel partners, entitlements, and reports.
32
32
  #
33
33
  # Using this service:
34
- # 1. Resellers or distributors can manage a customer entity.
35
- # 2. Distributors can register an authorized reseller in their channel and then
36
- # enable delegated admin access for the reseller.
37
- # 3. Resellers or distributors can manage entitlements for their customers.
34
+ # 1. Resellers and distributors can manage a customer entity.
35
+ # 2. Distributors can register an authorized reseller in their channel and
36
+ # provide them with delegated admin access.
37
+ # 3. Resellers and distributors can manage customer entitlements.
38
38
  #
39
- # The service primarily exposes the following resources:
40
- # - {::Google::Cloud::Channel::V1::Customer Customer}s: A Customer represents an entity managed by a reseller or
41
- # distributor. A customer typically represents an enterprise. In an n-tier
42
- # resale channel hierarchy, customers are generally represented as leaf nodes.
43
- # Customers primarily have an Entitlement sub-resource discussed below.
39
+ # CloudChannelService exposes the following resources:
40
+ # - {::Google::Cloud::Channel::V1::Customer Customer}s: An entity—usually an enterprise—managed by a reseller or
41
+ # distributor.
44
42
  #
45
- # - {::Google::Cloud::Channel::V1::Entitlement Entitlement}s: An Entitlement represents an entity which provides a
46
- # customer means to start using a service. Entitlements are created or updated
47
- # as a result of a successful fulfillment.
43
+ # - {::Google::Cloud::Channel::V1::Entitlement Entitlement}s: An entity that provides a customer with the means to use
44
+ # a service. Entitlements are created or updated as a result of a successful
45
+ # fulfillment.
48
46
  #
49
- # - {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s: A ChannelPartnerLink is an entity that identifies
50
- # links between distributors and their indirect resellers in a channel.
47
+ # - {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s: An entity that identifies links between
48
+ # distributors and their indirect resellers in a channel.
51
49
  #
52
50
  class Client
53
51
  include Paths
@@ -61,13 +59,12 @@ module Google
61
59
  # See {::Google::Cloud::Channel::V1::CloudChannelService::Client::Configuration}
62
60
  # for a description of the configuration fields.
63
61
  #
64
- # ## Example
62
+ # @example
65
63
  #
66
- # To modify the configuration for all CloudChannelService clients:
67
- #
68
- # ::Google::Cloud::Channel::V1::CloudChannelService::Client.configure do |config|
69
- # config.timeout = 10.0
70
- # end
64
+ # # Modify the configuration for all CloudChannelService clients
65
+ # ::Google::Cloud::Channel::V1::CloudChannelService::Client.configure do |config|
66
+ # config.timeout = 10.0
67
+ # end
71
68
  #
72
69
  # @yield [config] Configure the Client client.
73
70
  # @yieldparam config [Client::Configuration]
@@ -87,10 +84,7 @@ module Google
87
84
 
88
85
  default_config.timeout = 60.0
89
86
  default_config.retry_policy = {
90
- initial_delay: 1.0,
91
- max_delay: 10.0,
92
- multiplier: 1.3,
93
- retry_codes: [14]
87
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
94
88
  }
95
89
 
96
90
  default_config.rpcs.provision_cloud_identity.timeout = 60.0
@@ -144,19 +138,15 @@ module Google
144
138
  ##
145
139
  # Create a new CloudChannelService client object.
146
140
  #
147
- # ## Examples
148
- #
149
- # To create a new CloudChannelService client with the default
150
- # configuration:
151
- #
152
- # client = ::Google::Cloud::Channel::V1::CloudChannelService::Client.new
141
+ # @example
153
142
  #
154
- # To create a new CloudChannelService client with a custom
155
- # configuration:
143
+ # # Create a client using the default configuration
144
+ # client = ::Google::Cloud::Channel::V1::CloudChannelService::Client.new
156
145
  #
157
- # client = ::Google::Cloud::Channel::V1::CloudChannelService::Client.new do |config|
158
- # config.timeout = 10.0
159
- # end
146
+ # # Create a client using a custom configuration
147
+ # client = ::Google::Cloud::Channel::V1::CloudChannelService::Client.new do |config|
148
+ # config.timeout = 10.0
149
+ # end
160
150
  #
161
151
  # @yield [config] Configure the CloudChannelService client.
162
152
  # @yieldparam config [Client::Configuration]
@@ -176,14 +166,13 @@ module Google
176
166
 
177
167
  # Create credentials
178
168
  credentials = @config.credentials
179
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
169
+ # Use self-signed JWT if the endpoint is unchanged from default,
180
170
  # but only if the default endpoint does not have a region prefix.
181
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
182
- @config.endpoint == Client.configure.endpoint &&
171
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
183
172
  !@config.endpoint.split(".").first.include?("-")
184
173
  credentials ||= Credentials.default scope: @config.scope,
185
174
  enable_self_signed_jwt: enable_self_signed_jwt
186
- if credentials.is_a?(String) || credentials.is_a?(Hash)
175
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
187
176
  credentials = Credentials.new credentials, scope: @config.scope
188
177
  end
189
178
  @quota_project_id = @config.quota_project
@@ -213,18 +202,16 @@ module Google
213
202
  # Service calls
214
203
 
215
204
  ##
216
- # List downstream {::Google::Cloud::Channel::V1::Customer Customer}s.
205
+ # List {::Google::Cloud::Channel::V1::Customer Customer}s.
217
206
  #
218
- # Possible Error Codes:
207
+ # Possible error codes:
219
208
  #
220
- # * PERMISSION_DENIED: If the reseller account making the request and the
221
- # reseller account being queried for are different.
222
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
223
- # request.
209
+ # * PERMISSION_DENIED: The reseller account making the request is different
210
+ # from the reseller account in the API request.
211
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
224
212
  #
225
- # Return Value:
226
- # List of {::Google::Cloud::Channel::V1::Customer Customer}s pertaining to the reseller or empty list if
227
- # there are none.
213
+ # Return value:
214
+ # List of {::Google::Cloud::Channel::V1::Customer Customer}s, or an empty list if there are no customers.
228
215
  #
229
216
  # @overload list_customers(request, options = nil)
230
217
  # Pass arguments to `list_customers` via a request object, either of type
@@ -242,15 +229,15 @@ module Google
242
229
  # the default parameter values, pass an empty Hash as a request object (see above).
243
230
  #
244
231
  # @param parent [::String]
245
- # Required. The resource name of the reseller account from which to list customers.
246
- # The parent takes the format: accounts/\\{account_id}.
232
+ # Required. The resource name of the reseller account to list customers from.
233
+ # Parent uses the format: accounts/\\{account_id}.
247
234
  # @param page_size [::Integer]
248
235
  # Optional. The maximum number of customers to return. The service may return fewer
249
- # than this value. If unspecified, at most 10 customers will be returned. The
250
- # maximum value is 50; values about 50 will be coerced to 50.
236
+ # than this value. If unspecified, returns at most 10 customers. The
237
+ # maximum value is 50.
251
238
  # @param page_token [::String]
252
- # Optional. A token identifying a page of results, if other than the first one.
253
- # Typically obtained via
239
+ # Optional. A token identifying a page of results other than the first page.
240
+ # Obtained through
254
241
  # {::Google::Cloud::Channel::V1::ListCustomersResponse#next_page_token ListCustomersResponse.next_page_token} of the previous
255
242
  # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_customers CloudChannelService.ListCustomers} call.
256
243
  #
@@ -288,7 +275,9 @@ module Google
288
275
  options.apply_defaults timeout: @config.rpcs.list_customers.timeout,
289
276
  metadata: metadata,
290
277
  retry_policy: @config.rpcs.list_customers.retry_policy
291
- options.apply_defaults metadata: @config.metadata,
278
+
279
+ options.apply_defaults timeout: @config.timeout,
280
+ metadata: @config.metadata,
292
281
  retry_policy: @config.retry_policy
293
282
 
294
283
  @cloud_channel_service_stub.call_rpc :list_customers, request, options: options do |response, operation|
@@ -301,19 +290,18 @@ module Google
301
290
  end
302
291
 
303
292
  ##
304
- # Returns a requested {::Google::Cloud::Channel::V1::Customer Customer} resource.
293
+ # Returns the requested {::Google::Cloud::Channel::V1::Customer Customer} resource.
305
294
  #
306
- # Possible Error Codes:
295
+ # Possible error codes:
307
296
  #
308
- # * PERMISSION_DENIED: If the reseller account making the request and the
309
- # reseller account being queried for are different.
310
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
311
- # request.
312
- # * NOT_FOUND: If the customer resource doesn't exist. Usually
313
- # the result of an invalid name parameter.
297
+ # * PERMISSION_DENIED: The reseller account making the request is different
298
+ # from the reseller account in the API request.
299
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
300
+ # * NOT_FOUND: The customer resource doesn't exist. Usually the result of an
301
+ # invalid name parameter.
314
302
  #
315
- # Return Value:
316
- # {::Google::Cloud::Channel::V1::Customer Customer} resource if found, error otherwise.
303
+ # Return value:
304
+ # The {::Google::Cloud::Channel::V1::Customer Customer} resource.
317
305
  #
318
306
  # @overload get_customer(request, options = nil)
319
307
  # Pass arguments to `get_customer` via a request object, either of type
@@ -332,7 +320,7 @@ module Google
332
320
  #
333
321
  # @param name [::String]
334
322
  # Required. The resource name of the customer to retrieve.
335
- # The name takes the format: accounts/\\{account_id}/customers/\\{customer_id}
323
+ # Name uses the format: accounts/\\{account_id}/customers/\\{customer_id}
336
324
  #
337
325
  # @yield [response, operation] Access the result along with the RPC operation
338
326
  # @yieldparam response [::Google::Cloud::Channel::V1::Customer]
@@ -368,7 +356,9 @@ module Google
368
356
  options.apply_defaults timeout: @config.rpcs.get_customer.timeout,
369
357
  metadata: metadata,
370
358
  retry_policy: @config.rpcs.get_customer.retry_policy
371
- options.apply_defaults metadata: @config.metadata,
359
+
360
+ options.apply_defaults timeout: @config.timeout,
361
+ metadata: @config.metadata,
372
362
  retry_policy: @config.retry_policy
373
363
 
374
364
  @cloud_channel_service_stub.call_rpc :get_customer, request, options: options do |response, operation|
@@ -380,22 +370,21 @@ module Google
380
370
  end
381
371
 
382
372
  ##
383
- # Confirms the existence of Cloud Identity accounts, based on the domain and
384
- # whether the Cloud Identity accounts are owned by the reseller.
373
+ # Confirms the existence of Cloud Identity accounts based on the domain and
374
+ # if the Cloud Identity accounts are owned by the reseller.
385
375
  #
386
- # Possible Error Codes:
376
+ # Possible error codes:
387
377
  #
388
- # * PERMISSION_DENIED: If the reseller account making the request and the
389
- # reseller account being queried for are different.
390
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
391
- # request.
378
+ # * PERMISSION_DENIED: The reseller account making the request is different
379
+ # from the reseller account in the API request.
380
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
392
381
  # * INVALID_VALUE: Invalid domain value in the request.
393
382
  #
394
- # Return Value:
395
- # List of {::Google::Cloud::Channel::V1::CloudIdentityCustomerAccount CloudIdentityCustomerAccount} resources for the domain.
396
- # List may be empty.
383
+ # Return value:
384
+ # A list of {::Google::Cloud::Channel::V1::CloudIdentityCustomerAccount CloudIdentityCustomerAccount} resources for the domain (may be
385
+ # empty)
397
386
  #
398
- # Note: in the v1alpha1 version of the API, a NOT_FOUND error is returned if
387
+ # Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if
399
388
  # no {::Google::Cloud::Channel::V1::CloudIdentityCustomerAccount CloudIdentityCustomerAccount} resources match the domain.
400
389
  #
401
390
  # @overload check_cloud_identity_accounts_exist(request, options = nil)
@@ -414,10 +403,10 @@ module Google
414
403
  # the default parameter values, pass an empty Hash as a request object (see above).
415
404
  #
416
405
  # @param parent [::String]
417
- # Required. The resource name of the reseller account.
418
- # The parent takes the format: accounts/\\{account_id}
406
+ # Required. The reseller account's resource name.
407
+ # Parent uses the format: accounts/\\{account_id}
419
408
  # @param domain [::String]
420
- # Required. Domain for which the Cloud Identity account customer is fetched.
409
+ # Required. Domain to fetch for Cloud Identity account customer.
421
410
  #
422
411
  # @yield [response, operation] Access the result along with the RPC operation
423
412
  # @yieldparam response [::Google::Cloud::Channel::V1::CheckCloudIdentityAccountsExistResponse]
@@ -453,7 +442,9 @@ module Google
453
442
  options.apply_defaults timeout: @config.rpcs.check_cloud_identity_accounts_exist.timeout,
454
443
  metadata: metadata,
455
444
  retry_policy: @config.rpcs.check_cloud_identity_accounts_exist.retry_policy
456
- options.apply_defaults metadata: @config.metadata,
445
+
446
+ options.apply_defaults timeout: @config.timeout,
447
+ metadata: @config.metadata,
457
448
  retry_policy: @config.retry_policy
458
449
 
459
450
  @cloud_channel_service_stub.call_rpc :check_cloud_identity_accounts_exist, request, options: options do |response, operation|
@@ -468,18 +459,16 @@ module Google
468
459
  # Creates a new {::Google::Cloud::Channel::V1::Customer Customer} resource under the reseller or distributor
469
460
  # account.
470
461
  #
471
- # Possible Error Codes:
462
+ # Possible error codes:
472
463
  #
473
- # * PERMISSION_DENIED: If the reseller account making the request and the
474
- # reseller account being queried for are different.
475
- # * INVALID_ARGUMENT: It can happen in following scenarios -
476
- # * Missing or invalid required parameters in the request.
477
- # * Domain field value doesn't match the domain specified in primary
478
- # email.
464
+ # * PERMISSION_DENIED: The reseller account making the request is different
465
+ # from the reseller account in the API request.
466
+ # * INVALID_ARGUMENT:
467
+ # * Required request parameters are missing or invalid.
468
+ # * Domain field value doesn't match the primary email domain.
479
469
  #
480
- # Return Value:
481
- # If successful, the newly created {::Google::Cloud::Channel::V1::Customer Customer} resource, otherwise
482
- # returns an error.
470
+ # Return value:
471
+ # The newly created {::Google::Cloud::Channel::V1::Customer Customer} resource.
483
472
  #
484
473
  # @overload create_customer(request, options = nil)
485
474
  # Pass arguments to `create_customer` via a request object, either of type
@@ -498,7 +487,7 @@ module Google
498
487
  #
499
488
  # @param parent [::String]
500
489
  # Required. The resource name of reseller account in which to create the customer.
501
- # The parent takes the format: accounts/\\{account_id}
490
+ # Parent uses the format: accounts/\\{account_id}
502
491
  # @param customer [::Google::Cloud::Channel::V1::Customer, ::Hash]
503
492
  # Required. The customer to create.
504
493
  #
@@ -536,7 +525,9 @@ module Google
536
525
  options.apply_defaults timeout: @config.rpcs.create_customer.timeout,
537
526
  metadata: metadata,
538
527
  retry_policy: @config.rpcs.create_customer.retry_policy
539
- options.apply_defaults metadata: @config.metadata,
528
+
529
+ options.apply_defaults timeout: @config.timeout,
530
+ metadata: @config.metadata,
540
531
  retry_policy: @config.retry_policy
541
532
 
542
533
  @cloud_channel_service_stub.call_rpc :create_customer, request, options: options do |response, operation|
@@ -548,21 +539,18 @@ module Google
548
539
  end
549
540
 
550
541
  ##
551
- # Updates an existing {::Google::Cloud::Channel::V1::Customer Customer} resource belonging to the reseller or
542
+ # Updates an existing {::Google::Cloud::Channel::V1::Customer Customer} resource for the reseller or
552
543
  # distributor.
553
544
  #
554
- # Possible Error Codes:
545
+ # Possible error codes:
555
546
  #
556
- # * PERMISSION_DENIED: If the reseller account making the request and the
557
- # reseller account being queried for are different.
558
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
559
- # request.
560
- # * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found for the name
561
- # specified in the request.
547
+ # * PERMISSION_DENIED: The reseller account making the request is different
548
+ # from the reseller account in the API request.
549
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
550
+ # * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found for the name in the request.
562
551
  #
563
- # Return Value:
564
- # If successful, the updated {::Google::Cloud::Channel::V1::Customer Customer} resource, otherwise returns
565
- # an error.
552
+ # Return value:
553
+ # The updated {::Google::Cloud::Channel::V1::Customer Customer} resource.
566
554
  #
567
555
  # @overload update_customer(request, options = nil)
568
556
  # Pass arguments to `update_customer` via a request object, either of type
@@ -619,7 +607,9 @@ module Google
619
607
  options.apply_defaults timeout: @config.rpcs.update_customer.timeout,
620
608
  metadata: metadata,
621
609
  retry_policy: @config.rpcs.update_customer.retry_policy
622
- options.apply_defaults metadata: @config.metadata,
610
+
611
+ options.apply_defaults timeout: @config.timeout,
612
+ metadata: @config.metadata,
623
613
  retry_policy: @config.retry_policy
624
614
 
625
615
  @cloud_channel_service_stub.call_rpc :update_customer, request, options: options do |response, operation|
@@ -631,17 +621,15 @@ module Google
631
621
  end
632
622
 
633
623
  ##
634
- # Deletes the given {::Google::Cloud::Channel::V1::Customer Customer} permanently and irreversibly.
624
+ # Deletes the given {::Google::Cloud::Channel::V1::Customer Customer} permanently.
635
625
  #
636
- # Possible Error Codes:
626
+ # Possible error codes:
637
627
  #
638
- # * PERMISSION_DENIED: If the account making the request does not own
628
+ # * PERMISSION_DENIED: The account making the request does not own
639
629
  # this customer.
640
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
641
- # request.
642
- # * FAILED_PRECONDITION: If the customer has existing entitlements.
643
- # * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found for the name
644
- # specified in the request.
630
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
631
+ # * FAILED_PRECONDITION: The customer has existing entitlements.
632
+ # * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found for the name in the request.
645
633
  #
646
634
  # @overload delete_customer(request, options = nil)
647
635
  # Pass arguments to `delete_customer` via a request object, either of type
@@ -695,7 +683,9 @@ module Google
695
683
  options.apply_defaults timeout: @config.rpcs.delete_customer.timeout,
696
684
  metadata: metadata,
697
685
  retry_policy: @config.rpcs.delete_customer.retry_policy
698
- options.apply_defaults metadata: @config.metadata,
686
+
687
+ options.apply_defaults timeout: @config.timeout,
688
+ metadata: @config.metadata,
699
689
  retry_policy: @config.retry_policy
700
690
 
701
691
  @cloud_channel_service_stub.call_rpc :delete_customer, request, options: options do |response, operation|
@@ -708,25 +698,25 @@ module Google
708
698
 
709
699
  ##
710
700
  # Creates a Cloud Identity for the given customer using the customer's
711
- # information or the information provided here, if present.
701
+ # information, or the information provided here.
712
702
  #
713
- # Possible Error Codes:
703
+ # Possible error codes:
714
704
  #
715
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
716
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
717
- # * NOT_FOUND: If the customer is not found for the reseller.
718
- # * ALREADY_EXISTS: If the customer's primary email already exists. In this
719
- # case, retry after changing the customer's primary contact email.
720
- # * INTERNAL: Any non-user error related to a technical issue in the
721
- # backend. Contact Cloud Channel support in this case.
722
- # * UNKNOWN: Any non-user error related to a technical issue in the backend.
723
- # Contact Cloud Channel support in this case.
705
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
706
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
707
+ # * NOT_FOUND: The customer was not found.
708
+ # * ALREADY_EXISTS: The customer's primary email already exists. Retry
709
+ # after changing the customer's primary contact email.
710
+ # * INTERNAL: Any non-user error related to a technical issue in the
711
+ # backend. Contact Cloud Channel support.
712
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
713
+ # Contact Cloud Channel support.
724
714
  #
725
- # Return Value:
726
- # Long Running Operation ID.
715
+ # Return value:
716
+ # The ID of a long-running operation.
727
717
  #
728
718
  # To get the results of the operation, call the GetOperation method of
729
- # CloudChannelOperationsService. The Operation metadata will contain an
719
+ # CloudChannelOperationsService. The Operation metadata contains an
730
720
  # instance of {::Google::Cloud::Channel::V1::OperationMetadata OperationMetadata}.
731
721
  #
732
722
  # @overload provision_cloud_identity(request, options = nil)
@@ -752,8 +742,7 @@ module Google
752
742
  # @param user [::Google::Cloud::Channel::V1::AdminUser, ::Hash]
753
743
  # Admin user information.
754
744
  # @param validate_only [::Boolean]
755
- # If set, validate the request and preview the review, but do not actually
756
- # post it.
745
+ # Validate the request and preview the review, but do not post it.
757
746
  #
758
747
  # @yield [response, operation] Access the result along with the RPC operation
759
748
  # @yieldparam response [::Gapic::Operation]
@@ -789,7 +778,9 @@ module Google
789
778
  options.apply_defaults timeout: @config.rpcs.provision_cloud_identity.timeout,
790
779
  metadata: metadata,
791
780
  retry_policy: @config.rpcs.provision_cloud_identity.retry_policy
792
- options.apply_defaults metadata: @config.metadata,
781
+
782
+ options.apply_defaults timeout: @config.timeout,
783
+ metadata: @config.metadata,
793
784
  retry_policy: @config.retry_policy
794
785
 
795
786
  @cloud_channel_service_stub.call_rpc :provision_cloud_identity, request, options: options do |response, operation|
@@ -802,16 +793,15 @@ module Google
802
793
  end
803
794
 
804
795
  ##
805
- # List {::Google::Cloud::Channel::V1::Entitlement Entitlement}s belonging to a customer.
796
+ # Lists {::Google::Cloud::Channel::V1::Entitlement Entitlement}s belonging to a customer.
806
797
  #
807
- # Possible Error Codes:
798
+ # Possible error codes:
808
799
  #
809
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
810
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
800
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
801
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
811
802
  #
812
- # Return Value:
813
- # List of {::Google::Cloud::Channel::V1::Entitlement Entitlement}s belonging to the customer, or empty list if
814
- # there are none.
803
+ # Return value:
804
+ # A list of the customer's {::Google::Cloud::Channel::V1::Entitlement Entitlement}s.
815
805
  #
816
806
  # @overload list_entitlements(request, options = nil)
817
807
  # Pass arguments to `list_entitlements` via a request object, either of type
@@ -829,16 +819,16 @@ module Google
829
819
  # the default parameter values, pass an empty Hash as a request object (see above).
830
820
  #
831
821
  # @param parent [::String]
832
- # Required. The resource name of the reseller's customer account for which to list
833
- # entitlements.
834
- # The parent takes the format: accounts/\\{account_id}/customers/\\{customer_id}
822
+ # Required. The resource name of the reseller's customer account to list
823
+ # entitlements for.
824
+ # Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
835
825
  # @param page_size [::Integer]
836
826
  # Optional. Requested page size. Server might return fewer results than requested.
837
- # If unspecified, at most 50 entitlements will be returned.
838
- # The maximum value is 100; values above 100 will be coerced to 100.
827
+ # If unspecified, return at most 50 entitlements.
828
+ # The maximum value is 100; the server will coerce values above 100.
839
829
  # @param page_token [::String]
840
- # Optional. A token identifying a page of results, if other than the first one.
841
- # Typically obtained via
830
+ # Optional. A token for a page of results other than the first page.
831
+ # Obtained using
842
832
  # {::Google::Cloud::Channel::V1::ListEntitlementsResponse#next_page_token ListEntitlementsResponse.next_page_token} of the previous
843
833
  # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlements CloudChannelService.ListEntitlements} call.
844
834
  #
@@ -876,7 +866,9 @@ module Google
876
866
  options.apply_defaults timeout: @config.rpcs.list_entitlements.timeout,
877
867
  metadata: metadata,
878
868
  retry_policy: @config.rpcs.list_entitlements.retry_policy
879
- options.apply_defaults metadata: @config.metadata,
869
+
870
+ options.apply_defaults timeout: @config.timeout,
871
+ metadata: @config.metadata,
880
872
  retry_policy: @config.retry_policy
881
873
 
882
874
  @cloud_channel_service_stub.call_rpc :list_entitlements, request, options: options do |response, operation|
@@ -889,24 +881,24 @@ module Google
889
881
  end
890
882
 
891
883
  ##
892
- # List {::Google::Cloud::Channel::V1::TransferableSku TransferableSku}s of a customer based on Cloud Identity ID or
884
+ # List {::Google::Cloud::Channel::V1::TransferableSku TransferableSku}s of a customer based on the Cloud Identity ID or
893
885
  # Customer Name in the request.
894
886
  #
895
- # This method is used when a reseller lists the entitlements
896
- # information of a customer that is not owned. The reseller should provide
897
- # the customer's Cloud Identity ID or Customer Name.
887
+ # Use this method to list the entitlements information of an
888
+ # unowned customer. You should provide the customer's
889
+ # Cloud Identity ID or Customer Name.
898
890
  #
899
- # Possible Error Codes:
891
+ # Possible error codes:
900
892
  #
901
- # * PERMISSION_DENIED: Appears because of one of the following -
902
- # * The customer doesn't belong to the reseller and no auth token.
893
+ # * PERMISSION_DENIED:
894
+ # * The customer doesn't belong to the reseller and has no auth token.
903
895
  # * The supplied auth token is invalid.
904
- # * The reseller account making the request and the queries reseller
905
- # account are different.
906
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
896
+ # * The reseller account making the request is different
897
+ # from the reseller account in the query.
898
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
907
899
  #
908
- # Return Value:
909
- # List of {::Google::Cloud::Channel::V1::TransferableSku TransferableSku} for the given customer.
900
+ # Return value:
901
+ # A list of the customer's {::Google::Cloud::Channel::V1::TransferableSku TransferableSku}.
910
902
  #
911
903
  # @overload list_transferable_skus(request, options = nil)
912
904
  # Pass arguments to `list_transferable_skus` via a request object, either of type
@@ -928,32 +920,31 @@ module Google
928
920
  # @param customer_name [::String]
929
921
  # A reseller is required to create a customer and use the resource name of
930
922
  # the created customer here.
931
- # The customer_name takes the format:
923
+ # Customer_name uses the format:
932
924
  # accounts/\\{account_id}/customers/\\{customer_id}
933
925
  # @param parent [::String]
934
- # Required. The resource name of the reseller's account.
935
- # The parent takes the format: accounts/\\{account_id}
926
+ # Required. The reseller account's resource name.
927
+ # Parent uses the format: accounts/\\{account_id}
936
928
  # @param page_size [::Integer]
937
- # Requested page size. Server might return fewer results than requested.
938
- # If unspecified, at most 100 SKUs will be returned.
939
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
929
+ # The requested page size. Server might return fewer results than requested.
930
+ # If unspecified, returns at most 100 SKUs.
931
+ # The maximum value is 1000; the server will coerce values above 1000.
940
932
  # Optional.
941
933
  # @param page_token [::String]
942
- # A token identifying a page of results, if other than the first one.
943
- # Typically obtained via
934
+ # A token for a page of results other than the first page.
935
+ # Obtained using
944
936
  # {::Google::Cloud::Channel::V1::ListTransferableSkusResponse#next_page_token ListTransferableSkusResponse.next_page_token} of the previous
945
937
  # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_skus CloudChannelService.ListTransferableSkus} call.
946
938
  # Optional.
947
939
  # @param auth_token [::String]
948
- # This token is generated by the Super Admin of the resold customer to
940
+ # The super admin of the resold customer generates this token to
949
941
  # authorize a reseller to access their Cloud Identity and purchase
950
- # entitlements on their behalf. This token can be omitted once the
951
- # authorization is generated. See https://support.google.com/a/answer/7643790
952
- # for more details.
942
+ # entitlements on their behalf. You can omit this token after authorization.
943
+ # See https://support.google.com/a/answer/7643790 for more details.
953
944
  # @param language_code [::String]
954
- # The BCP-47 language code, such as "en-US". If specified, the
955
- # response will be localized to the corresponding language code. Default is
956
- # "en-US".
945
+ # The BCP-47 language code. For example, "en-US". The
946
+ # response will localize in the corresponding language code, if specified.
947
+ # The default value is "en-US".
957
948
  # Optional.
958
949
  #
959
950
  # @yield [response, operation] Access the result along with the RPC operation
@@ -990,7 +981,9 @@ module Google
990
981
  options.apply_defaults timeout: @config.rpcs.list_transferable_skus.timeout,
991
982
  metadata: metadata,
992
983
  retry_policy: @config.rpcs.list_transferable_skus.retry_policy
993
- options.apply_defaults metadata: @config.metadata,
984
+
985
+ options.apply_defaults timeout: @config.timeout,
986
+ metadata: @config.metadata,
994
987
  retry_policy: @config.retry_policy
995
988
 
996
989
  @cloud_channel_service_stub.call_rpc :list_transferable_skus, request, options: options do |response, operation|
@@ -1006,21 +999,20 @@ module Google
1006
999
  # List {::Google::Cloud::Channel::V1::TransferableOffer TransferableOffer}s of a customer based on Cloud Identity ID or
1007
1000
  # Customer Name in the request.
1008
1001
  #
1009
- # This method is used when a reseller gets the entitlement
1010
- # information of a customer that is not owned. The reseller should provide
1011
- # the customer's Cloud Identity ID or Customer Name.
1002
+ # Use this method when a reseller gets the entitlement information of an
1003
+ # unowned customer. The reseller should provide the customer's
1004
+ # Cloud Identity ID or Customer Name.
1012
1005
  #
1013
- # Possible Error Codes:
1006
+ # Possible error codes:
1014
1007
  #
1015
- # * PERMISSION_DENIED: Appears because of one of the following:
1016
- # * If the customer doesn't belong to the reseller and no auth token or
1017
- # invalid auth token is supplied.
1018
- # * If the reseller account making the request and the reseller account
1019
- # being queried for are different.
1020
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
1021
- # request.
1008
+ # * PERMISSION_DENIED:
1009
+ # * The customer doesn't belong to the reseller and has no auth token.
1010
+ # * The supplied auth token is invalid.
1011
+ # * The reseller account making the request is different
1012
+ # from the reseller account in the query.
1013
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
1022
1014
  #
1023
- # Return Value:
1015
+ # Return value:
1024
1016
  # List of {::Google::Cloud::Channel::V1::TransferableOffer TransferableOffer} for the given customer and SKU.
1025
1017
  #
1026
1018
  # @overload list_transferable_offers(request, options = nil)
@@ -1042,24 +1034,24 @@ module Google
1042
1034
  # Customer's Cloud Identity ID
1043
1035
  # @param customer_name [::String]
1044
1036
  # A reseller should create a customer and use the resource name of
1045
- # the created customer here.
1037
+ # that customer here.
1046
1038
  # @param parent [::String]
1047
1039
  # Required. The resource name of the reseller's account.
1048
1040
  # @param page_size [::Integer]
1049
1041
  # Requested page size. Server might return fewer results than requested.
1050
- # If unspecified, at most 100 Offers will be returned.
1051
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
1042
+ # If unspecified, returns at most 100 offers.
1043
+ # The maximum value is 1000; the server will coerce values above 1000.
1052
1044
  # @param page_token [::String]
1053
- # A token identifying a page of results, if other than the first one.
1054
- # Typically obtained via
1045
+ # A token for a page of results other than the first page.
1046
+ # Obtained using
1055
1047
  # {::Google::Cloud::Channel::V1::ListTransferableOffersResponse#next_page_token ListTransferableOffersResponse.next_page_token} of the previous
1056
1048
  # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_offers CloudChannelService.ListTransferableOffers} call.
1057
1049
  # @param sku [::String]
1058
- # Required. SKU for which the Offers are being looked up.
1050
+ # Required. The SKU to look up Offers for.
1059
1051
  # @param language_code [::String]
1060
- # The BCP-47 language code, such as "en-US". If specified, the
1061
- # response will be localized to the corresponding language code. Default is
1062
- # "en-US".
1052
+ # The BCP-47 language code. For example, "en-US". The
1053
+ # response will localize in the corresponding language code, if specified.
1054
+ # The default value is "en-US".
1063
1055
  #
1064
1056
  # @yield [response, operation] Access the result along with the RPC operation
1065
1057
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::TransferableOffer>]
@@ -1095,7 +1087,9 @@ module Google
1095
1087
  options.apply_defaults timeout: @config.rpcs.list_transferable_offers.timeout,
1096
1088
  metadata: metadata,
1097
1089
  retry_policy: @config.rpcs.list_transferable_offers.retry_policy
1098
- options.apply_defaults metadata: @config.metadata,
1090
+
1091
+ options.apply_defaults timeout: @config.timeout,
1092
+ metadata: @config.metadata,
1099
1093
  retry_policy: @config.retry_policy
1100
1094
 
1101
1095
  @cloud_channel_service_stub.call_rpc :list_transferable_offers, request, options: options do |response, operation|
@@ -1108,18 +1102,16 @@ module Google
1108
1102
  end
1109
1103
 
1110
1104
  ##
1111
- # Returns a requested {::Google::Cloud::Channel::V1::Entitlement Entitlement} resource.
1105
+ # Returns the requested {::Google::Cloud::Channel::V1::Entitlement Entitlement} resource.
1112
1106
  #
1113
- # Possible Error Codes:
1107
+ # Possible error codes:
1114
1108
  #
1115
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
1116
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
1117
- # request.
1118
- # * NOT_FOUND: If the entitlement is not found for the customer.
1109
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
1110
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
1111
+ # * NOT_FOUND: The customer entitlement was not found.
1119
1112
  #
1120
- # Return Value:
1121
- # If found, the requested {::Google::Cloud::Channel::V1::Entitlement Entitlement} resource, otherwise returns
1122
- # an error.
1113
+ # Return value:
1114
+ # The requested {::Google::Cloud::Channel::V1::Entitlement Entitlement} resource.
1123
1115
  #
1124
1116
  # @overload get_entitlement(request, options = nil)
1125
1117
  # Pass arguments to `get_entitlement` via a request object, either of type
@@ -1138,8 +1130,8 @@ module Google
1138
1130
  #
1139
1131
  # @param name [::String]
1140
1132
  # Required. The resource name of the entitlement to retrieve.
1141
- # The name takes the format:
1142
- # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{id}
1133
+ # Name uses the format:
1134
+ # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
1143
1135
  #
1144
1136
  # @yield [response, operation] Access the result along with the RPC operation
1145
1137
  # @yieldparam response [::Google::Cloud::Channel::V1::Entitlement]
@@ -1175,7 +1167,9 @@ module Google
1175
1167
  options.apply_defaults timeout: @config.rpcs.get_entitlement.timeout,
1176
1168
  metadata: metadata,
1177
1169
  retry_policy: @config.rpcs.get_entitlement.retry_policy
1178
- options.apply_defaults metadata: @config.metadata,
1170
+
1171
+ options.apply_defaults timeout: @config.timeout,
1172
+ metadata: @config.metadata,
1179
1173
  retry_policy: @config.retry_policy
1180
1174
 
1181
1175
  @cloud_channel_service_stub.call_rpc :get_entitlement, request, options: options do |response, operation|
@@ -1189,39 +1183,36 @@ module Google
1189
1183
  ##
1190
1184
  # Creates an entitlement for a customer.
1191
1185
  #
1192
- # Possible Error Codes:
1193
- #
1194
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
1195
- # * INVALID_ARGUMENT: It can happen in below scenarios -
1196
- # * Missing or invalid required parameters in the request.
1197
- # * Cannot purchase an entitlement if there is already an entitlement for
1198
- # customer, for a SKU from the same product family.
1199
- # * INVALID_VALUE: Offer passed in isn't valid. Make sure OfferId is
1200
- # valid. If it is valid, then contact Google Channel support for further
1201
- # troubleshooting.
1202
- # * NOT_FOUND: If the customer or offer resource is not found for the
1203
- # reseller.
1204
- # * ALREADY_EXISTS: This failure can happen in the following cases:
1205
- # * If the SKU has been already purchased for the customer.
1206
- # * If the customer's primary email already exists. In this case retry
1186
+ # Possible error codes:
1187
+ #
1188
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
1189
+ # * INVALID_ARGUMENT:
1190
+ # * Required request parameters are missing or invalid.
1191
+ # * There is already a customer entitlement for a SKU from the same
1192
+ # product family.
1193
+ # * INVALID_VALUE: Make sure the OfferId is valid. If it is, contact
1194
+ # Google Channel support for further troubleshooting.
1195
+ # * NOT_FOUND: The customer or offer resource was not found.
1196
+ # * ALREADY_EXISTS:
1197
+ # * The SKU was already purchased for the customer.
1198
+ # * The customer's primary email already exists. Retry
1207
1199
  # after changing the customer's primary contact email.
1208
- # * CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the
1209
- # following cases:
1210
- # * Purchasing a SKU that requires domain verification and the domain has
1211
- # not been verified.
1212
- # * Purchasing an Add-On SKU like Vault or Drive without purchasing the
1213
- # pre-requisite SKU, such as Google Workspace Business Starter.
1214
- # * Applicable only for developer accounts: reseller and resold domain.
1215
- # Must meet the following domain naming requirements:
1200
+ # * CONDITION_NOT_MET or FAILED_PRECONDITION:
1201
+ # * The domain required for purchasing a SKU has not been verified.
1202
+ # * A pre-requisite SKU required to purchase an Add-On SKU is missing.
1203
+ # For example, Google Workspace Business Starter is required to purchase
1204
+ # Vault or Drive.
1205
+ # * (Developer accounts only) Reseller and resold domain must meet the
1206
+ # following naming requirements:
1216
1207
  # * Domain names must start with goog-test.
1217
- # * Resold domain names must include the reseller domain.
1208
+ # * Domain names must include the reseller domain.
1218
1209
  # * INTERNAL: Any non-user error related to a technical issue in the
1219
- # backend. Contact Cloud Channel Support in this case.
1220
- # * UNKNOWN: Any non-user error related to a technical issue in the
1221
- # backend. Contact Cloud Channel Support in this case.
1210
+ # backend. Contact Cloud Channel support.
1211
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
1212
+ # Contact Cloud Channel support.
1222
1213
  #
1223
- # Return Value:
1224
- # Long Running Operation ID.
1214
+ # Return value:
1215
+ # The ID of a long-running operation.
1225
1216
  #
1226
1217
  # To get the results of the operation, call the GetOperation method of
1227
1218
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -1243,20 +1234,19 @@ module Google
1243
1234
  # the default parameter values, pass an empty Hash as a request object (see above).
1244
1235
  #
1245
1236
  # @param parent [::String]
1246
- # Required. The resource name of reseller's customer account in which to create the
1237
+ # Required. The resource name of the reseller's customer account in which to create the
1247
1238
  # entitlement.
1248
- # The parent takes the format: accounts/\\{account_id}/customers/\\{customer_id}
1239
+ # Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
1249
1240
  # @param entitlement [::Google::Cloud::Channel::V1::Entitlement, ::Hash]
1250
1241
  # Required. The entitlement to create.
1251
1242
  # @param request_id [::String]
1252
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
1253
- # that if you must retry your request, the server will know to ignore the
1254
- # request if it has already been completed.
1243
+ # Optional. You can specify an optional unique request ID, and if you need to retry
1244
+ # your request, the server will know to ignore the request if it's complete.
1255
1245
  #
1256
- # For example, consider a situation where you make an initial request and
1257
- # the request times out. If you make the request again with the same
1258
- # request ID, the server can check if the original operation with the same
1259
- # request ID was received, and if so, will ignore the second request.
1246
+ # For example, you make an initial request and the request times out. If you
1247
+ # make the request again with the same request ID, the server can check if
1248
+ # it received the original operation with the same request ID. If it did, it
1249
+ # will ignore the second request.
1260
1250
  #
1261
1251
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
1262
1252
  # with the exception that zero UUID is not supported
@@ -1296,7 +1286,9 @@ module Google
1296
1286
  options.apply_defaults timeout: @config.rpcs.create_entitlement.timeout,
1297
1287
  metadata: metadata,
1298
1288
  retry_policy: @config.rpcs.create_entitlement.retry_policy
1299
- options.apply_defaults metadata: @config.metadata,
1289
+
1290
+ options.apply_defaults timeout: @config.timeout,
1291
+ metadata: @config.metadata,
1300
1292
  retry_policy: @config.retry_policy
1301
1293
 
1302
1294
  @cloud_channel_service_stub.call_rpc :create_entitlement, request, options: options do |response, operation|
@@ -1309,26 +1301,25 @@ module Google
1309
1301
  end
1310
1302
 
1311
1303
  ##
1312
- # Change parameters of the entitlement
1304
+ # Change parameters of the entitlement.
1313
1305
  #
1314
- # An entitlement parameters update is a long-running operation and results in
1315
- # updates to the entitlement as a result of fulfillment.
1306
+ # An entitlement update is a long-running operation and it updates the
1307
+ # entitlement as a result of fulfillment.
1316
1308
  #
1317
- # Possible Error Codes:
1309
+ # Possible error codes:
1318
1310
  #
1319
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
1320
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
1321
- # request. For example, if the number of seats being changed to is greater
1322
- # than the allowed number of max seats for the resource. Or decreasing seats
1323
- # for a commitment based plan.
1311
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
1312
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
1313
+ # For example, the number of seats being changed is greater than the allowed
1314
+ # number of max seats, or decreasing seats for a commitment based plan.
1324
1315
  # * NOT_FOUND: Entitlement resource not found.
1325
- # * INTERNAL: Any non-user error related to a technical issue
1326
- # in the backend. In this case, contact Cloud Channel support.
1316
+ # * INTERNAL: Any non-user error related to a technical issue in the
1317
+ # backend. Contact Cloud Channel support.
1327
1318
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
1328
- # In this case, contact Cloud Channel support.
1319
+ # Contact Cloud Channel support.
1329
1320
  #
1330
- # Return Value:
1331
- # Long Running Operation ID.
1321
+ # Return value:
1322
+ # The ID of a long-running operation.
1332
1323
  #
1333
1324
  # To get the results of the operation, call the GetOperation method of
1334
1325
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -1351,24 +1342,21 @@ module Google
1351
1342
  #
1352
1343
  # @param name [::String]
1353
1344
  # Required. The name of the entitlement to update.
1354
- # The name takes the format:
1345
+ # Name uses the format:
1355
1346
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
1356
1347
  # @param parameters [::Array<::Google::Cloud::Channel::V1::Parameter, ::Hash>]
1357
- # Required. Entitlement parameters to update. Only editable parameters are allowed to
1358
- # be changed.
1348
+ # Required. Entitlement parameters to update. You can only change editable parameters.
1359
1349
  # @param request_id [::String]
1360
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
1361
- # that if you must retry your request, the server will know to ignore the
1362
- # request if it has already been completed.
1363
- #
1364
- # For example, consider a situation where you make an initial request and
1365
- # the request times out. If you make the request again with the same
1366
- # request ID, the server can check if the original operation with the same
1367
- # request ID was received, and if so, will ignore the second request.
1368
- #
1369
- # The request ID must be
1370
- # a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that
1371
- # zero UUID is not supported
1350
+ # Optional. You can specify an optional unique request ID, and if you need to retry
1351
+ # your request, the server will know to ignore the request if it's complete.
1352
+ #
1353
+ # For example, you make an initial request and the request times out. If you
1354
+ # make the request again with the same request ID, the server can check if
1355
+ # it received the original operation with the same request ID. If it did, it
1356
+ # will ignore the second request.
1357
+ #
1358
+ # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
1359
+ # with the exception that zero UUID is not supported
1372
1360
  # (`00000000-0000-0000-0000-000000000000`).
1373
1361
  # @param purchase_order_id [::String]
1374
1362
  # Optional. Purchase order ID provided by the reseller.
@@ -1407,7 +1395,9 @@ module Google
1407
1395
  options.apply_defaults timeout: @config.rpcs.change_parameters.timeout,
1408
1396
  metadata: metadata,
1409
1397
  retry_policy: @config.rpcs.change_parameters.retry_policy
1410
- options.apply_defaults metadata: @config.metadata,
1398
+
1399
+ options.apply_defaults timeout: @config.timeout,
1400
+ metadata: @config.metadata,
1411
1401
  retry_policy: @config.retry_policy
1412
1402
 
1413
1403
  @cloud_channel_service_stub.call_rpc :change_parameters, request, options: options do |response, operation|
@@ -1422,24 +1412,23 @@ module Google
1422
1412
  ##
1423
1413
  # Updates the renewal settings for an existing customer entitlement.
1424
1414
  #
1425
- # An entitlement update is a long-running operation and results in updates to
1426
- # the entitlement as a result of fulfillment.
1415
+ # An entitlement update is a long-running operation and it updates the
1416
+ # entitlement as a result of fulfillment.
1427
1417
  #
1428
- # Possible Error Codes:
1418
+ # Possible error codes:
1429
1419
  #
1430
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
1431
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
1432
- # request.
1420
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
1421
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
1433
1422
  # * NOT_FOUND: Entitlement resource not found.
1434
1423
  # * NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a
1435
- # commitment plan. Can't enable or disable renewal for non-commitment plans.
1436
- # * INTERNAL: Any non user error related to a technical issue in the
1437
- # backend. In this case, contact Cloud Channel support.
1438
- # * UNKNOWN: Any non user error related to a technical issue in the backend.
1439
- # In this case, contact Cloud Channel support.
1424
+ # commitment plan. Can't enable or disable renewals for non-commitment plans.
1425
+ # * INTERNAL: Any non-user error related to a technical issue in the
1426
+ # backend. Contact Cloud Channel support.
1427
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
1428
+ # Contact Cloud Channel support.
1440
1429
  #
1441
- # Return Value:
1442
- # Long Running Operation ID.
1430
+ # Return value:
1431
+ # The ID of a long-running operation.
1443
1432
  #
1444
1433
  # To get the results of the operation, call the GetOperation method of
1445
1434
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -1462,19 +1451,18 @@ module Google
1462
1451
  #
1463
1452
  # @param name [::String]
1464
1453
  # Required. The name of the entitlement to update.
1465
- # The name takes the format:
1454
+ # Name uses the format:
1466
1455
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
1467
1456
  # @param renewal_settings [::Google::Cloud::Channel::V1::RenewalSettings, ::Hash]
1468
1457
  # Required. New renewal settings.
1469
1458
  # @param request_id [::String]
1470
- # Optional. A request ID to identify requests. Specify a unique request ID so
1471
- # that if you must retry your request, the server will know to ignore the
1472
- # request if it has already been completed.
1459
+ # Optional. You can specify an optional unique request ID, and if you need to retry
1460
+ # your request, the server will know to ignore the request if it's complete.
1473
1461
  #
1474
- # For example, consider a situation where you make an initial request and
1475
- # the request times out. If you make the request again with the same
1476
- # request ID, the server can check if the original operation with the same
1477
- # request ID was received, and if so, will ignore the second request.
1462
+ # For example, you make an initial request and the request times out. If you
1463
+ # make the request again with the same request ID, the server can check if
1464
+ # it received the original operation with the same request ID. If it did, it
1465
+ # will ignore the second request.
1478
1466
  #
1479
1467
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
1480
1468
  # with the exception that zero UUID is not supported
@@ -1514,7 +1502,9 @@ module Google
1514
1502
  options.apply_defaults timeout: @config.rpcs.change_renewal_settings.timeout,
1515
1503
  metadata: metadata,
1516
1504
  retry_policy: @config.rpcs.change_renewal_settings.retry_policy
1517
- options.apply_defaults metadata: @config.metadata,
1505
+
1506
+ options.apply_defaults timeout: @config.timeout,
1507
+ metadata: @config.metadata,
1518
1508
  retry_policy: @config.retry_policy
1519
1509
 
1520
1510
  @cloud_channel_service_stub.call_rpc :change_renewal_settings, request, options: options do |response, operation|
@@ -1529,22 +1519,21 @@ module Google
1529
1519
  ##
1530
1520
  # Updates the Offer for an existing customer entitlement.
1531
1521
  #
1532
- # An entitlement update is a long-running operation and results in updates to
1533
- # the entitlement as a result of fulfillment.
1522
+ # An entitlement update is a long-running operation and it updates the
1523
+ # entitlement as a result of fulfillment.
1534
1524
  #
1535
- # Possible Error Codes:
1525
+ # Possible error codes:
1536
1526
  #
1537
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
1538
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
1539
- # request.
1527
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
1528
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
1540
1529
  # * NOT_FOUND: Offer or Entitlement resource not found.
1541
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
1542
- # In this case, contact Cloud Channel support.
1530
+ # * INTERNAL: Any non-user error related to a technical issue in the
1531
+ # backend. Contact Cloud Channel support.
1543
1532
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
1544
- # In this case, contact Cloud Channel support.
1533
+ # Contact Cloud Channel support.
1545
1534
  #
1546
- # Return Value:
1547
- # Long Running Operation ID.
1535
+ # Return value:
1536
+ # The ID of a long-running operation.
1548
1537
  #
1549
1538
  # To get the results of the operation, call the GetOperation method of
1550
1539
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -1566,8 +1555,8 @@ module Google
1566
1555
  # the default parameter values, pass an empty Hash as a request object (see above).
1567
1556
  #
1568
1557
  # @param name [::String]
1569
- # Required. The name of the entitlement to update.
1570
- # Format:
1558
+ # Required. The resource name of the entitlement to update.
1559
+ # Name uses the format:
1571
1560
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
1572
1561
  # @param offer [::String]
1573
1562
  # Required. New Offer.
@@ -1577,14 +1566,13 @@ module Google
1577
1566
  # @param purchase_order_id [::String]
1578
1567
  # Optional. Purchase order id provided by the reseller.
1579
1568
  # @param request_id [::String]
1580
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
1581
- # that if you must retry your request, the server will know to ignore the
1582
- # request if it has already been completed.
1569
+ # Optional. You can specify an optional unique request ID, and if you need to retry
1570
+ # your request, the server will know to ignore the request if it's complete.
1583
1571
  #
1584
- # For example, consider a situation where you make an initial request and
1585
- # the request times out. If you make the request again with the same
1586
- # request ID, the server can check if the original operation with the same
1587
- # request ID was received, and if so, will ignore the second request.
1572
+ # For example, you make an initial request and the request times out. If you
1573
+ # make the request again with the same request ID, the server can check if
1574
+ # it received the original operation with the same request ID. If it did, it
1575
+ # will ignore the second request.
1588
1576
  #
1589
1577
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
1590
1578
  # with the exception that zero UUID is not supported
@@ -1624,7 +1612,9 @@ module Google
1624
1612
  options.apply_defaults timeout: @config.rpcs.change_offer.timeout,
1625
1613
  metadata: metadata,
1626
1614
  retry_policy: @config.rpcs.change_offer.retry_policy
1627
- options.apply_defaults metadata: @config.metadata,
1615
+
1616
+ options.apply_defaults timeout: @config.timeout,
1617
+ metadata: @config.metadata,
1628
1618
  retry_policy: @config.retry_policy
1629
1619
 
1630
1620
  @cloud_channel_service_stub.call_rpc :change_offer, request, options: options do |response, operation|
@@ -1640,24 +1630,23 @@ module Google
1640
1630
  # Starts paid service for a trial entitlement.
1641
1631
  #
1642
1632
  # Starts paid service for a trial entitlement immediately. This method is
1643
- # only applicable if a plan has already been set up for a trial entitlement
1644
- # but has some trial days remaining.
1633
+ # only applicable if a plan is set up for a trial entitlement but has some
1634
+ # trial days remaining.
1645
1635
  #
1646
- # Possible Error Codes:
1636
+ # Possible error codes:
1647
1637
  #
1648
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
1649
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
1650
- # request.
1638
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
1639
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
1651
1640
  # * NOT_FOUND: Entitlement resource not found.
1652
1641
  # * FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for
1653
1642
  # entitlement on trial plans.
1654
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
1655
- # In this case, contact Cloud Channel support.
1656
- # * UNKNOWN: Any non-user error related to a technical issue
1657
- # in the backend. In this case, contact Cloud Channel support.
1643
+ # * INTERNAL: Any non-user error related to a technical issue in the
1644
+ # backend. Contact Cloud Channel support.
1645
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
1646
+ # Contact Cloud Channel support.
1658
1647
  #
1659
- # Return Value:
1660
- # Long Running Operation ID.
1648
+ # Return value:
1649
+ # The ID of a long-running operation.
1661
1650
  #
1662
1651
  # To get the results of the operation, call the GetOperation method of
1663
1652
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -1679,18 +1668,17 @@ module Google
1679
1668
  # the default parameter values, pass an empty Hash as a request object (see above).
1680
1669
  #
1681
1670
  # @param name [::String]
1682
- # Required. The name of the entitlement for which paid service is being started.
1683
- # The name takes the format:
1671
+ # Required. The name of the entitlement to start a paid service for.
1672
+ # Name uses the format:
1684
1673
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
1685
1674
  # @param request_id [::String]
1686
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
1687
- # that if you must retry your request, the server will know to ignore the
1688
- # request if it has already been completed.
1675
+ # Optional. You can specify an optional unique request ID, and if you need to retry
1676
+ # your request, the server will know to ignore the request if it's complete.
1689
1677
  #
1690
- # For example, consider a situation where you make an initial request and
1691
- # the request times out. If you make the request again with the same
1692
- # request ID, the server can check if the original operation with the same
1693
- # request ID was received, and if so, will ignore the second request.
1678
+ # For example, you make an initial request and the request times out. If you
1679
+ # make the request again with the same request ID, the server can check if
1680
+ # it received the original operation with the same request ID. If it did, it
1681
+ # will ignore the second request.
1694
1682
  #
1695
1683
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
1696
1684
  # with the exception that zero UUID is not supported
@@ -1730,7 +1718,9 @@ module Google
1730
1718
  options.apply_defaults timeout: @config.rpcs.start_paid_service.timeout,
1731
1719
  metadata: metadata,
1732
1720
  retry_policy: @config.rpcs.start_paid_service.retry_policy
1733
- options.apply_defaults metadata: @config.metadata,
1721
+
1722
+ options.apply_defaults timeout: @config.timeout,
1723
+ metadata: @config.metadata,
1734
1724
  retry_policy: @config.retry_policy
1735
1725
 
1736
1726
  @cloud_channel_service_stub.call_rpc :start_paid_service, request, options: options do |response, operation|
@@ -1744,22 +1734,22 @@ module Google
1744
1734
 
1745
1735
  ##
1746
1736
  # Suspends a previously fulfilled entitlement.
1737
+ #
1747
1738
  # An entitlement suspension is a long-running operation.
1748
1739
  #
1749
- # Possible Error Codes:
1740
+ # Possible error codes:
1750
1741
  #
1751
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
1752
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
1753
- # request.
1742
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
1743
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
1754
1744
  # * NOT_FOUND: Entitlement resource not found.
1755
1745
  # * NOT_ACTIVE: Entitlement is not active.
1756
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
1757
- # In this case, contact Cloud Channel support.
1746
+ # * INTERNAL: Any non-user error related to a technical issue in the
1747
+ # backend. Contact Cloud Channel support.
1758
1748
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
1759
- # In this case, contact Cloud Channel support.
1749
+ # Contact Cloud Channel support.
1760
1750
  #
1761
- # Return Value:
1762
- # Long Running Operation ID.
1751
+ # Return value:
1752
+ # The ID of a long-running operation.
1763
1753
  #
1764
1754
  # To get the results of the operation, call the GetOperation method of
1765
1755
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -1782,17 +1772,16 @@ module Google
1782
1772
  #
1783
1773
  # @param name [::String]
1784
1774
  # Required. The resource name of the entitlement to suspend.
1785
- # The name takes the format:
1775
+ # Name uses the format:
1786
1776
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
1787
1777
  # @param request_id [::String]
1788
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
1789
- # that if you must retry your request, the server will know to ignore the
1790
- # request if it has already been completed.
1778
+ # Optional. You can specify an optional unique request ID, and if you need to retry
1779
+ # your request, the server will know to ignore the request if it's complete.
1791
1780
  #
1792
- # For example, consider a situation where you make an initial request and
1793
- # the request times out. If you make the request again with the same
1794
- # request ID, the server can check if the original operation with the same
1795
- # request ID was received, and if so, will ignore the second request.
1781
+ # For example, you make an initial request and the request times out. If you
1782
+ # make the request again with the same request ID, the server can check if
1783
+ # it received the original operation with the same request ID. If it did, it
1784
+ # will ignore the second request.
1796
1785
  #
1797
1786
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
1798
1787
  # with the exception that zero UUID is not supported
@@ -1832,7 +1821,9 @@ module Google
1832
1821
  options.apply_defaults timeout: @config.rpcs.suspend_entitlement.timeout,
1833
1822
  metadata: metadata,
1834
1823
  retry_policy: @config.rpcs.suspend_entitlement.retry_policy
1835
- options.apply_defaults metadata: @config.metadata,
1824
+
1825
+ options.apply_defaults timeout: @config.timeout,
1826
+ metadata: @config.metadata,
1836
1827
  retry_policy: @config.retry_policy
1837
1828
 
1838
1829
  @cloud_channel_service_stub.call_rpc :suspend_entitlement, request, options: options do |response, operation|
@@ -1846,27 +1837,26 @@ module Google
1846
1837
 
1847
1838
  ##
1848
1839
  # Cancels a previously fulfilled entitlement.
1840
+ #
1849
1841
  # An entitlement cancellation is a long-running operation.
1850
1842
  #
1851
- # Possible Error Codes:
1843
+ # Possible error codes:
1852
1844
  #
1853
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller or
1854
- # if the reseller account making the request and reseller account being
1855
- # queried for are different.
1856
- # * FAILED_PRECONDITION: If there are any Google Cloud projects linked to the
1845
+ # * PERMISSION_DENIED: The reseller account making the request is different
1846
+ # from the reseller account in the API request.
1847
+ # * FAILED_PRECONDITION: There are Google Cloud projects linked to the
1857
1848
  # Google Cloud entitlement's Cloud Billing subaccount.
1858
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
1859
- # request.
1849
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
1860
1850
  # * NOT_FOUND: Entitlement resource not found.
1861
1851
  # * DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace
1862
- # add-ons or entitlements for Google Cloud's development platform.
1852
+ # add-ons, or entitlements for Google Cloud's development platform.
1863
1853
  # * INTERNAL: Any non-user error related to a technical issue in the
1864
- # backend. In this case, contact Cloud Channel support.
1854
+ # backend. Contact Cloud Channel support.
1865
1855
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
1866
- # In this case, contact Cloud Channel support.
1856
+ # Contact Cloud Channel support.
1867
1857
  #
1868
- # Return Value:
1869
- # Long Running Operation ID.
1858
+ # Return value:
1859
+ # The ID of a long-running operation.
1870
1860
  #
1871
1861
  # To get the results of the operation, call the GetOperation method of
1872
1862
  # CloudChannelOperationsService. The response will contain
@@ -1890,17 +1880,16 @@ module Google
1890
1880
  #
1891
1881
  # @param name [::String]
1892
1882
  # Required. The resource name of the entitlement to cancel.
1893
- # The name takes the format:
1883
+ # Name uses the format:
1894
1884
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
1895
1885
  # @param request_id [::String]
1896
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
1897
- # that if you must retry your request, the server will know to ignore the
1898
- # request if it has already been completed.
1886
+ # Optional. You can specify an optional unique request ID, and if you need to retry
1887
+ # your request, the server will know to ignore the request if it's complete.
1899
1888
  #
1900
- # For example, consider a situation where you make an initial request and
1901
- # the request times out. If you make the request again with the same
1902
- # request ID, the server can check if the original operation with the same
1903
- # request ID was received, and if so, will ignore the second request.
1889
+ # For example, you make an initial request and the request times out. If you
1890
+ # make the request again with the same request ID, the server can check if
1891
+ # it received the original operation with the same request ID. If it did, it
1892
+ # will ignore the second request.
1904
1893
  #
1905
1894
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
1906
1895
  # with the exception that zero UUID is not supported
@@ -1940,7 +1929,9 @@ module Google
1940
1929
  options.apply_defaults timeout: @config.rpcs.cancel_entitlement.timeout,
1941
1930
  metadata: metadata,
1942
1931
  retry_policy: @config.rpcs.cancel_entitlement.retry_policy
1943
- options.apply_defaults metadata: @config.metadata,
1932
+
1933
+ options.apply_defaults timeout: @config.timeout,
1934
+ metadata: @config.metadata,
1944
1935
  retry_policy: @config.retry_policy
1945
1936
 
1946
1937
  @cloud_channel_service_stub.call_rpc :cancel_entitlement, request, options: options do |response, operation|
@@ -1953,32 +1944,29 @@ module Google
1953
1944
  end
1954
1945
 
1955
1946
  ##
1956
- # Activates a previously suspended entitlement. The entitlement must be in a
1957
- # suspended state for it to be activated. Entitlements suspended for pending
1958
- # ToS acceptance can't be activated using this method. An entitlement
1959
- # activation is a long-running operation and can result in updates to
1947
+ # Activates a previously suspended entitlement. Entitlements suspended for
1948
+ # pending ToS acceptance can't be activated using this method.
1949
+ #
1950
+ # An entitlement activation is a long-running operation and it updates
1960
1951
  # the state of the customer entitlement.
1961
1952
  #
1962
- # Possible Error Codes:
1953
+ # Possible error codes:
1963
1954
  #
1964
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller or
1965
- # if the reseller account making the request and reseller account being
1966
- # queried for are different.
1967
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
1968
- # request.
1955
+ # * PERMISSION_DENIED: The reseller account making the request is different
1956
+ # from the reseller account in the API request.
1957
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
1969
1958
  # * NOT_FOUND: Entitlement resource not found.
1970
- # * SUSPENSION_NOT_RESELLER_INITIATED: Can't activate an
1971
- # entitlement that is pending TOS acceptance. Only reseller initiated
1972
- # suspensions can be activated.
1973
- # * NOT_SUSPENDED: Can't activate entitlements that are already in ACTIVE
1974
- # state. Can only activate suspended entitlements.
1975
- # * INTERNAL: Any non-user error related to a technical issue
1976
- # in the backend. In this case, contact Cloud Channel support.
1959
+ # * SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated
1960
+ # suspensions and entitlements that have accepted the TOS.
1961
+ # * NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE
1962
+ # state.
1963
+ # * INTERNAL: Any non-user error related to a technical issue in the
1964
+ # backend. Contact Cloud Channel support.
1977
1965
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
1978
- # In this case, contact Cloud Channel support.
1966
+ # Contact Cloud Channel support.
1979
1967
  #
1980
- # Return Value:
1981
- # Long Running Operation ID.
1968
+ # Return value:
1969
+ # The ID of a long-running operation.
1982
1970
  #
1983
1971
  # To get the results of the operation, call the GetOperation method of
1984
1972
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -2001,17 +1989,16 @@ module Google
2001
1989
  #
2002
1990
  # @param name [::String]
2003
1991
  # Required. The resource name of the entitlement to activate.
2004
- # The name takes the format:
1992
+ # Name uses the format:
2005
1993
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
2006
1994
  # @param request_id [::String]
2007
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
2008
- # that if you must retry your request, the server will know to ignore the
2009
- # request if it has already been completed.
1995
+ # Optional. You can specify an optional unique request ID, and if you need to retry
1996
+ # your request, the server will know to ignore the request if it's complete.
2010
1997
  #
2011
- # For example, consider a situation where you make an initial request and
2012
- # the request times out. If you make the request again with the same
2013
- # request ID, the server can check if the original operation with the same
2014
- # request ID was received, and if so, will ignore the second request.
1998
+ # For example, you make an initial request and the request times out. If you
1999
+ # make the request again with the same request ID, the server can check if
2000
+ # it received the original operation with the same request ID. If it did, it
2001
+ # will ignore the second request.
2015
2002
  #
2016
2003
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
2017
2004
  # with the exception that zero UUID is not supported
@@ -2051,7 +2038,9 @@ module Google
2051
2038
  options.apply_defaults timeout: @config.rpcs.activate_entitlement.timeout,
2052
2039
  metadata: metadata,
2053
2040
  retry_policy: @config.rpcs.activate_entitlement.retry_policy
2054
- options.apply_defaults metadata: @config.metadata,
2041
+
2042
+ options.apply_defaults timeout: @config.timeout,
2043
+ metadata: @config.metadata,
2055
2044
  retry_policy: @config.retry_policy
2056
2045
 
2057
2046
  @cloud_channel_service_stub.call_rpc :activate_entitlement, request, options: options do |response, operation|
@@ -2066,31 +2055,29 @@ module Google
2066
2055
  ##
2067
2056
  # Transfers customer entitlements to new reseller.
2068
2057
  #
2069
- # Possible Error Codes:
2070
- #
2071
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
2072
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
2073
- # * NOT_FOUND: If the customer or offer resource is not found for the
2074
- # reseller.
2075
- # * ALREADY_EXISTS: If the SKU has been already transferred for the customer.
2076
- # * CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the
2077
- # following cases:
2078
- # * Transferring a SKU that requires domain verification and the domain
2079
- # has not been verified.
2080
- # * Transferring an Add-On SKU like Vault or Drive without transferring
2081
- # the pre-requisite SKU, such as G Suite Basic.
2082
- # * Applicable only for developer accounts: reseller and resold domain
2083
- # must follow the domain naming convention as follows:
2058
+ # Possible error codes:
2059
+ #
2060
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
2061
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
2062
+ # * NOT_FOUND: The customer or offer resource was not found.
2063
+ # * ALREADY_EXISTS: The SKU was already transferred for the customer.
2064
+ # * CONDITION_NOT_MET or FAILED_PRECONDITION:
2065
+ # * The SKU requires domain verification to transfer, but the domain is
2066
+ # not verified.
2067
+ # * An Add-On SKU (example, Vault or Drive) is missing the
2068
+ # pre-requisite SKU (example, G Suite Basic).
2069
+ # * (Developer accounts only) Reseller and resold domain must meet the
2070
+ # following naming requirements:
2084
2071
  # * Domain names must start with goog-test.
2085
- # * Resold domain names must include the reseller domain.
2086
- # * All transferring entitlements must be specified.
2087
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
2088
- # Please contact Cloud Channel Support in this case.
2072
+ # * Domain names must include the reseller domain.
2073
+ # * Specify all transferring entitlements.
2074
+ # * INTERNAL: Any non-user error related to a technical issue in the
2075
+ # backend. Contact Cloud Channel support.
2089
2076
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
2090
- # Please contact Cloud Channel Support in this case.
2077
+ # Contact Cloud Channel support.
2091
2078
  #
2092
- # Return Value:
2093
- # Long Running Operation ID.
2079
+ # Return value:
2080
+ # The ID of a long-running operation.
2094
2081
  #
2095
2082
  # To get the results of the operation, call the GetOperation method of
2096
2083
  # CloudChannelOperationsService. The Operation metadata will contain an
@@ -2112,26 +2099,24 @@ module Google
2112
2099
  # the default parameter values, pass an empty Hash as a request object (see above).
2113
2100
  #
2114
2101
  # @param parent [::String]
2115
- # Required. The resource name of reseller's customer account where the entitlements
2116
- # transfer to.
2117
- # The parent takes the format: accounts/\\{account_id}/customers/\\{customer_id}
2102
+ # Required. The resource name of the reseller's customer account that will receive
2103
+ # transferred entitlements.
2104
+ # Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
2118
2105
  # @param entitlements [::Array<::Google::Cloud::Channel::V1::Entitlement, ::Hash>]
2119
- # Required. The new entitlements to be created or transferred.
2106
+ # Required. The new entitlements to create or transfer.
2120
2107
  # @param auth_token [::String]
2121
- # This token is generated by the Super Admin of the resold customer to
2108
+ # The super admin of the resold customer generates this token to
2122
2109
  # authorize a reseller to access their Cloud Identity and purchase
2123
- # entitlements on their behalf. This token can be omitted once the
2124
- # authorization is generated. See https://support.google.com/a/answer/7643790
2125
- # for more details.
2110
+ # entitlements on their behalf. You can omit this token after authorization.
2111
+ # See https://support.google.com/a/answer/7643790 for more details.
2126
2112
  # @param request_id [::String]
2127
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
2128
- # that if you must retry your request, the server will know to ignore the
2129
- # request if it has already been completed.
2113
+ # Optional. You can specify an optional unique request ID, and if you need to retry
2114
+ # your request, the server will know to ignore the request if it's complete.
2130
2115
  #
2131
- # For example, consider a situation where you make an initial request and
2132
- # the request times out. If you make the request again with the same
2133
- # request ID, the server can check if the original operation with the same
2134
- # request ID was received, and if so, will ignore the second request.
2116
+ # For example, you make an initial request and the request times out. If you
2117
+ # make the request again with the same request ID, the server can check if
2118
+ # it received the original operation with the same request ID. If it did, it
2119
+ # will ignore the second request.
2135
2120
  #
2136
2121
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
2137
2122
  # with the exception that zero UUID is not supported
@@ -2171,7 +2156,9 @@ module Google
2171
2156
  options.apply_defaults timeout: @config.rpcs.transfer_entitlements.timeout,
2172
2157
  metadata: metadata,
2173
2158
  retry_policy: @config.rpcs.transfer_entitlements.retry_policy
2174
- options.apply_defaults metadata: @config.metadata,
2159
+
2160
+ options.apply_defaults timeout: @config.timeout,
2161
+ metadata: @config.metadata,
2175
2162
  retry_policy: @config.retry_policy
2176
2163
 
2177
2164
  @cloud_channel_service_stub.call_rpc :transfer_entitlements, request, options: options do |response, operation|
@@ -2184,32 +2171,30 @@ module Google
2184
2171
  end
2185
2172
 
2186
2173
  ##
2187
- # Transfers customer entitlements from current reseller to Google.
2188
- #
2189
- # Possible Error Codes:
2190
- #
2191
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller.
2192
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the request.
2193
- # * NOT_FOUND: If the customer or offer resource is not found for the
2194
- # reseller.
2195
- # * ALREADY_EXISTS: If the SKU has been already transferred for the customer.
2196
- # * CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in
2197
- # the following cases:
2198
- # * Transferring a SKU that requires domain verification and the domain
2199
- # has not been verified.
2200
- # * Transferring an Add-On SKU like Vault or Drive without purchasing the
2201
- # pre-requisite SKU, such as G Suite Basic.
2202
- # * Applicable only for developer accounts: reseller and resold domain
2203
- # must follow the domain naming convention as follows:
2174
+ # Transfers customer entitlements from their current reseller to Google.
2175
+ #
2176
+ # Possible error codes:
2177
+ #
2178
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
2179
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
2180
+ # * NOT_FOUND: The customer or offer resource was not found.
2181
+ # * ALREADY_EXISTS: The SKU was already transferred for the customer.
2182
+ # * CONDITION_NOT_MET or FAILED_PRECONDITION:
2183
+ # * The SKU requires domain verification to transfer, but the domain is
2184
+ # not verified.
2185
+ # * An Add-On SKU (example, Vault or Drive) is missing the
2186
+ # pre-requisite SKU (example, G Suite Basic).
2187
+ # * (Developer accounts only) Reseller and resold domain must meet the
2188
+ # following naming requirements:
2204
2189
  # * Domain names must start with goog-test.
2205
- # * Resold domain names must include the reseller domain.
2206
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
2207
- # Please contact Cloud Channel Support in this case.
2190
+ # * Domain names must include the reseller domain.
2191
+ # * INTERNAL: Any non-user error related to a technical issue in the
2192
+ # backend. Contact Cloud Channel support.
2208
2193
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
2209
- # Please contact Cloud Channel Support in this case.
2194
+ # Contact Cloud Channel support.
2210
2195
  #
2211
- # Return Value:
2212
- # Long Running Operation ID.
2196
+ # Return value:
2197
+ # The ID of a long-running operation.
2213
2198
  #
2214
2199
  # To get the results of the operation, call the GetOperation method of
2215
2200
  # CloudChannelOperationsService. The response will contain
@@ -2232,20 +2217,19 @@ module Google
2232
2217
  # the default parameter values, pass an empty Hash as a request object (see above).
2233
2218
  #
2234
2219
  # @param parent [::String]
2235
- # Required. The resource name of reseller's customer account where the entitlements
2220
+ # Required. The resource name of the reseller's customer account where the entitlements
2236
2221
  # transfer from.
2237
- # The parent takes the format: accounts/\\{account_id}/customers/\\{customer_id}
2222
+ # Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
2238
2223
  # @param entitlements [::Array<::Google::Cloud::Channel::V1::Entitlement, ::Hash>]
2239
- # Required. The entitlements to be transferred to Google.
2224
+ # Required. The entitlements to transfer to Google.
2240
2225
  # @param request_id [::String]
2241
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
2242
- # that if you must retry your request, the server will know to ignore the
2243
- # request if it has already been completed.
2226
+ # Optional. You can specify an optional unique request ID, and if you need to retry
2227
+ # your request, the server will know to ignore the request if it's complete.
2244
2228
  #
2245
- # For example, consider a situation where you make an initial request and
2246
- # the request times out. If you make the request again with the same
2247
- # request ID, the server can check if the original operation with the same
2248
- # request ID was received, and if so, will ignore the second request.
2229
+ # For example, you make an initial request and the request times out. If you
2230
+ # make the request again with the same request ID, the server can check if
2231
+ # it received the original operation with the same request ID. If it did, it
2232
+ # will ignore the second request.
2249
2233
  #
2250
2234
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
2251
2235
  # with the exception that zero UUID is not supported
@@ -2285,7 +2269,9 @@ module Google
2285
2269
  options.apply_defaults timeout: @config.rpcs.transfer_entitlements_to_google.timeout,
2286
2270
  metadata: metadata,
2287
2271
  retry_policy: @config.rpcs.transfer_entitlements_to_google.retry_policy
2288
- options.apply_defaults metadata: @config.metadata,
2272
+
2273
+ options.apply_defaults timeout: @config.timeout,
2274
+ metadata: @config.metadata,
2289
2275
  retry_policy: @config.retry_policy
2290
2276
 
2291
2277
  @cloud_channel_service_stub.call_rpc :transfer_entitlements_to_google, request, options: options do |response, operation|
@@ -2299,18 +2285,16 @@ module Google
2299
2285
 
2300
2286
  ##
2301
2287
  # List {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s belonging to a distributor.
2302
- # To call this method, you must be a distributor.
2288
+ # You must be a distributor to call this method.
2303
2289
  #
2304
- # Possible Error Codes:
2290
+ # Possible error codes:
2305
2291
  #
2306
- # * PERMISSION_DENIED: If the reseller account making the request and the
2307
- # reseller account being queried for are different.
2308
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
2309
- # request.
2292
+ # * PERMISSION_DENIED: The reseller account making the request is different
2293
+ # from the reseller account in the API request.
2294
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
2310
2295
  #
2311
- # Return Value:
2312
- # If successful, returns the list of {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resources
2313
- # for the distributor account, otherwise returns an error.
2296
+ # Return value:
2297
+ # The list of the distributor account's {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resources.
2314
2298
  #
2315
2299
  # @overload list_channel_partner_links(request, options = nil)
2316
2300
  # Pass arguments to `list_channel_partner_links` via a request object, either of type
@@ -2330,14 +2314,14 @@ module Google
2330
2314
  # @param parent [::String]
2331
2315
  # Required. The resource name of the reseller account for listing channel partner
2332
2316
  # links.
2333
- # The parent takes the format: accounts/\\{account_id}
2317
+ # Parent uses the format: accounts/\\{account_id}
2334
2318
  # @param page_size [::Integer]
2335
2319
  # Optional. Requested page size. Server might return fewer results than requested.
2336
2320
  # If unspecified, server will pick a default size (25).
2337
- # The maximum value is 200, values above 200 will be coerced to 200.
2321
+ # The maximum value is 200; the server will coerce values above 200.
2338
2322
  # @param page_token [::String]
2339
- # Optional. A token identifying a page of results, if other than the first one.
2340
- # Typically obtained via
2323
+ # Optional. A token for a page of results other than the first page.
2324
+ # Obtained using
2341
2325
  # {::Google::Cloud::Channel::V1::ListChannelPartnerLinksResponse#next_page_token ListChannelPartnerLinksResponse.next_page_token} of the previous
2342
2326
  # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_channel_partner_links CloudChannelService.ListChannelPartnerLinks} call.
2343
2327
  # @param view [::Google::Cloud::Channel::V1::ChannelPartnerLinkView]
@@ -2377,7 +2361,9 @@ module Google
2377
2361
  options.apply_defaults timeout: @config.rpcs.list_channel_partner_links.timeout,
2378
2362
  metadata: metadata,
2379
2363
  retry_policy: @config.rpcs.list_channel_partner_links.retry_policy
2380
- options.apply_defaults metadata: @config.metadata,
2364
+
2365
+ options.apply_defaults timeout: @config.timeout,
2366
+ metadata: @config.metadata,
2381
2367
  retry_policy: @config.retry_policy
2382
2368
 
2383
2369
  @cloud_channel_service_stub.call_rpc :list_channel_partner_links, request, options: options do |response, operation|
@@ -2390,20 +2376,19 @@ module Google
2390
2376
  end
2391
2377
 
2392
2378
  ##
2393
- # Returns a requested {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
2394
- # To call this method, you must be a distributor.
2379
+ # Returns the requested {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
2380
+ # You must be a distributor to call this method.
2395
2381
  #
2396
- # Possible Error Codes:
2382
+ # Possible error codes:
2397
2383
  #
2398
- # * PERMISSION_DENIED: If the reseller account making the request and the
2399
- # reseller account being queried for are different.
2400
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
2401
- # request.
2402
- # * NOT_FOUND: ChannelPartnerLink resource not found. Results
2403
- # due invalid channel partner link name.
2384
+ # * PERMISSION_DENIED: The reseller account making the request is different
2385
+ # from the reseller account in the API request.
2386
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
2387
+ # * NOT_FOUND: ChannelPartnerLink resource not found because of an
2388
+ # invalid channel partner link name.
2404
2389
  #
2405
- # Return Value:
2406
- # {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource if found, otherwise returns an error.
2390
+ # Return value:
2391
+ # The {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
2407
2392
  #
2408
2393
  # @overload get_channel_partner_link(request, options = nil)
2409
2394
  # Pass arguments to `get_channel_partner_link` via a request object, either of type
@@ -2422,7 +2407,7 @@ module Google
2422
2407
  #
2423
2408
  # @param name [::String]
2424
2409
  # Required. The resource name of the channel partner link to retrieve.
2425
- # The name takes the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
2410
+ # Name uses the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
2426
2411
  # where \\{id} is the Cloud Identity ID of the partner.
2427
2412
  # @param view [::Google::Cloud::Channel::V1::ChannelPartnerLinkView]
2428
2413
  # Optional. The level of granularity the ChannelPartnerLink will display.
@@ -2461,7 +2446,9 @@ module Google
2461
2446
  options.apply_defaults timeout: @config.rpcs.get_channel_partner_link.timeout,
2462
2447
  metadata: metadata,
2463
2448
  retry_policy: @config.rpcs.get_channel_partner_link.retry_policy
2464
- options.apply_defaults metadata: @config.metadata,
2449
+
2450
+ options.apply_defaults timeout: @config.timeout,
2451
+ metadata: @config.metadata,
2465
2452
  retry_policy: @config.retry_policy
2466
2453
 
2467
2454
  @cloud_channel_service_stub.call_rpc :get_channel_partner_link, request, options: options do |response, operation|
@@ -2473,30 +2460,28 @@ module Google
2473
2460
  end
2474
2461
 
2475
2462
  ##
2476
- # Initiates a channel partner link between a distributor and a reseller or
2463
+ # Initiates a channel partner link between a distributor and a reseller, or
2477
2464
  # between resellers in an n-tier reseller channel.
2478
- # To accept the invite, the invited partner should follow the invite_link_uri
2479
- # provided in the response. If the link creation is accepted, a valid link is
2480
- # set up between the two involved parties.
2481
- # To call this method, you must be a distributor.
2482
- #
2483
- # Possible Error Codes:
2484
- #
2485
- # * PERMISSION_DENIED: If the reseller account making the request and the
2486
- # reseller account being queried for are different.
2487
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
2488
- # request.
2489
- # * ALREADY_EXISTS: If the ChannelPartnerLink sent in the request already
2465
+ # Invited partners need to follow the invite_link_uri provided in the
2466
+ # response to accept. After accepting the invitation, a link is set up
2467
+ # between the two parties.
2468
+ # You must be a distributor to call this method.
2469
+ #
2470
+ # Possible error codes:
2471
+ #
2472
+ # * PERMISSION_DENIED: The reseller account making the request is different
2473
+ # from the reseller account in the API request.
2474
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
2475
+ # * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already
2490
2476
  # exists.
2491
- # * NOT_FOUND: If no Cloud Identity customer exists for domain provided.
2477
+ # * NOT_FOUND: No Cloud Identity customer exists for provided domain.
2492
2478
  # * INTERNAL: Any non-user error related to a technical issue in the
2493
- # backend. In this case, contact Cloud Channel support.
2494
- # * UNKNOWN: Any non-user error related to a technical issue in
2495
- # the backend. In this case, contact Cloud Channel support.
2479
+ # backend. Contact Cloud Channel support.
2480
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
2481
+ # Contact Cloud Channel support.
2496
2482
  #
2497
- # Return Value:
2498
- # Newly created {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource if successful,
2499
- # otherwise error is returned.
2483
+ # Return value:
2484
+ # The new {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
2500
2485
  #
2501
2486
  # @overload create_channel_partner_link(request, options = nil)
2502
2487
  # Pass arguments to `create_channel_partner_link` via a request object, either of type
@@ -2514,9 +2499,9 @@ module Google
2514
2499
  # the default parameter values, pass an empty Hash as a request object (see above).
2515
2500
  #
2516
2501
  # @param parent [::String]
2517
- # Required. The resource name of reseller's account for which to create a channel
2518
- # partner link.
2519
- # The parent takes the format: accounts/\\{account_id}
2502
+ # Required. Create a channel partner link for the provided reseller account's
2503
+ # resource name.
2504
+ # Parent uses the format: accounts/\\{account_id}
2520
2505
  # @param channel_partner_link [::Google::Cloud::Channel::V1::ChannelPartnerLink, ::Hash]
2521
2506
  # Required. The channel partner link to create.
2522
2507
  # Either channel_partner_link.reseller_cloud_identity_id or domain can be
@@ -2556,7 +2541,9 @@ module Google
2556
2541
  options.apply_defaults timeout: @config.rpcs.create_channel_partner_link.timeout,
2557
2542
  metadata: metadata,
2558
2543
  retry_policy: @config.rpcs.create_channel_partner_link.retry_policy
2559
- options.apply_defaults metadata: @config.metadata,
2544
+
2545
+ options.apply_defaults timeout: @config.timeout,
2546
+ metadata: @config.metadata,
2560
2547
  retry_policy: @config.retry_policy
2561
2548
 
2562
2549
  @cloud_channel_service_stub.call_rpc :create_channel_partner_link, request, options: options do |response, operation|
@@ -2568,28 +2555,27 @@ module Google
2568
2555
  end
2569
2556
 
2570
2557
  ##
2571
- # Updates a channel partner link. A distributor calls this method to change a
2572
- # link's status. For example, suspend a partner link.
2573
- # To call this method, you must be a distributor.
2574
- #
2575
- # Possible Error Codes:
2576
- #
2577
- # * PERMISSION_DENIED: If the reseller account making the request and the
2578
- # reseller account being queried for are different.
2579
- # * INVALID_ARGUMENT: It can happen in following scenarios -
2580
- # * Missing or invalid required parameters in the request.
2581
- # * Updating link state from invited to active or suspended.
2582
- # * Sending reseller_cloud_identity_id, invite_url or name in update
2558
+ # Updates a channel partner link. Distributors call this method to change a
2559
+ # link's status. For example, to suspend a partner link.
2560
+ # You must be a distributor to call this method.
2561
+ #
2562
+ # Possible error codes:
2563
+ #
2564
+ # * PERMISSION_DENIED: The reseller account making the request is different
2565
+ # from the reseller account in the API request.
2566
+ # * INVALID_ARGUMENT:
2567
+ # * Required request parameters are missing or invalid.
2568
+ # * Link state cannot change from invited to active or suspended.
2569
+ # * Cannot send reseller_cloud_identity_id, invite_url, or name in update
2583
2570
  # mask.
2584
2571
  # * NOT_FOUND: ChannelPartnerLink resource not found.
2585
- # * INTERNAL: Any non-user error related to a technical issue in the backend.
2586
- # In this case, contact Cloud Channel support.
2572
+ # * INTERNAL: Any non-user error related to a technical issue in the
2573
+ # backend. Contact Cloud Channel support.
2587
2574
  # * UNKNOWN: Any non-user error related to a technical issue in the backend.
2588
- # In this case, contact Cloud Channel support.
2575
+ # Contact Cloud Channel support.
2589
2576
  #
2590
- # Return Value:
2591
- # If successful, the updated {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource, otherwise
2592
- # returns an error.
2577
+ # Return value:
2578
+ # The updated {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
2593
2579
  #
2594
2580
  # @overload update_channel_partner_link(request, options = nil)
2595
2581
  # Pass arguments to `update_channel_partner_link` via a request object, either of type
@@ -2608,14 +2594,14 @@ module Google
2608
2594
  #
2609
2595
  # @param name [::String]
2610
2596
  # Required. The resource name of the channel partner link to cancel.
2611
- # The name takes the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
2597
+ # Name uses the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
2612
2598
  # where \\{id} is the Cloud Identity ID of the partner.
2613
2599
  # @param channel_partner_link [::Google::Cloud::Channel::V1::ChannelPartnerLink, ::Hash]
2614
- # Required. The channel partner link to update. Only field
2615
- # channel_partner_link.link_state is allowed to be updated.
2600
+ # Required. The channel partner link to update. Only channel_partner_link.link_state
2601
+ # is allowed for updates.
2616
2602
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2617
2603
  # Required. The update mask that applies to the resource.
2618
- # The only allowable value for update mask is
2604
+ # The only allowable value for an update mask is
2619
2605
  # channel_partner_link.link_state.
2620
2606
  #
2621
2607
  # @yield [response, operation] Access the result along with the RPC operation
@@ -2652,7 +2638,9 @@ module Google
2652
2638
  options.apply_defaults timeout: @config.rpcs.update_channel_partner_link.timeout,
2653
2639
  metadata: metadata,
2654
2640
  retry_policy: @config.rpcs.update_channel_partner_link.retry_policy
2655
- options.apply_defaults metadata: @config.metadata,
2641
+
2642
+ options.apply_defaults timeout: @config.timeout,
2643
+ metadata: @config.metadata,
2656
2644
  retry_policy: @config.retry_policy
2657
2645
 
2658
2646
  @cloud_channel_service_stub.call_rpc :update_channel_partner_link, request, options: options do |response, operation|
@@ -2663,13 +2651,91 @@ module Google
2663
2651
  raise ::Google::Cloud::Error.from_error(e)
2664
2652
  end
2665
2653
 
2654
+ ##
2655
+ # Returns the requested {::Google::Cloud::Channel::V1::Offer Offer} resource.
2656
+ #
2657
+ # Possible error codes:
2658
+ #
2659
+ # * PERMISSION_DENIED: The entitlement doesn't belong to the reseller.
2660
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
2661
+ # * NOT_FOUND: Entitlement or offer was not found.
2662
+ #
2663
+ # Return value:
2664
+ # The {::Google::Cloud::Channel::V1::Offer Offer} resource.
2665
+ #
2666
+ # @overload lookup_offer(request, options = nil)
2667
+ # Pass arguments to `lookup_offer` via a request object, either of type
2668
+ # {::Google::Cloud::Channel::V1::LookupOfferRequest} or an equivalent Hash.
2669
+ #
2670
+ # @param request [::Google::Cloud::Channel::V1::LookupOfferRequest, ::Hash]
2671
+ # A request object representing the call parameters. Required. To specify no
2672
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2673
+ # @param options [::Gapic::CallOptions, ::Hash]
2674
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2675
+ #
2676
+ # @overload lookup_offer(entitlement: nil)
2677
+ # Pass arguments to `lookup_offer` via keyword arguments. Note that at
2678
+ # least one keyword argument is required. To specify no parameters, or to keep all
2679
+ # the default parameter values, pass an empty Hash as a request object (see above).
2680
+ #
2681
+ # @param entitlement [::String]
2682
+ # Required. The resource name of the entitlement to retrieve the Offer.
2683
+ # Entitlement uses the format:
2684
+ # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
2685
+ #
2686
+ # @yield [response, operation] Access the result along with the RPC operation
2687
+ # @yieldparam response [::Google::Cloud::Channel::V1::Offer]
2688
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2689
+ #
2690
+ # @return [::Google::Cloud::Channel::V1::Offer]
2691
+ #
2692
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2693
+ #
2694
+ def lookup_offer request, options = nil
2695
+ raise ::ArgumentError, "request must be provided" if request.nil?
2696
+
2697
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Channel::V1::LookupOfferRequest
2698
+
2699
+ # Converts hash and nil to an options object
2700
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2701
+
2702
+ # Customize the options with defaults
2703
+ metadata = @config.rpcs.lookup_offer.metadata.to_h
2704
+
2705
+ # Set x-goog-api-client and x-goog-user-project headers
2706
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2707
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2708
+ gapic_version: ::Google::Cloud::Channel::V1::VERSION
2709
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2710
+
2711
+ header_params = {
2712
+ "entitlement" => request.entitlement
2713
+ }
2714
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2715
+ metadata[:"x-goog-request-params"] ||= request_params_header
2716
+
2717
+ options.apply_defaults timeout: @config.rpcs.lookup_offer.timeout,
2718
+ metadata: metadata,
2719
+ retry_policy: @config.rpcs.lookup_offer.retry_policy
2720
+
2721
+ options.apply_defaults timeout: @config.timeout,
2722
+ metadata: @config.metadata,
2723
+ retry_policy: @config.retry_policy
2724
+
2725
+ @cloud_channel_service_stub.call_rpc :lookup_offer, request, options: options do |response, operation|
2726
+ yield response, operation if block_given?
2727
+ return response
2728
+ end
2729
+ rescue ::GRPC::BadStatus => e
2730
+ raise ::Google::Cloud::Error.from_error(e)
2731
+ end
2732
+
2666
2733
  ##
2667
2734
  # Lists the Products the reseller is authorized to sell.
2668
2735
  #
2669
- # Possible Error Codes:
2736
+ # Possible error codes:
2670
2737
  #
2671
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
2672
- # request.
2738
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
2673
2739
  #
2674
2740
  # @overload list_products(request, options = nil)
2675
2741
  # Pass arguments to `list_products` via a request object, either of type
@@ -2691,14 +2757,14 @@ module Google
2691
2757
  # Format: accounts/\\{account_id}.
2692
2758
  # @param page_size [::Integer]
2693
2759
  # Optional. Requested page size. Server might return fewer results than requested.
2694
- # If unspecified, at most 100 Products will be returned.
2695
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
2760
+ # If unspecified, returns at most 100 Products.
2761
+ # The maximum value is 1000; the server will coerce values above 1000.
2696
2762
  # @param page_token [::String]
2697
- # Optional. A token identifying a page of results, if other than the first one.
2763
+ # Optional. A token for a page of results other than the first page.
2698
2764
  # @param language_code [::String]
2699
- # Optional. The BCP-47 language code, such as "en-US". If specified, the
2700
- # response will be localized to the corresponding language code. Default is
2701
- # "en-US".
2765
+ # Optional. The BCP-47 language code. For example, "en-US". The
2766
+ # response will localize in the corresponding language code, if specified.
2767
+ # The default value is "en-US".
2702
2768
  #
2703
2769
  # @yield [response, operation] Access the result along with the RPC operation
2704
2770
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Product>]
@@ -2728,7 +2794,9 @@ module Google
2728
2794
  options.apply_defaults timeout: @config.rpcs.list_products.timeout,
2729
2795
  metadata: metadata,
2730
2796
  retry_policy: @config.rpcs.list_products.retry_policy
2731
- options.apply_defaults metadata: @config.metadata,
2797
+
2798
+ options.apply_defaults timeout: @config.timeout,
2799
+ metadata: @config.metadata,
2732
2800
  retry_policy: @config.retry_policy
2733
2801
 
2734
2802
  @cloud_channel_service_stub.call_rpc :list_products, request, options: options do |response, operation|
@@ -2743,10 +2811,9 @@ module Google
2743
2811
  ##
2744
2812
  # Lists the SKUs for a product the reseller is authorized to sell.
2745
2813
  #
2746
- # Possible Error Codes:
2814
+ # Possible error codes:
2747
2815
  #
2748
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
2749
- # request.
2816
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
2750
2817
  #
2751
2818
  # @overload list_skus(request, options = nil)
2752
2819
  # Pass arguments to `list_skus` via a request object, either of type
@@ -2764,23 +2831,23 @@ module Google
2764
2831
  # the default parameter values, pass an empty Hash as a request object (see above).
2765
2832
  #
2766
2833
  # @param parent [::String]
2767
- # Required. The resource name of the Product for which to list SKUs.
2768
- # The parent takes the format: products/\\{product_id}.
2834
+ # Required. The resource name of the Product to list SKUs for.
2835
+ # Parent uses the format: products/\\{product_id}.
2769
2836
  # Supports products/- to retrieve SKUs for all products.
2770
2837
  # @param account [::String]
2771
2838
  # Required. Resource name of the reseller.
2772
2839
  # Format: accounts/\\{account_id}.
2773
2840
  # @param page_size [::Integer]
2774
2841
  # Optional. Requested page size. Server might return fewer results than requested.
2775
- # If unspecified, at most 100 SKUs will be returned.
2776
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
2842
+ # If unspecified, returns at most 100 SKUs.
2843
+ # The maximum value is 1000; the server will coerce values above 1000.
2777
2844
  # @param page_token [::String]
2778
- # Optional. A token identifying a page of results, if other than the first one.
2845
+ # Optional. A token for a page of results other than the first page.
2779
2846
  # Optional.
2780
2847
  # @param language_code [::String]
2781
- # Optional. The BCP-47 language code, such as "en-US". If specified, the
2782
- # response will be localized to the corresponding language code. Default is
2783
- # "en-US".
2848
+ # Optional. The BCP-47 language code. For example, "en-US". The
2849
+ # response will localize in the corresponding language code, if specified.
2850
+ # The default value is "en-US".
2784
2851
  #
2785
2852
  # @yield [response, operation] Access the result along with the RPC operation
2786
2853
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Sku>]
@@ -2816,7 +2883,9 @@ module Google
2816
2883
  options.apply_defaults timeout: @config.rpcs.list_skus.timeout,
2817
2884
  metadata: metadata,
2818
2885
  retry_policy: @config.rpcs.list_skus.retry_policy
2819
- options.apply_defaults metadata: @config.metadata,
2886
+
2887
+ options.apply_defaults timeout: @config.timeout,
2888
+ metadata: @config.metadata,
2820
2889
  retry_policy: @config.retry_policy
2821
2890
 
2822
2891
  @cloud_channel_service_stub.call_rpc :list_skus, request, options: options do |response, operation|
@@ -2831,10 +2900,9 @@ module Google
2831
2900
  ##
2832
2901
  # Lists the Offers the reseller can sell.
2833
2902
  #
2834
- # Possible Error Codes:
2903
+ # Possible error codes:
2835
2904
  #
2836
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
2837
- # request.
2905
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
2838
2906
  #
2839
2907
  # @overload list_offers(request, options = nil)
2840
2908
  # Pass arguments to `list_offers` via a request object, either of type
@@ -2853,23 +2921,23 @@ module Google
2853
2921
  #
2854
2922
  # @param parent [::String]
2855
2923
  # Required. The resource name of the reseller account from which to list Offers.
2856
- # The parent takes the format: accounts/\\{account_id}.
2924
+ # Parent uses the format: accounts/\\{account_id}.
2857
2925
  # @param page_size [::Integer]
2858
2926
  # Optional. Requested page size. Server might return fewer results than requested.
2859
- # If unspecified, at most 500 Offers will be returned.
2860
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
2927
+ # If unspecified, returns at most 500 Offers.
2928
+ # The maximum value is 1000; the server will coerce values above 1000.
2861
2929
  # @param page_token [::String]
2862
- # Optional. A token identifying a page of results, if other than the first one.
2930
+ # Optional. A token for a page of results other than the first page.
2863
2931
  # @param filter [::String]
2864
2932
  # Optional. The expression to filter results by name (name of
2865
- # the Offer), sku.name (name of the SKU) or sku.product.name (name of the
2933
+ # the Offer), sku.name (name of the SKU), or sku.product.name (name of the
2866
2934
  # Product).
2867
2935
  # Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1
2868
2936
  # Example 2: name=accounts/a1/offers/o1
2869
2937
  # @param language_code [::String]
2870
- # Optional. The BCP-47 language code, such as "en-US". If specified, the
2871
- # response will be localized to the corresponding language code. Default is
2872
- # "en-US".
2938
+ # Optional. The BCP-47 language code. For example, "en-US". The
2939
+ # response will localize in the corresponding language code, if specified.
2940
+ # The default value is "en-US".
2873
2941
  #
2874
2942
  # @yield [response, operation] Access the result along with the RPC operation
2875
2943
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Offer>]
@@ -2905,7 +2973,9 @@ module Google
2905
2973
  options.apply_defaults timeout: @config.rpcs.list_offers.timeout,
2906
2974
  metadata: metadata,
2907
2975
  retry_policy: @config.rpcs.list_offers.retry_policy
2908
- options.apply_defaults metadata: @config.metadata,
2976
+
2977
+ options.apply_defaults timeout: @config.timeout,
2978
+ metadata: @config.metadata,
2909
2979
  retry_policy: @config.retry_policy
2910
2980
 
2911
2981
  @cloud_channel_service_stub.call_rpc :list_offers, request, options: options do |response, operation|
@@ -2918,16 +2988,15 @@ module Google
2918
2988
  end
2919
2989
 
2920
2990
  ##
2921
- # Lists the Purchasable SKUs for following cases:
2991
+ # Lists the following:
2922
2992
  #
2923
- # * SKUs that can be newly purchased for a customer
2924
- # * SKUs that can be upgraded/downgraded to, for an entitlement.
2993
+ # * SKUs that you can purchase for a customer
2994
+ # * SKUs that you can upgrade or downgrade for an entitlement.
2925
2995
  #
2926
- # Possible Error Codes:
2996
+ # Possible error codes:
2927
2997
  #
2928
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller
2929
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
2930
- # request.
2998
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
2999
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
2931
3000
  #
2932
3001
  # @overload list_purchasable_skus(request, options = nil)
2933
3002
  # Pass arguments to `list_purchasable_skus` via a request object, either of type
@@ -2949,18 +3018,18 @@ module Google
2949
3018
  # @param change_offer_purchase [::Google::Cloud::Channel::V1::ListPurchasableSkusRequest::ChangeOfferPurchase, ::Hash]
2950
3019
  # List SKUs for ChangeOffer purchase with a new SKU.
2951
3020
  # @param customer [::String]
2952
- # Required. The resource name of the customer for which to list SKUs.
3021
+ # Required. The resource name of the customer to list SKUs for.
2953
3022
  # Format: accounts/\\{account_id}/customers/\\{customer_id}.
2954
3023
  # @param page_size [::Integer]
2955
3024
  # Optional. Requested page size. Server might return fewer results than requested.
2956
- # If unspecified, at most 100 SKUs will be returned.
2957
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
3025
+ # If unspecified, returns at most 100 SKUs.
3026
+ # The maximum value is 1000; the server will coerce values above 1000.
2958
3027
  # @param page_token [::String]
2959
- # Optional. A token identifying a page of results, if other than the first one.
3028
+ # Optional. A token for a page of results other than the first page.
2960
3029
  # @param language_code [::String]
2961
- # Optional. The BCP-47 language code, such as "en-US". If specified, the
2962
- # response will be localized to the corresponding language code. Default is
2963
- # "en-US".
3030
+ # Optional. The BCP-47 language code. For example, "en-US". The
3031
+ # response will localize in the corresponding language code, if specified.
3032
+ # The default value is "en-US".
2964
3033
  #
2965
3034
  # @yield [response, operation] Access the result along with the RPC operation
2966
3035
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::PurchasableSku>]
@@ -2996,7 +3065,9 @@ module Google
2996
3065
  options.apply_defaults timeout: @config.rpcs.list_purchasable_skus.timeout,
2997
3066
  metadata: metadata,
2998
3067
  retry_policy: @config.rpcs.list_purchasable_skus.retry_policy
2999
- options.apply_defaults metadata: @config.metadata,
3068
+
3069
+ options.apply_defaults timeout: @config.timeout,
3070
+ metadata: @config.metadata,
3000
3071
  retry_policy: @config.retry_policy
3001
3072
 
3002
3073
  @cloud_channel_service_stub.call_rpc :list_purchasable_skus, request, options: options do |response, operation|
@@ -3009,16 +3080,15 @@ module Google
3009
3080
  end
3010
3081
 
3011
3082
  ##
3012
- # Lists the Purchasable Offers for the following cases:
3083
+ # Lists the following:
3013
3084
  #
3014
- # * Offers that can be newly purchased for a customer
3015
- # * Offers that can be changed to, for an entitlement.
3085
+ # * Offers that you can purchase for a customer.
3086
+ # * Offers that you can change for an entitlement.
3016
3087
  #
3017
- # Possible Error Codes:
3088
+ # Possible error codes:
3018
3089
  #
3019
- # * PERMISSION_DENIED: If the customer doesn't belong to the reseller
3020
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
3021
- # request.
3090
+ # * PERMISSION_DENIED: The customer doesn't belong to the reseller
3091
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
3022
3092
  #
3023
3093
  # @overload list_purchasable_offers(request, options = nil)
3024
3094
  # Pass arguments to `list_purchasable_offers` via a request object, either of type
@@ -3040,18 +3110,18 @@ module Google
3040
3110
  # @param change_offer_purchase [::Google::Cloud::Channel::V1::ListPurchasableOffersRequest::ChangeOfferPurchase, ::Hash]
3041
3111
  # List Offers for ChangeOffer purchase.
3042
3112
  # @param customer [::String]
3043
- # Required. The resource name of the customer for which to list Offers.
3113
+ # Required. The resource name of the customer to list Offers for.
3044
3114
  # Format: accounts/\\{account_id}/customers/\\{customer_id}.
3045
3115
  # @param page_size [::Integer]
3046
3116
  # Optional. Requested page size. Server might return fewer results than requested.
3047
- # If unspecified, at most 100 Offers will be returned.
3048
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
3117
+ # If unspecified, returns at most 100 Offers.
3118
+ # The maximum value is 1000; the server will coerce values above 1000.
3049
3119
  # @param page_token [::String]
3050
- # Optional. A token identifying a page of results, if other than the first one.
3120
+ # Optional. A token for a page of results other than the first page.
3051
3121
  # @param language_code [::String]
3052
- # Optional. The BCP-47 language code, such as "en-US". If specified, the
3053
- # response will be localized to the corresponding language code. Default is
3054
- # "en-US".
3122
+ # Optional. The BCP-47 language code. For example, "en-US". The
3123
+ # response will localize in the corresponding language code, if specified.
3124
+ # The default value is "en-US".
3055
3125
  #
3056
3126
  # @yield [response, operation] Access the result along with the RPC operation
3057
3127
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::PurchasableOffer>]
@@ -3087,7 +3157,9 @@ module Google
3087
3157
  options.apply_defaults timeout: @config.rpcs.list_purchasable_offers.timeout,
3088
3158
  metadata: metadata,
3089
3159
  retry_policy: @config.rpcs.list_purchasable_offers.retry_policy
3090
- options.apply_defaults metadata: @config.metadata,
3160
+
3161
+ options.apply_defaults timeout: @config.timeout,
3162
+ metadata: @config.metadata,
3091
3163
  retry_policy: @config.retry_policy
3092
3164
 
3093
3165
  @cloud_channel_service_stub.call_rpc :list_purchasable_offers, request, options: options do |response, operation|
@@ -3101,24 +3173,22 @@ module Google
3101
3173
 
3102
3174
  ##
3103
3175
  # Registers a service account with subscriber privileges on the Cloud Pub/Sub
3104
- # topic created for this Channel Services account. Once you create a
3105
- # subscriber, you will get the events as per {::Google::Cloud::Channel::V1::SubscriberEvent SubscriberEvent}
3176
+ # topic for this Channel Services account. After you create a
3177
+ # subscriber, you get the events through {::Google::Cloud::Channel::V1::SubscriberEvent SubscriberEvent}
3106
3178
  #
3107
- # Possible Error Codes:
3179
+ # Possible error codes:
3108
3180
  #
3109
- # * PERMISSION_DENIED: If the reseller account making the request and the
3110
- # reseller account being provided are different, or if the impersonated user
3181
+ # * PERMISSION_DENIED: The reseller account making the request and the
3182
+ # provided reseller account are different, or the impersonated user
3111
3183
  # is not a super admin.
3112
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
3113
- # request.
3184
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
3114
3185
  # * INTERNAL: Any non-user error related to a technical issue in the
3115
- # backend. In this case, contact Cloud Channel support.
3116
- # * UNKNOWN: Any non-user error related to a technical issue in
3117
- # the backend. In this case, contact Cloud Channel support.
3186
+ # backend. Contact Cloud Channel support.
3187
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
3188
+ # Contact Cloud Channel support.
3118
3189
  #
3119
- # Return Value:
3120
- # Topic name with service email address registered if successful,
3121
- # otherwise error is returned.
3190
+ # Return value:
3191
+ # The topic name with the registered service email address.
3122
3192
  #
3123
3193
  # @overload register_subscriber(request, options = nil)
3124
3194
  # Pass arguments to `register_subscriber` via a request object, either of type
@@ -3138,8 +3208,7 @@ module Google
3138
3208
  # @param account [::String]
3139
3209
  # Required. Resource name of the account.
3140
3210
  # @param service_account [::String]
3141
- # Required. Service account which will provide subscriber access to the
3142
- # registered topic.
3211
+ # Required. Service account that provides subscriber access to the registered topic.
3143
3212
  #
3144
3213
  # @yield [response, operation] Access the result along with the RPC operation
3145
3214
  # @yieldparam response [::Google::Cloud::Channel::V1::RegisterSubscriberResponse]
@@ -3175,7 +3244,9 @@ module Google
3175
3244
  options.apply_defaults timeout: @config.rpcs.register_subscriber.timeout,
3176
3245
  metadata: metadata,
3177
3246
  retry_policy: @config.rpcs.register_subscriber.retry_policy
3178
- options.apply_defaults metadata: @config.metadata,
3247
+
3248
+ options.apply_defaults timeout: @config.timeout,
3249
+ metadata: @config.metadata,
3179
3250
  retry_policy: @config.retry_policy
3180
3251
 
3181
3252
  @cloud_channel_service_stub.call_rpc :register_subscriber, request, options: options do |response, operation|
@@ -3189,26 +3260,25 @@ module Google
3189
3260
  ##
3190
3261
  # Unregisters a service account with subscriber privileges on the Cloud
3191
3262
  # Pub/Sub topic created for this Channel Services account. If there are no
3192
- # more service account left with sunbscriber privileges, the topic will be
3193
- # deleted. You can check this by calling ListSubscribers api.
3263
+ # service accounts left with subscriber privileges, this deletes the topic.
3264
+ # You can call ListSubscribers to check for these accounts.
3194
3265
  #
3195
- # Possible Error Codes:
3266
+ # Possible error codes:
3196
3267
  #
3197
- # * PERMISSION_DENIED: If the reseller account making the request and the
3198
- # reseller account being provided are different, or if the impersonated user
3268
+ # * PERMISSION_DENIED: The reseller account making the request and the
3269
+ # provided reseller account are different, or the impersonated user
3199
3270
  # is not a super admin.
3200
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
3201
- # request.
3202
- # * NOT_FOUND: If the topic resource doesn't exist.
3271
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
3272
+ # * NOT_FOUND: The topic resource doesn't exist.
3203
3273
  # * INTERNAL: Any non-user error related to a technical issue in the
3204
- # backend. In this case, contact Cloud Channel support.
3205
- # * UNKNOWN: Any non-user error related to a technical issue in
3206
- # the backend. In this case, contact Cloud Channel support.
3274
+ # backend. Contact Cloud Channel support.
3275
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
3276
+ # Contact Cloud Channel support.
3207
3277
  #
3208
- # Return Value:
3209
- # Topic name from which service email address has been unregistered if
3210
- # successful, otherwise error is returned. If the service email was already
3211
- # not associated with the topic, the success response will be returned.
3278
+ # Return value:
3279
+ # The topic name that unregistered the service email address.
3280
+ # Returns a success response if the service email address wasn't registered
3281
+ # with the topic.
3212
3282
  #
3213
3283
  # @overload unregister_subscriber(request, options = nil)
3214
3284
  # Pass arguments to `unregister_subscriber` via a request object, either of type
@@ -3228,8 +3298,7 @@ module Google
3228
3298
  # @param account [::String]
3229
3299
  # Required. Resource name of the account.
3230
3300
  # @param service_account [::String]
3231
- # Required. Service account which will be unregistered from getting subscriber access
3232
- # to the topic.
3301
+ # Required. Service account to unregister from subscriber access to the topic.
3233
3302
  #
3234
3303
  # @yield [response, operation] Access the result along with the RPC operation
3235
3304
  # @yieldparam response [::Google::Cloud::Channel::V1::UnregisterSubscriberResponse]
@@ -3265,7 +3334,9 @@ module Google
3265
3334
  options.apply_defaults timeout: @config.rpcs.unregister_subscriber.timeout,
3266
3335
  metadata: metadata,
3267
3336
  retry_policy: @config.rpcs.unregister_subscriber.retry_policy
3268
- options.apply_defaults metadata: @config.metadata,
3337
+
3338
+ options.apply_defaults timeout: @config.timeout,
3339
+ metadata: @config.metadata,
3269
3340
  retry_policy: @config.retry_policy
3270
3341
 
3271
3342
  @cloud_channel_service_stub.call_rpc :unregister_subscriber, request, options: options do |response, operation|
@@ -3280,22 +3351,20 @@ module Google
3280
3351
  # Lists service accounts with subscriber privileges on the Cloud Pub/Sub
3281
3352
  # topic created for this Channel Services account.
3282
3353
  #
3283
- # Possible Error Codes:
3354
+ # Possible error codes:
3284
3355
  #
3285
- # * PERMISSION_DENIED: If the reseller account making the request and the
3286
- # reseller account being provided are different, or if the account is not
3287
- # a super admin.
3288
- # * INVALID_ARGUMENT: Missing or invalid required parameters in the
3289
- # request.
3290
- # * NOT_FOUND: If the topic resource doesn't exist.
3356
+ # * PERMISSION_DENIED: The reseller account making the request and the
3357
+ # provided reseller account are different, or the impersonated user
3358
+ # is not a super admin.
3359
+ # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
3360
+ # * NOT_FOUND: The topic resource doesn't exist.
3291
3361
  # * INTERNAL: Any non-user error related to a technical issue in the
3292
- # backend. In this case, contact Cloud Channel support.
3293
- # * UNKNOWN: Any non-user error related to a technical issue in
3294
- # the backend. In this case, contact Cloud Channel support.
3362
+ # backend. Contact Cloud Channel support.
3363
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
3364
+ # Contact Cloud Channel support.
3295
3365
  #
3296
- # Return Value:
3297
- # List of service email addresses if successful, otherwise error is
3298
- # returned.
3366
+ # Return value:
3367
+ # A list of service email addresses.
3299
3368
  #
3300
3369
  # @overload list_subscribers(request, options = nil)
3301
3370
  # Pass arguments to `list_subscribers` via a request object, either of type
@@ -3317,14 +3386,14 @@ module Google
3317
3386
  # @param page_size [::Integer]
3318
3387
  # Optional. The maximum number of service accounts to return. The service may return
3319
3388
  # fewer than this value.
3320
- # If unspecified, at most 100 service accounts will be returned.
3321
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
3389
+ # If unspecified, returns at most 100 service accounts.
3390
+ # The maximum value is 1000; the server will coerce values above 1000.
3322
3391
  # @param page_token [::String]
3323
3392
  # Optional. A page token, received from a previous `ListSubscribers` call.
3324
3393
  # Provide this to retrieve the subsequent page.
3325
3394
  #
3326
3395
  # When paginating, all other parameters provided to `ListSubscribers` must
3327
- # match the call that provided the page token.
3396
+ # match the call that provided the page token.
3328
3397
  #
3329
3398
  # @yield [response, operation] Access the result along with the RPC operation
3330
3399
  # @yieldparam response [::Google::Cloud::Channel::V1::ListSubscribersResponse]
@@ -3360,7 +3429,9 @@ module Google
3360
3429
  options.apply_defaults timeout: @config.rpcs.list_subscribers.timeout,
3361
3430
  metadata: metadata,
3362
3431
  retry_policy: @config.rpcs.list_subscribers.retry_policy
3363
- options.apply_defaults metadata: @config.metadata,
3432
+
3433
+ options.apply_defaults timeout: @config.timeout,
3434
+ metadata: @config.metadata,
3364
3435
  retry_policy: @config.retry_policy
3365
3436
 
3366
3437
  @cloud_channel_service_stub.call_rpc :list_subscribers, request, options: options do |response, operation|
@@ -3384,22 +3455,21 @@ module Google
3384
3455
  # Configuration can be applied globally to all clients, or to a single client
3385
3456
  # on construction.
3386
3457
  #
3387
- # # Examples
3388
- #
3389
- # To modify the global config, setting the timeout for list_customers
3390
- # to 20 seconds, and all remaining timeouts to 10 seconds:
3458
+ # @example
3391
3459
  #
3392
- # ::Google::Cloud::Channel::V1::CloudChannelService::Client.configure do |config|
3393
- # config.timeout = 10.0
3394
- # config.rpcs.list_customers.timeout = 20.0
3395
- # end
3460
+ # # Modify the global config, setting the timeout for
3461
+ # # list_customers to 20 seconds,
3462
+ # # and all remaining timeouts to 10 seconds.
3463
+ # ::Google::Cloud::Channel::V1::CloudChannelService::Client.configure do |config|
3464
+ # config.timeout = 10.0
3465
+ # config.rpcs.list_customers.timeout = 20.0
3466
+ # end
3396
3467
  #
3397
- # To apply the above configuration only to a new client:
3398
- #
3399
- # client = ::Google::Cloud::Channel::V1::CloudChannelService::Client.new do |config|
3400
- # config.timeout = 10.0
3401
- # config.rpcs.list_customers.timeout = 20.0
3402
- # end
3468
+ # # Apply the above configuration only to a new client.
3469
+ # client = ::Google::Cloud::Channel::V1::CloudChannelService::Client.new do |config|
3470
+ # config.timeout = 10.0
3471
+ # config.rpcs.list_customers.timeout = 20.0
3472
+ # end
3403
3473
  #
3404
3474
  # @!attribute [rw] endpoint
3405
3475
  # The hostname or hostname:port of the service endpoint.
@@ -3633,6 +3703,11 @@ module Google
3633
3703
  #
3634
3704
  attr_reader :update_channel_partner_link
3635
3705
  ##
3706
+ # RPC-specific configuration for `lookup_offer`
3707
+ # @return [::Gapic::Config::Method]
3708
+ #
3709
+ attr_reader :lookup_offer
3710
+ ##
3636
3711
  # RPC-specific configuration for `list_products`
3637
3712
  # @return [::Gapic::Config::Method]
3638
3713
  #
@@ -3725,6 +3800,8 @@ module Google
3725
3800
  @create_channel_partner_link = ::Gapic::Config::Method.new create_channel_partner_link_config
3726
3801
  update_channel_partner_link_config = parent_rpcs.update_channel_partner_link if parent_rpcs.respond_to? :update_channel_partner_link
3727
3802
  @update_channel_partner_link = ::Gapic::Config::Method.new update_channel_partner_link_config
3803
+ lookup_offer_config = parent_rpcs.lookup_offer if parent_rpcs.respond_to? :lookup_offer
3804
+ @lookup_offer = ::Gapic::Config::Method.new lookup_offer_config
3728
3805
  list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
3729
3806
  @list_products = ::Gapic::Config::Method.new list_products_config
3730
3807
  list_skus_config = parent_rpcs.list_skus if parent_rpcs.respond_to? :list_skus