google-cloud-channel-v1 0.13.0 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -37,15 +37,16 @@ module Google
37
37
  # 3. Resellers and distributors can manage customer entitlements.
38
38
  #
39
39
  # CloudChannelService exposes the following resources:
40
- # - {::Google::Cloud::Channel::V1::Customer Customer}s: An entityusually an enterprise—managed by a reseller or
41
- # distributor.
40
+ # - {::Google::Cloud::Channel::V1::Customer Customer}s: An entity-usually an
41
+ # enterprise-managed by a reseller or distributor.
42
42
  #
43
- # - {::Google::Cloud::Channel::V1::Entitlement Entitlement}s: An entity that provides a customer with the means to use
44
- # a service. Entitlements are created or updated as a result of a successful
45
- # fulfillment.
43
+ # - {::Google::Cloud::Channel::V1::Entitlement Entitlement}s: An entity that
44
+ # provides a customer with the means to use a service. Entitlements are created
45
+ # or updated as a result of a successful fulfillment.
46
46
  #
47
- # - {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s: An entity that identifies links between
48
- # distributors and their indirect resellers in a channel.
47
+ # - {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s: An
48
+ # entity that identifies links between distributors and their indirect
49
+ # resellers in a channel.
49
50
  #
50
51
  class Client
51
52
  include Paths
@@ -212,7 +213,8 @@ module Google
212
213
  # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
213
214
  #
214
215
  # Return value:
215
- # List of {::Google::Cloud::Channel::V1::Customer Customer}s, or an empty list if there are no customers.
216
+ # List of {::Google::Cloud::Channel::V1::Customer Customer}s, or an empty list if
217
+ # there are no customers.
216
218
  #
217
219
  # @overload list_customers(request, options = nil)
218
220
  # Pass arguments to `list_customers` via a request object, either of type
@@ -233,16 +235,19 @@ module Google
233
235
  # Required. The resource name of the reseller account to list customers from.
234
236
  # Parent uses the format: accounts/\\{account_id}.
235
237
  # @param page_size [::Integer]
236
- # Optional. The maximum number of customers to return. The service may return fewer
237
- # than this value. If unspecified, returns at most 10 customers. The
238
+ # Optional. The maximum number of customers to return. The service may return
239
+ # fewer than this value. If unspecified, returns at most 10 customers. The
238
240
  # maximum value is 50.
239
241
  # @param page_token [::String]
240
242
  # Optional. A token identifying a page of results other than the first page.
241
243
  # Obtained through
242
- # {::Google::Cloud::Channel::V1::ListCustomersResponse#next_page_token ListCustomersResponse.next_page_token} of the previous
243
- # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_customers CloudChannelService.ListCustomers} call.
244
+ # {::Google::Cloud::Channel::V1::ListCustomersResponse#next_page_token ListCustomersResponse.next_page_token}
245
+ # of the previous
246
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_customers CloudChannelService.ListCustomers}
247
+ # call.
244
248
  # @param filter [::String]
245
- # Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See
249
+ # Optional. Filters applied to the [CloudChannelService.ListCustomers]
250
+ # results. See
246
251
  # https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers
247
252
  # for more information.
248
253
  #
@@ -318,7 +323,8 @@ module Google
318
323
  end
319
324
 
320
325
  ##
321
- # Returns the requested {::Google::Cloud::Channel::V1::Customer Customer} resource.
326
+ # Returns the requested {::Google::Cloud::Channel::V1::Customer Customer}
327
+ # resource.
322
328
  #
323
329
  # Possible error codes:
324
330
  #
@@ -426,11 +432,14 @@ module Google
426
432
  # * INVALID_VALUE: Invalid domain value in the request.
427
433
  #
428
434
  # Return value:
429
- # A list of {::Google::Cloud::Channel::V1::CloudIdentityCustomerAccount CloudIdentityCustomerAccount} resources for the domain (may be
430
- # empty)
435
+ # A list of
436
+ # {::Google::Cloud::Channel::V1::CloudIdentityCustomerAccount CloudIdentityCustomerAccount}
437
+ # resources for the domain (may be empty)
431
438
  #
432
439
  # Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if
433
- # no {::Google::Cloud::Channel::V1::CloudIdentityCustomerAccount CloudIdentityCustomerAccount} resources match the domain.
440
+ # no
441
+ # {::Google::Cloud::Channel::V1::CloudIdentityCustomerAccount CloudIdentityCustomerAccount}
442
+ # resources match the domain.
434
443
  #
435
444
  # @overload check_cloud_identity_accounts_exist(request, options = nil)
436
445
  # Pass arguments to `check_cloud_identity_accounts_exist` via a request object, either of type
@@ -518,8 +527,8 @@ module Google
518
527
  end
519
528
 
520
529
  ##
521
- # Creates a new {::Google::Cloud::Channel::V1::Customer Customer} resource under the reseller or distributor
522
- # account.
530
+ # Creates a new {::Google::Cloud::Channel::V1::Customer Customer} resource under
531
+ # the reseller or distributor account.
523
532
  #
524
533
  # Possible error codes:
525
534
  #
@@ -548,8 +557,8 @@ module Google
548
557
  # the default parameter values, pass an empty Hash as a request object (see above).
549
558
  #
550
559
  # @param parent [::String]
551
- # Required. The resource name of reseller account in which to create the customer.
552
- # Parent uses the format: accounts/\\{account_id}
560
+ # Required. The resource name of reseller account in which to create the
561
+ # customer. Parent uses the format: accounts/\\{account_id}
553
562
  # @param customer [::Google::Cloud::Channel::V1::Customer, ::Hash]
554
563
  # Required. The customer to create.
555
564
  #
@@ -618,15 +627,16 @@ module Google
618
627
  end
619
628
 
620
629
  ##
621
- # Updates an existing {::Google::Cloud::Channel::V1::Customer Customer} resource for the reseller or
622
- # distributor.
630
+ # Updates an existing {::Google::Cloud::Channel::V1::Customer Customer} resource
631
+ # for the reseller or distributor.
623
632
  #
624
633
  # Possible error codes:
625
634
  #
626
635
  # * PERMISSION_DENIED: The reseller account making the request is different
627
636
  # from the reseller account in the API request.
628
637
  # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
629
- # * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found for the name in the request.
638
+ # * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found
639
+ # for the name in the request.
630
640
  #
631
641
  # Return value:
632
642
  # The updated {::Google::Cloud::Channel::V1::Customer Customer} resource.
@@ -725,7 +735,8 @@ module Google
725
735
  # this customer.
726
736
  # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
727
737
  # * FAILED_PRECONDITION: The customer has existing entitlements.
728
- # * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found for the name in the request.
738
+ # * NOT_FOUND: No {::Google::Cloud::Channel::V1::Customer Customer} resource found
739
+ # for the name in the request.
729
740
  #
730
741
  # @overload delete_customer(request, options = nil)
731
742
  # Pass arguments to `delete_customer` via a request object, either of type
@@ -810,10 +821,10 @@ module Google
810
821
  end
811
822
 
812
823
  ##
