google-cloud-channel-v1 0.9.0 → 0.9.4

Sign up to get free protection for your applications and to get access to all the features.
@@ -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
 
@@ -332,6 +354,21 @@ module Google
332
354
  #
333
355
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
334
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
+ #
335
372
  def get_customer request, options = nil
336
373
  raise ::ArgumentError, "request must be provided" if request.nil?
337
374
 
@@ -420,6 +457,21 @@ module Google
420
457
  #
421
458
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
422
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
+ #
423
475
  def check_cloud_identity_accounts_exist request, options = nil
424
476
  raise ::ArgumentError, "request must be provided" if request.nil?
425
477
 
@@ -505,6 +557,21 @@ module Google
505
557
  #
506
558
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
507
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
+ #
508
575
  def create_customer request, options = nil
509
576
  raise ::ArgumentError, "request must be provided" if request.nil?
510
577
 
@@ -589,6 +656,21 @@ module Google
589
656
  #
590
657
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
591
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
+ #
592
674
  def update_customer request, options = nil
593
675
  raise ::ArgumentError, "request must be provided" if request.nil?
594
676
 
@@ -667,6 +749,21 @@ module Google
667
749
  #
668
750
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
669
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
+ #
670
767
  def delete_customer request, options = nil
671
768
  raise ::ArgumentError, "request must be provided" if request.nil?
672
769
 
@@ -776,6 +873,21 @@ module Google
776
873
  #
777
874
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
778
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
+ #
779
891
  def import_customer request, options = nil
780
892
  raise ::ArgumentError, "request must be provided" if request.nil?
781
893
 
@@ -873,6 +985,28 @@ module Google
873
985
  #
874
986
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
875
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
+ #
876
1010
  def provision_cloud_identity request, options = nil
877
1011
  raise ::ArgumentError, "request must be provided" if request.nil?
878
1012
 
@@ -963,6 +1097,27 @@ module Google
963
1097
  #
964
1098
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
965
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
+ #
966
1121
  def list_entitlements request, options = nil
967
1122
  raise ::ArgumentError, "request must be provided" if request.nil?
968
1123
 
@@ -1080,6 +1235,27 @@ module Google
1080
1235
  #
1081
1236
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1082
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
+ #
1083
1259
  def list_transferable_skus request, options = nil
1084
1260
  raise ::ArgumentError, "request must be provided" if request.nil?
1085
1261
 
@@ -1188,6 +1364,27 @@ module Google
1188
1364
  #
1189
1365
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1190
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
+ #
1191
1388
  def list_transferable_offers request, options = nil
1192
1389
  raise ::ArgumentError, "request must be provided" if request.nil?
1193
1390
 
@@ -1270,6 +1467,21 @@ module Google
1270
1467
  #
1271
1468
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1272
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
+ #
1273
1485
  def get_entitlement request, options = nil
1274
1486
  raise ::ArgumentError, "request must be provided" if request.nil?
1275
1487
 
@@ -1391,6 +1603,28 @@ module Google
1391
1603
  #
1392
1604
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1393
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
+ #
1394
1628
  def create_entitlement request, options = nil
1395
1629
  raise ::ArgumentError, "request must be provided" if request.nil?
1396
1630
 
@@ -1479,6 +1713,9 @@ module Google
1479
1713
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
1480
1714
  # @param parameters [::Array<::Google::Cloud::Channel::V1::Parameter, ::Hash>]
1481
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.
1482
1719
  # @param request_id [::String]
1483
1720
  # Optional. You can specify an optional unique request ID, and if you need to retry
1484
1721
  # your request, the server will know to ignore the request if it's complete.
@@ -1502,6 +1739,28 @@ module Google
1502
1739
  #
1503
1740
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1504
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
+ #
1505
1764
  def change_parameters request, options = nil
1506
1765
  raise ::ArgumentError, "request must be provided" if request.nil?
1507
1766
 
@@ -1611,6 +1870,28 @@ module Google
1611
1870
  #
1612
1871
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1613
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
+ #
1614
1895
  def change_renewal_settings request, options = nil
1615
1896
  raise ::ArgumentError, "request must be provided" if request.nil?
1616
1897
 
@@ -1699,7 +1980,8 @@ module Google
1699
1980
  # Required. New Offer.
1700
1981
  # Format: accounts/\\{account_id}/offers/\\{offer_id}.
1701
1982
  # @param parameters [::Array<::Google::Cloud::Channel::V1::Parameter, ::Hash>]
1702
- # 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.
1703
1985
  # @param purchase_order_id [::String]
1704
1986
  # Optional. Purchase order id provided by the reseller.
1705
1987
  # @param request_id [::String]
@@ -1723,6 +2005,28 @@ module Google
1723
2005
  #
1724
2006
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1725
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
+ #
1726
2030
  def change_offer request, options = nil
1727
2031
  raise ::ArgumentError, "request must be provided" if request.nil?
1728
2032
 
@@ -1831,6 +2135,28 @@ module Google
1831
2135
  #
1832
2136
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1833
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
+ #
1834
2160
  def start_paid_service request, options = nil
