google-cloud-channel-v1 0.8.0 → 0.9.3

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.
@@ -180,6 +180,7 @@ module Google
180
180
 
181
181
  @operations_client = Operations.new do |config|
182
182
  config.credentials = credentials
183
+ config.quota_project = @quota_project_id
183
184
  config.endpoint = @config.endpoint
184
185
  end
185
186
 
@@ -249,6 +250,27 @@ module Google
249
250
  #
250
251
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
251
252
  #
253
+ # @example Basic example
254
+ # require "google/cloud/channel/v1"
255
+ #
256
+ # # Create a client object. The client can be reused for multiple calls.
257
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
258
+ #
259
+ # # Create a request. To set request fields, pass in keyword arguments.
260
+ # request = Google::Cloud::Channel::V1::ListCustomersRequest.new
261
+ #
262
+ # # Call the list_customers method.
263
+ # result = client.list_customers request
264
+ #
265
+ # # The returned object is of type Gapic::PagedEnumerable. You can
266
+ # # iterate over all elements by calling #each, and the enumerable
267
+ # # will lazily make API calls to fetch subsequent pages. Other
268
+ # # methods are also available for managing paging directly.
269
+ # result.each do |response|
270
+ # # Each element is of type ::Google::Cloud::Channel::V1::Customer.
271
+ # p response
272
+ # end
273
+ #
252
274
  def list_customers request, options = nil
253
275
  raise ::ArgumentError, "request must be provided" if request.nil?
254
276
 
@@ -266,9 +288,11 @@ module Google
266
288
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
267
289
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
268
290
 
269
- header_params = {
270
- "parent" => request.parent
271
- }
291
+ header_params = {}
292
+ if request.parent
293
+ header_params["parent"] = request.parent
294
+ end
295
+
272
296
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
273
297
  metadata[:"x-goog-request-params"] ||= request_params_header
274
298
 
@@ -330,6 +354,21 @@ module Google
330
354
  #
331
355
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
332
356
  #
357
+ # @example Basic example
358
+ # require "google/cloud/channel/v1"
359
+ #
360
+ # # Create a client object. The client can be reused for multiple calls.
361
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
362
+ #
363
+ # # Create a request. To set request fields, pass in keyword arguments.
364
+ # request = Google::Cloud::Channel::V1::GetCustomerRequest.new
365
+ #
366
+ # # Call the get_customer method.
367
+ # result = client.get_customer request
368
+ #
369
+ # # The returned object is of type Google::Cloud::Channel::V1::Customer.
370
+ # p result
371
+ #
333
372
  def get_customer request, options = nil
334
373
  raise ::ArgumentError, "request must be provided" if request.nil?
335
374
 
@@ -347,9 +386,11 @@ module Google
347
386
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
348
387
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
349
388
 
350
- header_params = {
351
- "name" => request.name
352
- }
389
+ header_params = {}
390
+ if request.name
391
+ header_params["name"] = request.name
392
+ end
393
+
353
394
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
354
395
  metadata[:"x-goog-request-params"] ||= request_params_header
355
396
 
@@ -416,6 +457,21 @@ module Google
416
457
  #
417
458
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
418
459
  #
460
+ # @example Basic example
461
+ # require "google/cloud/channel/v1"
462
+ #
463
+ # # Create a client object. The client can be reused for multiple calls.
464
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
465
+ #
466
+ # # Create a request. To set request fields, pass in keyword arguments.
467
+ # request = Google::Cloud::Channel::V1::CheckCloudIdentityAccountsExistRequest.new
468
+ #
469
+ # # Call the check_cloud_identity_accounts_exist method.
470
+ # result = client.check_cloud_identity_accounts_exist request
471
+ #
472
+ # # The returned object is of type Google::Cloud::Channel::V1::CheckCloudIdentityAccountsExistResponse.
473
+ # p result
474
+ #
419
475
  def check_cloud_identity_accounts_exist request, options = nil
420
476
  raise ::ArgumentError, "request must be provided" if request.nil?
421
477
 
@@ -433,9 +489,11 @@ module Google
433
489
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
434
490
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
435
491
 
436
- header_params = {
437
- "parent" => request.parent
438
- }
492
+ header_params = {}
493
+ if request.parent
494
+ header_params["parent"] = request.parent
495
+ end
496
+
439
497
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
440
498
  metadata[:"x-goog-request-params"] ||= request_params_header
441
499
 
@@ -499,6 +557,21 @@ module Google
499
557
  #
500
558
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
501
559
  #
560
+ # @example Basic example
561
+ # require "google/cloud/channel/v1"
562
+ #
563
+ # # Create a client object. The client can be reused for multiple calls.
564
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
565
+ #
566
+ # # Create a request. To set request fields, pass in keyword arguments.
567
+ # request = Google::Cloud::Channel::V1::CreateCustomerRequest.new
568
+ #
569
+ # # Call the create_customer method.
570
+ # result = client.create_customer request
571
+ #
572
+ # # The returned object is of type Google::Cloud::Channel::V1::Customer.
573
+ # p result
574
+ #
502
575
  def create_customer request, options = nil
503
576
  raise ::ArgumentError, "request must be provided" if request.nil?
504
577
 
@@ -516,9 +589,11 @@ module Google
516
589
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
517
590
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
518
591
 
519
- header_params = {
520
- "parent" => request.parent
521
- }
592
+ header_params = {}
593
+ if request.parent
594
+ header_params["parent"] = request.parent
595
+ end
596
+
522
597
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
523
598
  metadata[:"x-goog-request-params"] ||= request_params_header
524
599
 
@@ -581,6 +656,21 @@ module Google
581
656
  #
582
657
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
583
658
  #
659
+ # @example Basic example
660
+ # require "google/cloud/channel/v1"
661
+ #
662
+ # # Create a client object. The client can be reused for multiple calls.
663
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
664
+ #
665
+ # # Create a request. To set request fields, pass in keyword arguments.
666
+ # request = Google::Cloud::Channel::V1::UpdateCustomerRequest.new
667
+ #
668
+ # # Call the update_customer method.
669
+ # result = client.update_customer request
670
+ #
671
+ # # The returned object is of type Google::Cloud::Channel::V1::Customer.
672
+ # p result
673
+ #
584
674
  def update_customer request, options = nil
585
675
  raise ::ArgumentError, "request must be provided" if request.nil?
586
676
 
@@ -598,9 +688,11 @@ module Google
598
688
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
599
689
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
600
690
 
601
- header_params = {
602
- "customer.name" => request.customer.name
603
- }
691
+ header_params = {}
692
+ if request.customer&.name
693
+ header_params["customer.name"] = request.customer.name
694
+ end
695
+
604
696
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
605
697
  metadata[:"x-goog-request-params"] ||= request_params_header