813
- # Imports a {::Google::Cloud::Channel::V1::Customer Customer} from the Cloud Identity associated with the provided
814
- # Cloud Identity ID or domain before a TransferEntitlements call. If a
815
- # linked Customer already exists and overwrite_if_exists is true, it will
816
- # update that Customer's data.
824
+ # Imports a {::Google::Cloud::Channel::V1::Customer Customer} from the Cloud
825
+ # Identity associated with the provided Cloud Identity ID or domain before a
826
+ # TransferEntitlements call. If a linked Customer already exists and
827
+ # overwrite_if_exists is true, it will update that Customer's data.
817
828
  #
818
829
  # Possible error codes:
819
830
  #
@@ -861,9 +872,10 @@ module Google
861
872
  # This must be set to true if there is an existing customer with a
862
873
  # conflicting region code or domain.
863
874
  # @param channel_partner_id [::String]
864
- # Optional. Cloud Identity ID of a channel partner who will be the direct reseller for
865
- # the customer's order. This field is required for 2-tier transfer scenarios
866
- # and can be provided via the request Parent binding as well.
875
+ # Optional. Cloud Identity ID of a channel partner who will be the direct
876
+ # reseller for the customer's order. This field is required for 2-tier
877
+ # transfer scenarios and can be provided via the request Parent binding as
878
+ # well.
867
879
  # @param customer [::String]
868
880
  # Optional. Specifies the customer that will receive imported Cloud Identity
869
881
  # information.
@@ -1054,7 +1066,8 @@ module Google
1054
1066
  end
1055
1067
 
1056
1068
  ##
1057
- # Lists {::Google::Cloud::Channel::V1::Entitlement Entitlement}s belonging to a customer.
1069
+ # Lists {::Google::Cloud::Channel::V1::Entitlement Entitlement}s belonging to a
1070
+ # customer.
1058
1071
  #
1059
1072
  # Possible error codes:
1060
1073
  #
@@ -1062,7 +1075,8 @@ module Google
1062
1075
  # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
1063
1076
  #
1064
1077
  # Return value:
1065
- # A list of the customer's {::Google::Cloud::Channel::V1::Entitlement Entitlement}s.
1078
+ # A list of the customer's
1079
+ # {::Google::Cloud::Channel::V1::Entitlement Entitlement}s.
1066
1080
  #
1067
1081
  # @overload list_entitlements(request, options = nil)
1068
1082
  # Pass arguments to `list_entitlements` via a request object, either of type
@@ -1084,14 +1098,16 @@ module Google
1084
1098
  # entitlements for.
1085
1099
  # Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
1086
1100
  # @param page_size [::Integer]
1087
- # Optional. Requested page size. Server might return fewer results than requested.
1088
- # If unspecified, return at most 50 entitlements.
1089
- # The maximum value is 100; the server will coerce values above 100.
1101
+ # Optional. Requested page size. Server might return fewer results than
1102
+ # requested. If unspecified, return at most 50 entitlements. The maximum
1103
+ # value is 100; the server will coerce values above 100.
1090
1104
  # @param page_token [::String]
1091
1105
  # Optional. A token for a page of results other than the first page.
1092
1106
  # Obtained using
1093
- # {::Google::Cloud::Channel::V1::ListEntitlementsResponse#next_page_token ListEntitlementsResponse.next_page_token} of the previous
1094
- # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlements CloudChannelService.ListEntitlements} call.
1107
+ # {::Google::Cloud::Channel::V1::ListEntitlementsResponse#next_page_token ListEntitlementsResponse.next_page_token}
1108
+ # of the previous
1109
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlements CloudChannelService.ListEntitlements}
1110
+ # call.
1095
1111
  #
1096
1112
  # @yield [response, operation] Access the result along with the RPC operation
1097
1113
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Entitlement>]
@@ -1165,8 +1181,8 @@ module Google
1165
1181
  end
1166
1182
 
1167
1183
  ##
1168
- # List {::Google::Cloud::Channel::V1::TransferableSku TransferableSku}s of a customer based on the Cloud Identity ID or
1169
- # Customer Name in the request.
1184
+ # List {::Google::Cloud::Channel::V1::TransferableSku TransferableSku}s of a
1185
+ # customer based on the Cloud Identity ID or Customer Name in the request.
1170
1186
  #
1171
1187
  # Use this method to list the entitlements information of an
1172
1188
  # unowned customer. You should provide the customer's
@@ -1182,7 +1198,8 @@ module Google
1182
1198
  # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
1183
1199
  #
1184
1200
  # Return value:
1185
- # A list of the customer's {::Google::Cloud::Channel::V1::TransferableSku TransferableSku}.
1201
+ # A list of the customer's
1202
+ # {::Google::Cloud::Channel::V1::TransferableSku TransferableSku}.
1186
1203
  #
1187
1204
  # @overload list_transferable_skus(request, options = nil)
1188
1205
  # Pass arguments to `list_transferable_skus` via a request object, either of type
@@ -1217,9 +1234,10 @@ module Google
1217
1234
  # @param page_token [::String]
1218
1235
  # A token for a page of results other than the first page.
1219
1236
  # Obtained using
1220
- # {::Google::Cloud::Channel::V1::ListTransferableSkusResponse#next_page_token ListTransferableSkusResponse.next_page_token} of the previous
1221
- # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_skus CloudChannelService.ListTransferableSkus} call.
1222
- # Optional.
1237
+ # {::Google::Cloud::Channel::V1::ListTransferableSkusResponse#next_page_token ListTransferableSkusResponse.next_page_token}
1238
+ # of the previous
1239
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_skus CloudChannelService.ListTransferableSkus}
1240
+ # call. Optional.
1223
1241
  # @param auth_token [::String]
1224
1242
  # Optional. The super admin of the resold customer generates this token to
1225
1243
  # authorize a reseller to access their Cloud Identity and purchase
@@ -1303,8 +1321,8 @@ module Google
1303
1321
  end
1304
1322
 
1305
1323
  ##
1306
- # List {::Google::Cloud::Channel::V1::TransferableOffer TransferableOffer}s of a customer based on Cloud Identity ID or
1307
- # Customer Name in the request.
1324
+ # List {::Google::Cloud::Channel::V1::TransferableOffer TransferableOffer}s of a
1325
+ # customer based on Cloud Identity ID or Customer Name in the request.
1308
1326
  #
1309
1327
  # Use this method when a reseller gets the entitlement information of an
1310
1328
  # unowned customer. The reseller should provide the customer's
@@ -1321,7 +1339,8 @@ module Google
1321
1339
  # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
1322
1340
  #
1323
1341
  # Return value:
1324
- # List of {::Google::Cloud::Channel::V1::TransferableOffer TransferableOffer} for the given customer and SKU.
1342
+ # List of {::Google::Cloud::Channel::V1::TransferableOffer TransferableOffer} for
1343
+ # the given customer and SKU.
1325
1344
  #
1326
1345
  # @overload list_transferable_offers(request, options = nil)
1327
1346
  # Pass arguments to `list_transferable_offers` via a request object, either of type
@@ -1352,8 +1371,10 @@ module Google
1352
1371
  # @param page_token [::String]
1353
1372
  # A token for a page of results other than the first page.
1354
1373
  # Obtained using
1355
- # {::Google::Cloud::Channel::V1::ListTransferableOffersResponse#next_page_token ListTransferableOffersResponse.next_page_token} of the previous
1356
- # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_offers CloudChannelService.ListTransferableOffers} call.
1374
+ # {::Google::Cloud::Channel::V1::ListTransferableOffersResponse#next_page_token ListTransferableOffersResponse.next_page_token}
1375
+ # of the previous
1376
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_offers CloudChannelService.ListTransferableOffers}
1377
+ # call.
1357
1378
  # @param sku [::String]
