google-apis-cloudchannel_v1 0.2.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module CloudchannelV1
|
18
18
|
# Version of the google-apis-cloudchannel_v1 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.7.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.2.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20210506"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -1214,6 +1214,8 @@ module Google
|
|
1214
1214
|
class GoogleCloudChannelV1TransferableSku
|
1215
1215
|
# @private
|
1216
1216
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1217
|
+
property :legacy_sku, as: 'legacySku', class: Google::Apis::CloudchannelV1::GoogleCloudChannelV1Sku, decorator: Google::Apis::CloudchannelV1::GoogleCloudChannelV1Sku::Representation
|
1218
|
+
|
1217
1219
|
property :sku, as: 'sku', class: Google::Apis::CloudchannelV1::GoogleCloudChannelV1Sku, decorator: Google::Apis::CloudchannelV1::GoogleCloudChannelV1Sku::Representation
|
1218
1220
|
|
1219
1221
|
property :transfer_eligibility, as: 'transferEligibility', class: Google::Apis::CloudchannelV1::GoogleCloudChannelV1TransferEligibility, decorator: Google::Apis::CloudchannelV1::GoogleCloudChannelV1TransferEligibility::Representation
|
@@ -1255,6 +1257,7 @@ module Google
|
|
1255
1257
|
class GoogleCloudChannelV1Value
|
1256
1258
|
# @private
|
1257
1259
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1260
|
+
property :bool_value, as: 'boolValue'
|
1258
1261
|
property :double_value, as: 'doubleValue'
|
1259
1262
|
property :int64_value, :numeric_string => true, as: 'int64Value'
|
1260
1263
|
hash :proto_value, as: 'protoValue'
|
@@ -1398,6 +1401,7 @@ module Google
|
|
1398
1401
|
class GoogleCloudChannelV1alpha1Value
|
1399
1402
|
# @private
|
1400
1403
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1404
|
+
property :bool_value, as: 'boolValue'
|
1401
1405
|
property :double_value, as: 'doubleValue'
|
1402
1406
|
property :int64_value, :numeric_string => true, as: 'int64Value'
|
1403
1407
|
hash :proto_value, as: 'protoValue'
|
@@ -49,18 +49,18 @@ module Google
|
|
49
49
|
@batch_path = 'batch'
|
50
50
|
end
|
51
51
|
|
52
|
-
# Confirms the existence of Cloud Identity accounts
|
53
|
-
#
|
54
|
-
#
|
55
|
-
# reseller account
|
56
|
-
#
|
57
|
-
#
|
58
|
-
#
|
59
|
-
#
|
60
|
-
#
|
52
|
+
# Confirms the existence of Cloud Identity accounts based on the domain and if
|
53
|
+
# the Cloud Identity accounts are owned by the reseller. Possible error codes: *
|
54
|
+
# PERMISSION_DENIED: The reseller account making the request is different from
|
55
|
+
# the reseller account in the API request. * INVALID_ARGUMENT: Required request
|
56
|
+
# parameters are missing or invalid. * INVALID_VALUE: Invalid domain value in
|
57
|
+
# the request. Return value: A list of CloudIdentityCustomerAccount resources
|
58
|
+
# for the domain (may be empty) Note: in the v1alpha1 version of the API, a
|
59
|
+
# NOT_FOUND error returns if no CloudIdentityCustomerAccount resources match the
|
60
|
+
# domain.
|
61
61
|
# @param [String] parent
|
62
|
-
# Required. The resource name
|
63
|
-
#
|
62
|
+
# Required. The reseller account's resource name. Parent uses the format:
|
63
|
+
# accounts/`account_id`
|
64
64
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest] google_cloud_channel_v1_check_cloud_identity_accounts_exist_request_object
|
65
65
|
# @param [String] fields
|
66
66
|
# Selector specifying which fields to include in a partial response.
|
@@ -92,22 +92,20 @@ module Google
|
|
92
92
|
end
|
93
93
|
|
94
94
|
# Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic
|
95
|
-
# created for this Channel Services account. Possible
|
96
|
-
# PERMISSION_DENIED:
|
97
|
-
# account
|
98
|
-
# INVALID_ARGUMENT:
|
99
|
-
# NOT_FOUND:
|
100
|
-
# related to a technical issue in the backend.
|
101
|
-
#
|
102
|
-
#
|
103
|
-
# of service email addresses if successful, otherwise error is returned.
|
95
|
+
# created for this Channel Services account. Possible error codes: *
|
96
|
+
# PERMISSION_DENIED: The reseller account making the request and the provided
|
97
|
+
# reseller account are different, or the impersonated user is not a super admin.
|
98
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid. *
|
99
|
+
# NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error
|
100
|
+
# related to a technical issue in the backend. Contact Cloud Channel support. *
|
101
|
+
# UNKNOWN: Any non-user error related to a technical issue in the backend.
|
102
|
+
# Contact Cloud Channel support. Return value: A list of service email addresses.
|
104
103
|
# @param [String] account
|
105
104
|
# Required. Resource name of the account.
|
106
105
|
# @param [Fixnum] page_size
|
107
106
|
# Optional. The maximum number of service accounts to return. The service may
|
108
|
-
# return fewer than this value. If unspecified, at most 100 service
|
109
|
-
#
|
110
|
-
# to 1000.
|
107
|
+
# return fewer than this value. If unspecified, returns at most 100 service
|
108
|
+
# accounts. The maximum value is 1000; the server will coerce values above 1000.
|
111
109
|
# @param [String] page_token
|
112
110
|
# Optional. A page token, received from a previous `ListSubscribers` call.
|
113
111
|
# Provide this to retrieve the subsequent page. When paginating, all other
|
@@ -143,14 +141,13 @@ module Google
|
|
143
141
|
end
|
144
142
|
|
145
143
|
# List TransferableOffers of a customer based on Cloud Identity ID or Customer
|
146
|
-
# Name in the request.
|
147
|
-
# information of
|
148
|
-
#
|
149
|
-
#
|
150
|
-
#
|
151
|
-
#
|
152
|
-
#
|
153
|
-
# invalid required parameters in the request. Return Value: List of
|
144
|
+
# Name in the request. Use this method when a reseller gets the entitlement
|
145
|
+
# information of an unowned customer. The reseller should provide the customer's
|
146
|
+
# Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED:
|
147
|
+
# * The customer doesn't belong to the reseller and has no auth token. * The
|
148
|
+
# supplied auth token is invalid. * The reseller account making the request is
|
149
|
+
# different from the reseller account in the query. * INVALID_ARGUMENT: Required
|
150
|
+
# request parameters are missing or invalid. Return value: List of
|
154
151
|
# TransferableOffer for the given customer and SKU.
|
155
152
|
# @param [String] parent
|
156
153
|
# Required. The resource name of the reseller's account.
|
@@ -184,19 +181,17 @@ module Google
|
|
184
181
|
execute_or_queue_command(command, &block)
|
185
182
|
end
|
186
183
|
|
187
|
-
# List TransferableSkus of a customer based on Cloud Identity ID or Customer
|
188
|
-
# Name in the request.
|
189
|
-
#
|
190
|
-
#
|
191
|
-
#
|
192
|
-
#
|
193
|
-
#
|
194
|
-
#
|
195
|
-
# required parameters in the request. Return Value: List of TransferableSku for
|
196
|
-
# the given customer.
|
184
|
+
# List TransferableSkus of a customer based on the Cloud Identity ID or Customer
|
185
|
+
# Name in the request. Use this method to list the entitlements information of
|
186
|
+
# an unowned customer. You should provide the customer's Cloud Identity ID or
|
187
|
+
# Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn'
|
188
|
+
# t belong to the reseller and has no auth token. * The supplied auth token is
|
189
|
+
# invalid. * The reseller account making the request is different from the
|
190
|
+
# reseller account in the query. * INVALID_ARGUMENT: Required request parameters
|
191
|
+
# are missing or invalid. Return value: A list of the customer's TransferableSku.
|
197
192
|
# @param [String] parent
|
198
|
-
# Required. The
|
199
|
-
#
|
193
|
+
# Required. The reseller account's resource name. Parent uses the format:
|
194
|
+
# accounts/`account_id`
|
200
195
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1ListTransferableSkusRequest] google_cloud_channel_v1_list_transferable_skus_request_object
|
201
196
|
# @param [String] fields
|
202
197
|
# Selector specifying which fields to include in a partial response.
|
@@ -228,16 +223,15 @@ module Google
|
|
228
223
|
end
|
229
224
|
|
230
225
|
# Registers a service account with subscriber privileges on the Cloud Pub/Sub
|
231
|
-
# topic
|
232
|
-
#
|
233
|
-
# PERMISSION_DENIED:
|
234
|
-
# account
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
# registered if successful, otherwise error is returned.
|
226
|
+
# topic for this Channel Services account. After you create a subscriber, you
|
227
|
+
# get the events through SubscriberEvent Possible error codes: *
|
228
|
+
# PERMISSION_DENIED: The reseller account making the request and the provided
|
229
|
+
# reseller account are different, or the impersonated user is not a super admin.
|
230
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid. *
|
231
|
+
# INTERNAL: Any non-user error related to a technical issue in the backend.
|
232
|
+
# Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a
|
233
|
+
# technical issue in the backend. Contact Cloud Channel support. Return value:
|
234
|
+
# The topic name with the registered service email address.
|
241
235
|
# @param [String] account
|
242
236
|
# Required. Resource name of the account.
|
243
237
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1RegisterSubscriberRequest] google_cloud_channel_v1_register_subscriber_request_object
|
@@ -271,19 +265,18 @@ module Google
|
|
271
265
|
end
|
272
266
|
|
273
267
|
# Unregisters a service account with subscriber privileges on the Cloud Pub/Sub
|
274
|
-
# topic created for this Channel Services account. If there are no
|
275
|
-
#
|
276
|
-
#
|
277
|
-
# PERMISSION_DENIED:
|
278
|
-
# account
|
279
|
-
#
|
280
|
-
#
|
281
|
-
#
|
282
|
-
#
|
283
|
-
#
|
284
|
-
#
|
285
|
-
#
|
286
|
-
# associated with the topic, the success response will be returned.
|
268
|
+
# topic created for this Channel Services account. If there are no service
|
269
|
+
# accounts left with subscriber privileges, this deletes the topic. You can call
|
270
|
+
# ListSubscribers to check for these accounts. Possible error codes: *
|
271
|
+
# PERMISSION_DENIED: The reseller account making the request and the provided
|
272
|
+
# reseller account are different, or the impersonated user is not a super admin.
|
273
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid. *
|
274
|
+
# NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error
|
275
|
+
# related to a technical issue in the backend. Contact Cloud Channel support. *
|
276
|
+
# UNKNOWN: Any non-user error related to a technical issue in the backend.
|
277
|
+
# Contact Cloud Channel support. Return value: The topic name that unregistered
|
278
|
+
# the service email address. Returns a success response if the service email
|
279
|
+
# address wasn't registered with the topic.
|
287
280
|
# @param [String] account
|
288
281
|
# Required. Resource name of the account.
|
289
282
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1UnregisterSubscriberRequest] google_cloud_channel_v1_unregister_subscriber_request_object
|
@@ -316,23 +309,22 @@ module Google
|
|
316
309
|
execute_or_queue_command(command, &block)
|
317
310
|
end
|
318
311
|
|
319
|
-
# Initiates a channel partner link between a distributor and a reseller or
|
320
|
-
# between resellers in an n-tier reseller channel.
|
321
|
-
#
|
322
|
-
# the
|
323
|
-
#
|
324
|
-
#
|
325
|
-
#
|
326
|
-
# or invalid
|
327
|
-
#
|
328
|
-
#
|
329
|
-
#
|
330
|
-
#
|
331
|
-
#
|
332
|
-
# created ChannelPartnerLink resource if successful, otherwise error is returned.
|
312
|
+
# Initiates a channel partner link between a distributor and a reseller, or
|
313
|
+
# between resellers in an n-tier reseller channel. Invited partners need to
|
314
|
+
# follow the invite_link_uri provided in the response to accept. After accepting
|
315
|
+
# the invitation, a link is set up between the two parties. You must be a
|
316
|
+
# distributor to call this method. Possible error codes: * PERMISSION_DENIED:
|
317
|
+
# The reseller account making the request is different from the reseller account
|
318
|
+
# in the API request. * INVALID_ARGUMENT: Required request parameters are
|
319
|
+
# missing or invalid. * ALREADY_EXISTS: The ChannelPartnerLink sent in the
|
320
|
+
# request already exists. * NOT_FOUND: No Cloud Identity customer exists for
|
321
|
+
# provided domain. * INTERNAL: Any non-user error related to a technical issue
|
322
|
+
# in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error
|
323
|
+
# related to a technical issue in the backend. Contact Cloud Channel support.
|
324
|
+
# Return value: The new ChannelPartnerLink resource.
|
333
325
|
# @param [String] parent
|
334
|
-
# Required.
|
335
|
-
#
|
326
|
+
# Required. Create a channel partner link for the provided reseller account's
|
327
|
+
# resource name. Parent uses the format: accounts/`account_id`
|
336
328
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1ChannelPartnerLink] google_cloud_channel_v1_channel_partner_link_object
|
337
329
|
# @param [String] fields
|
338
330
|
# Selector specifying which fields to include in a partial response.
|
@@ -363,17 +355,17 @@ module Google
|
|
363
355
|
execute_or_queue_command(command, &block)
|
364
356
|
end
|
365
357
|
|
366
|
-
# Returns
|
367
|
-
#
|
368
|
-
# account making the request
|
369
|
-
#
|
370
|
-
#
|
371
|
-
# invalid channel partner link name. Return
|
372
|
-
#
|
358
|
+
# Returns the requested ChannelPartnerLink resource. You must be a distributor
|
359
|
+
# to call this method. Possible error codes: * PERMISSION_DENIED: The reseller
|
360
|
+
# account making the request is different from the reseller account in the API
|
361
|
+
# request. * INVALID_ARGUMENT: Required request parameters are missing or
|
362
|
+
# invalid. * NOT_FOUND: ChannelPartnerLink resource not found because of an
|
363
|
+
# invalid channel partner link name. Return value: The ChannelPartnerLink
|
364
|
+
# resource.
|
373
365
|
# @param [String] name
|
374
|
-
# Required. The resource name of the channel partner link to retrieve.
|
375
|
-
#
|
376
|
-
#
|
366
|
+
# Required. The resource name of the channel partner link to retrieve. Name uses
|
367
|
+
# the format: accounts/`account_id`/channelPartnerLinks/`id` where `id` is the
|
368
|
+
# Cloud Identity ID of the partner.
|
377
369
|
# @param [String] view
|
378
370
|
# Optional. The level of granularity the ChannelPartnerLink will display.
|
379
371
|
# @param [String] fields
|
@@ -404,24 +396,23 @@ module Google
|
|
404
396
|
execute_or_queue_command(command, &block)
|
405
397
|
end
|
406
398
|
|
407
|
-
# List ChannelPartnerLinks belonging to a distributor.
|
408
|
-
#
|
409
|
-
#
|
410
|
-
#
|
411
|
-
#
|
412
|
-
# ChannelPartnerLink resources
|
413
|
-
# error.
|
399
|
+
# List ChannelPartnerLinks belonging to a distributor. You must be a distributor
|
400
|
+
# to call this method. Possible error codes: * PERMISSION_DENIED: The reseller
|
401
|
+
# account making the request is different from the reseller account in the API
|
402
|
+
# request. * INVALID_ARGUMENT: Required request parameters are missing or
|
403
|
+
# invalid. Return value: The list of the distributor account's
|
404
|
+
# ChannelPartnerLink resources.
|
414
405
|
# @param [String] parent
|
415
406
|
# Required. The resource name of the reseller account for listing channel
|
416
|
-
# partner links.
|
407
|
+
# partner links. Parent uses the format: accounts/`account_id`
|
417
408
|
# @param [Fixnum] page_size
|
418
409
|
# Optional. Requested page size. Server might return fewer results than
|
419
410
|
# requested. If unspecified, server will pick a default size (25). The maximum
|
420
|
-
# value is 200
|
411
|
+
# value is 200; the server will coerce values above 200.
|
421
412
|
# @param [String] page_token
|
422
|
-
# Optional. A token
|
423
|
-
#
|
424
|
-
#
|
413
|
+
# Optional. A token for a page of results other than the first page. Obtained
|
414
|
+
# using ListChannelPartnerLinksResponse.next_page_token of the previous
|
415
|
+
# CloudChannelService.ListChannelPartnerLinks call.
|
425
416
|
# @param [String] view
|
426
417
|
# Optional. The level of granularity the ChannelPartnerLink will display.
|
427
418
|
# @param [String] fields
|
@@ -454,23 +445,22 @@ module Google
|
|
454
445
|
execute_or_queue_command(command, &block)
|
455
446
|
end
|
456
447
|
|
457
|
-
# Updates a channel partner link.
|
458
|
-
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
466
|
-
#
|
467
|
-
#
|
468
|
-
#
|
469
|
-
# resource, otherwise returns an error.
|
448
|
+
# Updates a channel partner link. Distributors call this method to change a link'
|
449
|
+
# s status. For example, to suspend a partner link. You must be a distributor to
|
450
|
+
# call this method. Possible error codes: * PERMISSION_DENIED: The reseller
|
451
|
+
# account making the request is different from the reseller account in the API
|
452
|
+
# request. * INVALID_ARGUMENT: * Required request parameters are missing or
|
453
|
+
# invalid. * Link state cannot change from invited to active or suspended. *
|
454
|
+
# Cannot send reseller_cloud_identity_id, invite_url, or name in update mask. *
|
455
|
+
# NOT_FOUND: ChannelPartnerLink resource not found. * INTERNAL: Any non-user
|
456
|
+
# error related to a technical issue in the backend. Contact Cloud Channel
|
457
|
+
# support. * UNKNOWN: Any non-user error related to a technical issue in the
|
458
|
+
# backend. Contact Cloud Channel support. Return value: The updated
|
459
|
+
# ChannelPartnerLink resource.
|
470
460
|
# @param [String] name
|
471
|
-
# Required. The resource name of the channel partner link to cancel.
|
472
|
-
#
|
473
|
-
#
|
461
|
+
# Required. The resource name of the channel partner link to cancel. Name uses
|
462
|
+
# the format: accounts/`account_id`/channelPartnerLinks/`id` where `id` is the
|
463
|
+
# Cloud Identity ID of the partner.
|
474
464
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1UpdateChannelPartnerLinkRequest] google_cloud_channel_v1_update_channel_partner_link_request_object
|
475
465
|
# @param [String] fields
|
476
466
|
# Selector specifying which fields to include in a partial response.
|
@@ -502,15 +492,210 @@ module Google
|
|
502
492
|
end
|
503
493
|
|
504
494
|
# Creates a new Customer resource under the reseller or distributor account.
|
505
|
-
# Possible
|
506
|
-
# request
|
507
|
-
# INVALID_ARGUMENT:
|
508
|
-
#
|
509
|
-
#
|
510
|
-
#
|
495
|
+
# Possible error codes: * PERMISSION_DENIED: The reseller account making the
|
496
|
+
# request is different from the reseller account in the API request. *
|
497
|
+
# INVALID_ARGUMENT: * Required request parameters are missing or invalid. *
|
498
|
+
# Domain field value doesn't match the primary email domain. Return value: The
|
499
|
+
# newly created Customer resource.
|
500
|
+
# @param [String] parent
|
501
|
+
# Required. The resource name of reseller account in which to create the
|
502
|
+
# customer. Parent uses the format: accounts/`account_id`
|
503
|
+
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer] google_cloud_channel_v1_customer_object
|
504
|
+
# @param [String] fields
|
505
|
+
# Selector specifying which fields to include in a partial response.
|
506
|
+
# @param [String] quota_user
|
507
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
508
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
509
|
+
# @param [Google::Apis::RequestOptions] options
|
510
|
+
# Request-specific options
|
511
|
+
#
|
512
|
+
# @yield [result, err] Result & error if block supplied
|
513
|
+
# @yieldparam result [Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer] parsed result object
|
514
|
+
# @yieldparam err [StandardError] error object if request failed
|
515
|
+
#
|
516
|
+
# @return [Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer]
|
517
|
+
#
|
518
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
519
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
520
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
521
|
+
def create_account_channel_partner_link_customer(parent, google_cloud_channel_v1_customer_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
522
|
+
command = make_simple_command(:post, 'v1/{+parent}/customers', options)
|
523
|
+
command.request_representation = Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer::Representation
|
524
|
+
command.request_object = google_cloud_channel_v1_customer_object
|
525
|
+
command.response_representation = Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer::Representation
|
526
|
+
command.response_class = Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer
|
527
|
+
command.params['parent'] = parent unless parent.nil?
|
528
|
+
command.query['fields'] = fields unless fields.nil?
|
529
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
530
|
+
execute_or_queue_command(command, &block)
|
531
|
+
end
|
532
|
+
|
533
|
+
# Deletes the given Customer permanently. Possible error codes: *
|
534
|
+
# PERMISSION_DENIED: The account making the request does not own this customer. *
|
535
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid. *
|
536
|
+
# FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No
|
537
|
+
# Customer resource found for the name in the request.
|
538
|
+
# @param [String] name
|
539
|
+
# Required. The resource name of the customer to delete.
|
540
|
+
# @param [String] fields
|
541
|
+
# Selector specifying which fields to include in a partial response.
|
542
|
+
# @param [String] quota_user
|
543
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
544
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
545
|
+
# @param [Google::Apis::RequestOptions] options
|
546
|
+
# Request-specific options
|
547
|
+
#
|
548
|
+
# @yield [result, err] Result & error if block supplied
|
549
|
+
# @yieldparam result [Google::Apis::CloudchannelV1::GoogleProtobufEmpty] parsed result object
|
550
|
+
# @yieldparam err [StandardError] error object if request failed
|
551
|
+
#
|
552
|
+
# @return [Google::Apis::CloudchannelV1::GoogleProtobufEmpty]
|
553
|
+
#
|
554
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
555
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
556
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
557
|
+
def delete_account_channel_partner_link_customer(name, fields: nil, quota_user: nil, options: nil, &block)
|
558
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
559
|
+
command.response_representation = Google::Apis::CloudchannelV1::GoogleProtobufEmpty::Representation
|
560
|
+
command.response_class = Google::Apis::CloudchannelV1::GoogleProtobufEmpty
|
561
|
+
command.params['name'] = name unless name.nil?
|
562
|
+
command.query['fields'] = fields unless fields.nil?
|
563
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
564
|
+
execute_or_queue_command(command, &block)
|
565
|
+
end
|
566
|
+
|
567
|
+
# Returns the requested Customer resource. Possible error codes: *
|
568
|
+
# PERMISSION_DENIED: The reseller account making the request is different from
|
569
|
+
# the reseller account in the API request. * INVALID_ARGUMENT: Required request
|
570
|
+
# parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't
|
571
|
+
# exist. Usually the result of an invalid name parameter. Return value: The
|
572
|
+
# Customer resource.
|
573
|
+
# @param [String] name
|
574
|
+
# Required. The resource name of the customer to retrieve. Name uses the format:
|
575
|
+
# accounts/`account_id`/customers/`customer_id`
|
576
|
+
# @param [String] fields
|
577
|
+
# Selector specifying which fields to include in a partial response.
|
578
|
+
# @param [String] quota_user
|
579
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
580
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
581
|
+
# @param [Google::Apis::RequestOptions] options
|
582
|
+
# Request-specific options
|
583
|
+
#
|
584
|
+
# @yield [result, err] Result & error if block supplied
|
585
|
+
# @yieldparam result [Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer] parsed result object
|
586
|
+
# @yieldparam err [StandardError] error object if request failed
|
587
|
+
#
|
588
|
+
# @return [Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer]
|
589
|
+
#
|
590
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
591
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
592
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
593
|
+
def get_account_channel_partner_link_customer(name, fields: nil, quota_user: nil, options: nil, &block)
|
594
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
595
|
+
command.response_representation = Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer::Representation
|
596
|
+
command.response_class = Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer
|
597
|
+
command.params['name'] = name unless name.nil?
|
598
|
+
command.query['fields'] = fields unless fields.nil?
|
599
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
600
|
+
execute_or_queue_command(command, &block)
|
601
|
+
end
|
602
|
+
|
603
|
+
# List Customers. Possible error codes: * PERMISSION_DENIED: The reseller
|
604
|
+
# account making the request is different from the reseller account in the API
|
605
|
+
# request. * INVALID_ARGUMENT: Required request parameters are missing or
|
606
|
+
# invalid. Return value: List of Customers, or an empty list if there are no
|
607
|
+
# customers.
|
608
|
+
# @param [String] parent
|
609
|
+
# Required. The resource name of the reseller account to list customers from.
|
610
|
+
# Parent uses the format: accounts/`account_id`.
|
611
|
+
# @param [Fixnum] page_size
|
612
|
+
# Optional. The maximum number of customers to return. The service may return
|
613
|
+
# fewer than this value. If unspecified, returns at most 10 customers. The
|
614
|
+
# maximum value is 50.
|
615
|
+
# @param [String] page_token
|
616
|
+
# Optional. A token identifying a page of results other than the first page.
|
617
|
+
# Obtained through ListCustomersResponse.next_page_token of the previous
|
618
|
+
# CloudChannelService.ListCustomers call.
|
619
|
+
# @param [String] fields
|
620
|
+
# Selector specifying which fields to include in a partial response.
|
621
|
+
# @param [String] quota_user
|
622
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
623
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
624
|
+
# @param [Google::Apis::RequestOptions] options
|
625
|
+
# Request-specific options
|
626
|
+
#
|
627
|
+
# @yield [result, err] Result & error if block supplied
|
628
|
+
# @yieldparam result [Google::Apis::CloudchannelV1::GoogleCloudChannelV1ListCustomersResponse] parsed result object
|
629
|
+
# @yieldparam err [StandardError] error object if request failed
|
630
|
+
#
|
631
|
+
# @return [Google::Apis::CloudchannelV1::GoogleCloudChannelV1ListCustomersResponse]
|
632
|
+
#
|
633
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
634
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
635
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
636
|
+
def list_account_channel_partner_link_customers(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
637
|
+
command = make_simple_command(:get, 'v1/{+parent}/customers', options)
|
638
|
+
command.response_representation = Google::Apis::CloudchannelV1::GoogleCloudChannelV1ListCustomersResponse::Representation
|
639
|
+
command.response_class = Google::Apis::CloudchannelV1::GoogleCloudChannelV1ListCustomersResponse
|
640
|
+
command.params['parent'] = parent unless parent.nil?
|
641
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
642
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
643
|
+
command.query['fields'] = fields unless fields.nil?
|
644
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
645
|
+
execute_or_queue_command(command, &block)
|
646
|
+
end
|
647
|
+
|
648
|
+
# Updates an existing Customer resource for the reseller or distributor.
|
649
|
+
# Possible error codes: * PERMISSION_DENIED: The reseller account making the
|
650
|
+
# request is different from the reseller account in the API request. *
|
651
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid. *
|
652
|
+
# NOT_FOUND: No Customer resource found for the name in the request. Return
|
653
|
+
# value: The updated Customer resource.
|
654
|
+
# @param [String] name
|
655
|
+
# Output only. Resource name of the customer. Format: accounts/`account_id`/
|
656
|
+
# customers/`customer_id`
|
657
|
+
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer] google_cloud_channel_v1_customer_object
|
658
|
+
# @param [String] update_mask
|
659
|
+
# The update mask that applies to the resource. Optional.
|
660
|
+
# @param [String] fields
|
661
|
+
# Selector specifying which fields to include in a partial response.
|
662
|
+
# @param [String] quota_user
|
663
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
664
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
665
|
+
# @param [Google::Apis::RequestOptions] options
|
666
|
+
# Request-specific options
|
667
|
+
#
|
668
|
+
# @yield [result, err] Result & error if block supplied
|
669
|
+
# @yieldparam result [Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer] parsed result object
|
670
|
+
# @yieldparam err [StandardError] error object if request failed
|
671
|
+
#
|
672
|
+
# @return [Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer]
|
673
|
+
#
|
674
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
675
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
676
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
677
|
+
def patch_account_channel_partner_link_customer(name, google_cloud_channel_v1_customer_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
678
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
679
|
+
command.request_representation = Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer::Representation
|
680
|
+
command.request_object = google_cloud_channel_v1_customer_object
|
681
|
+
command.response_representation = Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer::Representation
|
682
|
+
command.response_class = Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer
|
683
|
+
command.params['name'] = name unless name.nil?
|
684
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
685
|
+
command.query['fields'] = fields unless fields.nil?
|
686
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
687
|
+
execute_or_queue_command(command, &block)
|
688
|
+
end
|
689
|
+
|
690
|
+
# Creates a new Customer resource under the reseller or distributor account.
|
691
|
+
# Possible error codes: * PERMISSION_DENIED: The reseller account making the
|
692
|
+
# request is different from the reseller account in the API request. *
|
693
|
+
# INVALID_ARGUMENT: * Required request parameters are missing or invalid. *
|
694
|
+
# Domain field value doesn't match the primary email domain. Return value: The
|
695
|
+
# newly created Customer resource.
|
511
696
|
# @param [String] parent
|
512
697
|
# Required. The resource name of reseller account in which to create the
|
513
|
-
# customer.
|
698
|
+
# customer. Parent uses the format: accounts/`account_id`
|
514
699
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1Customer] google_cloud_channel_v1_customer_object
|
515
700
|
# @param [String] fields
|
516
701
|
# Selector specifying which fields to include in a partial response.
|
@@ -541,11 +726,11 @@ module Google
|
|
541
726
|
execute_or_queue_command(command, &block)
|
542
727
|
end
|
543
728
|
|
544
|
-
# Deletes the given Customer permanently
|
545
|
-
#
|
546
|
-
#
|
547
|
-
#
|
548
|
-
#
|
729
|
+
# Deletes the given Customer permanently. Possible error codes: *
|
730
|
+
# PERMISSION_DENIED: The account making the request does not own this customer. *
|
731
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid. *
|
732
|
+
# FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No
|
733
|
+
# Customer resource found for the name in the request.
|
549
734
|
# @param [String] name
|
550
735
|
# Required. The resource name of the customer to delete.
|
551
736
|
# @param [String] fields
|
@@ -575,15 +760,15 @@ module Google
|
|
575
760
|
execute_or_queue_command(command, &block)
|
576
761
|
end
|
577
762
|
|
578
|
-
# Returns
|
579
|
-
# PERMISSION_DENIED:
|
580
|
-
# account
|
581
|
-
#
|
582
|
-
#
|
583
|
-
#
|
763
|
+
# Returns the requested Customer resource. Possible error codes: *
|
764
|
+
# PERMISSION_DENIED: The reseller account making the request is different from
|
765
|
+
# the reseller account in the API request. * INVALID_ARGUMENT: Required request
|
766
|
+
# parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't
|
767
|
+
# exist. Usually the result of an invalid name parameter. Return value: The
|
768
|
+
# Customer resource.
|
584
769
|
# @param [String] name
|
585
|
-
# Required. The resource name of the customer to retrieve.
|
586
|
-
#
|
770
|
+
# Required. The resource name of the customer to retrieve. Name uses the format:
|
771
|
+
# accounts/`account_id`/customers/`customer_id`
|
587
772
|
# @param [String] fields
|
588
773
|
# Selector specifying which fields to include in a partial response.
|
589
774
|
# @param [String] quota_user
|
@@ -611,21 +796,21 @@ module Google
|
|
611
796
|
execute_or_queue_command(command, &block)
|
612
797
|
end
|
613
798
|
|
614
|
-
# List
|
615
|
-
#
|
616
|
-
#
|
617
|
-
#
|
618
|
-
#
|
799
|
+
# List Customers. Possible error codes: * PERMISSION_DENIED: The reseller
|
800
|
+
# account making the request is different from the reseller account in the API
|
801
|
+
# request. * INVALID_ARGUMENT: Required request parameters are missing or
|
802
|
+
# invalid. Return value: List of Customers, or an empty list if there are no
|
803
|
+
# customers.
|
619
804
|
# @param [String] parent
|
620
|
-
# Required. The resource name of the reseller account
|
621
|
-
#
|
805
|
+
# Required. The resource name of the reseller account to list customers from.
|
806
|
+
# Parent uses the format: accounts/`account_id`.
|
622
807
|
# @param [Fixnum] page_size
|
623
808
|
# Optional. The maximum number of customers to return. The service may return
|
624
|
-
# fewer than this value. If unspecified, at most 10 customers
|
625
|
-
#
|
809
|
+
# fewer than this value. If unspecified, returns at most 10 customers. The
|
810
|
+
# maximum value is 50.
|
626
811
|
# @param [String] page_token
|
627
|
-
# Optional. A token identifying a page of results
|
628
|
-
#
|
812
|
+
# Optional. A token identifying a page of results other than the first page.
|
813
|
+
# Obtained through ListCustomersResponse.next_page_token of the previous
|
629
814
|
# CloudChannelService.ListCustomers call.
|
630
815
|
# @param [String] fields
|
631
816
|
# Selector specifying which fields to include in a partial response.
|
@@ -656,34 +841,32 @@ module Google
|
|
656
841
|
execute_or_queue_command(command, &block)
|
657
842
|
end
|
658
843
|
|
659
|
-
# Lists the
|
660
|
-
#
|
661
|
-
#
|
662
|
-
#
|
663
|
-
# parameters in the request.
|
844
|
+
# Lists the following: * Offers that you can purchase for a customer. * Offers
|
845
|
+
# that you can change for an entitlement. Possible error codes: *
|
846
|
+
# PERMISSION_DENIED: The customer doesn't belong to the reseller *
|
847
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
664
848
|
# @param [String] customer
|
665
|
-
# Required. The resource name of the customer
|
849
|
+
# Required. The resource name of the customer to list Offers for. Format:
|
666
850
|
# accounts/`account_id`/customers/`customer_id`.
|
667
851
|
# @param [String] change_offer_purchase_entitlement
|
668
852
|
# Required. Resource name of the entitlement. Format: accounts/`account_id`/
|
669
853
|
# customers/`customer_id`/entitlements/`entitlement_id`
|
670
854
|
# @param [String] change_offer_purchase_new_sku
|
671
|
-
# Optional. Resource name of the
|
672
|
-
#
|
673
|
-
# product_id`/skus/`sku_id`
|
855
|
+
# Optional. Resource name of the new target SKU. Provide this SKU when upgrading
|
856
|
+
# or downgrading an entitlement. Format: products/`product_id`/skus/`sku_id`
|
674
857
|
# @param [String] create_entitlement_purchase_sku
|
675
858
|
# Required. SKU that the result should be restricted to. Format: products/`
|
676
859
|
# product_id`/skus/`sku_id`.
|
677
860
|
# @param [String] language_code
|
678
|
-
# Optional. The BCP-47 language code
|
679
|
-
#
|
680
|
-
# US".
|
861
|
+
# Optional. The BCP-47 language code. For example, "en-US". The response will
|
862
|
+
# localize in the corresponding language code, if specified. The default value
|
863
|
+
# is "en-US".
|
681
864
|
# @param [Fixnum] page_size
|
682
865
|
# Optional. Requested page size. Server might return fewer results than
|
683
|
-
# requested. If unspecified, at most 100 Offers
|
684
|
-
#
|
866
|
+
# requested. If unspecified, returns at most 100 Offers. The maximum value is
|
867
|
+
# 1000; the server will coerce values above 1000.
|
685
868
|
# @param [String] page_token
|
686
|
-
# Optional. A token
|
869
|
+
# Optional. A token for a page of results other than the first page.
|
687
870
|
# @param [String] fields
|
688
871
|
# Selector specifying which fields to include in a partial response.
|
689
872
|
# @param [String] quota_user
|
@@ -717,14 +900,13 @@ module Google
|
|
717
900
|
execute_or_queue_command(command, &block)
|
718
901
|
end
|
719
902
|
|
720
|
-
# Lists the
|
721
|
-
#
|
722
|
-
#
|
723
|
-
#
|
724
|
-
# parameters in the request.
|
903
|
+
# Lists the following: * SKUs that you can purchase for a customer * SKUs that
|
904
|
+
# you can upgrade or downgrade for an entitlement. Possible error codes: *
|
905
|
+
# PERMISSION_DENIED: The customer doesn't belong to the reseller. *
|
906
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
725
907
|
# @param [String] customer
|
726
|
-
# Required. The resource name of the customer
|
727
|
-
#
|
908
|
+
# Required. The resource name of the customer to list SKUs for. Format: accounts/
|
909
|
+
# `account_id`/customers/`customer_id`.
|
728
910
|
# @param [String] change_offer_purchase_change_type
|
729
911
|
# Required. Change Type for the entitlement.
|
730
912
|
# @param [String] change_offer_purchase_entitlement
|
@@ -734,15 +916,15 @@ module Google
|
|
734
916
|
# Required. List SKUs belonging to this Product. Format: products/`product_id`.
|
735
917
|
# Supports products/- to retrieve SKUs for all products.
|
736
918
|
# @param [String] language_code
|
737
|
-
# Optional. The BCP-47 language code
|
738
|
-
#
|
739
|
-
# US".
|
919
|
+
# Optional. The BCP-47 language code. For example, "en-US". The response will
|
920
|
+
# localize in the corresponding language code, if specified. The default value
|
921
|
+
# is "en-US".
|
740
922
|
# @param [Fixnum] page_size
|
741
923
|
# Optional. Requested page size. Server might return fewer results than
|
742
|
-
# requested. If unspecified, at most 100 SKUs
|
743
|
-
#
|
924
|
+
# requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000;
|
925
|
+
# the server will coerce values above 1000.
|
744
926
|
# @param [String] page_token
|
745
|
-
# Optional. A token
|
927
|
+
# Optional. A token for a page of results other than the first page.
|
746
928
|
# @param [String] fields
|
747
929
|
# Selector specifying which fields to include in a partial response.
|
748
930
|
# @param [String] quota_user
|
@@ -776,13 +958,12 @@ module Google
|
|
776
958
|
execute_or_queue_command(command, &block)
|
777
959
|
end
|
778
960
|
|
779
|
-
# Updates an existing Customer resource
|
780
|
-
# Possible
|
781
|
-
# request
|
782
|
-
# INVALID_ARGUMENT:
|
783
|
-
# NOT_FOUND: No Customer resource found for the name
|
784
|
-
#
|
785
|
-
# an error.
|
961
|
+
# Updates an existing Customer resource for the reseller or distributor.
|
962
|
+
# Possible error codes: * PERMISSION_DENIED: The reseller account making the
|
963
|
+
# request is different from the reseller account in the API request. *
|
964
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid. *
|
965
|
+
# NOT_FOUND: No Customer resource found for the name in the request. Return
|
966
|
+
# value: The updated Customer resource.
|
786
967
|
# @param [String] name
|
787
968
|
# Output only. Resource name of the customer. Format: accounts/`account_id`/
|
788
969
|
# customers/`customer_id`
|
@@ -820,18 +1001,17 @@ module Google
|
|
820
1001
|
end
|
821
1002
|
|
822
1003
|
# Creates a Cloud Identity for the given customer using the customer's
|
823
|
-
# information or the information provided here
|
824
|
-
#
|
825
|
-
# INVALID_ARGUMENT:
|
826
|
-
# NOT_FOUND:
|
827
|
-
#
|
828
|
-
#
|
829
|
-
#
|
830
|
-
#
|
831
|
-
#
|
832
|
-
#
|
833
|
-
#
|
834
|
-
# will contain an instance of OperationMetadata.
|
1004
|
+
# information, or the information provided here. Possible error codes: *
|
1005
|
+
# PERMISSION_DENIED: The customer doesn't belong to the reseller. *
|
1006
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid. *
|
1007
|
+
# NOT_FOUND: The customer was not found. * ALREADY_EXISTS: The customer's
|
1008
|
+
# primary email already exists. Retry after changing the customer's primary
|
1009
|
+
# contact email. * INTERNAL: Any non-user error related to a technical issue in
|
1010
|
+
# the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error
|
1011
|
+
# related to a technical issue in the backend. Contact Cloud Channel support.
|
1012
|
+
# Return value: The ID of a long-running operation. To get the results of the
|
1013
|
+
# operation, call the GetOperation method of CloudChannelOperationsService. The
|
1014
|
+
# Operation metadata contains an instance of OperationMetadata.
|
835
1015
|
# @param [String] customer
|
836
1016
|
# Required. Resource name of the customer. Format: accounts/`account_id`/
|
837
1017
|
# customers/`customer_id`
|
@@ -865,29 +1045,27 @@ module Google
|
|
865
1045
|
execute_or_queue_command(command, &block)
|
866
1046
|
end
|
867
1047
|
|
868
|
-
# Transfers customer entitlements to new reseller. Possible
|
869
|
-
# PERMISSION_DENIED:
|
870
|
-
# INVALID_ARGUMENT:
|
871
|
-
# NOT_FOUND:
|
872
|
-
#
|
873
|
-
#
|
874
|
-
#
|
875
|
-
# the
|
876
|
-
#
|
877
|
-
#
|
878
|
-
#
|
879
|
-
#
|
880
|
-
#
|
881
|
-
#
|
882
|
-
#
|
883
|
-
#
|
884
|
-
#
|
885
|
-
# call the GetOperation method of CloudChannelOperationsService. The Operation
|
886
|
-
# metadata will contain an instance of OperationMetadata.
|
1048
|
+
# Transfers customer entitlements to new reseller. Possible error codes: *
|
1049
|
+
# PERMISSION_DENIED: The customer doesn't belong to the reseller. *
|
1050
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid. *
|
1051
|
+
# NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: The
|
1052
|
+
# SKU was already transferred for the customer. * CONDITION_NOT_MET or
|
1053
|
+
# FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but
|
1054
|
+
# the domain is not verified. * An Add-On SKU (example, Vault or Drive) is
|
1055
|
+
# missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts
|
1056
|
+
# only) Reseller and resold domain must meet the following naming requirements: *
|
1057
|
+
# Domain names must start with goog-test. * Domain names must include the
|
1058
|
+
# reseller domain. * Specify all transferring entitlements. * INTERNAL: Any non-
|
1059
|
+
# user error related to a technical issue in the backend. Contact Cloud Channel
|
1060
|
+
# support. * UNKNOWN: Any non-user error related to a technical issue in the
|
1061
|
+
# backend. Contact Cloud Channel support. Return value: The ID of a long-running
|
1062
|
+
# operation. To get the results of the operation, call the GetOperation method
|
1063
|
+
# of CloudChannelOperationsService. The Operation metadata will contain an
|
1064
|
+
# instance of OperationMetadata.
|
887
1065
|
# @param [String] parent
|
888
|
-
# Required. The resource name of reseller's customer account
|
889
|
-
#
|
890
|
-
# customers/`customer_id`
|
1066
|
+
# Required. The resource name of the reseller's customer account that will
|
1067
|
+
# receive transferred entitlements. Parent uses the format: accounts/`account_id`
|
1068
|
+
# /customers/`customer_id`
|
891
1069
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1TransferEntitlementsRequest] google_cloud_channel_v1_transfer_entitlements_request_object
|
892
1070
|
# @param [String] fields
|
893
1071
|
# Selector specifying which fields to include in a partial response.
|
@@ -918,28 +1096,27 @@ module Google
|
|
918
1096
|
execute_or_queue_command(command, &block)
|
919
1097
|
end
|
920
1098
|
|
921
|
-
# Transfers customer entitlements from current reseller to Google.
|
922
|
-
#
|
923
|
-
# reseller. * INVALID_ARGUMENT:
|
924
|
-
#
|
925
|
-
#
|
926
|
-
#
|
927
|
-
#
|
928
|
-
#
|
929
|
-
#
|
930
|
-
#
|
931
|
-
#
|
932
|
-
#
|
933
|
-
# non-user error related to a technical issue in the backend.
|
934
|
-
# Cloud Channel
|
935
|
-
#
|
936
|
-
#
|
937
|
-
#
|
938
|
-
#
|
939
|
-
# will contain an instance of OperationMetadata.
|
1099
|
+
# Transfers customer entitlements from their current reseller to Google.
|
1100
|
+
# Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the
|
1101
|
+
# reseller. * INVALID_ARGUMENT: Required request parameters are missing or
|
1102
|
+
# invalid. * NOT_FOUND: The customer or offer resource was not found. *
|
1103
|
+
# ALREADY_EXISTS: The SKU was already transferred for the customer. *
|
1104
|
+
# CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain
|
1105
|
+
# verification to transfer, but the domain is not verified. * An Add-On SKU (
|
1106
|
+
# example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite
|
1107
|
+
# Basic). * (Developer accounts only) Reseller and resold domain must meet the
|
1108
|
+
# following naming requirements: * Domain names must start with goog-test. *
|
1109
|
+
# Domain names must include the reseller domain. * INTERNAL: Any non-user error
|
1110
|
+
# related to a technical issue in the backend. Contact Cloud Channel support. *
|
1111
|
+
# UNKNOWN: Any non-user error related to a technical issue in the backend.
|
1112
|
+
# Contact Cloud Channel support. Return value: The ID of a long-running
|
1113
|
+
# operation. To get the results of the operation, call the GetOperation method
|
1114
|
+
# of CloudChannelOperationsService. The response will contain google.protobuf.
|
1115
|
+
# Empty on success. The Operation metadata will contain an instance of
|
1116
|
+
# OperationMetadata.
|
940
1117
|
# @param [String] parent
|
941
|
-
# Required. The resource name of reseller's customer account where the
|
942
|
-
# entitlements transfer from.
|
1118
|
+
# Required. The resource name of the reseller's customer account where the
|
1119
|
+
# entitlements transfer from. Parent uses the format: accounts/`account_id`/
|
943
1120
|
# customers/`customer_id`
|
944
1121
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1TransferEntitlementsToGoogleRequest] google_cloud_channel_v1_transfer_entitlements_to_google_request_object
|
945
1122
|
# @param [String] fields
|
@@ -971,27 +1148,24 @@ module Google
|
|
971
1148
|
execute_or_queue_command(command, &block)
|
972
1149
|
end
|
973
1150
|
|
974
|
-
# Activates a previously suspended entitlement.
|
975
|
-
#
|
976
|
-
#
|
977
|
-
#
|
978
|
-
#
|
979
|
-
#
|
980
|
-
#
|
981
|
-
#
|
982
|
-
#
|
983
|
-
#
|
984
|
-
#
|
985
|
-
#
|
986
|
-
#
|
987
|
-
#
|
988
|
-
#
|
989
|
-
#
|
990
|
-
# results of the operation, call the GetOperation method of
|
991
|
-
# CloudChannelOperationsService. The Operation metadata will contain an instance
|
992
|
-
# of OperationMetadata.
|
1151
|
+
# Activates a previously suspended entitlement. Entitlements suspended for
|
1152
|
+
# pending ToS acceptance can't be activated using this method. An entitlement
|
1153
|
+
# activation is a long-running operation and it updates the state of the
|
1154
|
+
# customer entitlement. Possible error codes: * PERMISSION_DENIED: The reseller
|
1155
|
+
# account making the request is different from the reseller account in the API
|
1156
|
+
# request. * INVALID_ARGUMENT: Required request parameters are missing or
|
1157
|
+
# invalid. * NOT_FOUND: Entitlement resource not found. *
|
1158
|
+
# SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated
|
1159
|
+
# suspensions and entitlements that have accepted the TOS. * NOT_SUSPENDED: Can
|
1160
|
+
# only activate suspended entitlements not in an ACTIVE state. * INTERNAL: Any
|
1161
|
+
# non-user error related to a technical issue in the backend. Contact Cloud
|
1162
|
+
# Channel support. * UNKNOWN: Any non-user error related to a technical issue in
|
1163
|
+
# the backend. Contact Cloud Channel support. Return value: The ID of a long-
|
1164
|
+
# running operation. To get the results of the operation, call the GetOperation
|
1165
|
+
# method of CloudChannelOperationsService. The Operation metadata will contain
|
1166
|
+
# an instance of OperationMetadata.
|
993
1167
|
# @param [String] name
|
994
|
-
# Required. The resource name of the entitlement to activate.
|
1168
|
+
# Required. The resource name of the entitlement to activate. Name uses the
|
995
1169
|
# format: accounts/`account_id`/customers/`customer_id`/entitlements/`
|
996
1170
|
# entitlement_id`
|
997
1171
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1ActivateEntitlementRequest] google_cloud_channel_v1_activate_entitlement_request_object
|
@@ -1025,26 +1199,23 @@ module Google
|
|
1025
1199
|
end
|
1026
1200
|
|
1027
1201
|
# Cancels a previously fulfilled entitlement. An entitlement cancellation is a
|
1028
|
-
# long-running operation. Possible
|
1029
|
-
#
|
1030
|
-
# request
|
1031
|
-
#
|
1032
|
-
#
|
1033
|
-
#
|
1034
|
-
#
|
1035
|
-
#
|
1036
|
-
#
|
1037
|
-
# issue in the backend.
|
1038
|
-
#
|
1039
|
-
#
|
1040
|
-
#
|
1041
|
-
#
|
1042
|
-
# on success. The Operation metadata will contain an instance of
|
1043
|
-
# OperationMetadata.
|
1202
|
+
# long-running operation. Possible error codes: * PERMISSION_DENIED: The
|
1203
|
+
# reseller account making the request is different from the reseller account in
|
1204
|
+
# the API request. * FAILED_PRECONDITION: There are Google Cloud projects linked
|
1205
|
+
# to the Google Cloud entitlement's Cloud Billing subaccount. * INVALID_ARGUMENT:
|
1206
|
+
# Required request parameters are missing or invalid. * NOT_FOUND: Entitlement
|
1207
|
+
# resource not found. * DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for
|
1208
|
+
# Google Workspace add-ons, or entitlements for Google Cloud's development
|
1209
|
+
# platform. * INTERNAL: Any non-user error related to a technical issue in the
|
1210
|
+
# backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related
|
1211
|
+
# to a technical issue in the backend. Contact Cloud Channel support. Return
|
1212
|
+
# value: The ID of a long-running operation. To get the results of the operation,
|
1213
|
+
# call the GetOperation method of CloudChannelOperationsService. The response
|
1214
|
+
# will contain google.protobuf.Empty on success. The Operation metadata will
|
1215
|
+
# contain an instance of OperationMetadata.
|
1044
1216
|
# @param [String] name
|
1045
|
-
# Required. The resource name of the entitlement to cancel.
|
1046
|
-
#
|
1047
|
-
# entitlement_id`
|
1217
|
+
# Required. The resource name of the entitlement to cancel. Name uses the format:
|
1218
|
+
# accounts/`account_id`/customers/`customer_id`/entitlements/`entitlement_id`
|
1048
1219
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1CancelEntitlementRequest] google_cloud_channel_v1_cancel_entitlement_request_object
|
1049
1220
|
# @param [String] fields
|
1050
1221
|
# Selector specifying which fields to include in a partial response.
|
@@ -1076,20 +1247,19 @@ module Google
|
|
1076
1247
|
end
|
1077
1248
|
|
1078
1249
|
# Updates the Offer for an existing customer entitlement. An entitlement update
|
1079
|
-
# is a long-running operation and
|
1080
|
-
#
|
1081
|
-
#
|
1082
|
-
#
|
1083
|
-
#
|
1084
|
-
#
|
1085
|
-
#
|
1086
|
-
#
|
1087
|
-
# the
|
1088
|
-
#
|
1089
|
-
# of OperationMetadata.
|
1250
|
+
# is a long-running operation and it updates the entitlement as a result of
|
1251
|
+
# fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't
|
1252
|
+
# belong to the reseller. * INVALID_ARGUMENT: Required request parameters are
|
1253
|
+
# missing or invalid. * NOT_FOUND: Offer or Entitlement resource not found. *
|
1254
|
+
# INTERNAL: Any non-user error related to a technical issue in the backend.
|
1255
|
+
# Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a
|
1256
|
+
# technical issue in the backend. Contact Cloud Channel support. Return value:
|
1257
|
+
# The ID of a long-running operation. To get the results of the operation, call
|
1258
|
+
# the GetOperation method of CloudChannelOperationsService. The Operation
|
1259
|
+
# metadata will contain an instance of OperationMetadata.
|
1090
1260
|
# @param [String] name
|
1091
|
-
# Required. The name of the entitlement to update.
|
1092
|
-
# customers/`customer_id`/entitlements/`entitlement_id`
|
1261
|
+
# Required. The resource name of the entitlement to update. Name uses the format:
|
1262
|
+
# accounts/`account_id`/customers/`customer_id`/entitlements/`entitlement_id`
|
1093
1263
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1ChangeOfferRequest] google_cloud_channel_v1_change_offer_request_object
|
1094
1264
|
# @param [String] fields
|
1095
1265
|
# Selector specifying which fields to include in a partial response.
|
@@ -1120,22 +1290,21 @@ module Google
|
|
1120
1290
|
execute_or_queue_command(command, &block)
|
1121
1291
|
end
|
1122
1292
|
|
1123
|
-
# Change parameters of the entitlement An entitlement
|
1124
|
-
#
|
1125
|
-
#
|
1126
|
-
#
|
1127
|
-
#
|
1128
|
-
#
|
1129
|
-
#
|
1130
|
-
#
|
1131
|
-
#
|
1132
|
-
#
|
1133
|
-
#
|
1134
|
-
# the results of the operation, call the GetOperation method of
|
1293
|
+
# Change parameters of the entitlement. An entitlement update is a long-running
|
1294
|
+
# operation and it updates the entitlement as a result of fulfillment. Possible
|
1295
|
+
# error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller.
|
1296
|
+
# * INVALID_ARGUMENT: Required request parameters are missing or invalid. For
|
1297
|
+
# example, the number of seats being changed is greater than the allowed number
|
1298
|
+
# of max seats, or decreasing seats for a commitment based plan. * NOT_FOUND:
|
1299
|
+
# Entitlement resource not found. * INTERNAL: Any non-user error related to a
|
1300
|
+
# technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any
|
1301
|
+
# non-user error related to a technical issue in the backend. Contact Cloud
|
1302
|
+
# Channel support. Return value: The ID of a long-running operation. To get the
|
1303
|
+
# results of the operation, call the GetOperation method of
|
1135
1304
|
# CloudChannelOperationsService. The Operation metadata will contain an instance
|
1136
1305
|
# of OperationMetadata.
|
1137
1306
|
# @param [String] name
|
1138
|
-
# Required. The name of the entitlement to update.
|
1307
|
+
# Required. The name of the entitlement to update. Name uses the format:
|
1139
1308
|
# accounts/`account_id`/customers/`customer_id`/entitlements/`entitlement_id`
|
1140
1309
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1ChangeParametersRequest] google_cloud_channel_v1_change_parameters_request_object
|
1141
1310
|
# @param [String] fields
|
@@ -1168,21 +1337,20 @@ module Google
|
|
1168
1337
|
end
|
1169
1338
|
|
1170
1339
|
# Updates the renewal settings for an existing customer entitlement. An
|
1171
|
-
# entitlement update is a long-running operation and
|
1172
|
-
#
|
1173
|
-
#
|
1174
|
-
#
|
1175
|
-
#
|
1176
|
-
#
|
1177
|
-
#
|
1178
|
-
#
|
1179
|
-
#
|
1180
|
-
#
|
1181
|
-
#
|
1182
|
-
#
|
1183
|
-
# of OperationMetadata.
|
1340
|
+
# entitlement update is a long-running operation and it updates the entitlement
|
1341
|
+
# as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The
|
1342
|
+
# customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request
|
1343
|
+
# parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found.
|
1344
|
+
# * NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment
|
1345
|
+
# plan. Can't enable or disable renewals for non-commitment plans. * INTERNAL:
|
1346
|
+
# Any non-user error related to a technical issue in the backend. Contact Cloud
|
1347
|
+
# Channel support. * UNKNOWN: Any non-user error related to a technical issue in
|
1348
|
+
# the backend. Contact Cloud Channel support. Return value: The ID of a long-
|
1349
|
+
# running operation. To get the results of the operation, call the GetOperation
|
1350
|
+
# method of CloudChannelOperationsService. The Operation metadata will contain
|
1351
|
+
# an instance of OperationMetadata.
|
1184
1352
|
# @param [String] name
|
1185
|
-
# Required. The name of the entitlement to update.
|
1353
|
+
# Required. The name of the entitlement to update. Name uses the format:
|
1186
1354
|
# accounts/`account_id`/customers/`customer_id`/entitlements/`entitlement_id`
|
1187
1355
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1ChangeRenewalSettingsRequest] google_cloud_channel_v1_change_renewal_settings_request_object
|
1188
1356
|
# @param [String] fields
|
@@ -1214,35 +1382,31 @@ module Google
|
|
1214
1382
|
execute_or_queue_command(command, &block)
|
1215
1383
|
end
|
1216
1384
|
|
1217
|
-
# Creates an entitlement for a customer. Possible
|
1218
|
-
# PERMISSION_DENIED:
|
1219
|
-
# INVALID_ARGUMENT:
|
1220
|
-
#
|
1221
|
-
#
|
1222
|
-
#
|
1223
|
-
#
|
1224
|
-
#
|
1225
|
-
#
|
1226
|
-
#
|
1227
|
-
#
|
1228
|
-
#
|
1229
|
-
#
|
1230
|
-
#
|
1231
|
-
#
|
1232
|
-
#
|
1233
|
-
#
|
1234
|
-
#
|
1235
|
-
#
|
1236
|
-
#
|
1237
|
-
#
|
1238
|
-
# Support in this case. Return Value: Long Running Operation ID. To get the
|
1239
|
-
# results of the operation, call the GetOperation method of
|
1240
|
-
# CloudChannelOperationsService. The Operation metadata will contain an instance
|
1241
|
-
# of OperationMetadata.
|
1385
|
+
# Creates an entitlement for a customer. Possible error codes: *
|
1386
|
+
# PERMISSION_DENIED: The customer doesn't belong to the reseller. *
|
1387
|
+
# INVALID_ARGUMENT: * Required request parameters are missing or invalid. *
|
1388
|
+
# There is already a customer entitlement for a SKU from the same product family.
|
1389
|
+
# * INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google
|
1390
|
+
# Channel support for further troubleshooting. * NOT_FOUND: The customer or
|
1391
|
+
# offer resource was not found. * ALREADY_EXISTS: * The SKU was already
|
1392
|
+
# purchased for the customer. * The customer's primary email already exists.
|
1393
|
+
# Retry after changing the customer's primary contact email. * CONDITION_NOT_MET
|
1394
|
+
# or FAILED_PRECONDITION: * The domain required for purchasing a SKU has not
|
1395
|
+
# been verified. * A pre-requisite SKU required to purchase an Add-On SKU is
|
1396
|
+
# missing. For example, Google Workspace Business Starter is required to
|
1397
|
+
# purchase Vault or Drive. * (Developer accounts only) Reseller and resold
|
1398
|
+
# domain must meet the following naming requirements: * Domain names must start
|
1399
|
+
# with goog-test. * Domain names must include the reseller domain. * INTERNAL:
|
1400
|
+
# Any non-user error related to a technical issue in the backend. Contact Cloud
|
1401
|
+
# Channel support. * UNKNOWN: Any non-user error related to a technical issue in
|
1402
|
+
# the backend. Contact Cloud Channel support. Return value: The ID of a long-
|
1403
|
+
# running operation. To get the results of the operation, call the GetOperation
|
1404
|
+
# method of CloudChannelOperationsService. The Operation metadata will contain
|
1405
|
+
# an instance of OperationMetadata.
|
1242
1406
|
# @param [String] parent
|
1243
|
-
# Required. The resource name of reseller's customer account in which to
|
1244
|
-
# the entitlement.
|
1245
|
-
# customer_id`
|
1407
|
+
# Required. The resource name of the reseller's customer account in which to
|
1408
|
+
# create the entitlement. Parent uses the format: accounts/`account_id`/
|
1409
|
+
# customers/`customer_id`
|
1246
1410
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1CreateEntitlementRequest] google_cloud_channel_v1_create_entitlement_request_object
|
1247
1411
|
# @param [String] fields
|
1248
1412
|
# Selector specifying which fields to include in a partial response.
|
@@ -1273,14 +1437,15 @@ module Google
|
|
1273
1437
|
execute_or_queue_command(command, &block)
|
1274
1438
|
end
|
1275
1439
|
|
1276
|
-
# Returns
|
1277
|
-
# PERMISSION_DENIED:
|
1278
|
-
# INVALID_ARGUMENT:
|
1279
|
-
# NOT_FOUND:
|
1280
|
-
#
|
1440
|
+
# Returns the requested Entitlement resource. Possible error codes: *
|
1441
|
+
# PERMISSION_DENIED: The customer doesn't belong to the reseller. *
|
1442
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid. *
|
1443
|
+
# NOT_FOUND: The customer entitlement was not found. Return value: The requested
|
1444
|
+
# Entitlement resource.
|
1281
1445
|
# @param [String] name
|
1282
|
-
# Required. The resource name of the entitlement to retrieve.
|
1283
|
-
# format: accounts/`account_id`/customers/`customer_id`/entitlements/`
|
1446
|
+
# Required. The resource name of the entitlement to retrieve. Name uses the
|
1447
|
+
# format: accounts/`account_id`/customers/`customer_id`/entitlements/`
|
1448
|
+
# entitlement_id`
|
1284
1449
|
# @param [String] fields
|
1285
1450
|
# Selector specifying which fields to include in a partial response.
|
1286
1451
|
# @param [String] quota_user
|
@@ -1308,23 +1473,22 @@ module Google
|
|
1308
1473
|
execute_or_queue_command(command, &block)
|
1309
1474
|
end
|
1310
1475
|
|
1311
|
-
#
|
1312
|
-
# PERMISSION_DENIED:
|
1313
|
-
# INVALID_ARGUMENT:
|
1314
|
-
#
|
1315
|
-
# there are none.
|
1476
|
+
# Lists Entitlements belonging to a customer. Possible error codes: *
|
1477
|
+
# PERMISSION_DENIED: The customer doesn't belong to the reseller. *
|
1478
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid. Return
|
1479
|
+
# value: A list of the customer's Entitlements.
|
1316
1480
|
# @param [String] parent
|
1317
|
-
# Required. The resource name of the reseller's customer account
|
1318
|
-
#
|
1319
|
-
#
|
1481
|
+
# Required. The resource name of the reseller's customer account to list
|
1482
|
+
# entitlements for. Parent uses the format: accounts/`account_id`/customers/`
|
1483
|
+
# customer_id`
|
1320
1484
|
# @param [Fixnum] page_size
|
1321
1485
|
# Optional. Requested page size. Server might return fewer results than
|
1322
|
-
# requested. If unspecified, at most 50 entitlements
|
1323
|
-
#
|
1486
|
+
# requested. If unspecified, return at most 50 entitlements. The maximum value
|
1487
|
+
# is 100; the server will coerce values above 100.
|
1324
1488
|
# @param [String] page_token
|
1325
|
-
# Optional. A token
|
1326
|
-
#
|
1327
|
-
#
|
1489
|
+
# Optional. A token for a page of results other than the first page. Obtained
|
1490
|
+
# using ListEntitlementsResponse.next_page_token of the previous
|
1491
|
+
# CloudChannelService.ListEntitlements call.
|
1328
1492
|
# @param [String] fields
|
1329
1493
|
# Selector specifying which fields to include in a partial response.
|
1330
1494
|
# @param [String] quota_user
|
@@ -1354,24 +1518,59 @@ module Google
|
|
1354
1518
|
execute_or_queue_command(command, &block)
|
1355
1519
|
end
|
1356
1520
|
|
1521
|
+
# Returns the requested Offer resource. Possible error codes: *
|
1522
|
+
# PERMISSION_DENIED: The entitlement doesn't belong to the reseller. *
|
1523
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid. *
|
1524
|
+
# NOT_FOUND: Entitlement or offer was not found. Return value: The Offer
|
1525
|
+
# resource.
|
1526
|
+
# @param [String] entitlement
|
1527
|
+
# Required. The resource name of the entitlement to retrieve the Offer.
|
1528
|
+
# Entitlement uses the format: accounts/`account_id`/customers/`customer_id`/
|
1529
|
+
# entitlements/`entitlement_id`
|
1530
|
+
# @param [String] fields
|
1531
|
+
# Selector specifying which fields to include in a partial response.
|
1532
|
+
# @param [String] quota_user
|
1533
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1534
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1535
|
+
# @param [Google::Apis::RequestOptions] options
|
1536
|
+
# Request-specific options
|
1537
|
+
#
|
1538
|
+
# @yield [result, err] Result & error if block supplied
|
1539
|
+
# @yieldparam result [Google::Apis::CloudchannelV1::GoogleCloudChannelV1Offer] parsed result object
|
1540
|
+
# @yieldparam err [StandardError] error object if request failed
|
1541
|
+
#
|
1542
|
+
# @return [Google::Apis::CloudchannelV1::GoogleCloudChannelV1Offer]
|
1543
|
+
#
|
1544
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1545
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1546
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1547
|
+
def lookup_account_customer_entitlement_offer(entitlement, fields: nil, quota_user: nil, options: nil, &block)
|
1548
|
+
command = make_simple_command(:get, 'v1/{+entitlement}:lookupOffer', options)
|
1549
|
+
command.response_representation = Google::Apis::CloudchannelV1::GoogleCloudChannelV1Offer::Representation
|
1550
|
+
command.response_class = Google::Apis::CloudchannelV1::GoogleCloudChannelV1Offer
|
1551
|
+
command.params['entitlement'] = entitlement unless entitlement.nil?
|
1552
|
+
command.query['fields'] = fields unless fields.nil?
|
1553
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1554
|
+
execute_or_queue_command(command, &block)
|
1555
|
+
end
|
1556
|
+
|
1357
1557
|
# Starts paid service for a trial entitlement. Starts paid service for a trial
|
1358
|
-
# entitlement immediately. This method is only applicable if a plan
|
1359
|
-
#
|
1360
|
-
#
|
1361
|
-
#
|
1362
|
-
#
|
1363
|
-
#
|
1364
|
-
#
|
1365
|
-
#
|
1366
|
-
#
|
1367
|
-
#
|
1368
|
-
#
|
1369
|
-
#
|
1370
|
-
# of OperationMetadata.
|
1558
|
+
# entitlement immediately. This method is only applicable if a plan is set up
|
1559
|
+
# for a trial entitlement but has some trial days remaining. Possible error
|
1560
|
+
# codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. *
|
1561
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid. *
|
1562
|
+
# NOT_FOUND: Entitlement resource not found. * FAILED_PRECONDITION/NOT_IN_TRIAL:
|
1563
|
+
# This method only works for entitlement on trial plans. * INTERNAL: Any non-
|
1564
|
+
# user error related to a technical issue in the backend. Contact Cloud Channel
|
1565
|
+
# support. * UNKNOWN: Any non-user error related to a technical issue in the
|
1566
|
+
# backend. Contact Cloud Channel support. Return value: The ID of a long-running
|
1567
|
+
# operation. To get the results of the operation, call the GetOperation method
|
1568
|
+
# of CloudChannelOperationsService. The Operation metadata will contain an
|
1569
|
+
# instance of OperationMetadata.
|
1371
1570
|
# @param [String] name
|
1372
|
-
# Required. The name of the entitlement
|
1373
|
-
#
|
1374
|
-
#
|
1571
|
+
# Required. The name of the entitlement to start a paid service for. Name uses
|
1572
|
+
# the format: accounts/`account_id`/customers/`customer_id`/entitlements/`
|
1573
|
+
# entitlement_id`
|
1375
1574
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1StartPaidServiceRequest] google_cloud_channel_v1_start_paid_service_request_object
|
1376
1575
|
# @param [String] fields
|
1377
1576
|
# Selector specifying which fields to include in a partial response.
|
@@ -1403,18 +1602,18 @@ module Google
|
|
1403
1602
|
end
|
1404
1603
|
|
1405
1604
|
# Suspends a previously fulfilled entitlement. An entitlement suspension is a
|
1406
|
-
# long-running operation. Possible
|
1407
|
-
# customer doesn't belong to the reseller. * INVALID_ARGUMENT:
|
1408
|
-
#
|
1409
|
-
#
|
1410
|
-
#
|
1411
|
-
#
|
1412
|
-
#
|
1413
|
-
#
|
1414
|
-
#
|
1415
|
-
#
|
1605
|
+
# long-running operation. Possible error codes: * PERMISSION_DENIED: The
|
1606
|
+
# customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request
|
1607
|
+
# parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found.
|
1608
|
+
# * NOT_ACTIVE: Entitlement is not active. * INTERNAL: Any non-user error
|
1609
|
+
# related to a technical issue in the backend. Contact Cloud Channel support. *
|
1610
|
+
# UNKNOWN: Any non-user error related to a technical issue in the backend.
|
1611
|
+
# Contact Cloud Channel support. Return value: The ID of a long-running
|
1612
|
+
# operation. To get the results of the operation, call the GetOperation method
|
1613
|
+
# of CloudChannelOperationsService. The Operation metadata will contain an
|
1614
|
+
# instance of OperationMetadata.
|
1416
1615
|
# @param [String] name
|
1417
|
-
# Required. The resource name of the entitlement to suspend.
|
1616
|
+
# Required. The resource name of the entitlement to suspend. Name uses the
|
1418
1617
|
# format: accounts/`account_id`/customers/`customer_id`/entitlements/`
|
1419
1618
|
# entitlement_id`
|
1420
1619
|
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1SuspendEntitlementRequest] google_cloud_channel_v1_suspend_entitlement_request_object
|
@@ -1447,26 +1646,26 @@ module Google
|
|
1447
1646
|
execute_or_queue_command(command, &block)
|
1448
1647
|
end
|
1449
1648
|
|
1450
|
-
# Lists the Offers the reseller can sell. Possible
|
1451
|
-
# INVALID_ARGUMENT:
|
1649
|
+
# Lists the Offers the reseller can sell. Possible error codes: *
|
1650
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
1452
1651
|
# @param [String] parent
|
1453
1652
|
# Required. The resource name of the reseller account from which to list Offers.
|
1454
|
-
#
|
1653
|
+
# Parent uses the format: accounts/`account_id`.
|
1455
1654
|
# @param [String] filter
|
1456
1655
|
# Optional. The expression to filter results by name (name of the Offer), sku.
|
1457
|
-
# name (name of the SKU) or sku.product.name (name of the Product). Example 1:
|
1656
|
+
# name (name of the SKU), or sku.product.name (name of the Product). Example 1:
|
1458
1657
|
# sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=
|
1459
1658
|
# accounts/a1/offers/o1
|
1460
1659
|
# @param [String] language_code
|
1461
|
-
# Optional. The BCP-47 language code
|
1462
|
-
#
|
1463
|
-
# US".
|
1660
|
+
# Optional. The BCP-47 language code. For example, "en-US". The response will
|
1661
|
+
# localize in the corresponding language code, if specified. The default value
|
1662
|
+
# is "en-US".
|
1464
1663
|
# @param [Fixnum] page_size
|
1465
1664
|
# Optional. Requested page size. Server might return fewer results than
|
1466
|
-
# requested. If unspecified, at most 500 Offers
|
1467
|
-
#
|
1665
|
+
# requested. If unspecified, returns at most 500 Offers. The maximum value is
|
1666
|
+
# 1000; the server will coerce values above 1000.
|
1468
1667
|
# @param [String] page_token
|
1469
|
-
# Optional. A token
|
1668
|
+
# Optional. A token for a page of results other than the first page.
|
1470
1669
|
# @param [String] fields
|
1471
1670
|
# Selector specifying which fields to include in a partial response.
|
1472
1671
|
# @param [String] quota_user
|
@@ -1648,21 +1847,21 @@ module Google
|
|
1648
1847
|
execute_or_queue_command(command, &block)
|
1649
1848
|
end
|
1650
1849
|
|
1651
|
-
# Lists the Products the reseller is authorized to sell. Possible
|
1652
|
-
# INVALID_ARGUMENT:
|
1850
|
+
# Lists the Products the reseller is authorized to sell. Possible error codes: *
|
1851
|
+
# INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
1653
1852
|
# @param [String] account
|
1654
1853
|
# Required. The resource name of the reseller account. Format: accounts/`
|
1655
1854
|
# account_id`.
|
1656
1855
|
# @param [String] language_code
|
1657
|
-
# Optional. The BCP-47 language code
|
1658
|
-
#
|
1659
|
-
# US".
|
1856
|
+
# Optional. The BCP-47 language code. For example, "en-US". The response will
|
1857
|
+
# localize in the corresponding language code, if specified. The default value
|
1858
|
+
# is "en-US".
|
1660
1859
|
# @param [Fixnum] page_size
|
1661
1860
|
# Optional. Requested page size. Server might return fewer results than
|
1662
|
-
# requested. If unspecified, at most 100 Products
|
1663
|
-
#
|
1861
|
+
# requested. If unspecified, returns at most 100 Products. The maximum value is
|
1862
|
+
# 1000; the server will coerce values above 1000.
|
1664
1863
|
# @param [String] page_token
|
1665
|
-
# Optional. A token
|
1864
|
+
# Optional. A token for a page of results other than the first page.
|
1666
1865
|
# @param [String] fields
|
1667
1866
|
# Selector specifying which fields to include in a partial response.
|
1668
1867
|
# @param [String] quota_user
|
@@ -1694,25 +1893,24 @@ module Google
|
|
1694
1893
|
end
|
1695
1894
|
|
1696
1895
|
# Lists the SKUs for a product the reseller is authorized to sell. Possible
|
1697
|
-
#
|
1698
|
-
#
|
1896
|
+
# error codes: * INVALID_ARGUMENT: Required request parameters are missing or
|
1897
|
+
# invalid.
|
1699
1898
|
# @param [String] parent
|
1700
|
-
# Required. The resource name of the Product
|
1701
|
-
#
|
1702
|
-
#
|
1899
|
+
# Required. The resource name of the Product to list SKUs for. Parent uses the
|
1900
|
+
# format: products/`product_id`. Supports products/- to retrieve SKUs for all
|
1901
|
+
# products.
|
1703
1902
|
# @param [String] account
|
1704
1903
|
# Required. Resource name of the reseller. Format: accounts/`account_id`.
|
1705
1904
|
# @param [String] language_code
|
1706
|
-
# Optional. The BCP-47 language code
|
1707
|
-
#
|
1708
|
-
# US".
|
1905
|
+
# Optional. The BCP-47 language code. For example, "en-US". The response will
|
1906
|
+
# localize in the corresponding language code, if specified. The default value
|
1907
|
+
# is "en-US".
|
1709
1908
|
# @param [Fixnum] page_size
|
1710
1909
|
# Optional. Requested page size. Server might return fewer results than
|
1711
|
-
# requested. If unspecified, at most 100 SKUs
|
1712
|
-
#
|
1910
|
+
# requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000;
|
1911
|
+
# the server will coerce values above 1000.
|
1713
1912
|
# @param [String] page_token
|
1714
|
-
# Optional. A token
|
1715
|
-
# Optional.
|
1913
|
+
# Optional. A token for a page of results other than the first page. Optional.
|
1716
1914
|
# @param [String] fields
|
1717
1915
|
# Selector specifying which fields to include in a partial response.
|
1718
1916
|
# @param [String] quota_user
|