606
698
 
@@ -657,6 +749,21 @@ module Google
657
749
  #
658
750
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
659
751
  #
752
+ # @example Basic example
753
+ # require "google/cloud/channel/v1"
754
+ #
755
+ # # Create a client object. The client can be reused for multiple calls.
756
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
757
+ #
758
+ # # Create a request. To set request fields, pass in keyword arguments.
759
+ # request = Google::Cloud::Channel::V1::DeleteCustomerRequest.new
760
+ #
761
+ # # Call the delete_customer method.
762
+ # result = client.delete_customer request
763
+ #
764
+ # # The returned object is of type Google::Protobuf::Empty.
765
+ # p result
766
+ #
660
767
  def delete_customer request, options = nil
661
768
  raise ::ArgumentError, "request must be provided" if request.nil?
662
769
 
@@ -674,9 +781,11 @@ module Google
674
781
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
675
782
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
676
783
 
677
- header_params = {
678
- "name" => request.name
679
- }
784
+ header_params = {}
785
+ if request.name
786
+ header_params["name"] = request.name
787
+ end
788
+
680
789
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
681
790
  metadata[:"x-goog-request-params"] ||= request_params_header
682
791
 
@@ -764,6 +873,21 @@ module Google
764
873
  #
765
874
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
766
875
  #
876
+ # @example Basic example
877
+ # require "google/cloud/channel/v1"
878
+ #
879
+ # # Create a client object. The client can be reused for multiple calls.
880
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
881
+ #
882
+ # # Create a request. To set request fields, pass in keyword arguments.
883
+ # request = Google::Cloud::Channel::V1::ImportCustomerRequest.new
884
+ #
885
+ # # Call the import_customer method.
886
+ # result = client.import_customer request
887
+ #
888
+ # # The returned object is of type Google::Cloud::Channel::V1::Customer.
889
+ # p result
890
+ #
767
891
  def import_customer request, options = nil
768
892
  raise ::ArgumentError, "request must be provided" if request.nil?
769
893
 
@@ -781,9 +905,11 @@ module Google
781
905
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
782
906
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
783
907
 
784
- header_params = {
785
- "parent" => request.parent
786
- }
908
+ header_params = {}
909
+ if request.parent
910
+ header_params["parent"] = request.parent
911
+ end
912
+
787
913
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
788
914
  metadata[:"x-goog-request-params"] ||= request_params_header
789
915
 
@@ -859,6 +985,28 @@ module Google
859
985
  #
860
986
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
861
987
  #
988
+ # @example Basic example
989
+ # require "google/cloud/channel/v1"
990
+ #
991
+ # # Create a client object. The client can be reused for multiple calls.
992
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
993
+ #
994
+ # # Create a request. To set request fields, pass in keyword arguments.
995
+ # request = Google::Cloud::Channel::V1::ProvisionCloudIdentityRequest.new
996
+ #
997
+ # # Call the provision_cloud_identity method.
998
+ # result = client.provision_cloud_identity request
999
+ #
1000
+ # # The returned object is of type Gapic::Operation. You can use this
1001
+ # # object to check the status of an operation, cancel it, or wait
1002
+ # # for results. Here is how to block until completion:
1003
+ # result.wait_until_done! timeout: 60
1004
+ # if result.response?
1005
+ # p result.response
1006
+ # else
1007
+ # puts "Error!"
1008
+ # end
1009
+ #
862
1010
  def provision_cloud_identity request, options = nil
863
1011
  raise ::ArgumentError, "request must be provided" if request.nil?
864
1012
 
@@ -876,9 +1024,11 @@ module Google
876
1024
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
877
1025
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
878
1026
 
879
- header_params = {
880
- "customer" => request.customer
881
- }
1027
+ header_params = {}
1028
+ if request.customer
1029
+ header_params["customer"] = request.customer
1030
+ end
1031
+
882
1032
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
883
1033
  metadata[:"x-goog-request-params"] ||= request_params_header
884
1034
 
@@ -947,6 +1097,27 @@ module Google
947
1097
  #
948
1098
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
949
1099
  #
1100
+ # @example Basic example
1101
+ # require "google/cloud/channel/v1"
1102
+ #
1103
+ # # Create a client object. The client can be reused for multiple calls.
1104
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
1105
+ #
1106
+ # # Create a request. To set request fields, pass in keyword arguments.
1107
+ # request = Google::Cloud::Channel::V1::ListEntitlementsRequest.new
1108
+ #
1109
+ # # Call the list_entitlements method.
1110
+ # result = client.list_entitlements request
1111
+ #
1112
+ # # The returned object is of type Gapic::PagedEnumerable. You can
1113
+ # # iterate over all elements by calling #each, and the enumerable
1114
+ # # will lazily make API calls to fetch subsequent pages. Other
1115
+ # # methods are also available for managing paging directly.
1116
+ # result.each do |response|
1117
+ # # Each element is of type ::Google::Cloud::Channel::V1::Entitlement.
1118
+ # p response
1119
+ # end
1120
+ #
950
1121
  def list_entitlements request, options = nil
951
1122
  raise ::ArgumentError, "request must be provided" if request.nil?
952
1123
 
@@ -964,9 +1135,11 @@ module Google
964
1135
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
965
1136
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
966
1137
 
967
- header_params = {
968
- "parent" => request.parent
969
- }
1138
+ header_params = {}
1139
+ if request.parent
1140
+ header_params["parent"] = request.parent
1141
+ end
1142
+
970
1143
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
971
1144
  metadata[:"x-goog-request-params"] ||= request_params_header
972
1145
 
@@ -1062,6 +1235,27 @@ module Google
1062
1235
  #
1063
1236
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1064
1237
  #
1238
+ # @example Basic example
1239
+ # require "google/cloud/channel/v1"
1240
+ #
1241
+ # # Create a client object. The client can be reused for multiple calls.
1242
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
1243
+ #
1244
+ # # Create a request. To set request fields, pass in keyword arguments.
1245
+ # request = Google::Cloud::Channel::V1::ListTransferableSkusRequest.new
1246
+ #
1247
+ # # Call the list_transferable_skus method.
1248
+ # result = client.list_transferable_skus request
1249
+ #
1250
+ # # The returned object is of type Gapic::PagedEnumerable. You can
1251
+ # # iterate over all elements by calling #each, and the enumerable
1252
+ # # will lazily make API calls to fetch subsequent pages. Other
1253
+ # # methods are also available for managing paging directly.
1254
+ # result.each do |response|
1255
+ # # Each element is of type ::Google::Cloud::Channel::V1::TransferableSku.
1256
+ # p response
1257
+ # end
1258
+ #
1065
1259
  def list_transferable_skus request, options = nil