1358
1379
  # Required. The SKU to look up Offers for.
1359
1380
  # @param language_code [::String]
@@ -1433,7 +1454,8 @@ module Google
1433
1454
  end
1434
1455
 
1435
1456
  ##
1436
- # Returns the requested {::Google::Cloud::Channel::V1::Entitlement Entitlement} resource.
1457
+ # Returns the requested {::Google::Cloud::Channel::V1::Entitlement Entitlement}
1458
+ # resource.
1437
1459
  #
1438
1460
  # Possible error codes:
1439
1461
  #
@@ -1582,14 +1604,15 @@ module Google
1582
1604
  # the default parameter values, pass an empty Hash as a request object (see above).
1583
1605
  #
1584
1606
  # @param parent [::String]
1585
- # Required. The resource name of the reseller's customer account in which to create the
1586
- # entitlement.
1587
- # Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
1607
+ # Required. The resource name of the reseller's customer account in which to
1608
+ # create the entitlement. Parent uses the format:
1609
+ # accounts/\\{account_id}/customers/\\{customer_id}
1588
1610
  # @param entitlement [::Google::Cloud::Channel::V1::Entitlement, ::Hash]
1589
1611
  # Required. The entitlement to create.
1590
1612
  # @param request_id [::String]
1591
- # Optional. You can specify an optional unique request ID, and if you need to retry
1592
- # your request, the server will know to ignore the request if it's complete.
1613
+ # Optional. You can specify an optional unique request ID, and if you need to
1614
+ # retry your request, the server will know to ignore the request if it's
1615
+ # complete.
1593
1616
  #
1594
1617
  # For example, you make an initial request and the request times out. If you
1595
1618
  # make the request again with the same request ID, the server can check if
@@ -1717,13 +1740,16 @@ module Google
1717
1740
  # Name uses the format:
1718
1741
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
1719
1742
  # @param parameters [::Array<::Google::Cloud::Channel::V1::Parameter, ::Hash>]
1720
- # Required. Entitlement parameters to update. You can only change editable parameters.
1743
+ # Required. Entitlement parameters to update. You can only change editable
1744
+ # parameters.
1721
1745
  #
1722
1746
  # To view the available Parameters for a request, refer to the
1723
- # {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions} from the desired offer.
1747
+ # {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions}
1748
+ # from the desired offer.
1724
1749
  # @param request_id [::String]
1725
- # Optional. You can specify an optional unique request ID, and if you need to retry
1726
- # your request, the server will know to ignore the request if it's complete.
1750
+ # Optional. You can specify an optional unique request ID, and if you need to
1751
+ # retry your request, the server will know to ignore the request if it's
1752
+ # complete.
1727
1753
  #
1728
1754
  # For example, you make an initial request and the request times out. If you
1729
1755
  # make the request again with the same request ID, the server can check if
@@ -1855,8 +1881,9 @@ module Google
1855
1881
  # @param renewal_settings [::Google::Cloud::Channel::V1::RenewalSettings, ::Hash]
1856
1882
  # Required. New renewal settings.
1857
1883
  # @param request_id [::String]
1858
- # Optional. You can specify an optional unique request ID, and if you need to retry
1859
- # your request, the server will know to ignore the request if it's complete.
1884
+ # Optional. You can specify an optional unique request ID, and if you need to
1885
+ # retry your request, the server will know to ignore the request if it's
1886
+ # complete.
1860
1887
  #
1861
1888
  # For example, you make an initial request and the request times out. If you
1862
1889
  # make the request again with the same request ID, the server can check if
@@ -1985,13 +2012,16 @@ module Google
1985
2012
  # Required. New Offer.
1986
2013
  # Format: accounts/\\{account_id}/offers/\\{offer_id}.
1987
2014
  # @param parameters [::Array<::Google::Cloud::Channel::V1::Parameter, ::Hash>]
1988
- # Optional. Parameters needed to purchase the Offer. To view the available Parameters
1989
- # refer to the {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions} from the desired offer.
2015
+ # Optional. Parameters needed to purchase the Offer. To view the available
2016
+ # Parameters refer to the
2017
+ # {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions}
2018
+ # from the desired offer.
1990
2019
  # @param purchase_order_id [::String]
1991
2020
  # Optional. Purchase order id provided by the reseller.
1992
2021
  # @param request_id [::String]
1993
- # Optional. You can specify an optional unique request ID, and if you need to retry
1994
- # your request, the server will know to ignore the request if it's complete.
2022
+ # Optional. You can specify an optional unique request ID, and if you need to
2023
+ # retry your request, the server will know to ignore the request if it's
2024
+ # complete.
1995
2025
  #
1996
2026
  # For example, you make an initial request and the request times out. If you
1997
2027
  # make the request again with the same request ID, the server can check if
@@ -2120,8 +2150,9 @@ module Google
2120
2150
  # Name uses the format:
2121
2151
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
2122
2152
  # @param request_id [::String]
2123
- # Optional. You can specify an optional unique request ID, and if you need to retry
2124
- # your request, the server will know to ignore the request if it's complete.
2153
+ # Optional. You can specify an optional unique request ID, and if you need to
2154
+ # retry your request, the server will know to ignore the request if it's
2155
+ # complete.
2125
2156
  #
2126
2157
  # For example, you make an initial request and the request times out. If you
2127
2158
  # make the request again with the same request ID, the server can check if
@@ -2247,8 +2278,9 @@ module Google
2247
2278
  # Name uses the format:
2248
2279
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
2249
2280
  # @param request_id [::String]
2250
- # Optional. You can specify an optional unique request ID, and if you need to retry
2251
- # your request, the server will know to ignore the request if it's complete.
2281
+ # Optional. You can specify an optional unique request ID, and if you need to
2282
+ # retry your request, the server will know to ignore the request if it's
2283
+ # complete.
2252
2284
  #
2253
2285
  # For example, you make an initial request and the request times out. If you
2254
2286
  # make the request again with the same request ID, the server can check if
@@ -2379,8 +2411,9 @@ module Google
2379
2411
  # Name uses the format:
2380
2412
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
2381
2413
  # @param request_id [::String]
2382
- # Optional. You can specify an optional unique request ID, and if you need to retry
2383
- # your request, the server will know to ignore the request if it's complete.
2414
+ # Optional. You can specify an optional unique request ID, and if you need to
2415
+ # retry your request, the server will know to ignore the request if it's
2416
+ # complete.
2384
2417
  #
2385
2418
  # For example, you make an initial request and the request times out. If you
2386
2419
  # make the request again with the same request ID, the server can check if
@@ -2512,8 +2545,9 @@ module Google
2512
2545
  # Name uses the format:
2513
2546
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
2514
2547
  # @param request_id [::String]
2515
- # Optional. You can specify an optional unique request ID, and if you need to retry
2516
- # your request, the server will know to ignore the request if it's complete.
2548
+ # Optional. You can specify an optional unique request ID, and if you need to
2549
+ # retry your request, the server will know to ignore the request if it's
2550
+ # complete.
2517
2551
  #
2518
2552
  # For example, you make an initial request and the request times out. If you
2519
2553
  # make the request again with the same request ID, the server can check if
