/
cloudchannel-api.json
4569 lines (4569 loc) · 236 KB
/
cloudchannel-api.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/apps.order": {
"description": "Manage users on your domain"
}
}
}
},
"basePath": "",
"baseUrl": "https://cloudchannel.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloudchannel",
"description": "The Cloud Channel API enables Google Cloud partners to have a single unified resale platform and APIs across all of Google Cloud including GCP, Workspace, Maps and Chrome.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/channel",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "cloudchannel:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://cloudchannel.mtls.googleapis.com/",
"name": "cloudchannel",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"accounts": {
"methods": {
"checkCloudIdentityAccountsExist": {
"description": "Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INVALID_VALUE: Invalid domain value in the request. Return value: A list of CloudIdentityCustomerAccount resources for the domain (may be empty) Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no CloudIdentityCustomerAccount resources match the domain.",
"flatPath": "v1/accounts/{accountsId}:checkCloudIdentityAccountsExist",
"httpMethod": "POST",
"id": "cloudchannel.accounts.checkCloudIdentityAccountsExist",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The reseller account's resource name. Parent uses the format: accounts/{account_id}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:checkCloudIdentityAccountsExist",
"request": {
"$ref": "GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest"
},
"response": {
"$ref": "GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"listSubscribers": {
"description": "Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.",
"flatPath": "v1/accounts/{accountsId}:listSubscribers",
"httpMethod": "GET",
"id": "cloudchannel.accounts.listSubscribers",
"parameterOrder": [
"account"
],
"parameters": {
"account": {
"description": "Required. Resource name of the account.",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+account}:listSubscribers",
"response": {
"$ref": "GoogleCloudChannelV1ListSubscribersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"listTransferableOffers": {
"description": "List TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request. Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The supplied auth token is invalid. * The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of TransferableOffer for the given customer and SKU.",
"flatPath": "v1/accounts/{accountsId}:listTransferableOffers",
"httpMethod": "POST",
"id": "cloudchannel.accounts.listTransferableOffers",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the reseller's account.",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:listTransferableOffers",
"request": {
"$ref": "GoogleCloudChannelV1ListTransferableOffersRequest"
},
"response": {
"$ref": "GoogleCloudChannelV1ListTransferableOffersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"listTransferableSkus": {
"description": "List TransferableSkus of a customer based on the Cloud Identity ID or Customer Name in the request. Use this method to list the entitlements information of an unowned customer. You should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The supplied auth token is invalid. * The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's TransferableSku.",
"flatPath": "v1/accounts/{accountsId}:listTransferableSkus",
"httpMethod": "POST",
"id": "cloudchannel.accounts.listTransferableSkus",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The reseller account's resource name. Parent uses the format: accounts/{account_id}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:listTransferableSkus",
"request": {
"$ref": "GoogleCloudChannelV1ListTransferableSkusRequest"
},
"response": {
"$ref": "GoogleCloudChannelV1ListTransferableSkusResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"register": {
"description": "Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.",
"flatPath": "v1/accounts/{accountsId}:register",
"httpMethod": "POST",
"id": "cloudchannel.accounts.register",
"parameterOrder": [
"account"
],
"parameters": {
"account": {
"description": "Required. Resource name of the account.",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+account}:register",
"request": {
"$ref": "GoogleCloudChannelV1RegisterSubscriberRequest"
},
"response": {
"$ref": "GoogleCloudChannelV1RegisterSubscriberResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"unregister": {
"description": "Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.",
"flatPath": "v1/accounts/{accountsId}:unregister",
"httpMethod": "POST",
"id": "cloudchannel.accounts.unregister",
"parameterOrder": [
"account"
],
"parameters": {
"account": {
"description": "Required. Resource name of the account.",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+account}:unregister",
"request": {
"$ref": "GoogleCloudChannelV1UnregisterSubscriberRequest"
},
"response": {
"$ref": "GoogleCloudChannelV1UnregisterSubscriberResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
}
},
"resources": {
"channelPartnerLinks": {
"methods": {
"create": {
"description": "Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists. * NOT_FOUND: No Cloud Identity customer exists for provided domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The new ChannelPartnerLink resource.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks",
"httpMethod": "POST",
"id": "cloudchannel.accounts.channelPartnerLinks.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Create a channel partner link for the provided reseller account's resource name. Parent uses the format: accounts/{account_id}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/channelPartnerLinks",
"request": {
"$ref": "GoogleCloudChannelV1ChannelPartnerLink"
},
"response": {
"$ref": "GoogleCloudChannelV1ChannelPartnerLink"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"get": {
"description": "Returns the requested ChannelPartnerLink resource. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}",
"httpMethod": "GET",
"id": "cloudchannel.accounts.channelPartnerLinks.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the channel partner link to retrieve. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner.",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Optional. The level of granularity the ChannelPartnerLink will display.",
"enum": [
"UNSPECIFIED",
"BASIC",
"FULL"
],
"enumDescriptions": [
"The default / unset value. The API will default to the BASIC view.",
"Includes all fields except the ChannelPartnerLink.channel_partner_cloud_identity_info.",
"Includes all fields."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudChannelV1ChannelPartnerLink"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"list": {
"description": "List ChannelPartnerLinks belonging to a distributor. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: The list of the distributor account's ChannelPartnerLink resources.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks",
"httpMethod": "GET",
"id": "cloudchannel.accounts.channelPartnerLinks.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. Requested page size. Server might return fewer results than requested. If unspecified, server will pick a default size (25). The maximum value is 200; the server will coerce values above 200.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A token for a page of results other than the first page. Obtained using ListChannelPartnerLinksResponse.next_page_token of the previous CloudChannelService.ListChannelPartnerLinks call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the reseller account for listing channel partner links. Parent uses the format: accounts/{account_id}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Optional. The level of granularity the ChannelPartnerLink will display.",
"enum": [
"UNSPECIFIED",
"BASIC",
"FULL"
],
"enumDescriptions": [
"The default / unset value. The API will default to the BASIC view.",
"Includes all fields except the ChannelPartnerLink.channel_partner_cloud_identity_info.",
"Includes all fields."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/channelPartnerLinks",
"response": {
"$ref": "GoogleCloudChannelV1ListChannelPartnerLinksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"patch": {
"description": "Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Link state cannot change from invited to active or suspended. * Cannot send reseller_cloud_identity_id, invite_url, or name in update mask. * NOT_FOUND: ChannelPartnerLink resource not found. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The updated ChannelPartnerLink resource.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}",
"httpMethod": "PATCH",
"id": "cloudchannel.accounts.channelPartnerLinks.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the channel partner link to cancel. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner.",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudChannelV1UpdateChannelPartnerLinkRequest"
},
"response": {
"$ref": "GoogleCloudChannelV1ChannelPartnerLink"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
}
},
"resources": {
"channelPartnerRepricingConfigs": {
"methods": {
"create": {
"description": "Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions. When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month. The following restrictions are for creating configs in the current month. * This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases. * The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours. * There is a limit of ten configs for any ChannelPartner or RepricingConfig.effective_invoice_month. * The contained ChannelPartnerRepricingConfig.repricing_config vaule must be different from the value used in the current config for a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/channelPartnerRepricingConfigs",
"httpMethod": "POST",
"id": "cloudchannel.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the ChannelPartner that will receive the repricing config. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/channelPartnerRepricingConfigs",
"request": {
"$ref": "GoogleCloudChannelV1ChannelPartnerRepricingConfig"
},
"response": {
"$ref": "GoogleCloudChannelV1ChannelPartnerRepricingConfig"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"delete": {
"description": "Deletes the given ChannelPartnerRepricingConfig permanently. You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The ChannelPartnerRepricingConfig is active or in the past. * NOT_FOUND: No ChannelPartnerRepricingConfig found for the name in the request.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/channelPartnerRepricingConfigs/{channelPartnerRepricingConfigsId}",
"httpMethod": "DELETE",
"id": "cloudchannel.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the channel partner repricing config rule to delete.",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+/channelPartnerRepricingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"get": {
"description": "Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The ChannelPartnerRepricingConfig was not found. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the ChannelPartnerRepricingConfig resource, otherwise returns an error.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/channelPartnerRepricingConfigs/{channelPartnerRepricingConfigsId}",
"httpMethod": "GET",
"id": "cloudchannel.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the ChannelPartnerRepricingConfig Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+/channelPartnerRepricingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudChannelV1ChannelPartnerRepricingConfig"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"list": {
"description": "Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the ChannelPartnerRepricingConfig resources. The data for each resource is displayed in the ascending order of: * channel partner ID * RepricingConfig.effective_invoice_month * ChannelPartnerRepricingConfig.update_time If unsuccessful, returns an error.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/channelPartnerRepricingConfigs",
"httpMethod": "GET",
"id": "cloudchannel.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. A filter for [CloudChannelService.ListChannelPartnerRepricingConfigs] results (channel_partner_link only). You can use this filter when you support a BatchGet-like query. To use the filter, you must set `parent=accounts/{account_id}/channelPartnerLinks/-`. Example: `channel_partner_link = accounts/account_id/channelPartnerLinks/c1` OR `channel_partner_link = accounts/account_id/channelPartnerLinks/c2`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of repricing configs to return. The service may return fewer than this value. If unspecified, returns a maximum of 50 rules. The maximum value is 100; values above 100 will be coerced to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A token identifying a page of results beyond the first page. Obtained through ListChannelPartnerRepricingConfigsResponse.next_page_token of the previous CloudChannelService.ListChannelPartnerRepricingConfigs call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the account's ChannelPartnerLink. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs for all channel partners.",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/channelPartnerRepricingConfigs",
"response": {
"$ref": "GoogleCloudChannelV1ListChannelPartnerRepricingConfigsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"patch": {
"description": "Updates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateChannelPartnerRepricingConfig, taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month. When updating a config in the future: * This config must already exist. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/channelPartnerRepricingConfigs/{channelPartnerRepricingConfigsId}",
"httpMethod": "PATCH",
"id": "cloudchannel.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Resource name of the ChannelPartnerRepricingConfig. Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+/channelPartnerRepricingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudChannelV1ChannelPartnerRepricingConfig"
},
"response": {
"$ref": "GoogleCloudChannelV1ChannelPartnerRepricingConfig"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
}
}
},
"customers": {
"methods": {
"create": {
"description": "Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers",
"httpMethod": "POST",
"id": "cloudchannel.accounts.channelPartnerLinks.customers.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id}",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/customers",
"request": {
"$ref": "GoogleCloudChannelV1Customer"
},
"response": {
"$ref": "GoogleCloudChannelV1Customer"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"delete": {
"description": "Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers/{customersId}",
"httpMethod": "DELETE",
"id": "cloudchannel.accounts.channelPartnerLinks.customers.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the customer to delete.",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+/customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"get": {
"description": "Returns the requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers/{customersId}",
"httpMethod": "GET",
"id": "cloudchannel.accounts.channelPartnerLinks.customers.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+/customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudChannelV1Customer"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"import": {
"description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers:import",
"httpMethod": "POST",
"id": "cloudchannel.accounts.channelPartnerLinks.customers.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/customers:import",
"request": {
"$ref": "GoogleCloudChannelV1ImportCustomerRequest"
},
"response": {
"$ref": "GoogleCloudChannelV1Customer"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"list": {
"description": "List Customers. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of Customers, or an empty list if there are no customers.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers",
"httpMethod": "GET",
"id": "cloudchannel.accounts.channelPartnerLinks.customers.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers for more information.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of customers to return. The service may return fewer than this value. If unspecified, returns at most 10 customers. The maximum value is 50.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A token identifying a page of results other than the first page. Obtained through ListCustomersResponse.next_page_token of the previous CloudChannelService.ListCustomers call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id}.",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/customers",
"response": {
"$ref": "GoogleCloudChannelV1ListCustomersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"patch": {
"description": "Updates an existing Customer resource for the reseller or distributor. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: No Customer resource found for the name in the request. Return value: The updated Customer resource.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers/{customersId}",
"httpMethod": "PATCH",
"id": "cloudchannel.accounts.channelPartnerLinks.customers.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+/customers/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The update mask that applies to the resource. Optional.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudChannelV1Customer"
},
"response": {
"$ref": "GoogleCloudChannelV1Customer"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
}
}
}
}
},
"customers": {
"methods": {
"create": {
"description": "Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.",
"flatPath": "v1/accounts/{accountsId}/customers",
"httpMethod": "POST",
"id": "cloudchannel.accounts.customers.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/customers",
"request": {
"$ref": "GoogleCloudChannelV1Customer"
},
"response": {
"$ref": "GoogleCloudChannelV1Customer"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"delete": {
"description": "Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request.",
"flatPath": "v1/accounts/{accountsId}/customers/{customersId}",
"httpMethod": "DELETE",
"id": "cloudchannel.accounts.customers.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the customer to delete.",
"location": "path",
"pattern": "^accounts/[^/]+/customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"get": {
"description": "Returns the requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.",
"flatPath": "v1/accounts/{accountsId}/customers/{customersId}",
"httpMethod": "GET",
"id": "cloudchannel.accounts.customers.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}",
"location": "path",
"pattern": "^accounts/[^/]+/customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudChannelV1Customer"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"import": {
"description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.",
"flatPath": "v1/accounts/{accountsId}/customers:import",
"httpMethod": "POST",
"id": "cloudchannel.accounts.customers.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/customers:import",
"request": {
"$ref": "GoogleCloudChannelV1ImportCustomerRequest"
},
"response": {
"$ref": "GoogleCloudChannelV1Customer"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"list": {
"description": "List Customers. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of Customers, or an empty list if there are no customers.",
"flatPath": "v1/accounts/{accountsId}/customers",
"httpMethod": "GET",
"id": "cloudchannel.accounts.customers.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers for more information.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of customers to return. The service may return fewer than this value. If unspecified, returns at most 10 customers. The maximum value is 50.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A token identifying a page of results other than the first page. Obtained through ListCustomersResponse.next_page_token of the previous CloudChannelService.ListCustomers call.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id}.",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/customers",
"response": {
"$ref": "GoogleCloudChannelV1ListCustomersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"listPurchasableOffers": {
"description": "Lists the following: * Offers that you can purchase for a customer. * Offers that you can change for an entitlement. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller * INVALID_ARGUMENT: Required request parameters are missing or invalid.",
"flatPath": "v1/accounts/{accountsId}/customers/{customersId}:listPurchasableOffers",
"httpMethod": "GET",
"id": "cloudchannel.accounts.customers.listPurchasableOffers",
"parameterOrder": [
"customer"
],
"parameters": {
"changeOfferPurchase.entitlement": {
"description": "Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}",
"location": "query",
"type": "string"
},
"changeOfferPurchase.newSku": {
"description": "Optional. Resource name of the new target SKU. Provide this SKU when upgrading or downgrading an entitlement. Format: products/{product_id}/skus/{sku_id}",
"location": "query",
"type": "string"
},
"createEntitlementPurchase.sku": {
"description": "Required. SKU that the result should be restricted to. Format: products/{product_id}/skus/{sku_id}.",
"location": "query",
"type": "string"
},
"customer": {
"description": "Required. The resource name of the customer to list Offers for. Format: accounts/{account_id}/customers/{customer_id}.",
"location": "path",
"pattern": "^accounts/[^/]+/customers/[^/]+$",
"required": true,
"type": "string"
},
"languageCode": {
"description": "Optional. The BCP-47 language code. For example, \"en-US\". The response will localize in the corresponding language code, if specified. The default value is \"en-US\".",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 Offers. The maximum value is 1000; the server will coerce values above 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A token for a page of results other than the first page.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+customer}:listPurchasableOffers",
"response": {
"$ref": "GoogleCloudChannelV1ListPurchasableOffersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"listPurchasableSkus": {
"description": "Lists the following: * SKUs that you can purchase for a customer * SKUs that you can upgrade or downgrade for an entitlement. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid.",
"flatPath": "v1/accounts/{accountsId}/customers/{customersId}:listPurchasableSkus",
"httpMethod": "GET",
"id": "cloudchannel.accounts.customers.listPurchasableSkus",
"parameterOrder": [
"customer"
],
"parameters": {
"changeOfferPurchase.changeType": {
"description": "Required. Change Type for the entitlement.",
"enum": [
"CHANGE_TYPE_UNSPECIFIED",
"UPGRADE",
"DOWNGRADE"
],
"enumDescriptions": [
"Not used.",
"SKU is an upgrade on the current entitlement.",