1066
1260
  raise ::ArgumentError, "request must be provided" if request.nil?
1067
1261
 
@@ -1079,9 +1273,11 @@ module Google
1079
1273
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
1080
1274
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1081
1275
 
1082
- header_params = {
1083
- "parent" => request.parent
1084
- }
1276
+ header_params = {}
1277
+ if request.parent
1278
+ header_params["parent"] = request.parent
1279
+ end
1280
+
1085
1281
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1086
1282
  metadata[:"x-goog-request-params"] ||= request_params_header
1087
1283
 
@@ -1168,6 +1364,27 @@ module Google
1168
1364
  #
1169
1365
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1170
1366
  #
1367
+ # @example Basic example
1368
+ # require "google/cloud/channel/v1"
1369
+ #
1370
+ # # Create a client object. The client can be reused for multiple calls.
1371
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
1372
+ #
1373
+ # # Create a request. To set request fields, pass in keyword arguments.
1374
+ # request = Google::Cloud::Channel::V1::ListTransferableOffersRequest.new
1375
+ #
1376
+ # # Call the list_transferable_offers method.
1377
+ # result = client.list_transferable_offers request
1378
+ #
1379
+ # # The returned object is of type Gapic::PagedEnumerable. You can
1380
+ # # iterate over all elements by calling #each, and the enumerable
1381
+ # # will lazily make API calls to fetch subsequent pages. Other
1382
+ # # methods are also available for managing paging directly.
1383
+ # result.each do |response|
1384
+ # # Each element is of type ::Google::Cloud::Channel::V1::TransferableOffer.
1385
+ # p response
1386
+ # end
1387
+ #
1171
1388
  def list_transferable_offers request, options = nil
1172
1389
  raise ::ArgumentError, "request must be provided" if request.nil?
1173
1390
 
@@ -1185,9 +1402,11 @@ module Google
1185
1402
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
1186
1403
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1187
1404
 
1188
- header_params = {
1189
- "parent" => request.parent
1190
- }
1405
+ header_params = {}
1406
+ if request.parent
1407
+ header_params["parent"] = request.parent
1408
+ end
1409
+
1191
1410
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1192
1411
  metadata[:"x-goog-request-params"] ||= request_params_header
1193
1412
 
@@ -1248,6 +1467,21 @@ module Google
1248
1467
  #
1249
1468
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1250
1469
  #
1470
+ # @example Basic example
1471
+ # require "google/cloud/channel/v1"
1472
+ #
1473
+ # # Create a client object. The client can be reused for multiple calls.
1474
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
1475
+ #
1476
+ # # Create a request. To set request fields, pass in keyword arguments.
1477
+ # request = Google::Cloud::Channel::V1::GetEntitlementRequest.new
1478
+ #
1479
+ # # Call the get_entitlement method.
1480
+ # result = client.get_entitlement request
1481
+ #
1482
+ # # The returned object is of type Google::Cloud::Channel::V1::Entitlement.
1483
+ # p result
1484
+ #
1251
1485
  def get_entitlement request, options = nil
1252
1486
  raise ::ArgumentError, "request must be provided" if request.nil?
1253
1487
 
@@ -1265,9 +1499,11 @@ module Google
1265
1499
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
1266
1500
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1267
1501
 
1268
- header_params = {
1269
- "name" => request.name
1270
- }
1502
+ header_params = {}
1503
+ if request.name
1504
+ header_params["name"] = request.name
1505
+ end
1506
+
1271
1507
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1272
1508
  metadata[:"x-goog-request-params"] ||= request_params_header
1273
1509
 
@@ -1367,6 +1603,28 @@ module Google
1367
1603
  #
1368
1604
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1369
1605
  #
1606
+ # @example Basic example
1607
+ # require "google/cloud/channel/v1"
1608
+ #
1609
+ # # Create a client object. The client can be reused for multiple calls.
1610
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
1611
+ #
1612
+ # # Create a request. To set request fields, pass in keyword arguments.
1613
+ # request = Google::Cloud::Channel::V1::CreateEntitlementRequest.new
1614
+ #
1615
+ # # Call the create_entitlement method.
1616
+ # result = client.create_entitlement request
1617
+ #
1618
+ # # The returned object is of type Gapic::Operation. You can use this
1619
+ # # object to check the status of an operation, cancel it, or wait
1620
+ # # for results. Here is how to block until completion:
1621
+ # result.wait_until_done! timeout: 60
1622
+ # if result.response?
1623
+ # p result.response
1624
+ # else
1625
+ # puts "Error!"
1626
+ # end
1627
+ #
1370
1628
  def create_entitlement request, options = nil
1371
1629
  raise ::ArgumentError, "request must be provided" if request.nil?
1372
1630
 
@@ -1384,9 +1642,11 @@ module Google
1384
1642
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
1385
1643
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1386
1644
 
1387
- header_params = {
1388
- "parent" => request.parent
1389
- }
1645
+ header_params = {}
1646
+ if request.parent
1647
+ header_params["parent"] = request.parent
1648
+ end
1649
+
1390
1650
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1391
1651
  metadata[:"x-goog-request-params"] ||= request_params_header
1392
1652
 
@@ -1453,6 +1713,9 @@ module Google
1453
1713
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
1454
1714
  # @param parameters [::Array<::Google::Cloud::Channel::V1::Parameter, ::Hash>]
1455
1715
  # Required. Entitlement parameters to update. You can only change editable parameters.
1716
+ #
1717
+ # To view the available Parameters for a request, refer to the
1718
+ # {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions} from the desired offer.
1456
1719
  # @param request_id [::String]
1457
1720
  # Optional. You can specify an optional unique request ID, and if you need to retry
1458
1721
  # your request, the server will know to ignore the request if it's complete.
@@ -1476,6 +1739,28 @@ module Google
1476
1739
  #
1477
1740
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1478
1741
  #
1742
+ # @example Basic example
1743
+ # require "google/cloud/channel/v1"
1744
+ #
1745
+ # # Create a client object. The client can be reused for multiple calls.
1746
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
1747
+ #
1748
+ # # Create a request. To set request fields, pass in keyword arguments.
1749
+ # request = Google::Cloud::Channel::V1::ChangeParametersRequest.new
1750
+ #
1751
+ # # Call the change_parameters method.
1752
+ # result = client.change_parameters request
1753
+ #
1754
+ # # The returned object is of type Gapic::Operation. You can use this
1755
+ # # object to check the status of an operation, cancel it, or wait
1756
+ # # for results. Here is how to block until completion:
1757
+ # result.wait_until_done! timeout: 60
1758
+ # if result.response?
1759
+ # p result.response
1760
+ # else
1761
+ # puts "Error!"
1762
+ # end
1763
+ #
1479
1764
  def change_parameters request, options = nil