@@ -2643,9 +2677,9 @@ module Google
2643
2677
  # the default parameter values, pass an empty Hash as a request object (see above).
2644
2678
  #
2645
2679
  # @param parent [::String]
2646
- # Required. The resource name of the reseller's customer account that will receive
2647
- # transferred entitlements.
2648
- # Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
2680
+ # Required. The resource name of the reseller's customer account that will
2681
+ # receive transferred entitlements. Parent uses the format:
2682
+ # accounts/\\{account_id}/customers/\\{customer_id}
2649
2683
  # @param entitlements [::Array<::Google::Cloud::Channel::V1::Entitlement, ::Hash>]
2650
2684
  # Required. The new entitlements to create or transfer.
2651
2685
  # @param auth_token [::String]
@@ -2654,8 +2688,9 @@ module Google
2654
2688
  # entitlements on their behalf. You can omit this token after authorization.
2655
2689
  # See https://support.google.com/a/answer/7643790 for more details.
2656
2690
  # @param request_id [::String]
2657
- # Optional. You can specify an optional unique request ID, and if you need to retry
2658
- # your request, the server will know to ignore the request if it's complete.
2691
+ # Optional. You can specify an optional unique request ID, and if you need to
2692
+ # retry your request, the server will know to ignore the request if it's
2693
+ # complete.
2659
2694
  #
2660
2695
  # For example, you make an initial request and the request times out. If you
2661
2696
  # make the request again with the same request ID, the server can check if
@@ -2785,14 +2820,15 @@ module Google
2785
2820
  # the default parameter values, pass an empty Hash as a request object (see above).
2786
2821
  #
2787
2822
  # @param parent [::String]
2788
- # Required. The resource name of the reseller's customer account where the entitlements
2789
- # transfer from.
2790
- # Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
2823
+ # Required. The resource name of the reseller's customer account where the
2824
+ # entitlements transfer from. Parent uses the format:
2825
+ # accounts/\\{account_id}/customers/\\{customer_id}
2791
2826
  # @param entitlements [::Array<::Google::Cloud::Channel::V1::Entitlement, ::Hash>]
2792
2827
  # Required. The entitlements to transfer to Google.
2793
2828
  # @param request_id [::String]
2794
- # Optional. You can specify an optional unique request ID, and if you need to retry
2795
- # your request, the server will know to ignore the request if it's complete.
2829
+ # Optional. You can specify an optional unique request ID, and if you need to
2830
+ # retry your request, the server will know to ignore the request if it's
2831
+ # complete.
2796
2832
  #
2797
2833
  # For example, you make an initial request and the request times out. If you
2798
2834
  # make the request again with the same request ID, the server can check if
@@ -2876,8 +2912,8 @@ module Google
2876
2912
  end
2877
2913
 
2878
2914
  ##
2879
- # List {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s belonging to a distributor.
2880
- # You must be a distributor to call this method.
2915
+ # List {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s
2916
+ # belonging to a distributor. You must be a distributor to call this method.
2881
2917
  #
2882
2918
  # Possible error codes:
2883
2919
  #
@@ -2886,7 +2922,8 @@ module Google
2886
2922
  # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
2887
2923
  #
2888
2924
  # Return value:
2889
- # The list of the distributor account's {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resources.
2925
+ # The list of the distributor account's
2926
+ # {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resources.
2890
2927
  #
2891
2928
  # @overload list_channel_partner_links(request, options = nil)
2892
2929
  # Pass arguments to `list_channel_partner_links` via a request object, either of type
@@ -2904,18 +2941,19 @@ module Google
2904
2941
  # the default parameter values, pass an empty Hash as a request object (see above).
2905
2942
  #
2906
2943
  # @param parent [::String]
2907
- # Required. The resource name of the reseller account for listing channel partner
2908
- # links.
2909
- # Parent uses the format: accounts/\\{account_id}
2944
+ # Required. The resource name of the reseller account for listing channel
2945
+ # partner links. Parent uses the format: accounts/\\{account_id}
2910
2946
  # @param page_size [::Integer]
2911
- # Optional. Requested page size. Server might return fewer results than requested.
2912
- # If unspecified, server will pick a default size (25).
2913
- # The maximum value is 200; the server will coerce values above 200.
2947
+ # Optional. Requested page size. Server might return fewer results than
2948
+ # requested. If unspecified, server will pick a default size (25). The
2949
+ # maximum value is 200; the server will coerce values above 200.
2914
2950
  # @param page_token [::String]
2915
2951
  # Optional. A token for a page of results other than the first page.
2916
2952
  # Obtained using
2917
- # {::Google::Cloud::Channel::V1::ListChannelPartnerLinksResponse#next_page_token ListChannelPartnerLinksResponse.next_page_token} of the previous
2918
- # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_channel_partner_links CloudChannelService.ListChannelPartnerLinks} call.
2953
+ # {::Google::Cloud::Channel::V1::ListChannelPartnerLinksResponse#next_page_token ListChannelPartnerLinksResponse.next_page_token}
2954
+ # of the previous
2955
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_channel_partner_links CloudChannelService.ListChannelPartnerLinks}
2956
+ # call.
2919
2957
  # @param view [::Google::Cloud::Channel::V1::ChannelPartnerLinkView]
2920
2958
  # Optional. The level of granularity the ChannelPartnerLink will display.
2921
2959
  #
@@ -2991,7 +3029,8 @@ module Google
2991
3029
  end
2992
3030
 
2993
3031
  ##
2994
- # Returns the requested {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
3032
+ # Returns the requested
3033
+ # {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
2995
3034
  # You must be a distributor to call this method.
2996
3035
  #
2997
3036
  # Possible error codes:
@@ -3003,7 +3042,8 @@ module Google
3003
3042
  # invalid channel partner link name.
3004
3043
  #
3005
3044
  # Return value:
3006
- # The {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
3045
+ # The {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}
3046
+ # resource.
3007
3047
  #
3008
3048
  # @overload get_channel_partner_link(request, options = nil)
3009
3049
  # Pass arguments to `get_channel_partner_link` via a request object, either of type
@@ -3113,7 +3153,8 @@ module Google
3113
3153
  # Contact Cloud Channel support.
3114
3154
  #
3115
3155
  # Return value:
3116
- # The new {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
3156
+ # The new {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}
3157
+ # resource.
3117
3158
  #
3118
3159
  # @overload create_channel_partner_link(request, options = nil)
3119
3160
  # Pass arguments to `create_channel_partner_link` via a request object, either of type
@@ -3224,7 +3265,8 @@ module Google
3224
3265
  # Contact Cloud Channel support.
3225
3266
  #
3226
3267
  # Return value:
3227
- # The updated {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
3268
+ # The updated
3269
+ # {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
3228
3270
  #
3229
3271
  # @overload update_channel_partner_link(request, options = nil)
3230
3272
  # Pass arguments to `update_channel_partner_link` via a request object, either of type
@@ -3246,8 +3288,8 @@ module Google
3246
3288
  # Name uses the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
3247
3289
  # where \\{id} is the Cloud Identity ID of the partner.
3248
3290
  # @param channel_partner_link [::Google::Cloud::Channel::V1::ChannelPartnerLink, ::Hash]
3249
- # Required. The channel partner link to update. Only channel_partner_link.link_state
3250
- # is allowed for updates.
3291
+ # Required. The channel partner link to update. Only
3292
+ # channel_partner_link.link_state is allowed for updates.
3251
3293
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
3252
3294
  # Required. The update mask that applies to the resource.