1835
2161
  raise ::ArgumentError, "request must be provided" if request.nil?
1836
2162
 
@@ -1936,6 +2262,28 @@ module Google
1936
2262
  #
1937
2263
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1938
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
+ #
1939
2287
  def suspend_entitlement request, options = nil
1940
2288
  raise ::ArgumentError, "request must be provided" if request.nil?
1941
2289
 
@@ -2046,6 +2394,28 @@ module Google
2046
2394
  #
2047
2395
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2048
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
+ #
2049
2419
  def cancel_entitlement request, options = nil
2050
2420
  raise ::ArgumentError, "request must be provided" if request.nil?
2051
2421
 
@@ -2157,6 +2527,28 @@ module Google
2157
2527
  #
2158
2528
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2159
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
+ #
2160
2552
  def activate_entitlement request, options = nil
2161
2553
  raise ::ArgumentError, "request must be provided" if request.nil?
2162
2554
 
@@ -2277,6 +2669,28 @@ module Google
2277
2669
  #
2278
2670
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2279
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
+ #
2280
2694
  def transfer_entitlements request, options = nil
2281
2695
  raise ::ArgumentError, "request must be provided" if request.nil?
2282
2696
 
@@ -2392,6 +2806,28 @@ module Google
2392
2806
  #
2393
2807
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2394
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
+ #
2395
2831
  def transfer_entitlements_to_google request, options = nil
2396
2832
  raise ::ArgumentError, "request must be provided" if request.nil?
2397
2833
 
@@ -2486,6 +2922,27 @@ module Google
2486
2922
  #
2487
2923
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2488
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
+ #
2489
2946
  def list_channel_partner_links request, options = nil
2490
2947
  raise ::ArgumentError, "request must be provided" if request.nil?
2491
2948
 
@@ -2573,6 +3030,21 @@ module Google
2573
3030
  #
2574
3031
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2575
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
+ #
2576
3048
  def get_channel_partner_link request, options = nil
2577
3049
  raise ::ArgumentError, "request must be provided" if request.nil?
2578
3050
 
@@ -2670,6 +3142,21 @@ module Google
2670
3142
  #
2671
3143
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2672
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
+ #
2673
3160
  def create_channel_partner_link request, options = nil
2674
3161
  raise ::ArgumentError, "request must be provided" if request.nil?
2675
3162
 
@@ -2769,6 +3256,21 @@ module Google
2769
3256
  #
2770
3257
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2771
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
+ #
2772
3274
  def update_channel_partner_link request, options = nil
2773
3275
  raise ::ArgumentError, "request must be provided" if request.nil?
2774
3276
 
@@ -2850,6 +3352,21 @@ module Google
2850
3352
  #
2851
3353
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2852
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
+ #
2853
3370
  def lookup_offer request, options = nil
2854
3371
  raise ::ArgumentError, "request must be provided" if request.nil?
2855
3372
 
@@ -2935,6 +3452,27 @@ module Google
2935
3452
  #
2936
3453
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2937
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
+ #
2938
3476
  def list_products request, options = nil
2939
3477
  raise ::ArgumentError, "request must be provided" if request.nil?
2940
3478
 
@@ -3018,6 +3556,27 @@ module Google
3018
3556
  #
3019
3557
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3020
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
+ #
3021
3580
  def list_skus request, options = nil
3022
3581
  raise ::ArgumentError, "request must be provided" if request.nil?
3023
3582
 
@@ -3110,6 +3669,27 @@ module Google
3110
3669
  #
3111
3670
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3112
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
+ #
3113
3693
  def list_offers request, options = nil
3114
3694
  raise ::ArgumentError, "request must be provided" if request.nil?
3115
3695
 
@@ -3204,6 +3784,27 @@ module Google
3204
3784
  #
3205
3785
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3206
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
+ #
3207
3808
  def list_purchasable_skus request, options = nil
3208
3809
  raise ::ArgumentError, "request must be provided" if request.nil?
3209
3810
 
@@ -3298,6 +3899,27 @@ module Google
3298
3899
  #
3299
3900
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3300
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
+ #
3301
3923
  def list_purchasable_offers request, options = nil
3302
3924
  raise ::ArgumentError, "request must be provided" if request.nil?
3303
3925
 
@@ -3387,6 +4009,21 @@ module Google
3387
4009
  #
3388
4010
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3389
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
+ #
3390
4027
  def register_subscriber request, options = nil
3391
4028
  raise ::ArgumentError, "request must be provided" if request.nil?
3392
4029
 
@@ -3479,6 +4116,21 @@ module Google
3479
4116
  #
3480
4117
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3481
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
+ #
3482
4134
  def unregister_subscriber request, options = nil
3483
4135
  raise ::ArgumentError, "request must be provided" if request.nil?
3484
4136
 
@@ -3576,6 +4228,21 @@ module Google
3576
4228
  #
3577
4229
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3578
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
+ #
3579
4246
  def list_subscribers request, options = nil
3580
4247
  raise ::ArgumentError, "request must be provided" if request.nil?
3581
4248