1480
1765
  raise ::ArgumentError, "request must be provided" if request.nil?
1481
1766
 
@@ -1493,9 +1778,11 @@ module Google
1493
1778
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
1494
1779
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1495
1780
 
1496
- header_params = {
1497
- "name" => request.name
1498
- }
1781
+ header_params = {}
1782
+ if request.name
1783
+ header_params["name"] = request.name
1784
+ end
1785
+
1499
1786
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1500
1787
  metadata[:"x-goog-request-params"] ||= request_params_header
1501
1788
 
@@ -1583,6 +1870,28 @@ module Google
1583
1870
  #
1584
1871
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1585
1872
  #
1873
+ # @example Basic example
1874
+ # require "google/cloud/channel/v1"
1875
+ #
1876
+ # # Create a client object. The client can be reused for multiple calls.
1877
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
1878
+ #
1879
+ # # Create a request. To set request fields, pass in keyword arguments.
1880
+ # request = Google::Cloud::Channel::V1::ChangeRenewalSettingsRequest.new
1881
+ #
1882
+ # # Call the change_renewal_settings method.
1883
+ # result = client.change_renewal_settings request
1884
+ #
1885
+ # # The returned object is of type Gapic::Operation. You can use this
1886
+ # # object to check the status of an operation, cancel it, or wait
1887
+ # # for results. Here is how to block until completion:
1888
+ # result.wait_until_done! timeout: 60
1889
+ # if result.response?
1890
+ # p result.response
1891
+ # else
1892
+ # puts "Error!"
1893
+ # end
1894
+ #
1586
1895
  def change_renewal_settings request, options = nil
1587
1896
  raise ::ArgumentError, "request must be provided" if request.nil?
1588
1897
 
@@ -1600,9 +1909,11 @@ module Google
1600
1909
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
1601
1910
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1602
1911
 
1603
- header_params = {
1604
- "name" => request.name
1605
- }
1912
+ header_params = {}
1913
+ if request.name
1914
+ header_params["name"] = request.name
1915
+ end
1916
+
1606
1917
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1607
1918
  metadata[:"x-goog-request-params"] ||= request_params_header
1608
1919
 
@@ -1669,7 +1980,8 @@ module Google
1669
1980
  # Required. New Offer.
1670
1981
  # Format: accounts/\\{account_id}/offers/\\{offer_id}.
1671
1982
  # @param parameters [::Array<::Google::Cloud::Channel::V1::Parameter, ::Hash>]
1672
- # Optional. Parameters needed to purchase the Offer.
1983
+ # Optional. Parameters needed to purchase the Offer. To view the available Parameters
1984
+ # refer to the {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions} from the desired offer.
1673
1985
  # @param purchase_order_id [::String]
1674
1986
  # Optional. Purchase order id provided by the reseller.
1675
1987
  # @param request_id [::String]
@@ -1693,6 +2005,28 @@ module Google
1693
2005
  #
1694
2006
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1695
2007
  #
2008
+ # @example Basic example
2009
+ # require "google/cloud/channel/v1"
2010
+ #
2011
+ # # Create a client object. The client can be reused for multiple calls.
2012
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
2013
+ #
2014
+ # # Create a request. To set request fields, pass in keyword arguments.
2015
+ # request = Google::Cloud::Channel::V1::ChangeOfferRequest.new
2016
+ #
2017
+ # # Call the change_offer method.
2018
+ # result = client.change_offer request
2019
+ #
2020
+ # # The returned object is of type Gapic::Operation. You can use this
2021
+ # # object to check the status of an operation, cancel it, or wait
2022
+ # # for results. Here is how to block until completion:
2023
+ # result.wait_until_done! timeout: 60
2024
+ # if result.response?
2025
+ # p result.response
2026
+ # else
2027
+ # puts "Error!"
2028
+ # end
2029
+ #
1696
2030
  def change_offer request, options = nil
1697
2031
  raise ::ArgumentError, "request must be provided" if request.nil?
1698
2032
 
@@ -1710,9 +2044,11 @@ module Google
1710
2044
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
1711
2045
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1712
2046
 
1713
- header_params = {
1714
- "name" => request.name
1715
- }
2047
+ header_params = {}
2048
+ if request.name
2049
+ header_params["name"] = request.name
2050
+ end
2051
+
1716
2052
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1717
2053
  metadata[:"x-goog-request-params"] ||= request_params_header
1718
2054
 
@@ -1799,6 +2135,28 @@ module Google
1799
2135
  #
1800
2136
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1801
2137
  #
2138
+ # @example Basic example
2139
+ # require "google/cloud/channel/v1"
2140
+ #
2141
+ # # Create a client object. The client can be reused for multiple calls.
2142
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
2143
+ #
2144
+ # # Create a request. To set request fields, pass in keyword arguments.
2145
+ # request = Google::Cloud::Channel::V1::StartPaidServiceRequest.new
2146
+ #
2147
+ # # Call the start_paid_service method.
2148
+ # result = client.start_paid_service request
2149
+ #
2150
+ # # The returned object is of type Gapic::Operation. You can use this
2151
+ # # object to check the status of an operation, cancel it, or wait
2152
+ # # for results. Here is how to block until completion:
2153
+ # result.wait_until_done! timeout: 60
2154
+ # if result.response?
2155
+ # p result.response
2156
+ # else
2157
+ # puts "Error!"
2158
+ # end
2159
+ #
1802
2160
  def start_paid_service request, options = nil
1803
2161
  raise ::ArgumentError, "request must be provided" if request.nil?
1804
2162
 
@@ -1816,9 +2174,11 @@ module Google
1816
2174
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
1817
2175
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1818
2176
 
1819
- header_params = {
1820
- "name" => request.name
1821
- }
2177
+ header_params = {}
2178
+ if request.name
2179
+ header_params["name"] = request.name
2180
+ end
2181
+
1822
2182
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1823
2183
  metadata[:"x-goog-request-params"] ||= request_params_header
1824
2184
 
@@ -1902,6 +2262,28 @@ module Google
1902
2262
  #
1903
2263
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1904
2264
  #