3253
3295
  # The only allowable value for an update mask is
@@ -3325,13 +3367,16 @@ module Google
3325
3367
  #
3326
3368
  # * PERMISSION_DENIED: If the account making the request and the account
3327
3369
  # being queried are different.
3328
- # * NOT_FOUND: The {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig} was not found.
3370
+ # * NOT_FOUND: The
3371
+ # {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig}
3372
+ # was not found.
3329
3373
  # * INTERNAL: Any non-user error related to technical issues in the
3330
3374
  # backend. In this case, contact Cloud Channel support.
3331
3375
  #
3332
3376
  # Return Value:
3333
- # If successful, the {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig} resource, otherwise returns
3334
- # an error.
3377
+ # If successful, the
3378
+ # {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig}
3379
+ # resource, otherwise returns an error.
3335
3380
  #
3336
3381
  # @overload get_customer_repricing_config(request, options = nil)
3337
3382
  # Pass arguments to `get_customer_repricing_config` via a request object, either of type
@@ -3425,14 +3470,17 @@ module Google
3425
3470
  #
3426
3471
  # * PERMISSION_DENIED: If the account making the request and the account
3427
3472
  # being queried are different.
3428
- # * NOT_FOUND: The {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig} specified does not exist or is
3429
- # not associated with the given account.
3473
+ # * NOT_FOUND: The
3474
+ # {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig}
3475
+ # specified does not exist or is not associated with the given account.
3430
3476
  # * INTERNAL: Any non-user error related to technical issues in the
3431
3477
  # backend. In this case, contact Cloud Channel support.
3432
3478
  #
3433
3479
  # Return Value:
3434
- # If successful, the {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig} resources. The
3435
- # data for each resource is displayed in the ascending order of:
3480
+ # If successful, the
3481
+ # {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig}
3482
+ # resources. The data for each resource is displayed in the ascending order
3483
+ # of:
3436
3484
  # * customer ID
3437
3485
  # * {::Google::Cloud::Channel::V1::RepricingConfig::EntitlementGranularity#entitlement RepricingConfig.EntitlementGranularity.entitlement}
3438
3486
  # * {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
@@ -3461,14 +3509,16 @@ module Google
3461
3509
  # Supports accounts/\\{account_id}/customers/- to retrieve configs for all
3462
3510
  # customers.
3463
3511
  # @param page_size [::Integer]
3464
- # Optional. The maximum number of repricing configs to return. The service may return
3465
- # fewer than this value. If unspecified, returns a maximum of 50 rules. The
3466
- # maximum value is 100; values above 100 will be coerced to 100.
3512
+ # Optional. The maximum number of repricing configs to return. The service
3513
+ # may return fewer than this value. If unspecified, returns a maximum of 50
3514
+ # rules. The maximum value is 100; values above 100 will be coerced to 100.
3467
3515
  # @param page_token [::String]
3468
3516
  # Optional. A token identifying a page of results beyond the first page.
3469
3517
  # Obtained through
3470
- # {::Google::Cloud::Channel::V1::ListCustomerRepricingConfigsResponse#next_page_token ListCustomerRepricingConfigsResponse.next_page_token} of the previous
3471
- # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_customer_repricing_configs CloudChannelService.ListCustomerRepricingConfigs} call.
3518
+ # {::Google::Cloud::Channel::V1::ListCustomerRepricingConfigsResponse#next_page_token ListCustomerRepricingConfigsResponse.next_page_token}
3519
+ # of the previous
3520
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_customer_repricing_configs CloudChannelService.ListCustomerRepricingConfigs}
3521
+ # call.
3472
3522
  # @param filter [::String]
3473
3523
  # Optional. A filter for [CloudChannelService.ListCustomerRepricingConfigs]
3474
3524
  # results (customer only). You can use this filter when you support
@@ -3552,9 +3602,9 @@ module Google
3552
3602
  ##
3553
3603
  # Creates a CustomerRepricingConfig. Call this method to set modifications
3554
3604
  # for a specific customer's bill. You can only create configs if the
3555
- # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month} is a
3556
- # future month. If needed, you can create a config for the current month,
3557
- # with some restrictions.
3605
+ # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
3606
+ # is a future month. If needed, you can create a config for the current
3607
+ # month, with some restrictions.
3558
3608
  #
3559
3609
  # When creating a config for a future month, make sure there are no existing
3560
3610
  # configs for that
@@ -3568,9 +3618,11 @@ module Google
3568
3618
  # Changes to the config may be immediate, but may take up to 24 hours.
3569
3619
  # * There is a limit of ten configs for any
3570
3620
  # {::Google::Cloud::Channel::V1::RepricingConfig::EntitlementGranularity#entitlement RepricingConfig.EntitlementGranularity.entitlement}
3571
- # or {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}.
3572
- # * The contained {::Google::Cloud::Channel::V1::CustomerRepricingConfig#repricing_config CustomerRepricingConfig.repricing_config} vaule must be
3573
- # different from the value used in the current config for a
3621
+ # or
3622
+ # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}.
3623
+ # * The contained
3624
+ # {::Google::Cloud::Channel::V1::CustomerRepricingConfig#repricing_config CustomerRepricingConfig.repricing_config}
3625
+ # vaule must be different from the value used in the current config for a
3574
3626
  # {::Google::Cloud::Channel::V1::RepricingConfig::EntitlementGranularity#entitlement RepricingConfig.EntitlementGranularity.entitlement}.
3575
3627
  #
3576
3628
  # Possible Error Codes:
@@ -3580,14 +3632,16 @@ module Google
3580
3632
  # * INVALID_ARGUMENT: Missing or invalid required parameters in the
3581
3633
  # request. Also displays if the updated config is for the current month or
3582
3634
  # past months.
3583
- # * NOT_FOUND: The {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig} specified does not exist or is
3584
- # not associated with the given account.
3635
+ # * NOT_FOUND: The
3636
+ # {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig}
3637
+ # specified does not exist or is not associated with the given account.
3585
3638
  # * INTERNAL: Any non-user error related to technical issues in the
3586
3639
  # backend. In this case, contact Cloud Channel support.
3587
3640
  #
3588
3641
  # Return Value:
3589
- # If successful, the updated {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig} resource, otherwise
3590
- # returns an error.
3642
+ # If successful, the updated
3643
+ # {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig}
3644
+ # resource, otherwise returns an error.
3591
3645
  #
3592
3646
  # @overload create_customer_repricing_config(request, options = nil)
3593
3647
  # Pass arguments to `create_customer_repricing_config` via a request object, either of type
@@ -3605,8 +3659,9 @@ module Google
3605
3659
  # the default parameter values, pass an empty Hash as a request object (see above).
3606
3660
  #
3607
3661
  # @param parent [::String]
3608
- # Required. The resource name of the customer that will receive this repricing config.
3609
- # Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
3662
+ # Required. The resource name of the customer that will receive this
3663
+ # repricing config. Parent uses the format:
3664
+ # accounts/\\{account_id}/customers/\\{customer_id}
3610
3665
  # @param customer_repricing_config [::Google::Cloud::Channel::V1::CustomerRepricingConfig, ::Hash]
