v1.d.ts
271 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace cloudchannel_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Channel API
*
*
*
* @example
* ```js
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
* ```
*/
export class Cloudchannel {
context: APIRequestContext;
accounts: Resource$Accounts;
operations: Resource$Operations;
products: Resource$Products;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Request message for CloudChannelService.ActivateEntitlement.
*/
export interface Schema$GoogleCloudChannelV1ActivateEntitlementRequest {
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Information needed to create an Admin User for Google Workspace.
*/
export interface Schema$GoogleCloudChannelV1AdminUser {
/**
* Primary email of the admin user.
*/
email?: string | null;
/**
* Family name of the admin user.
*/
familyName?: string | null;
/**
* Given name of the admin user.
*/
givenName?: string | null;
}
/**
* Association links that an entitlement has to other entitlements.
*/
export interface Schema$GoogleCloudChannelV1alpha1AssociationInfo {
/**
* The name of the base entitlement, for which this entitlement is an add-on.
*/
baseEntitlement?: string | null;
}
/**
* Commitment settings for commitment-based offers.
*/
export interface Schema$GoogleCloudChannelV1alpha1CommitmentSettings {
/**
* Output only. Commitment end timestamp.
*/
endTime?: string | null;
/**
* Optional. Renewal settings applicable for a commitment-based Offer.
*/
renewalSettings?: Schema$GoogleCloudChannelV1alpha1RenewalSettings;
/**
* Output only. Commitment start timestamp.
*/
startTime?: string | null;
}
/**
* Represents Pub/Sub message content describing customer update.
*/
export interface Schema$GoogleCloudChannelV1alpha1CustomerEvent {
/**
* Resource name of the customer. Format: accounts/{account_id\}/customers/{customer_id\}
*/
customer?: string | null;
/**
* Type of event which happened on the customer.
*/
eventType?: string | null;
}
/**
* An entitlement is a representation of a customer's ability to use a service.
*/
export interface Schema$GoogleCloudChannelV1alpha1Entitlement {
/**
* The current number of users that are assigned a license for the product defined in provisioned_service.skuId. Read-only. Deprecated: Use `parameters` instead.
*/
assignedUnits?: number | null;
/**
* Association information to other entitlements.
*/
associationInfo?: Schema$GoogleCloudChannelV1alpha1AssociationInfo;
/**
* Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order. This field is generally used in 2-tier ordering, where the order is placed by a top-level distributor on behalf of their channel partner or reseller. Required for distributors. Deprecated: `channel_partner_id` has been moved to the Customer.
*/
channelPartnerId?: string | null;
/**
* Commitment settings for a commitment-based Offer. Required for commitment based offers.
*/
commitmentSettings?: Schema$GoogleCloudChannelV1alpha1CommitmentSettings;
/**
* Output only. The time at which the entitlement is created.
*/
createTime?: string | null;
/**
* Maximum number of units for a non commitment-based Offer, such as Flexible, Trial or Free entitlements. For commitment-based entitlements, this is a read-only field, which only the internal support team can update. Deprecated: Use `parameters` instead.
*/
maxUnits?: number | null;
/**
* Output only. Resource name of an entitlement in the form: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}.
*/
name?: string | null;
/**
* Number of units for a commitment-based Offer. For example, for seat-based Offers, this would be the number of seats; for license-based Offers, this would be the number of licenses. Required for creating commitment-based Offers. Deprecated: Use `parameters` instead.
*/
numUnits?: number | null;
/**
* Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id\}/offers/{offer_id\}.
*/
offer?: string | null;
/**
* Extended entitlement parameters. When creating an entitlement, valid parameters' names and values are defined in the offer's parameter definitions.
*/
parameters?: Schema$GoogleCloudChannelV1alpha1Parameter[];
/**
* Output only. Service provisioning details for the entitlement.
*/
provisionedService?: Schema$GoogleCloudChannelV1alpha1ProvisionedService;
/**
* Output only. Current provisioning state of the entitlement.
*/
provisioningState?: string | null;
/**
* Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
*/
purchaseOrderId?: string | null;
/**
* Output only. Enumerable of all current suspension reasons for an entitlement.
*/
suspensionReasons?: string[] | null;
/**
* Output only. Settings for trial offers.
*/
trialSettings?: Schema$GoogleCloudChannelV1alpha1TrialSettings;
/**
* Output only. The time at which the entitlement is updated.
*/
updateTime?: string | null;
}
/**
* Represents Pub/Sub message content describing entitlement update.
*/
export interface Schema$GoogleCloudChannelV1alpha1EntitlementEvent {
/**
* Resource name of an entitlement of the form: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
entitlement?: string | null;
/**
* Type of event which happened on the entitlement.
*/
eventType?: string | null;
}
/**
* Provides contextual information about a google.longrunning.Operation.
*/
export interface Schema$GoogleCloudChannelV1alpha1OperationMetadata {
/**
* The RPC that initiated this Long Running Operation.
*/
operationType?: string | null;
}
/**
* Definition for extended entitlement parameters.
*/
export interface Schema$GoogleCloudChannelV1alpha1Parameter {
/**
* Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active.
*/
editable?: boolean | null;
/**
* Name of the parameter.
*/
name?: string | null;
/**
* Value of the parameter.
*/
value?: Schema$GoogleCloudChannelV1alpha1Value;
}
/**
* Represents period in days/months/years.
*/
export interface Schema$GoogleCloudChannelV1alpha1Period {
/**
* Total duration of Period Type defined.
*/
duration?: number | null;
/**
* Period Type.
*/
periodType?: string | null;
}
/**
* Service provisioned for an entitlement.
*/
export interface Schema$GoogleCloudChannelV1alpha1ProvisionedService {
/**
* Output only. The product pertaining to the provisioning resource as specified in the Offer.
*/
productId?: string | null;
/**
* Output only. Provisioning ID of the entitlement. For Google Workspace, this would be the underlying Subscription ID.
*/
provisioningId?: string | null;
/**
* Output only. The SKU pertaining to the provisioning resource as specified in the Offer.
*/
skuId?: string | null;
}
/**
* Renewal settings for renewable Offers.
*/
export interface Schema$GoogleCloudChannelV1alpha1RenewalSettings {
/**
* If true, disables commitment-based offer on renewal and switches to flexible or pay as you go. Deprecated: Use `payment_plan` instead.
*/
disableCommitment?: boolean | null;
/**
* If false, the plan will be completed at the end date.
*/
enableRenewal?: boolean | null;
/**
* Describes how frequently the reseller will be billed, such as once per month.
*/
paymentCycle?: Schema$GoogleCloudChannelV1alpha1Period;
/**
* Set if enable_renewal=true. Deprecated: Use `payment_cycle` instead.
*/
paymentOption?: string | null;
/**
* Describes how a reseller will be billed.
*/
paymentPlan?: string | null;
/**
* If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.
*/
resizeUnitCount?: boolean | null;
}
/**
* Represents information which resellers will get as part of notification from Cloud Pub/Sub.
*/
export interface Schema$GoogleCloudChannelV1alpha1SubscriberEvent {
/**
* Customer event send as part of Pub/Sub event to partners.
*/
customerEvent?: Schema$GoogleCloudChannelV1alpha1CustomerEvent;
/**
* Entitlement event send as part of Pub/Sub event to partners.
*/
entitlementEvent?: Schema$GoogleCloudChannelV1alpha1EntitlementEvent;
}
/**
* Response message for CloudChannelService.TransferEntitlements. This is put in the response field of google.longrunning.Operation.
*/
export interface Schema$GoogleCloudChannelV1alpha1TransferEntitlementsResponse {
/**
* The transferred entitlements.
*/
entitlements?: Schema$GoogleCloudChannelV1alpha1Entitlement[];
}
/**
* Settings for trial offers.
*/
export interface Schema$GoogleCloudChannelV1alpha1TrialSettings {
/**
* Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example [Epoch converter](https://www.epochconverter.com).
*/
endTime?: string | null;
/**
* Determines if the entitlement is in a trial or not: * `true` - The entitlement is in trial. * `false` - The entitlement is not in trial.
*/
trial?: boolean | null;
}
/**
* Data type and value of a parameter.
*/
export interface Schema$GoogleCloudChannelV1alpha1Value {
/**
* Represents a boolean value.
*/
boolValue?: boolean | null;
/**
* Represents a double value.
*/
doubleValue?: number | null;
/**
* Represents an int64 value.
*/
int64Value?: string | null;
/**
* Represents an 'Any' proto value.
*/
protoValue?: {
[key: string]: any;
} | null;
/**
* Represents a string value.
*/
stringValue?: string | null;
}
/**
* Association links that an entitlement has to other entitlements.
*/
export interface Schema$GoogleCloudChannelV1AssociationInfo {
/**
* The name of the base entitlement, for which this entitlement is an add-on.
*/
baseEntitlement?: string | null;
}
/**
* Request message for CloudChannelService.CancelEntitlement.
*/
export interface Schema$GoogleCloudChannelV1CancelEntitlementRequest {
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Request message for CloudChannelService.ChangeOffer.
*/
export interface Schema$GoogleCloudChannelV1ChangeOfferRequest {
/**
* Required. New Offer. Format: accounts/{account_id\}/offers/{offer_id\}.
*/
offer?: string | null;
/**
* Optional. Parameters needed to purchase the Offer.
*/
parameters?: Schema$GoogleCloudChannelV1Parameter[];
/**
* Optional. Purchase order id provided by the reseller.
*/
purchaseOrderId?: string | null;
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Request message for CloudChannelService.ChangeParametersRequest.
*/
export interface Schema$GoogleCloudChannelV1ChangeParametersRequest {
/**
* Required. Entitlement parameters to update. You can only change editable parameters.
*/
parameters?: Schema$GoogleCloudChannelV1Parameter[];
/**
* Optional. Purchase order ID provided by the reseller.
*/
purchaseOrderId?: string | null;
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Request message for CloudChannelService.ChangeRenewalSettings.
*/
export interface Schema$GoogleCloudChannelV1ChangeRenewalSettingsRequest {
/**
* Required. New renewal settings.
*/
renewalSettings?: Schema$GoogleCloudChannelV1RenewalSettings;
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
*/
export interface Schema$GoogleCloudChannelV1ChannelPartnerLink {
/**
* Output only. Cloud Identity info of the channel partner (IR).
*/
channelPartnerCloudIdentityInfo?: Schema$GoogleCloudChannelV1CloudIdentityInfo;
/**
* Output only. Timestamp of when the channel partner link is created.
*/
createTime?: string | null;
/**
* Output only. URI of the web page where partner accepts the link invitation.
*/
inviteLinkUri?: string | null;
/**
* Required. State of the channel partner link.
*/
linkState?: string | null;
/**
* Output only. Resource name for the channel partner link, in the format accounts/{account_id\}/channelPartnerLinks/{id\}.
*/
name?: string | null;
/**
* Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
*/
publicId?: string | null;
/**
* Required. Cloud Identity ID of the linked reseller.
*/
resellerCloudIdentityId?: string | null;
/**
* Output only. Timestamp of when the channel partner link is updated.
*/
updateTime?: string | null;
}
/**
* Request message for CloudChannelService.CheckCloudIdentityAccountsExist.
*/
export interface Schema$GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest {
/**
* Required. Domain to fetch for Cloud Identity account customer.
*/
domain?: string | null;
}
/**
* Response message for CloudChannelService.CheckCloudIdentityAccountsExist.
*/
export interface Schema$GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse {
/**
* The Cloud Identity accounts associated with the domain.
*/
cloudIdentityAccounts?: Schema$GoogleCloudChannelV1CloudIdentityCustomerAccount[];
}
/**
* Entity representing a Cloud Identity account that may be associated with a Channel Services API partner.
*/
export interface Schema$GoogleCloudChannelV1CloudIdentityCustomerAccount {
/**
* If existing = true, the Cloud Identity ID of the customer.
*/
customerCloudIdentityId?: string | null;
/**
* If owned = true, the name of the customer that owns the Cloud Identity account. Customer_name uses the format: accounts/{account_id\}/customers/{customer_id\}
*/
customerName?: string | null;
/**
* Returns true if a Cloud Identity account exists for a specific domain.
*/
existing?: boolean | null;
/**
* Returns true if the Cloud Identity account is associated with a customer of the Channel Services partner.
*/
owned?: boolean | null;
}
/**
* Cloud Identity information for the Cloud Channel Customer.
*/
export interface Schema$GoogleCloudChannelV1CloudIdentityInfo {
/**
* Output only. URI of Customer's Admin console dashboard.
*/
adminConsoleUri?: string | null;
/**
* The alternate email.
*/
alternateEmail?: string | null;
/**
* CustomerType indicates verification type needed for using services.
*/
customerType?: string | null;
/**
* Edu information about the customer.
*/
eduData?: Schema$GoogleCloudChannelV1EduData;
/**
* Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.
*/
isDomainVerified?: boolean | null;
/**
* Language code.
*/
languageCode?: string | null;
/**
* Phone number associated with the Cloud Identity.
*/
phoneNumber?: string | null;
/**
* Output only. The primary domain name.
*/
primaryDomain?: string | null;
}
/**
* Commitment settings for commitment-based offers.
*/
export interface Schema$GoogleCloudChannelV1CommitmentSettings {
/**
* Output only. Commitment end timestamp.
*/
endTime?: string | null;
/**
* Optional. Renewal settings applicable for a commitment-based Offer.
*/
renewalSettings?: Schema$GoogleCloudChannelV1RenewalSettings;
/**
* Output only. Commitment start timestamp.
*/
startTime?: string | null;
}
/**
* Represents the constraints for buying the Offer.
*/
export interface Schema$GoogleCloudChannelV1Constraints {
/**
* Represents constraints required to purchase the Offer for a customer.
*/
customerConstraints?: Schema$GoogleCloudChannelV1CustomerConstraints;
}
/**
* Contact information for a customer account.
*/
export interface Schema$GoogleCloudChannelV1ContactInfo {
/**
* Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name.
*/
displayName?: string | null;
/**
* The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts.
*/
email?: string | null;
/**
* The customer account contact's first name.
*/
firstName?: string | null;
/**
* The customer account contact's last name.
*/
lastName?: string | null;
/**
* The customer account's contact phone number.
*/
phone?: string | null;
/**
* Optional. The customer account contact's job title.
*/
title?: string | null;
}
/**
* Request message for CloudChannelService.CreateEntitlement
*/
export interface Schema$GoogleCloudChannelV1CreateEntitlementRequest {
/**
* Required. The entitlement to create.
*/
entitlement?: Schema$GoogleCloudChannelV1Entitlement;
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Entity representing a customer of a reseller or distributor.
*/
export interface Schema$GoogleCloudChannelV1Customer {
/**
* Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses.
*/
alternateEmail?: string | null;
/**
* Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer.
*/
channelPartnerId?: string | null;
/**
* Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource.
*/
cloudIdentityId?: string | null;
/**
* Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer.
*/
cloudIdentityInfo?: Schema$GoogleCloudChannelV1CloudIdentityInfo;
/**
* Output only. Time when the customer was created.
*/
createTime?: string | null;
/**
* Required. The customer's primary domain. Must match the primary contact email's domain.
*/
domain?: string | null;
/**
* Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
*/
languageCode?: string | null;
/**
* Output only. Resource name of the customer. Format: accounts/{account_id\}/customers/{customer_id\}
*/
name?: string | null;
/**
* Required. Name of the organization that the customer entity represents.
*/
orgDisplayName?: string | null;
/**
* Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.
*/
orgPostalAddress?: Schema$GoogleTypePostalAddress;
/**
* Primary contact info.
*/
primaryContactInfo?: Schema$GoogleCloudChannelV1ContactInfo;
/**
* Output only. Time when the customer was updated.
*/
updateTime?: string | null;
}
/**
* Represents constraints required to purchase the Offer for a customer.
*/
export interface Schema$GoogleCloudChannelV1CustomerConstraints {
/**
* Allowed Customer Type.
*/
allowedCustomerTypes?: string[] | null;
/**
* Allowed geographical regions of the customer.
*/
allowedRegions?: string[] | null;
/**
* Allowed Promotional Order Type. Present for Promotional offers.
*/
promotionalOrderTypes?: string[] | null;
}
/**
* Represents Pub/Sub message content describing customer update.
*/
export interface Schema$GoogleCloudChannelV1CustomerEvent {
/**
* Resource name of the customer. Format: accounts/{account_id\}/customers/{customer_id\}
*/
customer?: string | null;
/**
* Type of event which happened on the customer.
*/
eventType?: string | null;
}
/**
* Required Edu Attributes
*/
export interface Schema$GoogleCloudChannelV1EduData {
/**
* Size of the institute.
*/
instituteSize?: string | null;
/**
* Designated institute type of customer.
*/
instituteType?: string | null;
/**
* Web address for the edu customer's institution.
*/
website?: string | null;
}
/**
* An entitlement is a representation of a customer's ability to use a service.
*/
export interface Schema$GoogleCloudChannelV1Entitlement {
/**
* Association information to other entitlements.
*/
associationInfo?: Schema$GoogleCloudChannelV1AssociationInfo;
/**
* Commitment settings for a commitment-based Offer. Required for commitment based offers.
*/
commitmentSettings?: Schema$GoogleCloudChannelV1CommitmentSettings;
/**
* Output only. The time at which the entitlement is created.
*/
createTime?: string | null;
/**
* Output only. Resource name of an entitlement in the form: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}.
*/
name?: string | null;
/**
* Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id\}/offers/{offer_id\}.
*/
offer?: string | null;
/**
* Extended entitlement parameters. When creating an entitlement, valid parameters' names and values are defined in the offer's parameter definitions.
*/
parameters?: Schema$GoogleCloudChannelV1Parameter[];
/**
* Output only. Service provisioning details for the entitlement.
*/
provisionedService?: Schema$GoogleCloudChannelV1ProvisionedService;
/**
* Output only. Current provisioning state of the entitlement.
*/
provisioningState?: string | null;
/**
* Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
*/
purchaseOrderId?: string | null;
/**
* Output only. Enumerable of all current suspension reasons for an entitlement.
*/
suspensionReasons?: string[] | null;
/**
* Output only. Settings for trial offers.
*/
trialSettings?: Schema$GoogleCloudChannelV1TrialSettings;
/**
* Output only. The time at which the entitlement is updated.
*/
updateTime?: string | null;
}
/**
* Represents Pub/Sub message content describing entitlement update.
*/
export interface Schema$GoogleCloudChannelV1EntitlementEvent {
/**
* Resource name of an entitlement of the form: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
entitlement?: string | null;
/**
* Type of event which happened on the entitlement.
*/
eventType?: string | null;
}
/**
* Response message for CloudChannelService.ListChannelPartnerLinks.
*/
export interface Schema$GoogleCloudChannelV1ListChannelPartnerLinksResponse {
/**
* The Channel partner links for a reseller.
*/
channelPartnerLinks?: Schema$GoogleCloudChannelV1ChannelPartnerLink[];
/**
* A token to retrieve the next page of results. Pass to ListChannelPartnerLinksRequest.page_token to obtain that page.
*/
nextPageToken?: string | null;
}
/**
* Response message for CloudChannelService.ListCustomers.
*/
export interface Schema$GoogleCloudChannelV1ListCustomersResponse {
/**
* The customers belonging to a reseller or distributor.
*/
customers?: Schema$GoogleCloudChannelV1Customer[];
/**
* A token to retrieve the next page of results. Pass to ListCustomersRequest.page_token to obtain that page.
*/
nextPageToken?: string | null;
}
/**
* Response message for CloudChannelService.ListEntitlements.
*/
export interface Schema$GoogleCloudChannelV1ListEntitlementsResponse {
/**
* The reseller customer's entitlements.
*/
entitlements?: Schema$GoogleCloudChannelV1Entitlement[];
/**
* A token to list the next page of results. Pass to ListEntitlementsRequest.page_token to obtain that page.
*/
nextPageToken?: string | null;
}
/**
* Response message for ListOffers.
*/
export interface Schema$GoogleCloudChannelV1ListOffersResponse {
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of Offers requested.
*/
offers?: Schema$GoogleCloudChannelV1Offer[];
}
/**
* Response message for ListProducts.
*/
export interface Schema$GoogleCloudChannelV1ListProductsResponse {
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* List of Products requested.
*/
products?: Schema$GoogleCloudChannelV1Product[];
}
/**
* Response message for ListPurchasableOffers.
*/
export interface Schema$GoogleCloudChannelV1ListPurchasableOffersResponse {
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of Offers requested.
*/
purchasableOffers?: Schema$GoogleCloudChannelV1PurchasableOffer[];
}
/**
* Response message for ListPurchasableSkus.
*/
export interface Schema$GoogleCloudChannelV1ListPurchasableSkusResponse {
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of SKUs requested.
*/
purchasableSkus?: Schema$GoogleCloudChannelV1PurchasableSku[];
}
/**
* Response message for ListSkus.
*/
export interface Schema$GoogleCloudChannelV1ListSkusResponse {
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of SKUs requested.
*/
skus?: Schema$GoogleCloudChannelV1Sku[];
}
/**
* Response Message for ListSubscribers.
*/
export interface Schema$GoogleCloudChannelV1ListSubscribersResponse {
/**
* A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* List of service accounts which have subscriber access to the topic.
*/
serviceAccounts?: string[] | null;
/**
* Name of the topic registered with the reseller.
*/
topic?: string | null;
}
/**
* Request message for CloudChannelService.ListTransferableOffers
*/
export interface Schema$GoogleCloudChannelV1ListTransferableOffersRequest {
/**
* Customer's Cloud Identity ID
*/
cloudIdentityId?: string | null;
/**
* A reseller should create a customer and use the resource name of that customer here.
*/
customerName?: string | null;
/**
* 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".
*/
languageCode?: string | null;
/**
* 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.
*/
pageSize?: number | null;
/**
* A token for a page of results other than the first page. Obtained using ListTransferableOffersResponse.next_page_token of the previous CloudChannelService.ListTransferableOffers call.
*/
pageToken?: string | null;
/**
* Required. The SKU to look up Offers for.
*/
sku?: string | null;
}
/**
* Response message for CloudChannelService.ListTransferableOffers.
*/
export interface Schema$GoogleCloudChannelV1ListTransferableOffersResponse {
/**
* A token to retrieve the next page of results. Pass to ListTransferableOffersRequest.page_token to obtain that page.
*/
nextPageToken?: string | null;
/**
* Information about Offers for a customer that can be used for transfer.
*/
transferableOffers?: Schema$GoogleCloudChannelV1TransferableOffer[];
}
/**
* Request message for CloudChannelService.ListTransferableSkus
*/
export interface Schema$GoogleCloudChannelV1ListTransferableSkusRequest {
/**
* The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.
*/
authToken?: string | null;
/**
* Customer's Cloud Identity ID
*/
cloudIdentityId?: string | null;
/**
* A reseller is required to create a customer and use the resource name of the created customer here. Customer_name uses the format: accounts/{account_id\}/customers/{customer_id\}
*/
customerName?: string | null;
/**
* 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". Optional.
*/
languageCode?: string | null;
/**
* The requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000. Optional.
*/
pageSize?: number | null;
/**
* A token for a page of results other than the first page. Obtained using ListTransferableSkusResponse.next_page_token of the previous CloudChannelService.ListTransferableSkus call. Optional.
*/
pageToken?: string | null;
}
/**
* Response message for CloudChannelService.ListTransferableSkus.
*/
export interface Schema$GoogleCloudChannelV1ListTransferableSkusResponse {
/**
* A token to retrieve the next page of results. Pass to ListTransferableSkusRequest.page_token to obtain that page.
*/
nextPageToken?: string | null;
/**
* Information about existing SKUs for a customer that needs a transfer.
*/
transferableSkus?: Schema$GoogleCloudChannelV1TransferableSku[];
}
/**
* Represents the marketing information for a Product, SKU or Offer.
*/
export interface Schema$GoogleCloudChannelV1MarketingInfo {
/**
* Default logo.
*/
defaultLogo?: Schema$GoogleCloudChannelV1Media;
/**
* Human readable description. Description can contain HTML.
*/
description?: string | null;
/**
* Human readable name.
*/
displayName?: string | null;
}
/**
* Represents media information.
*/
export interface Schema$GoogleCloudChannelV1Media {
/**
* URL of the media.
*/
content?: string | null;
/**
* Title of the media.
*/
title?: string | null;
/**
* Type of the media.
*/
type?: string | null;
}
/**
* Represents an offer made to resellers for purchase. An offer is associated with a Sku, has a plan for payment, a price, and defines the constraints for buying.
*/
export interface Schema$GoogleCloudChannelV1Offer {
/**
* Constraints on transacting the Offer.
*/
constraints?: Schema$GoogleCloudChannelV1Constraints;
/**
* Output only. End of the Offer validity time.
*/
endTime?: string | null;
/**
* Marketing information for the Offer.
*/
marketingInfo?: Schema$GoogleCloudChannelV1MarketingInfo;
/**
* Resource Name of the Offer. Format: accounts/{account_id\}/offers/{offer_id\}
*/
name?: string | null;
/**
* Parameters required to use current Offer to purchase.
*/
parameterDefinitions?: Schema$GoogleCloudChannelV1ParameterDefinition[];
/**
* Describes the payment plan for the Offer.
*/
plan?: Schema$GoogleCloudChannelV1Plan;
/**
* Price for each monetizable resource type.
*/
priceByResources?: Schema$GoogleCloudChannelV1PriceByResource[];
/**
* SKU the offer is associated with.
*/
sku?: Schema$GoogleCloudChannelV1Sku;
/**
* Start of the Offer validity time.
*/
startTime?: string | null;
}
/**
* Provides contextual information about a google.longrunning.Operation.
*/
export interface Schema$GoogleCloudChannelV1OperationMetadata {
/**
* The RPC that initiated this Long Running Operation.
*/
operationType?: string | null;
}
/**
* Definition for extended entitlement parameters.
*/
export interface Schema$GoogleCloudChannelV1Parameter {
/**
* Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active.
*/
editable?: boolean | null;
/**
* Name of the parameter.
*/
name?: string | null;
/**
* Value of the parameter.
*/
value?: Schema$GoogleCloudChannelV1Value;
}
/**
* Parameter's definition. Specifies what parameter is required to use the current Offer to purchase.
*/
export interface Schema$GoogleCloudChannelV1ParameterDefinition {
/**
* If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.
*/
allowedValues?: Schema$GoogleCloudChannelV1Value[];
/**
* Maximum value of the parameter, if applicable. Inclusive. For example, maximum seats when purchasing Google Workspace Business Standard. Applicable to INT64 and DOUBLE parameter types.
*/
maxValue?: Schema$GoogleCloudChannelV1Value;
/**
* Minimal value of the parameter, if applicable. Inclusive. For example, minimal commitment when purchasing Anthos is 0.01. Applicable to INT64 and DOUBLE parameter types.
*/
minValue?: Schema$GoogleCloudChannelV1Value;
/**
* Name of the parameter.
*/
name?: string | null;
/**
* If set to true, parameter is optional to purchase this Offer.
*/
optional?: boolean | null;
/**
* Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here.
*/
parameterType?: string | null;
}
/**
* Represents period in days/months/years.
*/
export interface Schema$GoogleCloudChannelV1Period {
/**
* Total duration of Period Type defined.
*/
duration?: number | null;
/**
* Period Type.
*/
periodType?: string | null;
}
/**
* The payment plan for the Offer. Describes how to make a payment.
*/
export interface Schema$GoogleCloudChannelV1Plan {
/**
* Reseller Billing account to charge after an offer transaction. Only present for Google Cloud Platform offers.
*/
billingAccount?: string | null;
/**
* Describes how frequently the reseller will be billed, such as once per month.
*/
paymentCycle?: Schema$GoogleCloudChannelV1Period;
/**
* Describes how a reseller will be billed.
*/
paymentPlan?: string | null;
/**
* Specifies when the payment needs to happen.
*/
paymentType?: string | null;
/**
* Present for Offers with a trial period. For trial-only Offers, a paid service needs to start before the trial period ends for continued service. For Regular Offers with a trial period, the regular pricing goes into effect when trial period ends, or if paid service is started before the end of the trial period.
*/
trialPeriod?: Schema$GoogleCloudChannelV1Period;
}
/**
* Represents the price of the Offer.
*/
export interface Schema$GoogleCloudChannelV1Price {
/**
* Base price.
*/
basePrice?: Schema$GoogleTypeMoney;
/**
* Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2.
*/
discount?: number | null;
/**
* Effective Price after applying the discounts.
*/
effectivePrice?: Schema$GoogleTypeMoney;
/**
* Link to external price list, such as link to Google Voice rate card.
*/
externalPriceUri?: string | null;
}
/**
* Represents price by resource type.
*/
export interface Schema$GoogleCloudChannelV1PriceByResource {
/**
* Price of the Offer. Present if there are no price phases.
*/
price?: Schema$GoogleCloudChannelV1Price;
/**
* Specifies the price by time range.
*/
pricePhases?: Schema$GoogleCloudChannelV1PricePhase[];
/**
* Resource Type. Example: SEAT
*/
resourceType?: string | null;
}
/**
* Specifies the price by the duration of months. For example, a 20% discount for the first six months, then a 10% discount starting on the seventh month.
*/
export interface Schema$GoogleCloudChannelV1PricePhase {
/**
* Defines first period for the phase.
*/
firstPeriod?: number | null;
/**
* Defines first period for the phase.
*/
lastPeriod?: number | null;
/**
* Defines the phase period type.
*/
periodType?: string | null;
/**
* Price of the phase. Present if there are no price tiers.
*/
price?: Schema$GoogleCloudChannelV1Price;
/**
* Price by the resource tiers.
*/
priceTiers?: Schema$GoogleCloudChannelV1PriceTier[];
}
/**
* Defines price at resource tier level. For example, an offer with following definition : * Tier 1: Provide 25% discount for all seats between 1 and 25. * Tier 2: Provide 10% discount for all seats between 26 and 100. * Tier 3: Provide flat 15% discount for all seats above 100. Each of these tiers is represented as a PriceTier.
*/
export interface Schema$GoogleCloudChannelV1PriceTier {
/**
* First resource for which the tier price applies.
*/
firstResource?: number | null;
/**
* Last resource for which the tier price applies.
*/
lastResource?: number | null;
/**
* Price of the tier.
*/
price?: Schema$GoogleCloudChannelV1Price;
}
/**
* A Product is the entity a customer uses when placing an order. For example, Google Workspace, Google Voice, etc.
*/
export interface Schema$GoogleCloudChannelV1Product {
/**
* Marketing information for the product.
*/
marketingInfo?: Schema$GoogleCloudChannelV1MarketingInfo;
/**
* Resource Name of the Product. Format: products/{product_id\}
*/
name?: string | null;
}
/**
* Request message for CloudChannelService.ProvisionCloudIdentity
*/
export interface Schema$GoogleCloudChannelV1ProvisionCloudIdentityRequest {
/**
* CloudIdentity-specific customer information.
*/
cloudIdentityInfo?: Schema$GoogleCloudChannelV1CloudIdentityInfo;
/**
* Admin user information.
*/
user?: Schema$GoogleCloudChannelV1AdminUser;
/**
* Validate the request and preview the review, but do not post it.
*/
validateOnly?: boolean | null;
}
/**
* Service provisioned for an entitlement.
*/
export interface Schema$GoogleCloudChannelV1ProvisionedService {
/**
* Output only. The product pertaining to the provisioning resource as specified in the Offer.
*/
productId?: string | null;
/**
* Output only. Provisioning ID of the entitlement. For Google Workspace, this would be the underlying Subscription ID.
*/
provisioningId?: string | null;
/**
* Output only. The SKU pertaining to the provisioning resource as specified in the Offer.
*/
skuId?: string | null;
}
/**
* Offer that you can purchase for a customer. This is used in the ListPurchasableOffer API response.
*/
export interface Schema$GoogleCloudChannelV1PurchasableOffer {
/**
* Offer.
*/
offer?: Schema$GoogleCloudChannelV1Offer;
}
/**
* SKU that you can purchase. This is used in ListPurchasableSku API response.
*/
export interface Schema$GoogleCloudChannelV1PurchasableSku {
/**
* SKU
*/
sku?: Schema$GoogleCloudChannelV1Sku;
}
/**
* Request Message for RegisterSubscriber.
*/
export interface Schema$GoogleCloudChannelV1RegisterSubscriberRequest {
/**
* Required. Service account that provides subscriber access to the registered topic.
*/
serviceAccount?: string | null;
}
/**
* Response Message for RegisterSubscriber.
*/
export interface Schema$GoogleCloudChannelV1RegisterSubscriberResponse {
/**
* Name of the topic the subscriber will listen to.
*/
topic?: string | null;
}
/**
* Renewal settings for renewable Offers.
*/
export interface Schema$GoogleCloudChannelV1RenewalSettings {
/**
* If false, the plan will be completed at the end date.
*/
enableRenewal?: boolean | null;
/**
* Describes how frequently the reseller will be billed, such as once per month.
*/
paymentCycle?: Schema$GoogleCloudChannelV1Period;
/**
* Describes how a reseller will be billed.
*/
paymentPlan?: string | null;
/**
* If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.
*/
resizeUnitCount?: boolean | null;
}
/**
* Represents a product's purchasable Stock Keeping Unit (SKU). SKUs represent the different variations of the product. For example, Google Workspace Business Standard and Google Workspace Business Plus are Google Workspace product SKUs.
*/
export interface Schema$GoogleCloudChannelV1Sku {
/**
* Marketing information for the SKU.
*/
marketingInfo?: Schema$GoogleCloudChannelV1MarketingInfo;
/**
* Resource Name of the SKU. Format: products/{product_id\}/skus/{sku_id\}
*/
name?: string | null;
/**
* Product the SKU is associated with.
*/
product?: Schema$GoogleCloudChannelV1Product;
}
/**
* Request message for CloudChannelService.StartPaidService.
*/
export interface Schema$GoogleCloudChannelV1StartPaidServiceRequest {
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Represents information which resellers will get as part of notification from Cloud Pub/Sub.
*/
export interface Schema$GoogleCloudChannelV1SubscriberEvent {
/**
* Customer event send as part of Pub/Sub event to partners.
*/
customerEvent?: Schema$GoogleCloudChannelV1CustomerEvent;
/**
* Entitlement event send as part of Pub/Sub event to partners.
*/
entitlementEvent?: Schema$GoogleCloudChannelV1EntitlementEvent;
}
/**
* Request message for CloudChannelService.SuspendEntitlement.
*/
export interface Schema$GoogleCloudChannelV1SuspendEntitlementRequest {
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* TransferableOffer represents an Offer that can be used in Transfer. Read-only.
*/
export interface Schema$GoogleCloudChannelV1TransferableOffer {
/**
* Offer with parameter constraints updated to allow the Transfer.
*/
offer?: Schema$GoogleCloudChannelV1Offer;
}
/**
* TransferableSku represents information a reseller needs to view existing provisioned services for a customer that they do not own. Read-only.
*/
export interface Schema$GoogleCloudChannelV1TransferableSku {
/**
* Optional. The customer to transfer has an entitlement with the populated legacy SKU.
*/
legacySku?: Schema$GoogleCloudChannelV1Sku;
/**
* The SKU pertaining to the provisioning resource as specified in the Offer.
*/
sku?: Schema$GoogleCloudChannelV1Sku;
/**
* Describes the transfer eligibility of a SKU.
*/
transferEligibility?: Schema$GoogleCloudChannelV1TransferEligibility;
}
/**
* Specifies transfer eligibility of a SKU.
*/
export interface Schema$GoogleCloudChannelV1TransferEligibility {
/**
* Localized description if reseller is not eligible to transfer the SKU.
*/
description?: string | null;
/**
* Specified the reason for ineligibility.
*/
ineligibilityReason?: string | null;
/**
* Whether reseller is eligible to transfer the SKU.
*/
isEligible?: boolean | null;
}
/**
* Request message for CloudChannelService.TransferEntitlements.
*/
export interface Schema$GoogleCloudChannelV1TransferEntitlementsRequest {
/**
* The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.
*/
authToken?: string | null;
/**
* Required. The new entitlements to create or transfer.
*/
entitlements?: Schema$GoogleCloudChannelV1Entitlement[];
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Response message for CloudChannelService.TransferEntitlements. This is put in the response field of google.longrunning.Operation.
*/
export interface Schema$GoogleCloudChannelV1TransferEntitlementsResponse {
/**
* The transferred entitlements.
*/
entitlements?: Schema$GoogleCloudChannelV1Entitlement[];
}
/**
* Request message for CloudChannelService.TransferEntitlementsToGoogle.
*/
export interface Schema$GoogleCloudChannelV1TransferEntitlementsToGoogleRequest {
/**
* Required. The entitlements to transfer to Google.
*/
entitlements?: Schema$GoogleCloudChannelV1Entitlement[];
/**
* Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
*/
requestId?: string | null;
}
/**
* Settings for trial offers.
*/
export interface Schema$GoogleCloudChannelV1TrialSettings {
/**
* Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example [Epoch converter](https://www.epochconverter.com).
*/
endTime?: string | null;
/**
* Determines if the entitlement is in a trial or not: * `true` - The entitlement is in trial. * `false` - The entitlement is not in trial.
*/
trial?: boolean | null;
}
/**
* Request Message for UnregisterSubscriber.
*/
export interface Schema$GoogleCloudChannelV1UnregisterSubscriberRequest {
/**
* Required. Service account to unregister from subscriber access to the topic.
*/
serviceAccount?: string | null;
}
/**
* Response Message for UnregisterSubscriber.
*/
export interface Schema$GoogleCloudChannelV1UnregisterSubscriberResponse {
/**
* Name of the topic the service account subscriber access was removed from.
*/
topic?: string | null;
}
/**
* Request message for CloudChannelService.UpdateChannelPartnerLink
*/
export interface Schema$GoogleCloudChannelV1UpdateChannelPartnerLinkRequest {
/**
* Required. The channel partner link to update. Only channel_partner_link.link_state is allowed for updates.
*/
channelPartnerLink?: Schema$GoogleCloudChannelV1ChannelPartnerLink;
/**
* Required. The update mask that applies to the resource. The only allowable value for an update mask is channel_partner_link.link_state.
*/
updateMask?: string | null;
}
/**
* Data type and value of a parameter.
*/
export interface Schema$GoogleCloudChannelV1Value {
/**
* Represents a boolean value.
*/
boolValue?: boolean | null;
/**
* Represents a double value.
*/
doubleValue?: number | null;
/**
* Represents an int64 value.
*/
int64Value?: string | null;
/**
* Represents an 'Any' proto value.
*/
protoValue?: {
[key: string]: any;
} | null;
/**
* Represents a string value.
*/
stringValue?: string | null;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$GoogleLongrunningCancelOperationRequest {
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$GoogleLongrunningListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$GoogleLongrunningOperation[];
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$GoogleLongrunningOperation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$GoogleRpcStatus;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`.
*/
name?: string | null;
/**
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
export interface Schema$GoogleProtobufEmpty {
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$GoogleRpcStatus {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* Represents an amount of money with its currency type.
*/
export interface Schema$GoogleTypeMoney {
/**
* The three-letter currency code defined in ISO 4217.
*/
currencyCode?: string | null;
/**
* Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
*/
nanos?: number | null;
/**
* The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
*/
units?: string | null;
}
/**
* Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478
*/
export interface Schema$GoogleTypePostalAddress {
/**
* Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
*/
addressLines?: string[] | null;
/**
* Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
*/
administrativeArea?: string | null;
/**
* Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
*/
languageCode?: string | null;
/**
* Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
*/
locality?: string | null;
/**
* Optional. The name of the organization at the address.
*/
organization?: string | null;
/**
* Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
*/
postalCode?: string | null;
/**
* Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
*/
recipients?: string[] | null;
/**
* Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
*/
regionCode?: string | null;
/**
* The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
*/
revision?: number | null;
/**
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
*/
sortingCode?: string | null;
/**
* Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
*/
sublocality?: string | null;
}
export class Resource$Accounts {
context: APIRequestContext;
channelPartnerLinks: Resource$Accounts$Channelpartnerlinks;
customers: Resource$Accounts$Customers;
offers: Resource$Accounts$Offers;
constructor(context: APIRequestContext);
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.checkCloudIdentityAccountsExist({
* // Required. The reseller account's resource name. Parent uses the format: accounts/{account_id\}
* parent: 'accounts/my-account',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "domain": "my_domain"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "cloudIdentityAccounts": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
checkCloudIdentityAccountsExist(params: Params$Resource$Accounts$Checkcloudidentityaccountsexist, options: StreamMethodOptions): GaxiosPromise<Readable>;
checkCloudIdentityAccountsExist(params?: Params$Resource$Accounts$Checkcloudidentityaccountsexist, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse>;
checkCloudIdentityAccountsExist(params: Params$Resource$Accounts$Checkcloudidentityaccountsexist, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
checkCloudIdentityAccountsExist(params: Params$Resource$Accounts$Checkcloudidentityaccountsexist, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse>): void;
checkCloudIdentityAccountsExist(params: Params$Resource$Accounts$Checkcloudidentityaccountsexist, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse>): void;
checkCloudIdentityAccountsExist(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.listSubscribers({
* // Required. Resource name of the account.
* account: 'accounts/my-account',
* // 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.
* pageSize: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "serviceAccounts": [],
* // "topic": "my_topic"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
listSubscribers(params: Params$Resource$Accounts$Listsubscribers, options: StreamMethodOptions): GaxiosPromise<Readable>;
listSubscribers(params?: Params$Resource$Accounts$Listsubscribers, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ListSubscribersResponse>;
listSubscribers(params: Params$Resource$Accounts$Listsubscribers, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listSubscribers(params: Params$Resource$Accounts$Listsubscribers, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ListSubscribersResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListSubscribersResponse>): void;
listSubscribers(params: Params$Resource$Accounts$Listsubscribers, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListSubscribersResponse>): void;
listSubscribers(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListSubscribersResponse>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.listTransferableOffers({
* // Required. The resource name of the reseller's account.
* parent: 'accounts/my-account',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "cloudIdentityId": "my_cloudIdentityId",
* // "customerName": "my_customerName",
* // "languageCode": "my_languageCode",
* // "pageSize": 0,
* // "pageToken": "my_pageToken",
* // "sku": "my_sku"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "transferableOffers": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
listTransferableOffers(params: Params$Resource$Accounts$Listtransferableoffers, options: StreamMethodOptions): GaxiosPromise<Readable>;
listTransferableOffers(params?: Params$Resource$Accounts$Listtransferableoffers, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ListTransferableOffersResponse>;
listTransferableOffers(params: Params$Resource$Accounts$Listtransferableoffers, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listTransferableOffers(params: Params$Resource$Accounts$Listtransferableoffers, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ListTransferableOffersResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListTransferableOffersResponse>): void;
listTransferableOffers(params: Params$Resource$Accounts$Listtransferableoffers, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListTransferableOffersResponse>): void;
listTransferableOffers(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListTransferableOffersResponse>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.listTransferableSkus({
* // Required. The reseller account's resource name. Parent uses the format: accounts/{account_id\}
* parent: 'accounts/my-account',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "authToken": "my_authToken",
* // "cloudIdentityId": "my_cloudIdentityId",
* // "customerName": "my_customerName",
* // "languageCode": "my_languageCode",
* // "pageSize": 0,
* // "pageToken": "my_pageToken"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "transferableSkus": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
listTransferableSkus(params: Params$Resource$Accounts$Listtransferableskus, options: StreamMethodOptions): GaxiosPromise<Readable>;
listTransferableSkus(params?: Params$Resource$Accounts$Listtransferableskus, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ListTransferableSkusResponse>;
listTransferableSkus(params: Params$Resource$Accounts$Listtransferableskus, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listTransferableSkus(params: Params$Resource$Accounts$Listtransferableskus, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ListTransferableSkusResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListTransferableSkusResponse>): void;
listTransferableSkus(params: Params$Resource$Accounts$Listtransferableskus, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListTransferableSkusResponse>): void;
listTransferableSkus(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListTransferableSkusResponse>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.register({
* // Required. Resource name of the account.
* account: 'accounts/my-account',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "serviceAccount": "my_serviceAccount"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "topic": "my_topic"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
register(params: Params$Resource$Accounts$Register, options: StreamMethodOptions): GaxiosPromise<Readable>;
register(params?: Params$Resource$Accounts$Register, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1RegisterSubscriberResponse>;
register(params: Params$Resource$Accounts$Register, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
register(params: Params$Resource$Accounts$Register, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1RegisterSubscriberResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1RegisterSubscriberResponse>): void;
register(params: Params$Resource$Accounts$Register, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1RegisterSubscriberResponse>): void;
register(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1RegisterSubscriberResponse>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.unregister({
* // Required. Resource name of the account.
* account: 'accounts/my-account',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "serviceAccount": "my_serviceAccount"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "topic": "my_topic"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
unregister(params: Params$Resource$Accounts$Unregister, options: StreamMethodOptions): GaxiosPromise<Readable>;
unregister(params?: Params$Resource$Accounts$Unregister, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1UnregisterSubscriberResponse>;
unregister(params: Params$Resource$Accounts$Unregister, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
unregister(params: Params$Resource$Accounts$Unregister, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1UnregisterSubscriberResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1UnregisterSubscriberResponse>): void;
unregister(params: Params$Resource$Accounts$Unregister, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1UnregisterSubscriberResponse>): void;
unregister(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1UnregisterSubscriberResponse>): void;
}
export interface Params$Resource$Accounts$Checkcloudidentityaccountsexist extends StandardParameters {
/**
* Required. The reseller account's resource name. Parent uses the format: accounts/{account_id\}
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest;
}
export interface Params$Resource$Accounts$Listsubscribers extends StandardParameters {
/**
* Required. Resource name of the account.
*/
account?: string;
/**
* 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.
*/
pageSize?: number;
/**
* 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.
*/
pageToken?: string;
}
export interface Params$Resource$Accounts$Listtransferableoffers extends StandardParameters {
/**
* Required. The resource name of the reseller's account.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1ListTransferableOffersRequest;
}
export interface Params$Resource$Accounts$Listtransferableskus extends StandardParameters {
/**
* Required. The reseller account's resource name. Parent uses the format: accounts/{account_id\}
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1ListTransferableSkusRequest;
}
export interface Params$Resource$Accounts$Register extends StandardParameters {
/**
* Required. Resource name of the account.
*/
account?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1RegisterSubscriberRequest;
}
export interface Params$Resource$Accounts$Unregister extends StandardParameters {
/**
* Required. Resource name of the account.
*/
account?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1UnregisterSubscriberRequest;
}
export class Resource$Accounts$Channelpartnerlinks {
context: APIRequestContext;
customers: Resource$Accounts$Channelpartnerlinks$Customers;
constructor(context: APIRequestContext);
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.channelPartnerLinks.create({
* // Required. Create a channel partner link for the provided reseller account's resource name. Parent uses the format: accounts/{account_id\}
* parent: 'accounts/my-account',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "channelPartnerCloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "inviteLinkUri": "my_inviteLinkUri",
* // "linkState": "my_linkState",
* // "name": "my_name",
* // "publicId": "my_publicId",
* // "resellerCloudIdentityId": "my_resellerCloudIdentityId",
* // "updateTime": "my_updateTime"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "channelPartnerCloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "inviteLinkUri": "my_inviteLinkUri",
* // "linkState": "my_linkState",
* // "name": "my_name",
* // "publicId": "my_publicId",
* // "resellerCloudIdentityId": "my_resellerCloudIdentityId",
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Accounts$Channelpartnerlinks$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Accounts$Channelpartnerlinks$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ChannelPartnerLink>;
create(params: Params$Resource$Accounts$Channelpartnerlinks$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Accounts$Channelpartnerlinks$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ChannelPartnerLink>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ChannelPartnerLink>): void;
create(params: Params$Resource$Accounts$Channelpartnerlinks$Create, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ChannelPartnerLink>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ChannelPartnerLink>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.channelPartnerLinks.get({
* // 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.
* name: 'accounts/my-account/channelPartnerLinks/my-channelPartnerLink',
* // Optional. The level of granularity the ChannelPartnerLink will display.
* view: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "channelPartnerCloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "inviteLinkUri": "my_inviteLinkUri",
* // "linkState": "my_linkState",
* // "name": "my_name",
* // "publicId": "my_publicId",
* // "resellerCloudIdentityId": "my_resellerCloudIdentityId",
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Accounts$Channelpartnerlinks$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Accounts$Channelpartnerlinks$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ChannelPartnerLink>;
get(params: Params$Resource$Accounts$Channelpartnerlinks$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Accounts$Channelpartnerlinks$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ChannelPartnerLink>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ChannelPartnerLink>): void;
get(params: Params$Resource$Accounts$Channelpartnerlinks$Get, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ChannelPartnerLink>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ChannelPartnerLink>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.channelPartnerLinks.list({
* // 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.
* pageSize: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
* // Required. The resource name of the reseller account for listing channel partner links. Parent uses the format: accounts/{account_id\}
* parent: 'accounts/my-account',
* // Optional. The level of granularity the ChannelPartnerLink will display.
* view: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "channelPartnerLinks": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Channelpartnerlinks$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Channelpartnerlinks$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ListChannelPartnerLinksResponse>;
list(params: Params$Resource$Accounts$Channelpartnerlinks$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Channelpartnerlinks$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ListChannelPartnerLinksResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListChannelPartnerLinksResponse>): void;
list(params: Params$Resource$Accounts$Channelpartnerlinks$List, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListChannelPartnerLinksResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListChannelPartnerLinksResponse>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.channelPartnerLinks.patch({
* // 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.
* name: 'accounts/my-account/channelPartnerLinks/my-channelPartnerLink',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "channelPartnerLink": {},
* // "updateMask": "my_updateMask"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "channelPartnerCloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "inviteLinkUri": "my_inviteLinkUri",
* // "linkState": "my_linkState",
* // "name": "my_name",
* // "publicId": "my_publicId",
* // "resellerCloudIdentityId": "my_resellerCloudIdentityId",
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Accounts$Channelpartnerlinks$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Accounts$Channelpartnerlinks$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ChannelPartnerLink>;
patch(params: Params$Resource$Accounts$Channelpartnerlinks$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Accounts$Channelpartnerlinks$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ChannelPartnerLink>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ChannelPartnerLink>): void;
patch(params: Params$Resource$Accounts$Channelpartnerlinks$Patch, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ChannelPartnerLink>): void;
patch(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ChannelPartnerLink>): void;
}
export interface Params$Resource$Accounts$Channelpartnerlinks$Create extends StandardParameters {
/**
* Required. Create a channel partner link for the provided reseller account's resource name. Parent uses the format: accounts/{account_id\}
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1ChannelPartnerLink;
}
export interface Params$Resource$Accounts$Channelpartnerlinks$Get extends StandardParameters {
/**
* 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.
*/
name?: string;
/**
* Optional. The level of granularity the ChannelPartnerLink will display.
*/
view?: string;
}
export interface Params$Resource$Accounts$Channelpartnerlinks$List extends StandardParameters {
/**
* 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.
*/
pageSize?: number;
/**
* 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.
*/
pageToken?: string;
/**
* Required. The resource name of the reseller account for listing channel partner links. Parent uses the format: accounts/{account_id\}
*/
parent?: string;
/**
* Optional. The level of granularity the ChannelPartnerLink will display.
*/
view?: string;
}
export interface Params$Resource$Accounts$Channelpartnerlinks$Patch extends StandardParameters {
/**
* 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.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1UpdateChannelPartnerLinkRequest;
}
export class Resource$Accounts$Channelpartnerlinks$Customers {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.channelPartnerLinks.customers.create({
* // Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id\}
* parent: 'accounts/my-account/channelPartnerLinks/my-channelPartnerLink',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "alternateEmail": "my_alternateEmail",
* // "channelPartnerId": "my_channelPartnerId",
* // "cloudIdentityId": "my_cloudIdentityId",
* // "cloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "domain": "my_domain",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "orgDisplayName": "my_orgDisplayName",
* // "orgPostalAddress": {},
* // "primaryContactInfo": {},
* // "updateTime": "my_updateTime"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alternateEmail": "my_alternateEmail",
* // "channelPartnerId": "my_channelPartnerId",
* // "cloudIdentityId": "my_cloudIdentityId",
* // "cloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "domain": "my_domain",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "orgDisplayName": "my_orgDisplayName",
* // "orgPostalAddress": {},
* // "primaryContactInfo": {},
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Accounts$Channelpartnerlinks$Customers$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1Customer>;
create(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
create(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Create, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.channelPartnerLinks.customers.delete({
* // Required. The resource name of the customer to delete.
* name: 'accounts/my-account/channelPartnerLinks/my-channelPartnerLink/customers/my-customer',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Accounts$Channelpartnerlinks$Customers$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
delete(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.channelPartnerLinks.customers.get({
* // Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id\}/customers/{customer_id\}
* name: 'accounts/my-account/channelPartnerLinks/my-channelPartnerLink/customers/my-customer',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alternateEmail": "my_alternateEmail",
* // "channelPartnerId": "my_channelPartnerId",
* // "cloudIdentityId": "my_cloudIdentityId",
* // "cloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "domain": "my_domain",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "orgDisplayName": "my_orgDisplayName",
* // "orgPostalAddress": {},
* // "primaryContactInfo": {},
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Accounts$Channelpartnerlinks$Customers$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1Customer>;
get(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
get(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Get, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.channelPartnerLinks.customers.list({
* // 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.
* pageSize: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
* // Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id\}.
* parent: 'accounts/my-account/channelPartnerLinks/my-channelPartnerLink',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "customers": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Channelpartnerlinks$Customers$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ListCustomersResponse>;
list(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ListCustomersResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListCustomersResponse>): void;
list(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$List, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListCustomersResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListCustomersResponse>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.channelPartnerLinks.customers.patch({
* // Output only. Resource name of the customer. Format: accounts/{account_id\}/customers/{customer_id\}
* name: 'accounts/my-account/channelPartnerLinks/my-channelPartnerLink/customers/my-customer',
* // The update mask that applies to the resource. Optional.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "alternateEmail": "my_alternateEmail",
* // "channelPartnerId": "my_channelPartnerId",
* // "cloudIdentityId": "my_cloudIdentityId",
* // "cloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "domain": "my_domain",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "orgDisplayName": "my_orgDisplayName",
* // "orgPostalAddress": {},
* // "primaryContactInfo": {},
* // "updateTime": "my_updateTime"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alternateEmail": "my_alternateEmail",
* // "channelPartnerId": "my_channelPartnerId",
* // "cloudIdentityId": "my_cloudIdentityId",
* // "cloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "domain": "my_domain",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "orgDisplayName": "my_orgDisplayName",
* // "orgPostalAddress": {},
* // "primaryContactInfo": {},
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Accounts$Channelpartnerlinks$Customers$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1Customer>;
patch(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
patch(params: Params$Resource$Accounts$Channelpartnerlinks$Customers$Patch, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
patch(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
}
export interface Params$Resource$Accounts$Channelpartnerlinks$Customers$Create extends StandardParameters {
/**
* Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id\}
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1Customer;
}
export interface Params$Resource$Accounts$Channelpartnerlinks$Customers$Delete extends StandardParameters {
/**
* Required. The resource name of the customer to delete.
*/
name?: string;
}
export interface Params$Resource$Accounts$Channelpartnerlinks$Customers$Get extends StandardParameters {
/**
* Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id\}/customers/{customer_id\}
*/
name?: string;
}
export interface Params$Resource$Accounts$Channelpartnerlinks$Customers$List extends StandardParameters {
/**
* 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.
*/
pageSize?: number;
/**
* 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.
*/
pageToken?: string;
/**
* Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id\}.
*/
parent?: string;
}
export interface Params$Resource$Accounts$Channelpartnerlinks$Customers$Patch extends StandardParameters {
/**
* Output only. Resource name of the customer. Format: accounts/{account_id\}/customers/{customer_id\}
*/
name?: string;
/**
* The update mask that applies to the resource. Optional.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1Customer;
}
export class Resource$Accounts$Customers {
context: APIRequestContext;
entitlements: Resource$Accounts$Customers$Entitlements;
constructor(context: APIRequestContext);
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.create({
* // Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id\}
* parent: 'accounts/my-account',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "alternateEmail": "my_alternateEmail",
* // "channelPartnerId": "my_channelPartnerId",
* // "cloudIdentityId": "my_cloudIdentityId",
* // "cloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "domain": "my_domain",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "orgDisplayName": "my_orgDisplayName",
* // "orgPostalAddress": {},
* // "primaryContactInfo": {},
* // "updateTime": "my_updateTime"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alternateEmail": "my_alternateEmail",
* // "channelPartnerId": "my_channelPartnerId",
* // "cloudIdentityId": "my_cloudIdentityId",
* // "cloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "domain": "my_domain",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "orgDisplayName": "my_orgDisplayName",
* // "orgPostalAddress": {},
* // "primaryContactInfo": {},
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Accounts$Customers$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Accounts$Customers$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1Customer>;
create(params: Params$Resource$Accounts$Customers$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Accounts$Customers$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
create(params: Params$Resource$Accounts$Customers$Create, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.delete({
* // Required. The resource name of the customer to delete.
* name: 'accounts/my-account/customers/my-customer',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Accounts$Customers$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Accounts$Customers$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
delete(params: Params$Resource$Accounts$Customers$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Accounts$Customers$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(params: Params$Resource$Accounts$Customers$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.get({
* // Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id\}/customers/{customer_id\}
* name: 'accounts/my-account/customers/my-customer',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alternateEmail": "my_alternateEmail",
* // "channelPartnerId": "my_channelPartnerId",
* // "cloudIdentityId": "my_cloudIdentityId",
* // "cloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "domain": "my_domain",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "orgDisplayName": "my_orgDisplayName",
* // "orgPostalAddress": {},
* // "primaryContactInfo": {},
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Accounts$Customers$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Accounts$Customers$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1Customer>;
get(params: Params$Resource$Accounts$Customers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Accounts$Customers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
get(params: Params$Resource$Accounts$Customers$Get, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.list({
* // 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.
* pageSize: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
* // Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id\}.
* parent: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "customers": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Customers$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Customers$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ListCustomersResponse>;
list(params: Params$Resource$Accounts$Customers$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Customers$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ListCustomersResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListCustomersResponse>): void;
list(params: Params$Resource$Accounts$Customers$List, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListCustomersResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListCustomersResponse>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.listPurchasableOffers({
* // Required. Resource name of the entitlement. Format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
* 'changeOfferPurchase.entitlement': 'placeholder-value',
* // Optional. Resource name of the new target SKU. Provide this SKU when upgrading or downgrading an entitlement. Format: products/{product_id\}/skus/{sku_id\}
* 'changeOfferPurchase.newSku': 'placeholder-value',
* // Required. SKU that the result should be restricted to. Format: products/{product_id\}/skus/{sku_id\}.
* 'createEntitlementPurchase.sku': 'placeholder-value',
* // Required. The resource name of the customer to list Offers for. Format: accounts/{account_id\}/customers/{customer_id\}.
* customer: 'accounts/my-account/customers/my-customer',
* // 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".
* languageCode: 'placeholder-value',
* // 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.
* pageSize: 'placeholder-value',
* // Optional. A token for a page of results other than the first page.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "purchasableOffers": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
listPurchasableOffers(params: Params$Resource$Accounts$Customers$Listpurchasableoffers, options: StreamMethodOptions): GaxiosPromise<Readable>;
listPurchasableOffers(params?: Params$Resource$Accounts$Customers$Listpurchasableoffers, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ListPurchasableOffersResponse>;
listPurchasableOffers(params: Params$Resource$Accounts$Customers$Listpurchasableoffers, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listPurchasableOffers(params: Params$Resource$Accounts$Customers$Listpurchasableoffers, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ListPurchasableOffersResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListPurchasableOffersResponse>): void;
listPurchasableOffers(params: Params$Resource$Accounts$Customers$Listpurchasableoffers, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListPurchasableOffersResponse>): void;
listPurchasableOffers(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListPurchasableOffersResponse>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.listPurchasableSkus({
* // Required. Change Type for the entitlement.
* 'changeOfferPurchase.changeType': 'placeholder-value',
* // Required. Resource name of the entitlement. Format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
* 'changeOfferPurchase.entitlement': 'placeholder-value',
* // Required. List SKUs belonging to this Product. Format: products/{product_id\}. Supports products/- to retrieve SKUs for all products.
* 'createEntitlementPurchase.product': 'placeholder-value',
* // Required. The resource name of the customer to list SKUs for. Format: accounts/{account_id\}/customers/{customer_id\}.
* customer: 'accounts/my-account/customers/my-customer',
* // 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".
* languageCode: 'placeholder-value',
* // Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000.
* pageSize: 'placeholder-value',
* // Optional. A token for a page of results other than the first page.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "purchasableSkus": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
listPurchasableSkus(params: Params$Resource$Accounts$Customers$Listpurchasableskus, options: StreamMethodOptions): GaxiosPromise<Readable>;
listPurchasableSkus(params?: Params$Resource$Accounts$Customers$Listpurchasableskus, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ListPurchasableSkusResponse>;
listPurchasableSkus(params: Params$Resource$Accounts$Customers$Listpurchasableskus, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listPurchasableSkus(params: Params$Resource$Accounts$Customers$Listpurchasableskus, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ListPurchasableSkusResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListPurchasableSkusResponse>): void;
listPurchasableSkus(params: Params$Resource$Accounts$Customers$Listpurchasableskus, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListPurchasableSkusResponse>): void;
listPurchasableSkus(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListPurchasableSkusResponse>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.patch({
* // Output only. Resource name of the customer. Format: accounts/{account_id\}/customers/{customer_id\}
* name: 'accounts/my-account/customers/my-customer',
* // The update mask that applies to the resource. Optional.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "alternateEmail": "my_alternateEmail",
* // "channelPartnerId": "my_channelPartnerId",
* // "cloudIdentityId": "my_cloudIdentityId",
* // "cloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "domain": "my_domain",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "orgDisplayName": "my_orgDisplayName",
* // "orgPostalAddress": {},
* // "primaryContactInfo": {},
* // "updateTime": "my_updateTime"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alternateEmail": "my_alternateEmail",
* // "channelPartnerId": "my_channelPartnerId",
* // "cloudIdentityId": "my_cloudIdentityId",
* // "cloudIdentityInfo": {},
* // "createTime": "my_createTime",
* // "domain": "my_domain",
* // "languageCode": "my_languageCode",
* // "name": "my_name",
* // "orgDisplayName": "my_orgDisplayName",
* // "orgPostalAddress": {},
* // "primaryContactInfo": {},
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Accounts$Customers$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Accounts$Customers$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1Customer>;
patch(params: Params$Resource$Accounts$Customers$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Accounts$Customers$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
patch(params: Params$Resource$Accounts$Customers$Patch, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
patch(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Customer>): void;
/**
* Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer was not found. * ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email. * 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 ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.provisionCloudIdentity({
* // Required. Resource name of the customer. Format: accounts/{account_id\}/customers/{customer_id\}
* customer: 'accounts/my-account/customers/my-customer',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "cloudIdentityInfo": {},
* // "user": {},
* // "validateOnly": false
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
provisionCloudIdentity(params: Params$Resource$Accounts$Customers$Provisioncloudidentity, options: StreamMethodOptions): GaxiosPromise<Readable>;
provisionCloudIdentity(params?: Params$Resource$Accounts$Customers$Provisioncloudidentity, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
provisionCloudIdentity(params: Params$Resource$Accounts$Customers$Provisioncloudidentity, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
provisionCloudIdentity(params: Params$Resource$Accounts$Customers$Provisioncloudidentity, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
provisionCloudIdentity(params: Params$Resource$Accounts$Customers$Provisioncloudidentity, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
provisionCloudIdentity(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* Transfers customer entitlements to new reseller. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: The SKU was already transferred for the customer. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * Specify all transferring entitlements. * 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 ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.transferEntitlements({
* // Required. The resource name of the reseller's customer account that will receive transferred entitlements. Parent uses the format: accounts/{account_id\}/customers/{customer_id\}
* parent: 'accounts/my-account/customers/my-customer',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "authToken": "my_authToken",
* // "entitlements": [],
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
transferEntitlements(params: Params$Resource$Accounts$Customers$Transferentitlements, options: StreamMethodOptions): GaxiosPromise<Readable>;
transferEntitlements(params?: Params$Resource$Accounts$Customers$Transferentitlements, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
transferEntitlements(params: Params$Resource$Accounts$Customers$Transferentitlements, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
transferEntitlements(params: Params$Resource$Accounts$Customers$Transferentitlements, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
transferEntitlements(params: Params$Resource$Accounts$Customers$Transferentitlements, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
transferEntitlements(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* Transfers customer entitlements from their current reseller to Google. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: The SKU was already transferred for the customer. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller 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 ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await cloudchannel.accounts.customers.transferEntitlementsToGoogle({
* // Required. The resource name of the reseller's customer account where the entitlements transfer from. Parent uses the format: accounts/{account_id\}/customers/{customer_id\}
* parent: 'accounts/my-account/customers/my-customer',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "entitlements": [],
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
transferEntitlementsToGoogle(params: Params$Resource$Accounts$Customers$Transferentitlementstogoogle, options: StreamMethodOptions): GaxiosPromise<Readable>;
transferEntitlementsToGoogle(params?: Params$Resource$Accounts$Customers$Transferentitlementstogoogle, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
transferEntitlementsToGoogle(params: Params$Resource$Accounts$Customers$Transferentitlementstogoogle, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
transferEntitlementsToGoogle(params: Params$Resource$Accounts$Customers$Transferentitlementstogoogle, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
transferEntitlementsToGoogle(params: Params$Resource$Accounts$Customers$Transferentitlementstogoogle, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
transferEntitlementsToGoogle(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
}
export interface Params$Resource$Accounts$Customers$Create extends StandardParameters {
/**
* Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id\}
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1Customer;
}
export interface Params$Resource$Accounts$Customers$Delete extends StandardParameters {
/**
* Required. The resource name of the customer to delete.
*/
name?: string;
}
export interface Params$Resource$Accounts$Customers$Get extends StandardParameters {
/**
* Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id\}/customers/{customer_id\}
*/
name?: string;
}
export interface Params$Resource$Accounts$Customers$List extends StandardParameters {
/**
* 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.
*/
pageSize?: number;
/**
* 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.
*/
pageToken?: string;
/**
* Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id\}.
*/
parent?: string;
}
export interface Params$Resource$Accounts$Customers$Listpurchasableoffers extends StandardParameters {
/**
* Required. Resource name of the entitlement. Format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
'changeOfferPurchase.entitlement'?: string;
/**
* Optional. Resource name of the new target SKU. Provide this SKU when upgrading or downgrading an entitlement. Format: products/{product_id\}/skus/{sku_id\}
*/
'changeOfferPurchase.newSku'?: string;
/**
* Required. SKU that the result should be restricted to. Format: products/{product_id\}/skus/{sku_id\}.
*/
'createEntitlementPurchase.sku'?: string;
/**
* Required. The resource name of the customer to list Offers for. Format: accounts/{account_id\}/customers/{customer_id\}.
*/
customer?: string;
/**
* 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".
*/
languageCode?: string;
/**
* 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.
*/
pageSize?: number;
/**
* Optional. A token for a page of results other than the first page.
*/
pageToken?: string;
}
export interface Params$Resource$Accounts$Customers$Listpurchasableskus extends StandardParameters {
/**
* Required. Change Type for the entitlement.
*/
'changeOfferPurchase.changeType'?: string;
/**
* Required. Resource name of the entitlement. Format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
'changeOfferPurchase.entitlement'?: string;
/**
* Required. List SKUs belonging to this Product. Format: products/{product_id\}. Supports products/- to retrieve SKUs for all products.
*/
'createEntitlementPurchase.product'?: string;
/**
* Required. The resource name of the customer to list SKUs for. Format: accounts/{account_id\}/customers/{customer_id\}.
*/
customer?: string;
/**
* 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".
*/
languageCode?: string;
/**
* Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000.
*/
pageSize?: number;
/**
* Optional. A token for a page of results other than the first page.
*/
pageToken?: string;
}
export interface Params$Resource$Accounts$Customers$Patch extends StandardParameters {
/**
* Output only. Resource name of the customer. Format: accounts/{account_id\}/customers/{customer_id\}
*/
name?: string;
/**
* The update mask that applies to the resource. Optional.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1Customer;
}
export interface Params$Resource$Accounts$Customers$Provisioncloudidentity extends StandardParameters {
/**
* Required. Resource name of the customer. Format: accounts/{account_id\}/customers/{customer_id\}
*/
customer?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1ProvisionCloudIdentityRequest;
}
export interface Params$Resource$Accounts$Customers$Transferentitlements extends StandardParameters {
/**
* Required. The resource name of the reseller's customer account that will receive transferred entitlements. Parent uses the format: accounts/{account_id\}/customers/{customer_id\}
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1TransferEntitlementsRequest;
}
export interface Params$Resource$Accounts$Customers$Transferentitlementstogoogle extends StandardParameters {
/**
* Required. The resource name of the reseller's customer account where the entitlements transfer from. Parent uses the format: accounts/{account_id\}/customers/{customer_id\}
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1TransferEntitlementsToGoogleRequest;
}
export class Resource$Accounts$Customers$Entitlements {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and it updates the state of the customer entitlement. 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: Entitlement resource not found. * SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS. * NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state. * 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 ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.entitlements.activate({
* // Required. The resource name of the entitlement to activate. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
* name: 'accounts/my-account/customers/my-customer/entitlements/my-entitlement',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
activate(params: Params$Resource$Accounts$Customers$Entitlements$Activate, options: StreamMethodOptions): GaxiosPromise<Readable>;
activate(params?: Params$Resource$Accounts$Customers$Entitlements$Activate, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
activate(params: Params$Resource$Accounts$Customers$Entitlements$Activate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
activate(params: Params$Resource$Accounts$Customers$Entitlements$Activate, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
activate(params: Params$Resource$Accounts$Customers$Entitlements$Activate, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
activate(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons, or entitlements for Google Cloud's development platform. * 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 ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.entitlements.cancel({
* // Required. The resource name of the entitlement to cancel. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
* name: 'accounts/my-account/customers/my-customer/entitlements/my-entitlement',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
cancel(params: Params$Resource$Accounts$Customers$Entitlements$Cancel, options: StreamMethodOptions): GaxiosPromise<Readable>;
cancel(params?: Params$Resource$Accounts$Customers$Entitlements$Cancel, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
cancel(params: Params$Resource$Accounts$Customers$Entitlements$Cancel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
cancel(params: Params$Resource$Accounts$Customers$Entitlements$Cancel, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
cancel(params: Params$Resource$Accounts$Customers$Entitlements$Cancel, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
cancel(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* Updates the Offer for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Offer or Entitlement 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 ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.entitlements.changeOffer({
* // Required. The resource name of the entitlement to update. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
* name: 'accounts/my-account/customers/my-customer/entitlements/my-entitlement',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "offer": "my_offer",
* // "parameters": [],
* // "purchaseOrderId": "my_purchaseOrderId",
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
changeOffer(params: Params$Resource$Accounts$Customers$Entitlements$Changeoffer, options: StreamMethodOptions): GaxiosPromise<Readable>;
changeOffer(params?: Params$Resource$Accounts$Customers$Entitlements$Changeoffer, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
changeOffer(params: Params$Resource$Accounts$Customers$Entitlements$Changeoffer, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
changeOffer(params: Params$Resource$Accounts$Customers$Entitlements$Changeoffer, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
changeOffer(params: Params$Resource$Accounts$Customers$Entitlements$Changeoffer, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
changeOffer(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* Change parameters of the entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan. * NOT_FOUND: Entitlement 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 ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await cloudchannel.accounts.customers.entitlements.changeParameters({
* // Required. The name of the entitlement to update. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
* name: 'accounts/my-account/customers/my-customer/entitlements/my-entitlement',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "parameters": [],
* // "purchaseOrderId": "my_purchaseOrderId",
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
changeParameters(params: Params$Resource$Accounts$Customers$Entitlements$Changeparameters, options: StreamMethodOptions): GaxiosPromise<Readable>;
changeParameters(params?: Params$Resource$Accounts$Customers$Entitlements$Changeparameters, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
changeParameters(params: Params$Resource$Accounts$Customers$Entitlements$Changeparameters, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
changeParameters(params: Params$Resource$Accounts$Customers$Entitlements$Changeparameters, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
changeParameters(params: Params$Resource$Accounts$Customers$Entitlements$Changeparameters, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
changeParameters(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* Updates the renewal settings for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans. * 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 ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await cloudchannel.accounts.customers.entitlements.changeRenewalSettings({
* // Required. The name of the entitlement to update. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
* name: 'accounts/my-account/customers/my-customer/entitlements/my-entitlement',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "renewalSettings": {},
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
changeRenewalSettings(params: Params$Resource$Accounts$Customers$Entitlements$Changerenewalsettings, options: StreamMethodOptions): GaxiosPromise<Readable>;
changeRenewalSettings(params?: Params$Resource$Accounts$Customers$Entitlements$Changerenewalsettings, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
changeRenewalSettings(params: Params$Resource$Accounts$Customers$Entitlements$Changerenewalsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
changeRenewalSettings(params: Params$Resource$Accounts$Customers$Entitlements$Changerenewalsettings, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
changeRenewalSettings(params: Params$Resource$Accounts$Customers$Entitlements$Changerenewalsettings, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
changeRenewalSettings(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* Creates an entitlement for a customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * There is already a customer entitlement for a SKU from the same product family. * INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: * The SKU was already purchased for the customer. * The customer's primary email already exists. Retry after changing the customer's primary contact email. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The domain required for purchasing a SKU has not been verified. * A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller 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 ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.entitlements.create({
* // Required. The resource name of the reseller's customer account in which to create the entitlement. Parent uses the format: accounts/{account_id\}/customers/{customer_id\}
* parent: 'accounts/my-account/customers/my-customer',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "entitlement": {},
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Accounts$Customers$Entitlements$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Accounts$Customers$Entitlements$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
create(params: Params$Resource$Accounts$Customers$Entitlements$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Accounts$Customers$Entitlements$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
create(params: Params$Resource$Accounts$Customers$Entitlements$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* Returns the requested Entitlement resource. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested Entitlement resource.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.entitlements.get({
* // Required. The resource name of the entitlement to retrieve. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
* name: 'accounts/my-account/customers/my-customer/entitlements/my-entitlement',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "associationInfo": {},
* // "commitmentSettings": {},
* // "createTime": "my_createTime",
* // "name": "my_name",
* // "offer": "my_offer",
* // "parameters": [],
* // "provisionedService": {},
* // "provisioningState": "my_provisioningState",
* // "purchaseOrderId": "my_purchaseOrderId",
* // "suspensionReasons": [],
* // "trialSettings": {},
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Accounts$Customers$Entitlements$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Accounts$Customers$Entitlements$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1Entitlement>;
get(params: Params$Resource$Accounts$Customers$Entitlements$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Accounts$Customers$Entitlements$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1Entitlement>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Entitlement>): void;
get(params: Params$Resource$Accounts$Customers$Entitlements$Get, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Entitlement>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Entitlement>): void;
/**
* Lists Entitlements belonging to a customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's Entitlements.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.entitlements.list({
* // Optional. Requested page size. Server might return fewer results than requested. If unspecified, return at most 50 entitlements. The maximum value is 100; the server will coerce values above 100.
* pageSize: 'placeholder-value',
* // Optional. A token for a page of results other than the first page. Obtained using ListEntitlementsResponse.next_page_token of the previous CloudChannelService.ListEntitlements call.
* pageToken: 'placeholder-value',
* // Required. The resource name of the reseller's customer account to list entitlements for. Parent uses the format: accounts/{account_id\}/customers/{customer_id\}
* parent: 'accounts/my-account/customers/my-customer',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "entitlements": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Customers$Entitlements$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Customers$Entitlements$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ListEntitlementsResponse>;
list(params: Params$Resource$Accounts$Customers$Entitlements$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Customers$Entitlements$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ListEntitlementsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListEntitlementsResponse>): void;
list(params: Params$Resource$Accounts$Customers$Entitlements$List, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListEntitlementsResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListEntitlementsResponse>): void;
/**
* Returns the requested Offer resource. Possible error codes: * PERMISSION_DENIED: The entitlement doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement or offer was not found. Return value: The Offer resource.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.entitlements.lookupOffer({
* // Required. The resource name of the entitlement to retrieve the Offer. Entitlement uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
* entitlement:
* 'accounts/my-account/customers/my-customer/entitlements/my-entitlement',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "constraints": {},
* // "endTime": "my_endTime",
* // "marketingInfo": {},
* // "name": "my_name",
* // "parameterDefinitions": [],
* // "plan": {},
* // "priceByResources": [],
* // "sku": {},
* // "startTime": "my_startTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
lookupOffer(params: Params$Resource$Accounts$Customers$Entitlements$Lookupoffer, options: StreamMethodOptions): GaxiosPromise<Readable>;
lookupOffer(params?: Params$Resource$Accounts$Customers$Entitlements$Lookupoffer, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1Offer>;
lookupOffer(params: Params$Resource$Accounts$Customers$Entitlements$Lookupoffer, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
lookupOffer(params: Params$Resource$Accounts$Customers$Entitlements$Lookupoffer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1Offer>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Offer>): void;
lookupOffer(params: Params$Resource$Accounts$Customers$Entitlements$Lookupoffer, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Offer>): void;
lookupOffer(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1Offer>): void;
/**
* Starts paid service for a trial entitlement. Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans. * 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 ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await cloudchannel.accounts.customers.entitlements.startPaidService({
* // Required. The name of the entitlement to start a paid service for. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
* name: 'accounts/my-account/customers/my-customer/entitlements/my-entitlement',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
startPaidService(params: Params$Resource$Accounts$Customers$Entitlements$Startpaidservice, options: StreamMethodOptions): GaxiosPromise<Readable>;
startPaidService(params?: Params$Resource$Accounts$Customers$Entitlements$Startpaidservice, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
startPaidService(params: Params$Resource$Accounts$Customers$Entitlements$Startpaidservice, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
startPaidService(params: Params$Resource$Accounts$Customers$Entitlements$Startpaidservice, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
startPaidService(params: Params$Resource$Accounts$Customers$Entitlements$Startpaidservice, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
startPaidService(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * NOT_ACTIVE: Entitlement is not active. * 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 ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.customers.entitlements.suspend({
* // Required. The resource name of the entitlement to suspend. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
* name: 'accounts/my-account/customers/my-customer/entitlements/my-entitlement',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "requestId": "my_requestId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
suspend(params: Params$Resource$Accounts$Customers$Entitlements$Suspend, options: StreamMethodOptions): GaxiosPromise<Readable>;
suspend(params?: Params$Resource$Accounts$Customers$Entitlements$Suspend, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
suspend(params: Params$Resource$Accounts$Customers$Entitlements$Suspend, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
suspend(params: Params$Resource$Accounts$Customers$Entitlements$Suspend, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
suspend(params: Params$Resource$Accounts$Customers$Entitlements$Suspend, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
suspend(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
}
export interface Params$Resource$Accounts$Customers$Entitlements$Activate extends StandardParameters {
/**
* Required. The resource name of the entitlement to activate. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1ActivateEntitlementRequest;
}
export interface Params$Resource$Accounts$Customers$Entitlements$Cancel extends StandardParameters {
/**
* Required. The resource name of the entitlement to cancel. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1CancelEntitlementRequest;
}
export interface Params$Resource$Accounts$Customers$Entitlements$Changeoffer extends StandardParameters {
/**
* Required. The resource name of the entitlement to update. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1ChangeOfferRequest;
}
export interface Params$Resource$Accounts$Customers$Entitlements$Changeparameters extends StandardParameters {
/**
* Required. The name of the entitlement to update. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1ChangeParametersRequest;
}
export interface Params$Resource$Accounts$Customers$Entitlements$Changerenewalsettings extends StandardParameters {
/**
* Required. The name of the entitlement to update. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1ChangeRenewalSettingsRequest;
}
export interface Params$Resource$Accounts$Customers$Entitlements$Create extends StandardParameters {
/**
* Required. The resource name of the reseller's customer account in which to create the entitlement. Parent uses the format: accounts/{account_id\}/customers/{customer_id\}
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1CreateEntitlementRequest;
}
export interface Params$Resource$Accounts$Customers$Entitlements$Get extends StandardParameters {
/**
* Required. The resource name of the entitlement to retrieve. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
name?: string;
}
export interface Params$Resource$Accounts$Customers$Entitlements$List extends StandardParameters {
/**
* Optional. Requested page size. Server might return fewer results than requested. If unspecified, return at most 50 entitlements. The maximum value is 100; the server will coerce values above 100.
*/
pageSize?: number;
/**
* Optional. A token for a page of results other than the first page. Obtained using ListEntitlementsResponse.next_page_token of the previous CloudChannelService.ListEntitlements call.
*/
pageToken?: string;
/**
* Required. The resource name of the reseller's customer account to list entitlements for. Parent uses the format: accounts/{account_id\}/customers/{customer_id\}
*/
parent?: string;
}
export interface Params$Resource$Accounts$Customers$Entitlements$Lookupoffer extends StandardParameters {
/**
* Required. The resource name of the entitlement to retrieve the Offer. Entitlement uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
entitlement?: string;
}
export interface Params$Resource$Accounts$Customers$Entitlements$Startpaidservice extends StandardParameters {
/**
* Required. The name of the entitlement to start a paid service for. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1StartPaidServiceRequest;
}
export interface Params$Resource$Accounts$Customers$Entitlements$Suspend extends StandardParameters {
/**
* Required. The resource name of the entitlement to suspend. Name uses the format: accounts/{account_id\}/customers/{customer_id\}/entitlements/{entitlement_id\}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudChannelV1SuspendEntitlementRequest;
}
export class Resource$Accounts$Offers {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Lists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.accounts.offers.list({
* // Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1
* filter: 'placeholder-value',
* // 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".
* languageCode: 'placeholder-value',
* // Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.
* pageSize: 'placeholder-value',
* // Optional. A token for a page of results other than the first page.
* pageToken: 'placeholder-value',
* // Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id\}.
* parent: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "offers": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Offers$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Offers$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ListOffersResponse>;
list(params: Params$Resource$Accounts$Offers$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Offers$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ListOffersResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListOffersResponse>): void;
list(params: Params$Resource$Accounts$Offers$List, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListOffersResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListOffersResponse>): void;
}
export interface Params$Resource$Accounts$Offers$List extends StandardParameters {
/**
* Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1
*/
filter?: string;
/**
* 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".
*/
languageCode?: string;
/**
* Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.
*/
pageSize?: number;
/**
* Optional. A token for a page of results other than the first page.
*/
pageToken?: string;
/**
* Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id\}.
*/
parent?: string;
}
export class Resource$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.operations.cancel({
* // The name of the operation resource to be cancelled.
* name: 'operations/.*',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
cancel(params: Params$Resource$Operations$Cancel, options: StreamMethodOptions): GaxiosPromise<Readable>;
cancel(params?: Params$Resource$Operations$Cancel, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
cancel(params: Params$Resource$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
cancel(params: Params$Resource$Operations$Cancel, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
cancel(params: Params$Resource$Operations$Cancel, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
cancel(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.operations.delete({
* // The name of the operation resource to be deleted.
* name: 'operations/.*',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Operations$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Operations$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
delete(params: Params$Resource$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Operations$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(params: Params$Resource$Operations$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.operations.get({
* // The name of the operation resource.
* name: 'operations/.*',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
get(params: Params$Resource$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
/**
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x\}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.operations.list({
* // The standard list filter.
* filter: 'placeholder-value',
* // The name of the operation's parent resource.
* name: 'operations',
* // The standard list page size.
* pageSize: 'placeholder-value',
* // The standard list page token.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "operations": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Operations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
list(params: Params$Resource$Operations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
list(params: Params$Resource$Operations$List, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
}
export interface Params$Resource$Operations$Cancel extends StandardParameters {
/**
* The name of the operation resource to be cancelled.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleLongrunningCancelOperationRequest;
}
export interface Params$Resource$Operations$Delete extends StandardParameters {
/**
* The name of the operation resource to be deleted.
*/
name?: string;
}
export interface Params$Resource$Operations$Get extends StandardParameters {
/**
* The name of the operation resource.
*/
name?: string;
}
export interface Params$Resource$Operations$List extends StandardParameters {
/**
* The standard list filter.
*/
filter?: string;
/**
* The name of the operation's parent resource.
*/
name?: string;
/**
* The standard list page size.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
export class Resource$Products {
context: APIRequestContext;
skus: Resource$Products$Skus;
constructor(context: APIRequestContext);
/**
* Lists the Products the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.products.list({
* // Required. The resource name of the reseller account. Format: accounts/{account_id\}.
* account: 'placeholder-value',
* // 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".
* languageCode: 'placeholder-value',
* // Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 Products. The maximum value is 1000; the server will coerce values above 1000.
* pageSize: 'placeholder-value',
* // Optional. A token for a page of results other than the first page.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "products": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Products$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Products$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ListProductsResponse>;
list(params: Params$Resource$Products$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Products$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ListProductsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListProductsResponse>): void;
list(params: Params$Resource$Products$List, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListProductsResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListProductsResponse>): void;
}
export interface Params$Resource$Products$List extends StandardParameters {
/**
* Required. The resource name of the reseller account. Format: accounts/{account_id\}.
*/
account?: string;
/**
* 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".
*/
languageCode?: string;
/**
* Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 Products. The maximum value is 1000; the server will coerce values above 1000.
*/
pageSize?: number;
/**
* Optional. A token for a page of results other than the first page.
*/
pageToken?: string;
}
export class Resource$Products$Skus {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Lists the SKUs for a product the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudchannel.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudchannel = google.cloudchannel('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/apps.order'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudchannel.products.skus.list({
* // Required. Resource name of the reseller. Format: accounts/{account_id\}.
* account: 'placeholder-value',
* // 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".
* languageCode: 'placeholder-value',
* // Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000.
* pageSize: 'placeholder-value',
* // Optional. A token for a page of results other than the first page. Optional.
* pageToken: 'placeholder-value',
* // Required. The resource name of the Product to list SKUs for. Parent uses the format: products/{product_id\}. Supports products/- to retrieve SKUs for all products.
* parent: 'products/my-product',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "skus": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Products$Skus$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Products$Skus$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudChannelV1ListSkusResponse>;
list(params: Params$Resource$Products$Skus$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Products$Skus$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudChannelV1ListSkusResponse>, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListSkusResponse>): void;
list(params: Params$Resource$Products$Skus$List, callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListSkusResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudChannelV1ListSkusResponse>): void;
}
export interface Params$Resource$Products$Skus$List extends StandardParameters {
/**
* Required. Resource name of the reseller. Format: accounts/{account_id\}.
*/
account?: string;
/**
* 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".
*/
languageCode?: string;
/**
* Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000.
*/
pageSize?: number;
/**
* Optional. A token for a page of results other than the first page. Optional.
*/
pageToken?: string;
/**
* Required. The resource name of the Product to list SKUs for. Parent uses the format: products/{product_id\}. Supports products/- to retrieve SKUs for all products.
*/
parent?: string;
}
export {};
}