2265
+ # @example Basic example
2266
+ # require "google/cloud/channel/v1"
2267
+ #
2268
+ # # Create a client object. The client can be reused for multiple calls.
2269
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
2270
+ #
2271
+ # # Create a request. To set request fields, pass in keyword arguments.
2272
+ # request = Google::Cloud::Channel::V1::SuspendEntitlementRequest.new
2273
+ #
2274
+ # # Call the suspend_entitlement method.
2275
+ # result = client.suspend_entitlement request
2276
+ #
2277
+ # # The returned object is of type Gapic::Operation. You can use this
2278
+ # # object to check the status of an operation, cancel it, or wait
2279
+ # # for results. Here is how to block until completion:
2280
+ # result.wait_until_done! timeout: 60
2281
+ # if result.response?
2282
+ # p result.response
2283
+ # else
2284
+ # puts "Error!"
2285
+ # end
2286
+ #
1905
2287
  def suspend_entitlement request, options = nil
1906
2288
  raise ::ArgumentError, "request must be provided" if request.nil?
1907
2289
 
@@ -1919,9 +2301,11 @@ module Google
1919
2301
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
1920
2302
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1921
2303
 
1922
- header_params = {
1923
- "name" => request.name
1924
- }
2304
+ header_params = {}
2305
+ if request.name
2306
+ header_params["name"] = request.name
2307
+ end
2308
+
1925
2309
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1926
2310
  metadata[:"x-goog-request-params"] ||= request_params_header
1927
2311
 
@@ -2010,6 +2394,28 @@ module Google
2010
2394
  #
2011
2395
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2012
2396
  #
2397
+ # @example Basic example
2398
+ # require "google/cloud/channel/v1"
2399
+ #
2400
+ # # Create a client object. The client can be reused for multiple calls.
2401
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
2402
+ #
2403
+ # # Create a request. To set request fields, pass in keyword arguments.
2404
+ # request = Google::Cloud::Channel::V1::CancelEntitlementRequest.new
2405
+ #
2406
+ # # Call the cancel_entitlement method.
2407
+ # result = client.cancel_entitlement request
2408
+ #
2409
+ # # The returned object is of type Gapic::Operation. You can use this
2410
+ # # object to check the status of an operation, cancel it, or wait
2411
+ # # for results. Here is how to block until completion:
2412
+ # result.wait_until_done! timeout: 60
2413
+ # if result.response?
2414
+ # p result.response
2415
+ # else
2416
+ # puts "Error!"
2417
+ # end
2418
+ #
2013
2419
  def cancel_entitlement request, options = nil
2014
2420
  raise ::ArgumentError, "request must be provided" if request.nil?
2015
2421
 
@@ -2027,9 +2433,11 @@ module Google
2027
2433
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
2028
2434
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2029
2435
 
2030
- header_params = {
2031
- "name" => request.name
2032
- }
2436
+ header_params = {}
2437
+ if request.name
2438
+ header_params["name"] = request.name
2439
+ end
2440
+
2033
2441
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2034
2442
  metadata[:"x-goog-request-params"] ||= request_params_header
2035
2443
 
@@ -2119,6 +2527,28 @@ module Google
2119
2527
  #
2120
2528
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2121
2529
  #
2530
+ # @example Basic example
2531
+ # require "google/cloud/channel/v1"
2532
+ #
2533
+ # # Create a client object. The client can be reused for multiple calls.
2534
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
2535
+ #
2536
+ # # Create a request. To set request fields, pass in keyword arguments.
2537
+ # request = Google::Cloud::Channel::V1::ActivateEntitlementRequest.new
2538
+ #
2539
+ # # Call the activate_entitlement method.
2540
+ # result = client.activate_entitlement request
2541
+ #
2542
+ # # The returned object is of type Gapic::Operation. You can use this
2543
+ # # object to check the status of an operation, cancel it, or wait
2544
+ # # for results. Here is how to block until completion:
2545
+ # result.wait_until_done! timeout: 60
2546
+ # if result.response?
2547
+ # p result.response
2548
+ # else
2549
+ # puts "Error!"
2550
+ # end
2551
+ #
2122
2552
  def activate_entitlement request, options = nil
2123
2553
  raise ::ArgumentError, "request must be provided" if request.nil?
2124
2554
 
@@ -2136,9 +2566,11 @@ module Google
2136
2566
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
2137
2567
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2138
2568
 
2139
- header_params = {
2140
- "name" => request.name
2141
- }
2569
+ header_params = {}
2570
+ if request.name
2571
+ header_params["name"] = request.name
2572
+ end
2573
+
2142
2574
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2143
2575
  metadata[:"x-goog-request-params"] ||= request_params_header
2144
2576
 
@@ -2237,6 +2669,28 @@ module Google
2237
2669
  #
2238
2670
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2239
2671
  #
2672
+ # @example Basic example
2673
+ # require "google/cloud/channel/v1"
2674
+ #
2675
+ # # Create a client object. The client can be reused for multiple calls.
2676
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
2677
+ #
2678
+ # # Create a request. To set request fields, pass in keyword arguments.
2679
+ # request = Google::Cloud::Channel::V1::TransferEntitlementsRequest.new
2680
+ #
2681
+ # # Call the transfer_entitlements method.
2682
+ # result = client.transfer_entitlements request
2683
+ #
2684
+ # # The returned object is of type Gapic::Operation. You can use this
2685
+ # # object to check the status of an operation, cancel it, or wait
2686
+ # # for results. Here is how to block until completion:
2687
+ # result.wait_until_done! timeout: 60
2688
+ # if result.response?
2689
+ # p result.response
2690
+ # else
2691
+ # puts "Error!"
2692
+ # end
2693
+ #
2240
2694
  def transfer_entitlements request, options = nil
2241
2695
  raise ::ArgumentError, "request must be provided" if request.nil?
2242
2696
 
@@ -2254,9 +2708,11 @@ module Google
2254
2708
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
2255
2709
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2256
2710
 
2257
- header_params = {
2258
- "parent" => request.parent
2259
- }
2711
+ header_params = {}
2712
+ if request.parent
2713
+ header_params["parent"] = request.parent
2714
+ end
2715
+
2260
2716
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2261
2717
  metadata[:"x-goog-request-params"] ||= request_params_header
2262
2718
 
@@ -2350,6 +2806,28 @@ module Google
2350
2806
  #
2351
2807
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2352
2808
  #
2809
+ # @example Basic example
2810
+ # require "google/cloud/channel/v1"
2811
+ #
2812
+ # # Create a client object. The client can be reused for multiple calls.
2813
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
2814
+ #
2815
+ # # Create a request. To set request fields, pass in keyword arguments.
2816
+ # request = Google::Cloud::Channel::V1::TransferEntitlementsToGoogleRequest.new
2817
+ #
2818
+ # # Call the transfer_entitlements_to_google method.
2819
+ # result = client.transfer_entitlements_to_google request
2820
+ #
2821
+ # # The returned object is of type Gapic::Operation. You can use this
2822
+ # # object to check the status of an operation, cancel it, or wait
2823
+ # # for results. Here is how to block until completion:
2824
+ # result.wait_until_done! timeout: 60
2825
+ # if result.response?
2826
+ # p result.response
2827
+ # else
2828
+ # puts "Error!"
2829
+ # end
2830
+ #
2353
2831
  def transfer_entitlements_to_google request, options = nil