3611
3666
  # Required. The CustomerRepricingConfig object to update.
3612
3667
  #
@@ -3680,10 +3735,11 @@ module Google
3680
3735
  # CustomerRepricingConfig.
3681
3736
  #
3682
3737
  # You can only update configs if the
3683
- # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month} is a
3684
- # future month. To make changes to configs for the current month, use
3685
- # {::Google::Cloud::Channel::V1::CloudChannelService::Client#create_customer_repricing_config CreateCustomerRepricingConfig}, taking note of its restrictions. You
3686
- # cannot update the {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}.
3738
+ # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
3739
+ # is a future month. To make changes to configs for the current month, use
3740
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Client#create_customer_repricing_config CreateCustomerRepricingConfig},
3741
+ # taking note of its restrictions. You cannot update the
3742
+ # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}.
3687
3743
  #
3688
3744
  # When updating a config in the future:
3689
3745
  #
@@ -3696,14 +3752,16 @@ module Google
3696
3752
  # * INVALID_ARGUMENT: Missing or invalid required parameters in the
3697
3753
  # request. Also displays if the updated config is for the current month or
3698
3754
  # past months.
3699
- # * NOT_FOUND: The {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig} specified does not exist or is
3700
- # not associated with the given account.
3755
+ # * NOT_FOUND: The
3756
+ # {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig}
3757
+ # specified does not exist or is not associated with the given account.
3701
3758
  # * INTERNAL: Any non-user error related to technical issues in the
3702
3759
  # backend. In this case, contact Cloud Channel support.
3703
3760
  #
3704
3761
  # Return Value:
3705
- # If successful, the updated {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig} resource, otherwise
3706
- # returns an error.
3762
+ # If successful, the updated
3763
+ # {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig}
3764
+ # resource, otherwise returns an error.
3707
3765
  #
3708
3766
  # @overload update_customer_repricing_config(request, options = nil)
3709
3767
  # Pass arguments to `update_customer_repricing_config` via a request object, either of type
@@ -3788,19 +3846,23 @@ module Google
3788
3846
  end
3789
3847
 
3790
3848
  ##
3791
- # Deletes the given {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig} permanently. You can only
3792
- # delete configs if their {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month} is set
3793
- # to a date after the current month.
3849
+ # Deletes the given
3850
+ # {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig}
3851
+ # permanently. You can only delete configs if their
3852
+ # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
3853
+ # is set to a date after the current month.
3794
3854
  #
3795
3855
  # Possible error codes:
3796
3856
  #
3797
3857
  # * PERMISSION_DENIED: The account making the request does not own
3798
3858
  # this customer.
3799
3859
  # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
3800
- # * FAILED_PRECONDITION: The {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig} is active or in the
3801
- # past.
3802
- # * NOT_FOUND: No {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig} found for the name in the
3803
- # request.
3860
+ # * FAILED_PRECONDITION: The
3861
+ # {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig}
3862
+ # is active or in the past.
3863
+ # * NOT_FOUND: No
3864
+ # {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig}
3865
+ # found for the name in the request.
3804
3866
  #
3805
3867
  # @overload delete_customer_repricing_config(request, options = nil)
3806
3868
  # Pass arguments to `delete_customer_repricing_config` via a request object, either of type
@@ -3818,8 +3880,8 @@ module Google
3818
3880
  # the default parameter values, pass an empty Hash as a request object (see above).
3819
3881
  #
3820
3882
  # @param name [::String]
3821
- # Required. The resource name of the customer repricing config rule to delete.
3822
- # Format:
3883
+ # Required. The resource name of the customer repricing config rule to
3884
+ # delete. Format:
3823
3885
  # accounts/\\{account_id}/customers/\\{customer_id}/customerRepricingConfigs/\\{id}.
3824
3886
  #
3825
3887
  # @yield [response, operation] Access the result along with the RPC operation
@@ -3894,13 +3956,16 @@ module Google
3894
3956
  #
3895
3957
  # * PERMISSION_DENIED: If the account making the request and the account
3896
3958
  # being queried are different.
3897
- # * NOT_FOUND: The {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig} was not found.
3959
+ # * NOT_FOUND: The
3960
+ # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}
3961
+ # was not found.
3898
3962
  # * INTERNAL: Any non-user error related to technical issues in the
3899
3963
  # backend. In this case, contact Cloud Channel support.
3900
3964
  #
3901
3965
  # Return Value:
3902
- # If successful, the {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig} resource, otherwise
3903
- # returns an error.
3966
+ # If successful, the
3967
+ # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}
3968
+ # resource, otherwise returns an error.
3904
3969
  #
3905
3970
  # @overload get_channel_partner_repricing_config(request, options = nil)
3906
3971
  # Pass arguments to `get_channel_partner_repricing_config` via a request object, either of type
@@ -3994,14 +4059,17 @@ module Google
3994
4059
  #
3995
4060
  # * PERMISSION_DENIED: If the account making the request and the account
3996
4061
  # being queried are different.
3997
- # * NOT_FOUND: The {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig} specified does not exist
3998
- # or is not associated with the given account.
4062
+ # * NOT_FOUND: The
4063
+ # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}
4064
+ # specified does not exist or is not associated with the given account.
3999
4065
  # * INTERNAL: Any non-user error related to technical issues in the
4000
4066
  # backend. In this case, contact Cloud Channel support.
4001
4067
  #
4002
4068
  # Return Value:
4003
- # If successful, the {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig} resources.
4004
- # The data for each resource is displayed in the ascending order of:
4069
+ # If successful, the
4070
+ # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}
4071
+ # resources. The data for each resource is displayed in the ascending order
4072
+ # of:
4005
4073
  # * channel partner ID
4006
4074
  # * {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
4007
4075
  # * {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig#update_time ChannelPartnerRepricingConfig.update_time}
@@ -4024,25 +4092,28 @@ module Google
4024
4092
  # the default parameter values, pass an empty Hash as a request object (see above).
4025
4093
  #
4026
4094
  # @param parent [::String]
4027
- # Required. The resource name of the account's {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}.
4028
- # Parent uses the format:
4095
+ # Required. The resource name of the account's
4096
+ # {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}. Parent
4097
+ # uses the format:
4029
4098
  # accounts/\\{account_id}/channelPartnerLinks/\\{channel_partner_id}.
4030
4099
  # Supports accounts/\\{account_id}/channelPartnerLinks/- to retrieve configs
4031
4100
  # for all channel partners.
4032
4101
  # @param page_size [::Integer]
4033
- # Optional. The maximum number of repricing configs to return. The service may return
4034
- # fewer than this value. If unspecified, returns a maximum of 50 rules. The
4035
- # maximum value is 100; values above 100 will be coerced to 100.
4102
+ # Optional. The maximum number of repricing configs to return. The service
4103
+ # may return fewer than this value. If unspecified, returns a maximum of 50
4104
+ # rules. The maximum value is 100; values above 100 will be coerced to 100.
4036
4105
  # @param page_token [::String]
4037
4106
  # Optional. A token identifying a page of results beyond the first page.
4038
4107
  # Obtained through
4039
- # {::Google::Cloud::Channel::V1::ListChannelPartnerRepricingConfigsResponse#next_page_token ListChannelPartnerRepricingConfigsResponse.next_page_token} of the
4040
- # previous {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_channel_partner_repricing_configs CloudChannelService.ListChannelPartnerRepricingConfigs} call.
4108
+ # {::Google::Cloud::Channel::V1::ListChannelPartnerRepricingConfigsResponse#next_page_token ListChannelPartnerRepricingConfigsResponse.next_page_token}
4109
+ # of the previous
4110
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_channel_partner_repricing_configs CloudChannelService.ListChannelPartnerRepricingConfigs}
4111
+ # call.
4041
4112
  # @param filter [::String]
4042
- # Optional. A filter for [CloudChannelService.ListChannelPartnerRepricingConfigs]
4043
- # results (channel_partner_link only). You can use this filter when you
4044
- # support a BatchGet-like query.
4045
- # To use the filter, you must set
4113
+ # Optional. A filter for
4114
+ # [CloudChannelService.ListChannelPartnerRepricingConfigs] results
4115
+ # (channel_partner_link only). You can use this filter when you support a
4116
+ # BatchGet-like query. To use the filter, you must set
4046
4117
  # `parent=accounts/{account_id}/channelPartnerLinks/-`.
4047
4118
  #
4048
4119
  # Example: `channel_partner_link =
@@ -4123,9 +4194,10 @@ module Google
4123
4194
  ##
4124
4195
  # Creates a ChannelPartnerRepricingConfig. Call this method to set
4125
4196
  # modifications for a specific ChannelPartner's bill. You can only create
4126
- # configs if the {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month} is a future
4127
- # month. If needed, you can create a config for the current month, with some
4128
- # restrictions.
4197
+ # configs if the
4198
+ # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
4199
+ # is a future month. If needed, you can create a config for the current
4200
+ # month, with some restrictions.
4129
4201
  #
4130
4202
  # When creating a config for a future month, make sure there are no existing
4131
4203
  # configs for that
@@ -4139,8 +4211,9 @@ module Google
4139
4211
  # Changes to the config may be immediate, but may take up to 24 hours.
4140
4212
  # * There is a limit of ten configs for any ChannelPartner or
4141
4213
  # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}.
4142
- # * The contained {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig#repricing_config ChannelPartnerRepricingConfig.repricing_config} vaule
4143
- # must be different from the value used in the current config for a
4214
+ # * The contained
4215
+ # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig#repricing_config ChannelPartnerRepricingConfig.repricing_config}
4216
+ # vaule must be different from the value used in the current config for a
4144
4217
  # ChannelPartner.
4145
4218
  #
4146
4219
  # Possible Error Codes:
@@ -4150,14 +4223,16 @@ module Google
4150
4223
  # * INVALID_ARGUMENT: Missing or invalid required parameters in the
4151
4224
  # request. Also displays if the updated config is for the current month or
4152
4225
  # past months.
4153
- # * NOT_FOUND: The {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig} specified does not exist
4154
- # or is not associated with the given account.
4226
+ # * NOT_FOUND: The
4227
+ # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}
4228
+ # specified does not exist or is not associated with the given account.
4155
4229
  # * INTERNAL: Any non-user error related to technical issues in the
4156
4230
  # backend. In this case, contact Cloud Channel support.
4157
4231
  #
4158
4232
  # Return Value:
4159
- # If successful, the updated {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig} resource,
4160
- # otherwise returns an error.
4233
+ # If successful, the updated
4234
+ # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}
4235
+ # resource, otherwise returns an error.
4161
4236
  #
4162
4237
  # @overload create_channel_partner_repricing_config(request, options = nil)
4163
4238
  # Pass arguments to `create_channel_partner_repricing_config` via a request object, either of type
@@ -4175,8 +4250,8 @@ module Google
4175
4250
  # the default parameter values, pass an empty Hash as a request object (see above).
4176
4251
  #
4177
4252
  # @param parent [::String]
4178
- # Required. The resource name of the ChannelPartner that will receive the repricing
4179
- # config. Parent uses the format:
4253
+ # Required. The resource name of the ChannelPartner that will receive the
4254
+ # repricing config. Parent uses the format:
4180
4255
  # accounts/\\{account_id}/channelPartnerLinks/\\{channel_partner_id}
4181
4256
  # @param channel_partner_repricing_config [::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig, ::Hash]
4182
4257
  # Required. The ChannelPartnerRepricingConfig object to update.
@@ -4251,10 +4326,11 @@ module Google
4251
4326
  # the existing CustomerRepricingConfig.
4252
4327
  #
4253
4328
  # You can only update configs if the
4254
- # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month} is a
4255
- # future month. To make changes to configs for the current month, use
4256
- # {::Google::Cloud::Channel::V1::CloudChannelService::Client#create_channel_partner_repricing_config CreateChannelPartnerRepricingConfig}, taking note of its restrictions.
4257
- # You cannot update the {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}.
4329
+ # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
4330
+ # is a future month. To make changes to configs for the current month, use
4331
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Client#create_channel_partner_repricing_config CreateChannelPartnerRepricingConfig},
4332
+ # taking note of its restrictions. You cannot update the
4333
+ # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}.
4258
4334
  #
4259
4335
  # When updating a config in the future:
4260
4336
  #
@@ -4267,14 +4343,16 @@ module Google
4267
4343
  # * INVALID_ARGUMENT: Missing or invalid required parameters in the
4268
4344
  # request. Also displays if the updated config is for the current month or
4269
4345
  # past months.
4270
- # * NOT_FOUND: The {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig} specified does not exist
4271
- # or is not associated with the given account.
4346
+ # * NOT_FOUND: The
4347
+ # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}
4348
+ # specified does not exist or is not associated with the given account.
4272
4349
  # * INTERNAL: Any non-user error related to technical issues in the
4273
4350
  # backend. In this case, contact Cloud Channel support.
4274
4351
  #
4275
4352
  # Return Value:
4276
- # If successful, the updated {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig} resource,
4277
- # otherwise returns an error.
4353
+ # If successful, the updated
4354
+ # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}
4355
+ # resource, otherwise returns an error.
4278
4356
  #
4279
4357
  # @overload update_channel_partner_repricing_config(request, options = nil)
4280
4358
  # Pass arguments to `update_channel_partner_repricing_config` via a request object, either of type
@@ -4359,19 +4437,23 @@ module Google
4359
4437
  end
4360
4438
 
4361
4439
  ##
4362
- # Deletes the given {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig} permanently. You can
4363
- # only delete configs if their {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month} is
4364
- # set to a date after the current month.
4440
+ # Deletes the given
4441
+ # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}
4442
+ # permanently. You can only delete configs if their
4443
+ # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
4444
+ # is set to a date after the current month.
4365
4445
  #
4366
4446
  # Possible error codes:
4367
4447
  #
4368
4448
  # * PERMISSION_DENIED: The account making the request does not own
4369
4449
  # this customer.
4370
4450
  # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
4371
- # * FAILED_PRECONDITION: The {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig} is active or
4372
- # in the past.
4373
- # * NOT_FOUND: No {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig} found for the name in the
4374
- # request.
4451
+ # * FAILED_PRECONDITION: The
4452
+ # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}
4453
+ # is active or in the past.
4454
+ # * NOT_FOUND: No
4455
+ # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}
4456
+ # found for the name in the request.
4375
4457
  #
4376
4458
  # @overload delete_channel_partner_repricing_config(request, options = nil)