2354
2832
  raise ::ArgumentError, "request must be provided" if request.nil?
2355
2833
 
@@ -2367,9 +2845,11 @@ module Google
2367
2845
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
2368
2846
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2369
2847
 
2370
- header_params = {
2371
- "parent" => request.parent
2372
- }
2848
+ header_params = {}
2849
+ if request.parent
2850
+ header_params["parent"] = request.parent
2851
+ end
2852
+
2373
2853
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2374
2854
  metadata[:"x-goog-request-params"] ||= request_params_header
2375
2855
 
@@ -2442,6 +2922,27 @@ module Google
2442
2922
  #
2443
2923
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2444
2924
  #
2925
+ # @example Basic example
2926
+ # require "google/cloud/channel/v1"
2927
+ #
2928
+ # # Create a client object. The client can be reused for multiple calls.
2929
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
2930
+ #
2931
+ # # Create a request. To set request fields, pass in keyword arguments.
2932
+ # request = Google::Cloud::Channel::V1::ListChannelPartnerLinksRequest.new
2933
+ #
2934
+ # # Call the list_channel_partner_links method.
2935
+ # result = client.list_channel_partner_links request
2936
+ #
2937
+ # # The returned object is of type Gapic::PagedEnumerable. You can
2938
+ # # iterate over all elements by calling #each, and the enumerable
2939
+ # # will lazily make API calls to fetch subsequent pages. Other
2940
+ # # methods are also available for managing paging directly.
2941
+ # result.each do |response|
2942
+ # # Each element is of type ::Google::Cloud::Channel::V1::ChannelPartnerLink.
2943
+ # p response
2944
+ # end
2945
+ #
2445
2946
  def list_channel_partner_links request, options = nil
2446
2947
  raise ::ArgumentError, "request must be provided" if request.nil?
2447
2948
 
@@ -2459,9 +2960,11 @@ module Google
2459
2960
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
2460
2961
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2461
2962
 
2462
- header_params = {
2463
- "parent" => request.parent
2464
- }
2963
+ header_params = {}
2964
+ if request.parent
2965
+ header_params["parent"] = request.parent
2966
+ end
2967
+
2465
2968
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2466
2969
  metadata[:"x-goog-request-params"] ||= request_params_header
2467
2970
 
@@ -2527,6 +3030,21 @@ module Google
2527
3030
  #
2528
3031
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2529
3032
  #
3033
+ # @example Basic example
3034
+ # require "google/cloud/channel/v1"
3035
+ #
3036
+ # # Create a client object. The client can be reused for multiple calls.
3037
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
3038
+ #
3039
+ # # Create a request. To set request fields, pass in keyword arguments.
3040
+ # request = Google::Cloud::Channel::V1::GetChannelPartnerLinkRequest.new
3041
+ #
3042
+ # # Call the get_channel_partner_link method.
3043
+ # result = client.get_channel_partner_link request
3044
+ #
3045
+ # # The returned object is of type Google::Cloud::Channel::V1::ChannelPartnerLink.
3046
+ # p result
3047
+ #
2530
3048
  def get_channel_partner_link request, options = nil
2531
3049
  raise ::ArgumentError, "request must be provided" if request.nil?
2532
3050
 
@@ -2544,9 +3062,11 @@ module Google
2544
3062
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
2545
3063
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2546
3064
 
2547
- header_params = {
2548
- "name" => request.name
2549
- }
3065
+ header_params = {}
3066
+ if request.name
3067
+ header_params["name"] = request.name
3068
+ end
3069
+
2550
3070
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2551
3071
  metadata[:"x-goog-request-params"] ||= request_params_header
2552
3072
 
@@ -2622,6 +3142,21 @@ module Google
2622
3142
  #
2623
3143
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2624
3144
  #
3145
+ # @example Basic example
3146
+ # require "google/cloud/channel/v1"
3147
+ #
3148
+ # # Create a client object. The client can be reused for multiple calls.
3149
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
3150
+ #
3151
+ # # Create a request. To set request fields, pass in keyword arguments.
3152
+ # request = Google::Cloud::Channel::V1::CreateChannelPartnerLinkRequest.new
3153
+ #
3154
+ # # Call the create_channel_partner_link method.
3155
+ # result = client.create_channel_partner_link request
3156
+ #
3157
+ # # The returned object is of type Google::Cloud::Channel::V1::ChannelPartnerLink.
3158
+ # p result
3159
+ #
2625
3160
  def create_channel_partner_link request, options = nil
2626
3161
  raise ::ArgumentError, "request must be provided" if request.nil?
2627
3162
 
@@ -2639,9 +3174,11 @@ module Google
2639
3174
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
2640
3175
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2641
3176
 
2642
- header_params = {
2643
- "parent" => request.parent
2644
- }
3177
+ header_params = {}
3178
+ if request.parent
3179
+ header_params["parent"] = request.parent
3180
+ end
3181
+
2645
3182
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2646
3183
  metadata[:"x-goog-request-params"] ||= request_params_header
2647
3184
 
@@ -2719,6 +3256,21 @@ module Google
2719
3256
  #
2720
3257
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2721
3258
  #
3259
+ # @example Basic example
3260
+ # require "google/cloud/channel/v1"
3261
+ #
3262
+ # # Create a client object. The client can be reused for multiple calls.
3263
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
3264
+ #
3265
+ # # Create a request. To set request fields, pass in keyword arguments.
3266
+ # request = Google::Cloud::Channel::V1::UpdateChannelPartnerLinkRequest.new
3267
+ #
3268
+ # # Call the update_channel_partner_link method.
3269
+ # result = client.update_channel_partner_link request
3270
+ #
3271
+ # # The returned object is of type Google::Cloud::Channel::V1::ChannelPartnerLink.
3272
+ # p result
3273
+ #
2722
3274
  def update_channel_partner_link request, options = nil
2723
3275
  raise ::ArgumentError, "request must be provided" if request.nil?
2724
3276
 
@@ -2736,9 +3288,11 @@ module Google
2736
3288
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
2737
3289
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2738
3290
 
2739
- header_params = {
2740
- "name" => request.name
2741
- }
3291
+ header_params = {}
3292
+ if request.name
3293
+ header_params["name"] = request.name
3294
+ end
3295
+
2742
3296
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2743
3297
  metadata[:"x-goog-request-params"] ||= request_params_header