4377
4459
  # Pass arguments to `delete_channel_partner_repricing_config` via a request object, either of type
@@ -4389,7 +4471,8 @@ module Google
4389
4471
  # the default parameter values, pass an empty Hash as a request object (see above).
4390
4472
  #
4391
4473
  # @param name [::String]
4392
- # Required. The resource name of the channel partner repricing config rule to delete.
4474
+ # Required. The resource name of the channel partner repricing config rule to
4475
+ # delete.
4393
4476
  #
4394
4477
  # @yield [response, operation] Access the result along with the RPC operation
4395
4478
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -4577,9 +4660,9 @@ module Google
4577
4660
  # Required. The resource name of the reseller account.
4578
4661
  # Format: accounts/\\{account_id}.
4579
4662
  # @param page_size [::Integer]
4580
- # Optional. Requested page size. Server might return fewer results than requested.
4581
- # If unspecified, returns at most 100 Products.
4582
- # The maximum value is 1000; the server will coerce values above 1000.
4663
+ # Optional. Requested page size. Server might return fewer results than
4664
+ # requested. If unspecified, returns at most 100 Products. The maximum value
4665
+ # is 1000; the server will coerce values above 1000.
4583
4666
  # @param page_token [::String]
4584
4667
  # Optional. A token for a page of results other than the first page.
4585
4668
  # @param language_code [::String]
@@ -4680,9 +4763,9 @@ module Google
4680
4763
  # Required. Resource name of the reseller.
4681
4764
  # Format: accounts/\\{account_id}.
4682
4765
  # @param page_size [::Integer]
4683
- # Optional. Requested page size. Server might return fewer results than requested.
4684
- # If unspecified, returns at most 100 SKUs.
4685
- # The maximum value is 1000; the server will coerce values above 1000.
4766
+ # Optional. Requested page size. Server might return fewer results than
4767
+ # requested. If unspecified, returns at most 100 SKUs. The maximum value is
4768
+ # 1000; the server will coerce values above 1000.
4686
4769
  # @param page_token [::String]
4687
4770
  # Optional. A token for a page of results other than the first page.
4688
4771
  # Optional.
@@ -4785,12 +4868,12 @@ module Google
4785
4868
  # the default parameter values, pass an empty Hash as a request object (see above).
4786
4869
  #
4787
4870
  # @param parent [::String]
4788
- # Required. The resource name of the reseller account from which to list Offers.
4789
- # Parent uses the format: accounts/\\{account_id}.
4871
+ # Required. The resource name of the reseller account from which to list
4872
+ # Offers. Parent uses the format: accounts/\\{account_id}.
4790
4873
  # @param page_size [::Integer]
4791
- # Optional. Requested page size. Server might return fewer results than requested.
4792
- # If unspecified, returns at most 500 Offers.
4793
- # The maximum value is 1000; the server will coerce values above 1000.
4874
+ # Optional. Requested page size. Server might return fewer results than
4875
+ # requested. If unspecified, returns at most 500 Offers. The maximum value is
4876
+ # 1000; the server will coerce values above 1000.
4794
4877
  # @param page_token [::String]
4795
4878
  # Optional. A token for a page of results other than the first page.
4796
4879
  # @param filter [::String]
@@ -4909,9 +4992,9 @@ module Google
4909
4992
  # Required. The resource name of the customer to list SKUs for.
4910
4993
  # Format: accounts/\\{account_id}/customers/\\{customer_id}.
4911
4994
  # @param page_size [::Integer]
4912
- # Optional. Requested page size. Server might return fewer results than requested.
4913
- # If unspecified, returns at most 100 SKUs.
4914
- # The maximum value is 1000; the server will coerce values above 1000.
4995
+ # Optional. Requested page size. Server might return fewer results than
4996
+ # requested. If unspecified, returns at most 100 SKUs. The maximum value is
4997
+ # 1000; the server will coerce values above 1000.
4915
4998
  # @param page_token [::String]
4916
4999
  # Optional. A token for a page of results other than the first page.
4917
5000
  # @param language_code [::String]
@@ -5024,9 +5107,9 @@ module Google
5024
5107
  # Required. The resource name of the customer to list Offers for.
5025
5108
  # Format: accounts/\\{account_id}/customers/\\{customer_id}.
5026
5109
  # @param page_size [::Integer]
5027
- # Optional. Requested page size. Server might return fewer results than requested.
5028
- # If unspecified, returns at most 100 Offers.
5029
- # The maximum value is 1000; the server will coerce values above 1000.
5110
+ # Optional. Requested page size. Server might return fewer results than
5111
+ # requested. If unspecified, returns at most 100 Offers. The maximum value is
5112
+ # 1000; the server will coerce values above 1000.
5030
5113
  # @param page_token [::String]
5031
5114
  # Optional. A token for a page of results other than the first page.
5032
5115
  # @param language_code [::String]
@@ -5108,7 +5191,8 @@ module Google
5108
5191
  ##
5109
5192
  # Registers a service account with subscriber privileges on the Cloud Pub/Sub
5110
5193
  # topic for this Channel Services account. After you create a
5111
- # subscriber, you get the events through {::Google::Cloud::Channel::V1::SubscriberEvent SubscriberEvent}
5194
+ # subscriber, you get the events through
5195
+ # {::Google::Cloud::Channel::V1::SubscriberEvent SubscriberEvent}
5112
5196
  #
5113
5197
  # Possible error codes:
5114
5198
  #
@@ -5142,7 +5226,8 @@ module Google
5142
5226
  # @param account [::String]
5143
5227
  # Required. Resource name of the account.
5144
5228
  # @param service_account [::String]
5145
- # Required. Service account that provides subscriber access to the registered topic.
5229
+ # Required. Service account that provides subscriber access to the registered
5230
+ # topic.
5146
5231
  #
5147
5232
  # @yield [response, operation] Access the result along with the RPC operation
5148
5233
  # @yieldparam response [::Google::Cloud::Channel::V1::RegisterSubscriberResponse]
@@ -5249,7 +5334,8 @@ module Google
5249
5334
  # @param account [::String]
5250
5335
  # Required. Resource name of the account.
5251
5336
  # @param service_account [::String]
5252
- # Required. Service account to unregister from subscriber access to the topic.
5337
+ # Required. Service account to unregister from subscriber access to the
5338
+ # topic.
5253
5339
  #
5254
5340
  # @yield [response, operation] Access the result along with the RPC operation
5255
5341
  # @yieldparam response [::Google::Cloud::Channel::V1::UnregisterSubscriberResponse]
@@ -5352,10 +5438,10 @@ module Google
5352
5438
  # @param account [::String]
5353
5439
  # Required. Resource name of the account.
5354
5440
  # @param page_size [::Integer]
5355
- # Optional. The maximum number of service accounts to return. The service may return
5356
- # fewer than this value.
5357
- # If unspecified, returns at most 100 service accounts.
5358
- # The maximum value is 1000; the server will coerce values above 1000.
5441
+ # Optional. The maximum number of service accounts to return. The service may
5442
+ # return fewer than this value. If unspecified, returns at most 100 service
5443
+ # accounts. The maximum value is 1000; the server will coerce values above
5444
+ # 1000.
5359
5445
  # @param page_token [::String]
5360
5446
  # Optional. A page token, received from a previous `ListSubscribers` call.
5361
5447
  # Provide this to retrieve the subsequent page.