2744
3298
 
@@ -2798,6 +3352,21 @@ module Google
2798
3352
  #
2799
3353
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2800
3354
  #
3355
+ # @example Basic example
3356
+ # require "google/cloud/channel/v1"
3357
+ #
3358
+ # # Create a client object. The client can be reused for multiple calls.
3359
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
3360
+ #
3361
+ # # Create a request. To set request fields, pass in keyword arguments.
3362
+ # request = Google::Cloud::Channel::V1::LookupOfferRequest.new
3363
+ #
3364
+ # # Call the lookup_offer method.
3365
+ # result = client.lookup_offer request
3366
+ #
3367
+ # # The returned object is of type Google::Cloud::Channel::V1::Offer.
3368
+ # p result
3369
+ #
2801
3370
  def lookup_offer request, options = nil
2802
3371
  raise ::ArgumentError, "request must be provided" if request.nil?
2803
3372
 
@@ -2815,9 +3384,11 @@ module Google
2815
3384
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
2816
3385
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2817
3386
 
2818
- header_params = {
2819
- "entitlement" => request.entitlement
2820
- }
3387
+ header_params = {}
3388
+ if request.entitlement
3389
+ header_params["entitlement"] = request.entitlement
3390
+ end
3391
+
2821
3392
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2822
3393
  metadata[:"x-goog-request-params"] ||= request_params_header
2823
3394
 
@@ -2881,6 +3452,27 @@ module Google
2881
3452
  #
2882
3453
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2883
3454
  #
3455
+ # @example Basic example
3456
+ # require "google/cloud/channel/v1"
3457
+ #
3458
+ # # Create a client object. The client can be reused for multiple calls.
3459
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
3460
+ #
3461
+ # # Create a request. To set request fields, pass in keyword arguments.
3462
+ # request = Google::Cloud::Channel::V1::ListProductsRequest.new
3463
+ #
3464
+ # # Call the list_products method.
3465
+ # result = client.list_products request
3466
+ #
3467
+ # # The returned object is of type Gapic::PagedEnumerable. You can
3468
+ # # iterate over all elements by calling #each, and the enumerable
3469
+ # # will lazily make API calls to fetch subsequent pages. Other
3470
+ # # methods are also available for managing paging directly.
3471
+ # result.each do |response|
3472
+ # # Each element is of type ::Google::Cloud::Channel::V1::Product.
3473
+ # p response
3474
+ # end
3475
+ #
2884
3476
  def list_products request, options = nil
2885
3477
  raise ::ArgumentError, "request must be provided" if request.nil?
2886
3478
 
@@ -2964,6 +3556,27 @@ module Google
2964
3556
  #
2965
3557
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2966
3558
  #
3559
+ # @example Basic example
3560
+ # require "google/cloud/channel/v1"
3561
+ #
3562
+ # # Create a client object. The client can be reused for multiple calls.
3563
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
3564
+ #
3565
+ # # Create a request. To set request fields, pass in keyword arguments.
3566
+ # request = Google::Cloud::Channel::V1::ListSkusRequest.new
3567
+ #
3568
+ # # Call the list_skus method.
3569
+ # result = client.list_skus request
3570
+ #
3571
+ # # The returned object is of type Gapic::PagedEnumerable. You can
3572
+ # # iterate over all elements by calling #each, and the enumerable
3573
+ # # will lazily make API calls to fetch subsequent pages. Other
3574
+ # # methods are also available for managing paging directly.
3575
+ # result.each do |response|
3576
+ # # Each element is of type ::Google::Cloud::Channel::V1::Sku.
3577
+ # p response
3578
+ # end
3579
+ #
2967
3580
  def list_skus request, options = nil
2968
3581
  raise ::ArgumentError, "request must be provided" if request.nil?
2969
3582
 
@@ -2981,9 +3594,11 @@ module Google
2981
3594
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
2982
3595
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2983
3596
 
2984
- header_params = {
2985
- "parent" => request.parent
2986
- }
3597
+ header_params = {}
3598
+ if request.parent
3599
+ header_params["parent"] = request.parent
3600
+ end
3601
+
2987
3602
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2988
3603
  metadata[:"x-goog-request-params"] ||= request_params_header
2989
3604
 
@@ -3054,6 +3669,27 @@ module Google
3054
3669
  #
3055
3670
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3056
3671
  #
3672
+ # @example Basic example
3673
+ # require "google/cloud/channel/v1"
3674
+ #
3675
+ # # Create a client object. The client can be reused for multiple calls.
3676
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
3677
+ #
3678
+ # # Create a request. To set request fields, pass in keyword arguments.
3679
+ # request = Google::Cloud::Channel::V1::ListOffersRequest.new
3680
+ #
3681
+ # # Call the list_offers method.
3682
+ # result = client.list_offers request
3683
+ #
3684
+ # # The returned object is of type Gapic::PagedEnumerable. You can
3685
+ # # iterate over all elements by calling #each, and the enumerable
3686
+ # # will lazily make API calls to fetch subsequent pages. Other
3687
+ # # methods are also available for managing paging directly.
3688
+ # result.each do |response|
3689
+ # # Each element is of type ::Google::Cloud::Channel::V1::Offer.
3690
+ # p response
3691
+ # end
3692
+ #
3057
3693
  def list_offers request, options = nil
3058
3694
  raise ::ArgumentError, "request must be provided" if request.nil?
3059
3695
 
@@ -3071,9 +3707,11 @@ module Google
3071
3707
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
3072
3708
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3073
3709
 
3074
- header_params = {
3075
- "parent" => request.parent
3076
- }
3710
+ header_params = {}
3711
+ if request.parent
3712
+ header_params["parent"] = request.parent
3713
+ end
3714
+
3077
3715
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3078
3716
  metadata[:"x-goog-request-params"] ||= request_params_header
3079
3717
 
@@ -3146,6 +3784,27 @@ module Google
3146
3784
  #
3147
3785
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3148
3786
  #
3787
+ # @example Basic example
3788
+ # require "google/cloud/channel/v1"
3789
+ #
3790
+ # # Create a client object. The client can be reused for multiple calls.
3791
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
3792
+ #
3793
+ # # Create a request. To set request fields, pass in keyword arguments.
3794
+ # request = Google::Cloud::Channel::V1::ListPurchasableSkusRequest.new
3795
+ #
3796
+ # # Call the list_purchasable_skus method.
3797
+ # result = client.list_purchasable_skus request
3798
+ #
3799
+ # # The returned object is of type Gapic::PagedEnumerable. You can
3800
+ # # iterate over all elements by calling #each, and the enumerable
3801
+ # # will lazily make API calls to fetch subsequent pages. Other
3802
+ # # methods are also available for managing paging directly.
3803
+ # result.each do |response|
3804
+ # # Each element is of type ::Google::Cloud::Channel::V1::PurchasableSku.
3805
+ # p response
3806
+ # end
3807
+ #
3149
3808
  def list_purchasable_skus request, options = nil
3150
3809
  raise ::ArgumentError, "request must be provided" if request.nil?
3151
3810
 
@@ -3163,9 +3822,11 @@ module Google
3163
3822
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
3164
3823
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3165
3824
 
3166
- header_params = {
3167
- "customer" => request.customer
3168
- }
3825
+ header_params = {}
3826
+ if request.customer
3827
+ header_params["customer"] = request.customer
3828
+ end
3829
+
3169
3830
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3170
3831
  metadata[:"x-goog-request-params"] ||= request_params_header
3171
3832
 
@@ -3238,6 +3899,27 @@ module Google
3238
3899
  #
3239
3900
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3240
3901
  #
3902
+ # @example Basic example
3903
+ # require "google/cloud/channel/v1"
3904
+ #
3905
+ # # Create a client object. The client can be reused for multiple calls.
3906
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
3907
+ #
3908
+ # # Create a request. To set request fields, pass in keyword arguments.
3909
+ # request = Google::Cloud::Channel::V1::ListPurchasableOffersRequest.new
3910
+ #
3911
+ # # Call the list_purchasable_offers method.
3912
+ # result = client.list_purchasable_offers request
3913
+ #
3914
+ # # The returned object is of type Gapic::PagedEnumerable. You can
3915
+ # # iterate over all elements by calling #each, and the enumerable
3916
+ # # will lazily make API calls to fetch subsequent pages. Other
3917
+ # # methods are also available for managing paging directly.
3918
+ # result.each do |response|
3919
+ # # Each element is of type ::Google::Cloud::Channel::V1::PurchasableOffer.
3920
+ # p response
3921
+ # end
3922
+ #
3241
3923
  def list_purchasable_offers request, options = nil
3242
3924
  raise ::ArgumentError, "request must be provided" if request.nil?
3243
3925
 
@@ -3255,9 +3937,11 @@ module Google
3255
3937
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
3256
3938
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3257
3939
 
3258
- header_params = {
3259
- "customer" => request.customer
3260
- }
3940
+ header_params = {}
3941
+ if request.customer
3942
+ header_params["customer"] = request.customer
3943
+ end
3944
+
3261
3945
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3262
3946
  metadata[:"x-goog-request-params"] ||= request_params_header
3263
3947
 
@@ -3325,6 +4009,21 @@ module Google
3325
4009
  #
3326
4010
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3327
4011
  #
4012
+ # @example Basic example
4013
+ # require "google/cloud/channel/v1"
4014
+ #
4015
+ # # Create a client object. The client can be reused for multiple calls.
4016
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
4017
+ #
4018
+ # # Create a request. To set request fields, pass in keyword arguments.
4019
+ # request = Google::Cloud::Channel::V1::RegisterSubscriberRequest.new
4020
+ #
4021
+ # # Call the register_subscriber method.
4022
+ # result = client.register_subscriber request
4023
+ #
4024
+ # # The returned object is of type Google::Cloud::Channel::V1::RegisterSubscriberResponse.
4025
+ # p result
4026
+ #
3328
4027
  def register_subscriber request, options = nil
3329
4028
  raise ::ArgumentError, "request must be provided" if request.nil?
3330
4029
 
@@ -3342,9 +4041,11 @@ module Google
3342
4041
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
3343
4042
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3344
4043
 
3345
- header_params = {
3346
- "account" => request.account
3347
- }
4044
+ header_params = {}
4045
+ if request.account
4046
+ header_params["account"] = request.account
4047
+ end
4048
+
3348
4049
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3349
4050
  metadata[:"x-goog-request-params"] ||= request_params_header
3350
4051
 
@@ -3415,6 +4116,21 @@ module Google
3415
4116
  #
3416
4117
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3417
4118
  #
4119
+ # @example Basic example
4120
+ # require "google/cloud/channel/v1"
4121
+ #
4122
+ # # Create a client object. The client can be reused for multiple calls.
4123
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
4124
+ #
4125
+ # # Create a request. To set request fields, pass in keyword arguments.
4126
+ # request = Google::Cloud::Channel::V1::UnregisterSubscriberRequest.new
4127
+ #
4128
+ # # Call the unregister_subscriber method.
4129
+ # result = client.unregister_subscriber request
4130
+ #
4131
+ # # The returned object is of type Google::Cloud::Channel::V1::UnregisterSubscriberResponse.
4132
+ # p result
4133
+ #
3418
4134
  def unregister_subscriber request, options = nil
3419
4135
  raise ::ArgumentError, "request must be provided" if request.nil?
3420
4136
 
@@ -3432,9 +4148,11 @@ module Google
3432
4148
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
3433
4149
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3434
4150
 
3435
- header_params = {
3436
- "account" => request.account
3437
- }
4151
+ header_params = {}
4152
+ if request.account
4153
+ header_params["account"] = request.account
4154
+ end
4155
+
3438
4156
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3439
4157
  metadata[:"x-goog-request-params"] ||= request_params_header
3440
4158
 
@@ -3510,6 +4228,21 @@ module Google
3510
4228
  #
3511
4229
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3512
4230
  #
4231
+ # @example Basic example
4232
+ # require "google/cloud/channel/v1"
4233
+ #
4234
+ # # Create a client object. The client can be reused for multiple calls.
4235
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
4236
+ #
4237
+ # # Create a request. To set request fields, pass in keyword arguments.
4238
+ # request = Google::Cloud::Channel::V1::ListSubscribersRequest.new
4239
+ #
4240
+ # # Call the list_subscribers method.
4241
+ # result = client.list_subscribers request
4242
+ #
4243
+ # # The returned object is of type Google::Cloud::Channel::V1::ListSubscribersResponse.
4244
+ # p result
4245
+ #
3513
4246
  def list_subscribers request, options = nil
3514
4247
  raise ::ArgumentError, "request must be provided" if request.nil?
3515
4248
 
@@ -3527,9 +4260,11 @@ module Google
3527
4260
  gapic_version: ::Google::Cloud::Channel::V1::VERSION
3528
4261
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3529
4262
 
3530
- header_params = {
3531
- "account" => request.account
3532
- }
4263
+ header_params = {}
4264
+ if request.account
4265
+ header_params["account"] = request.account
4266
+ end
4267
+
3533
4268
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3534
4269
  metadata[:"x-goog-request-params"] ||= request_params_header
3535
4270