v2.d.ts
233 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
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace drive_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* Data format for the response.
*/
alt?: 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;
/**
* An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* Drive API
*
* Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.
*
* @example
* const {google} = require('googleapis');
* const drive = google.drive('v2');
*
* @namespace drive
* @type {Function}
* @version v2
* @variation v2
* @param {object=} options Options for Drive
*/
export class Drive {
context: APIRequestContext;
about: Resource$About;
apps: Resource$Apps;
changes: Resource$Changes;
channels: Resource$Channels;
children: Resource$Children;
comments: Resource$Comments;
drives: Resource$Drives;
files: Resource$Files;
parents: Resource$Parents;
permissions: Resource$Permissions;
properties: Resource$Properties;
realtime: Resource$Realtime;
replies: Resource$Replies;
revisions: Resource$Revisions;
teamdrives: Resource$Teamdrives;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* An item with user information and settings.
*/
export interface Schema$About {
/**
* Information about supported additional roles per file type. The most specific type takes precedence.
*/
additionalRoleInfo?: Array<{
roleSets?: Array<{
additionalRoles?: string[];
primaryRole?: string;
}>;
type?: string;
}> | null;
/**
* Whether the user can create shared drives.
*/
canCreateDrives?: boolean | null;
/**
* Deprecated - use canCreateDrives instead.
*/
canCreateTeamDrives?: boolean | null;
/**
* The domain sharing policy for the current user. Possible values are: - allowed - allowedWithWarning - incomingOnly - disallowed
*/
domainSharingPolicy?: string | null;
/**
* A list of themes that are supported for shared drives.
*/
driveThemes?: Array<{
backgroundImageLink?: string;
colorRgb?: string;
id?: string;
}> | null;
/**
* The ETag of the item.
*/
etag?: string | null;
/**
* The allowable export formats.
*/
exportFormats?: Array<{
source?: string;
targets?: string[];
}> | null;
/**
* List of additional features enabled on this account.
*/
features?: Array<{
featureName?: string;
featureRate?: number;
}> | null;
/**
* The palette of allowable folder colors as RGB hex strings.
*/
folderColorPalette?: string[] | null;
/**
* The allowable import formats.
*/
importFormats?: Array<{
source?: string;
targets?: string[];
}> | null;
/**
* A boolean indicating whether the authenticated app is installed by the authenticated user.
*/
isCurrentAppInstalled?: boolean | null;
/**
* This is always drive#about.
*/
kind?: string | null;
/**
* The user's language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).
*/
languageCode?: string | null;
/**
* The largest change id.
*/
largestChangeId?: string | null;
/**
* List of max upload sizes for each file type. The most specific type takes precedence.
*/
maxUploadSizes?: Array<{
size?: string;
type?: string;
}> | null;
/**
* The name of the current user.
*/
name?: string | null;
/**
* The current user's ID as visible in the permissions collection.
*/
permissionId?: string | null;
/**
* The amount of storage quota used by different Google services.
*/
quotaBytesByService?: Array<{
bytesUsed?: string;
serviceName?: string;
}> | null;
/**
* The total number of quota bytes. This is only relevant when quotaType is LIMITED.
*/
quotaBytesTotal?: string | null;
/**
* The number of quota bytes used by Google Drive.
*/
quotaBytesUsed?: string | null;
/**
* The number of quota bytes used by all Google apps (Drive, Picasa, etc.).
*/
quotaBytesUsedAggregate?: string | null;
/**
* The number of quota bytes used by trashed items.
*/
quotaBytesUsedInTrash?: string | null;
/**
* The type of the user's storage quota. Possible values are: - LIMITED - UNLIMITED
*/
quotaType?: string | null;
/**
* The number of remaining change ids, limited to no more than 2500.
*/
remainingChangeIds?: string | null;
/**
* The id of the root folder.
*/
rootFolderId?: string | null;
/**
* A link back to this item.
*/
selfLink?: string | null;
/**
* Deprecated - use driveThemes instead.
*/
teamDriveThemes?: Array<{
backgroundImageLink?: string;
colorRgb?: string;
id?: string;
}> | null;
/**
* The authenticated user.
*/
user?: Schema$User;
}
/**
* The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details.
*/
export interface Schema$App {
/**
* Whether the app is authorized to access data on the user's Drive.
*/
authorized?: boolean | null;
/**
* The template url to create a new file with this app in a given folder. The template will contain {folderId} to be replaced by the folder to create the new file in.
*/
createInFolderTemplate?: string | null;
/**
* The url to create a new file with this app.
*/
createUrl?: string | null;
/**
* Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive.
*/
hasDriveWideScope?: boolean | null;
/**
* The various icons for the app.
*/
icons?: Array<{
category?: string;
iconUrl?: string;
size?: number;
}> | null;
/**
* The ID of the app.
*/
id?: string | null;
/**
* Whether the app is installed.
*/
installed?: boolean | null;
/**
* This is always drive#app.
*/
kind?: string | null;
/**
* A long description of the app.
*/
longDescription?: string | null;
/**
* The name of the app.
*/
name?: string | null;
/**
* The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
*/
objectType?: string | null;
/**
* The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids. See Open Files for the full documentation.
*/
openUrlTemplate?: string | null;
/**
* The list of primary file extensions.
*/
primaryFileExtensions?: string[] | null;
/**
* The list of primary mime types.
*/
primaryMimeTypes?: string[] | null;
/**
* The ID of the product listing for this app.
*/
productId?: string | null;
/**
* A link to the product listing for this app.
*/
productUrl?: string | null;
/**
* The list of secondary file extensions.
*/
secondaryFileExtensions?: string[] | null;
/**
* The list of secondary mime types.
*/
secondaryMimeTypes?: string[] | null;
/**
* A short description of the app.
*/
shortDescription?: string | null;
/**
* Whether this app supports creating new objects.
*/
supportsCreate?: boolean | null;
/**
* Whether this app supports importing Google Docs.
*/
supportsImport?: boolean | null;
/**
* Whether this app supports opening more than one file.
*/
supportsMultiOpen?: boolean | null;
/**
* Whether this app supports creating new files when offline.
*/
supportsOfflineCreate?: boolean | null;
/**
* Whether the app is selected as the default handler for the types it supports.
*/
useByDefault?: boolean | null;
}
/**
* A list of third-party applications which the user has installed or given access to Google Drive.
*/
export interface Schema$AppList {
/**
* List of app IDs that the user has specified to use by default. The list is in reverse-priority order (lowest to highest).
*/
defaultAppIds?: string[] | null;
/**
* The ETag of the list.
*/
etag?: string | null;
/**
* The list of apps.
*/
items?: Schema$App[];
/**
* This is always drive#appList.
*/
kind?: string | null;
/**
* A link back to this list.
*/
selfLink?: string | null;
}
/**
* Representation of a change to a file or shared drive.
*/
export interface Schema$Change {
/**
* The type of the change. Possible values are file and drive.
*/
changeType?: string | null;
/**
* Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access.
*/
deleted?: boolean | null;
/**
* The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted.
*/
drive?: Schema$Drive;
/**
* The ID of the shared drive associated with this change.
*/
driveId?: string | null;
/**
* The updated state of the file. Present if the type is file and the file has not been removed from this list of changes.
*/
file?: Schema$File;
/**
* The ID of the file associated with this change.
*/
fileId?: string | null;
/**
* The ID of the change.
*/
id?: string | null;
/**
* This is always drive#change.
*/
kind?: string | null;
/**
* The time of this modification.
*/
modificationDate?: string | null;
/**
* A link back to this change.
*/
selfLink?: string | null;
/**
* Deprecated - use drive instead.
*/
teamDrive?: Schema$TeamDrive;
/**
* Deprecated - use driveId instead.
*/
teamDriveId?: string | null;
/**
* Deprecated - use changeType instead.
*/
type?: string | null;
}
/**
* A list of changes for a user.
*/
export interface Schema$ChangeList {
/**
* The ETag of the list.
*/
etag?: string | null;
/**
* The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
*/
items?: Schema$Change[];
/**
* This is always drive#changeList.
*/
kind?: string | null;
/**
* The current largest change ID.
*/
largestChangeId?: string | null;
/**
* The starting page token for future changes. This will be present only if the end of the current changes list has been reached.
*/
newStartPageToken?: string | null;
/**
* A link to the next page of changes.
*/
nextLink?: string | null;
/**
* The page token for the next page of changes. This will be absent if the end of the changes list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
*/
nextPageToken?: string | null;
/**
* A link back to this list.
*/
selfLink?: string | null;
}
/**
* An notification channel used to watch for resource changes.
*/
export interface Schema$Channel {
/**
* The address where notifications are delivered for this channel.
*/
address?: string | null;
/**
* Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
*/
expiration?: string | null;
/**
* A UUID or similar unique string that identifies this channel.
*/
id?: string | null;
/**
* Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
*/
kind?: string | null;
/**
* Additional parameters controlling delivery channel behavior. Optional.
*/
params?: {
[key: string]: string;
} | null;
/**
* A Boolean value to indicate whether payload is wanted. Optional.
*/
payload?: boolean | null;
/**
* An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
*/
resourceId?: string | null;
/**
* A version-specific identifier for the watched resource.
*/
resourceUri?: string | null;
/**
* An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
*/
token?: string | null;
/**
* The type of delivery mechanism used for this channel.
*/
type?: string | null;
}
/**
* A list of children of a file.
*/
export interface Schema$ChildList {
/**
* The ETag of the list.
*/
etag?: string | null;
/**
* The list of children. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
*/
items?: Schema$ChildReference[];
/**
* This is always drive#childList.
*/
kind?: string | null;
/**
* A link to the next page of children.
*/
nextLink?: string | null;
/**
* The page token for the next page of children. This will be absent if the end of the children list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
*/
nextPageToken?: string | null;
/**
* A link back to this list.
*/
selfLink?: string | null;
}
/**
* A reference to a folder's child.
*/
export interface Schema$ChildReference {
/**
* A link to the child.
*/
childLink?: string | null;
/**
* The ID of the child.
*/
id?: string | null;
/**
* This is always drive#childReference.
*/
kind?: string | null;
/**
* A link back to this reference.
*/
selfLink?: string | null;
}
/**
* A comment on a file in Google Drive.
*/
export interface Schema$Comment {
/**
* A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
*/
anchor?: string | null;
/**
* The author of the comment. The author's email address and permission ID will not be populated.
*/
author?: Schema$User;
/**
* The ID of the comment.
*/
commentId?: string | null;
/**
* The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
*/
content?: string | null;
/**
* The context of the file which is being commented on.
*/
context?: {
type?: string;
value?: string;
} | null;
/**
* The date when this comment was first created.
*/
createdDate?: string | null;
/**
* Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
*/
deleted?: boolean | null;
/**
* The file which this comment is addressing.
*/
fileId?: string | null;
/**
* The title of the file which this comment is addressing.
*/
fileTitle?: string | null;
/**
* HTML formatted content for this comment.
*/
htmlContent?: string | null;
/**
* This is always drive#comment.
*/
kind?: string | null;
/**
* The date when this comment or any of its replies were last modified.
*/
modifiedDate?: string | null;
/**
* Replies to this post.
*/
replies?: Schema$CommentReply[];
/**
* A link back to this comment.
*/
selfLink?: string | null;
/**
* The status of this comment. Status can be changed by posting a reply to a comment with the desired status. - "open" - The comment is still open. - "resolved" - The comment has been resolved by one of its replies.
*/
status?: string | null;
}
/**
* A list of comments on a file in Google Drive.
*/
export interface Schema$CommentList {
/**
* The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
*/
items?: Schema$Comment[];
/**
* This is always drive#commentList.
*/
kind?: string | null;
/**
* A link to the next page of comments.
*/
nextLink?: string | null;
/**
* The page token for the next page of comments. This will be absent if the end of the comments list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
*/
nextPageToken?: string | null;
/**
* A link back to this list.
*/
selfLink?: string | null;
}
/**
* A comment on a file in Google Drive.
*/
export interface Schema$CommentReply {
/**
* The author of the reply. The author's email address and permission ID will not be populated.
*/
author?: Schema$User;
/**
* The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
*/
content?: string | null;
/**
* The date when this reply was first created.
*/
createdDate?: string | null;
/**
* Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
*/
deleted?: boolean | null;
/**
* HTML formatted content for this reply.
*/
htmlContent?: string | null;
/**
* This is always drive#commentReply.
*/
kind?: string | null;
/**
* The date when this reply was last modified.
*/
modifiedDate?: string | null;
/**
* The ID of the reply.
*/
replyId?: string | null;
/**
* The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: - "resolve" - To resolve a comment. - "reopen" - To reopen (un-resolve) a comment.
*/
verb?: string | null;
}
/**
* A list of replies to a comment on a file in Google Drive.
*/
export interface Schema$CommentReplyList {
/**
* The list of replies. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
*/
items?: Schema$CommentReply[];
/**
* This is always drive#commentReplyList.
*/
kind?: string | null;
/**
* A link to the next page of replies.
*/
nextLink?: string | null;
/**
* The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
*/
nextPageToken?: string | null;
/**
* A link back to this list.
*/
selfLink?: string | null;
}
/**
* Representation of a shared drive.
*/
export interface Schema$Drive {
/**
* An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.
*/
backgroundImageFile?: {
id?: string;
width?: number;
xCoordinate?: number;
yCoordinate?: number;
} | null;
/**
* A short-lived link to this shared drive's background image.
*/
backgroundImageLink?: string | null;
/**
* Capabilities the current user has on this shared drive.
*/
capabilities?: {
canAddChildren?: boolean;
canChangeCopyRequiresWriterPermissionRestriction?: boolean;
canChangeDomainUsersOnlyRestriction?: boolean;
canChangeDriveBackground?: boolean;
canChangeDriveMembersOnlyRestriction?: boolean;
canComment?: boolean;
canCopy?: boolean;
canDeleteChildren?: boolean;
canDeleteDrive?: boolean;
canDownload?: boolean;
canEdit?: boolean;
canListChildren?: boolean;
canManageMembers?: boolean;
canReadRevisions?: boolean;
canRename?: boolean;
canRenameDrive?: boolean;
canShare?: boolean;
canTrashChildren?: boolean;
} | null;
/**
* The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId.
*/
colorRgb?: string | null;
/**
* The time at which the shared drive was created (RFC 3339 date-time).
*/
createdDate?: string | null;
/**
* Whether the shared drive is hidden from default view.
*/
hidden?: boolean | null;
/**
* The ID of this shared drive which is also the ID of the top level folder of this shared drive.
*/
id?: string | null;
/**
* This is always drive#drive
*/
kind?: string | null;
/**
* The name of this shared drive.
*/
name?: string | null;
/**
* A set of restrictions that apply to this shared drive or items inside this shared drive.
*/
restrictions?: {
adminManagedRestrictions?: boolean;
copyRequiresWriterPermission?: boolean;
domainUsersOnly?: boolean;
driveMembersOnly?: boolean;
} | null;
/**
* The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.
*/
themeId?: string | null;
}
/**
* A list of shared drives.
*/
export interface Schema$DriveList {
/**
* The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
*/
items?: Schema$Drive[];
/**
* This is always drive#driveList
*/
kind?: string | null;
/**
* The page token for the next page of shared drives. This will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
*/
nextPageToken?: string | null;
}
/**
* The metadata for a file.
*/
export interface Schema$File {
/**
* A link for opening the file in a relevant Google editor or viewer.
*/
alternateLink?: string | null;
/**
* Whether this file is in the Application Data folder.
*/
appDataContents?: boolean | null;
/**
* Deprecated: use capabilities/canComment.
*/
canComment?: boolean | null;
/**
* Deprecated: use capabilities/canReadRevisions.
*/
canReadRevisions?: boolean | null;
/**
* Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
*/
capabilities?: {
canAddChildren?: boolean;
canChangeCopyRequiresWriterPermission?: boolean;
canChangeRestrictedDownload?: boolean;
canComment?: boolean;
canCopy?: boolean;
canDelete?: boolean;
canDeleteChildren?: boolean;
canDownload?: boolean;
canEdit?: boolean;
canListChildren?: boolean;
canModifyContent?: boolean;
canMoveChildrenOutOfDrive?: boolean;
canMoveChildrenOutOfTeamDrive?: boolean;
canMoveChildrenWithinDrive?: boolean;
canMoveChildrenWithinTeamDrive?: boolean;
canMoveItemIntoTeamDrive?: boolean;
canMoveItemOutOfDrive?: boolean;
canMoveItemOutOfTeamDrive?: boolean;
canMoveItemWithinDrive?: boolean;
canMoveItemWithinTeamDrive?: boolean;
canMoveTeamDriveItem?: boolean;
canReadDrive?: boolean;
canReadRevisions?: boolean;
canReadTeamDrive?: boolean;
canRemoveChildren?: boolean;
canRename?: boolean;
canShare?: boolean;
canTrash?: boolean;
canTrashChildren?: boolean;
canUntrash?: boolean;
} | null;
/**
* Deprecated: use capabilities/canCopy.
*/
copyable?: boolean | null;
/**
* Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
*/
copyRequiresWriterPermission?: boolean | null;
/**
* Create time for this file (formatted RFC 3339 timestamp).
*/
createdDate?: string | null;
/**
* A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
*/
defaultOpenWithLink?: string | null;
/**
* A short description of the file.
*/
description?: string | null;
/**
* Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
*/
downloadUrl?: string | null;
/**
* ID of the shared drive the file resides in. Only populated for items in shared drives.
*/
driveId?: string | null;
/**
* Deprecated: use capabilities/canEdit.
*/
editable?: boolean | null;
/**
* A link for embedding the file.
*/
embedLink?: string | null;
/**
* ETag of the file.
*/
etag?: string | null;
/**
* Whether this file has been explicitly trashed, as opposed to recursively trashed.
*/
explicitlyTrashed?: boolean | null;
/**
* Links for exporting Google Docs to specific formats.
*/
exportLinks?: {
[key: string]: string;
} | null;
/**
* The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
*/
fileExtension?: string | null;
/**
* The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
*/
fileSize?: string | null;
/**
* Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives.
*/
folderColorRgb?: string | null;
/**
* The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
*/
fullFileExtension?: string | null;
/**
* Whether there are permissions directly on this file. This field is only populated for items in shared drives.
*/
hasAugmentedPermissions?: boolean | null;
/**
* Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
*/
hasThumbnail?: boolean | null;
/**
* The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
*/
headRevisionId?: string | null;
/**
* A link to the file's icon.
*/
iconLink?: string | null;
/**
* The ID of the file.
*/
id?: string | null;
/**
* Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
*/
imageMediaMetadata?: {
aperture?: number;
cameraMake?: string;
cameraModel?: string;
colorSpace?: string;
date?: string;
exposureBias?: number;
exposureMode?: string;
exposureTime?: number;
flashUsed?: boolean;
focalLength?: number;
height?: number;
isoSpeed?: number;
lens?: string;
location?: {
altitude?: number;
latitude?: number;
longitude?: number;
};
maxApertureValue?: number;
meteringMode?: string;
rotation?: number;
sensor?: string;
subjectDistance?: number;
whiteBalance?: string;
width?: number;
} | null;
/**
* Indexable text attributes for the file (can only be written)
*/
indexableText?: {
text?: string;
} | null;
/**
* Whether the file was created or opened by the requesting app.
*/
isAppAuthorized?: boolean | null;
/**
* The type of file. This is always drive#file.
*/
kind?: string | null;
/**
* A group of labels for the file.
*/
labels?: {
hidden?: boolean;
modified?: boolean;
restricted?: boolean;
starred?: boolean;
trashed?: boolean;
viewed?: boolean;
} | null;
/**
* The last user to modify this file.
*/
lastModifyingUser?: Schema$User;
/**
* Name of the last user to modify this file.
*/
lastModifyingUserName?: string | null;
/**
* Last time this file was viewed by the user (formatted RFC 3339 timestamp).
*/
lastViewedByMeDate?: string | null;
/**
* Deprecated.
*/
markedViewedByMeDate?: string | null;
/**
* An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
*/
md5Checksum?: string | null;
/**
* The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
*/
mimeType?: string | null;
/**
* Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
*/
modifiedByMeDate?: string | null;
/**
* Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
*/
modifiedDate?: string | null;
/**
* A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
*/
openWithLinks?: {
[key: string]: string;
} | null;
/**
* The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive.
*/
originalFilename?: string | null;
/**
* Whether the file is owned by the current user. Not populated for items in shared drives.
*/
ownedByMe?: boolean | null;
/**
* Name(s) of the owner(s) of this file. Not populated for items in shared drives.
*/
ownerNames?: string[] | null;
/**
* The owner(s) of this file. Not populated for items in shared drives.
*/
owners?: Schema$User[];
/**
* Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list.
*/
parents?: Schema$ParentReference[];
/**
* List of permission IDs for users with access to this file.
*/
permissionIds?: string[] | null;
/**
* The list of permissions for users with access to this file. Not populated for items in shared drives.
*/
permissions?: Schema$Permission[];
/**
* The list of properties.
*/
properties?: Schema$Property[];
/**
* The number of quota bytes used by this file.
*/
quotaBytesUsed?: string | null;
/**
* A link back to this file.
*/
selfLink?: string | null;
/**
* Deprecated: use capabilities/canShare.
*/
shareable?: boolean | null;
/**
* Whether the file has been shared. Not populated for items in shared drives.
*/
shared?: boolean | null;
/**
* Time at which this file was shared with the user (formatted RFC 3339 timestamp).
*/
sharedWithMeDate?: string | null;
/**
* User that shared the item with the current user, if available.
*/
sharingUser?: Schema$User;
/**
* The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
*/
spaces?: string[] | null;
/**
* Deprecated - use driveId instead.
*/
teamDriveId?: string | null;
/**
* A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
*/
thumbnail?: {
image?: string;
mimeType?: string;
} | null;
/**
* A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
*/
thumbnailLink?: string | null;
/**
* The thumbnail version for use in thumbnail cache invalidation.
*/
thumbnailVersion?: string | null;
/**
* The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
*/
title?: string | null;
/**
* The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
*/
trashedDate?: string | null;
/**
* If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
*/
trashingUser?: Schema$User;
/**
* The permissions for the authenticated user on this file.
*/
userPermission?: Schema$Permission;
/**
* A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
*/
version?: string | null;
/**
* Metadata about video media. This will only be present for video types.
*/
videoMediaMetadata?: {
durationMillis?: string;
height?: number;
width?: number;
} | null;
/**
* A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
*/
webContentLink?: string | null;
/**
* A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
*/
webViewLink?: string | null;
/**
* Whether writers can share the document with other users. Not populated for items in shared drives.
*/
writersCanShare?: boolean | null;
}
/**
* A list of files.
*/
export interface Schema$FileList {
/**
* The ETag of the list.
*/
etag?: string | null;
/**
* Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the "allDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "default" or "drive".
*/
incompleteSearch?: boolean | null;
/**
* The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
*/
items?: Schema$File[];
/**
* This is always drive#fileList.
*/
kind?: string | null;
/**
* A link to the next page of files.
*/
nextLink?: string | null;
/**
* The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
*/
nextPageToken?: string | null;
/**
* A link back to this list.
*/
selfLink?: string | null;
}
/**
* A list of generated IDs which can be provided in insert requests
*/
export interface Schema$GeneratedIds {
/**
* The IDs generated for the requesting user in the specified space.
*/
ids?: string[] | null;
/**
* This is always drive#generatedIds
*/
kind?: string | null;
/**
* The type of file that can be created with these IDs.
*/
space?: string | null;
}
/**
* A list of a file's parents.
*/
export interface Schema$ParentList {
/**
* The ETag of the list.
*/
etag?: string | null;
/**
* The list of parents.
*/
items?: Schema$ParentReference[];
/**
* This is always drive#parentList.
*/
kind?: string | null;
/**
* A link back to this list.
*/
selfLink?: string | null;
}
/**
* A reference to a file's parent.
*/
export interface Schema$ParentReference {
/**
* The ID of the parent.
*/
id?: string | null;
/**
* Whether or not the parent is the root folder.
*/
isRoot?: boolean | null;
/**
* This is always drive#parentReference.
*/
kind?: string | null;
/**
* A link to the parent.
*/
parentLink?: string | null;
/**
* A link back to this reference.
*/
selfLink?: string | null;
}
/**
* A permission for a file.
*/
export interface Schema$Permission {
/**
* Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
*/
additionalRoles?: string[] | null;
/**
* Deprecated.
*/
authKey?: string | null;
/**
* Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
*/
deleted?: boolean | null;
/**
* The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
*/
domain?: string | null;
/**
* The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
*/
emailAddress?: string | null;
/**
* The ETag of the permission.
*/
etag?: string | null;
/**
* The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
*/
expirationDate?: string | null;
/**
* The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
*/
id?: string | null;
/**
* This is always drive#permission.
*/
kind?: string | null;
/**
* The name for this permission.
*/
name?: string | null;
/**
* Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
*/
permissionDetails?: Array<{
additionalRoles?: string[];
inherited?: boolean;
inheritedFrom?: string;
permissionType?: string;
role?: string;
}> | null;
/**
* A link to the profile photo, if available.
*/
photoLink?: string | null;
/**
* The primary role for this user. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - reader
*/
role?: string | null;
/**
* A link back to this permission.
*/
selfLink?: string | null;
/**
* Deprecated - use permissionDetails instead.
*/
teamDrivePermissionDetails?: Array<{
additionalRoles?: string[];
inherited?: boolean;
inheritedFrom?: string;
role?: string;
teamDrivePermissionType?: string;
}> | null;
/**
* The account type. Allowed values are: - user - group - domain - anyone
*/
type?: string | null;
/**
* The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
*/
value?: string | null;
/**
* Whether the link is required for this permission.
*/
withLink?: boolean | null;
}
/**
* An ID for a user or group as seen in Permission items.
*/
export interface Schema$PermissionId {
/**
* The permission ID.
*/
id?: string | null;
/**
* This is always drive#permissionId.
*/
kind?: string | null;
}
/**
* A list of permissions associated with a file.
*/
export interface Schema$PermissionList {
/**
* The ETag of the list.
*/
etag?: string | null;
/**
* The list of permissions.
*/
items?: Schema$Permission[];
/**
* This is always drive#permissionList.
*/
kind?: string | null;
/**
* The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
*/
nextPageToken?: string | null;
/**
* A link back to this list.
*/
selfLink?: string | null;
}
/**
* A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: - Maximum of 100 properties total per file - Maximum of 30 private properties per app - Maximum of 30 public properties - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
*/
export interface Schema$Property {
/**
* ETag of the property.
*/
etag?: string | null;
/**
* The key of this property.
*/
key?: string | null;
/**
* This is always drive#property.
*/
kind?: string | null;
/**
* The link back to this property.
*/
selfLink?: string | null;
/**
* The value of this property.
*/
value?: string | null;
/**
* The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
*/
visibility?: string | null;
}
/**
* A collection of properties, key-value pairs that are either public or private to an application.
*/
export interface Schema$PropertyList {
/**
* The ETag of the list.
*/
etag?: string | null;
/**
* The list of properties.
*/
items?: Schema$Property[];
/**
* This is always drive#propertyList.
*/
kind?: string | null;
/**
* The link back to this list.
*/
selfLink?: string | null;
}
/**
* A revision of a file.
*/
export interface Schema$Revision {
/**
* Short term download URL for the file. This will only be populated on files with content stored in Drive.
*/
downloadUrl?: string | null;
/**
* The ETag of the revision.
*/
etag?: string | null;
/**
* Links for exporting Google Docs to specific formats.
*/
exportLinks?: {
[key: string]: string;
} | null;
/**
* The size of the revision in bytes. This will only be populated on files with content stored in Drive.
*/
fileSize?: string | null;
/**
* The ID of the revision.
*/
id?: string | null;
/**
* This is always drive#revision.
*/
kind?: string | null;
/**
* The last user to modify this revision.
*/
lastModifyingUser?: Schema$User;
/**
* Name of the last user to modify this revision.
*/
lastModifyingUserName?: string | null;
/**
* An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
*/
md5Checksum?: string | null;
/**
* The MIME type of the revision.
*/
mimeType?: string | null;
/**
* Last time this revision was modified (formatted RFC 3339 timestamp).
*/
modifiedDate?: string | null;
/**
* The original filename when this revision was created. This will only be populated on files with content stored in Drive.
*/
originalFilename?: string | null;
/**
* Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. Pinned revisions are stored indefinitely using additional storage quota, up to a maximum of 200 revisions.
*/
pinned?: boolean | null;
/**
* Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
*/
publishAuto?: boolean | null;
/**
* Whether this revision is published. This is only populated and can only be modified for Google Docs.
*/
published?: boolean | null;
/**
* A link to the published revision.
*/
publishedLink?: string | null;
/**
* Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
*/
publishedOutsideDomain?: boolean | null;
/**
* A link back to this revision.
*/
selfLink?: string | null;
}
/**
* A list of revisions of a file.
*/
export interface Schema$RevisionList {
/**
* The ETag of the list.
*/
etag?: string | null;
/**
* The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
*/
items?: Schema$Revision[];
/**
* This is always drive#revisionList.
*/
kind?: string | null;
/**
* The page token for the next page of revisions. This field will be absent if the end of the revisions list has been reached. If the token is rejected for any reason, it should be discarded and pagination should be restarted from the first page of results.
*/
nextPageToken?: string | null;
/**
* A link back to this list.
*/
selfLink?: string | null;
}
export interface Schema$StartPageToken {
/**
* Identifies what kind of resource this is. Value: the fixed string "drive#startPageToken".
*/
kind?: string | null;
/**
* The starting page token for listing changes.
*/
startPageToken?: string | null;
}
/**
* Deprecated: use the drive collection instead.
*/
export interface Schema$TeamDrive {
/**
* An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.
*/
backgroundImageFile?: {
id?: string;
width?: number;
xCoordinate?: number;
yCoordinate?: number;
} | null;
/**
* A short-lived link to this Team Drive's background image.
*/
backgroundImageLink?: string | null;
/**
* Capabilities the current user has on this Team Drive.
*/
capabilities?: {
canAddChildren?: boolean;
canChangeCopyRequiresWriterPermissionRestriction?: boolean;
canChangeDomainUsersOnlyRestriction?: boolean;
canChangeTeamDriveBackground?: boolean;
canChangeTeamMembersOnlyRestriction?: boolean;
canComment?: boolean;
canCopy?: boolean;
canDeleteChildren?: boolean;
canDeleteTeamDrive?: boolean;
canDownload?: boolean;
canEdit?: boolean;
canListChildren?: boolean;
canManageMembers?: boolean;
canReadRevisions?: boolean;
canRemoveChildren?: boolean;
canRename?: boolean;
canRenameTeamDrive?: boolean;
canShare?: boolean;
canTrashChildren?: boolean;
} | null;
/**
* The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId.
*/
colorRgb?: string | null;
/**
* The time at which the Team Drive was created (RFC 3339 date-time).
*/
createdDate?: string | null;
/**
* The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
*/
id?: string | null;
/**
* This is always drive#teamDrive
*/
kind?: string | null;
/**
* The name of this Team Drive.
*/
name?: string | null;
/**
* A set of restrictions that apply to this Team Drive or items inside this Team Drive.
*/
restrictions?: {
adminManagedRestrictions?: boolean;
copyRequiresWriterPermission?: boolean;
domainUsersOnly?: boolean;
teamMembersOnly?: boolean;
} | null;
/**
* The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.
*/
themeId?: string | null;
}
/**
* A list of Team Drives.
*/
export interface Schema$TeamDriveList {
/**
* The list of Team Drives.
*/
items?: Schema$TeamDrive[];
/**
* This is always drive#teamDriveList
*/
kind?: string | null;
/**
* The page token for the next page of Team Drives.
*/
nextPageToken?: string | null;
}
/**
* Information about a Drive user.
*/
export interface Schema$User {
/**
* A plain text displayable name for this user.
*/
displayName?: string | null;
/**
* The email address of the user.
*/
emailAddress?: string | null;
/**
* Whether this user is the same as the authenticated user for whom the request was made.
*/
isAuthenticatedUser?: boolean | null;
/**
* This is always drive#user.
*/
kind?: string | null;
/**
* The user's ID as visible in the permissions collection.
*/
permissionId?: string | null;
/**
* The user's profile picture.
*/
picture?: {
url?: string;
} | null;
}
export class Resource$About {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.about.get
* @desc Gets the information about the current user along with Drive API settings
* @alias drive.about.get
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {boolean=} params.includeSubscribed Whether to count changes outside the My Drive hierarchy. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the maxChangeIdCount.
* @param {string=} params.maxChangeIdCount Maximum number of remaining change IDs to count
* @param {string=} params.startChangeId Change ID to start counting from when calculating number of remaining change IDs
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$About$Get, options?: MethodOptions): GaxiosPromise<Schema$About>;
get(params: Params$Resource$About$Get, options: MethodOptions | BodyResponseCallback<Schema$About>, callback: BodyResponseCallback<Schema$About>): void;
get(params: Params$Resource$About$Get, callback: BodyResponseCallback<Schema$About>): void;
get(callback: BodyResponseCallback<Schema$About>): void;
}
export interface Params$Resource$About$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to count changes outside the My Drive hierarchy. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the maxChangeIdCount.
*/
includeSubscribed?: boolean;
/**
* Maximum number of remaining change IDs to count
*/
maxChangeIdCount?: string;
/**
* Change ID to start counting from when calculating number of remaining change IDs
*/
startChangeId?: string;
}
export class Resource$Apps {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.apps.get
* @desc Gets a specific app.
* @alias drive.apps.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appId The ID of the app.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Apps$Get, options?: MethodOptions): GaxiosPromise<Schema$App>;
get(params: Params$Resource$Apps$Get, options: MethodOptions | BodyResponseCallback<Schema$App>, callback: BodyResponseCallback<Schema$App>): void;
get(params: Params$Resource$Apps$Get, callback: BodyResponseCallback<Schema$App>): void;
get(callback: BodyResponseCallback<Schema$App>): void;
/**
* drive.apps.list
* @desc Lists a user's installed apps.
* @alias drive.apps.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.appFilterExtensions A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be included in the response. If appFilterMimeTypes are provided as well, the result is a union of the two resulting app lists.
* @param {string=} params.appFilterMimeTypes A comma-separated list of MIME types for open with filtering. All apps within the given app query scope which can open any of the given MIME types will be included in the response. If appFilterExtensions are provided as well, the result is a union of the two resulting app lists.
* @param {string=} params.languageCode A language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Apps$List, options?: MethodOptions): GaxiosPromise<Schema$AppList>;
list(params: Params$Resource$Apps$List, options: MethodOptions | BodyResponseCallback<Schema$AppList>, callback: BodyResponseCallback<Schema$AppList>): void;
list(params: Params$Resource$Apps$List, callback: BodyResponseCallback<Schema$AppList>): void;
list(callback: BodyResponseCallback<Schema$AppList>): void;
}
export interface Params$Resource$Apps$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the app.
*/
appId?: string;
}
export interface Params$Resource$Apps$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be included in the response. If appFilterMimeTypes are provided as well, the result is a union of the two resulting app lists.
*/
appFilterExtensions?: string;
/**
* A comma-separated list of MIME types for open with filtering. All apps within the given app query scope which can open any of the given MIME types will be included in the response. If appFilterExtensions are provided as well, the result is a union of the two resulting app lists.
*/
appFilterMimeTypes?: string;
/**
* A language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).
*/
languageCode?: string;
}
export class Resource$Changes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.changes.get
* @desc Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes.
* @alias drive.changes.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.changeId The ID of the change.
* @param {string=} params.driveId The shared drive from which the change will be returned.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {string=} params.teamDriveId Deprecated use driveId instead.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Changes$Get, options?: MethodOptions): GaxiosPromise<Schema$Change>;
get(params: Params$Resource$Changes$Get, options: MethodOptions | BodyResponseCallback<Schema$Change>, callback: BodyResponseCallback<Schema$Change>): void;
get(params: Params$Resource$Changes$Get, callback: BodyResponseCallback<Schema$Change>): void;
get(callback: BodyResponseCallback<Schema$Change>): void;
/**
* drive.changes.getStartPageToken
* @desc Gets the starting pageToken for listing future changes.
* @alias drive.changes.getStartPageToken
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.driveId The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {string=} params.teamDriveId Deprecated use driveId instead.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getStartPageToken(params?: Params$Resource$Changes$Getstartpagetoken, options?: MethodOptions): GaxiosPromise<Schema$StartPageToken>;
getStartPageToken(params: Params$Resource$Changes$Getstartpagetoken, options: MethodOptions | BodyResponseCallback<Schema$StartPageToken>, callback: BodyResponseCallback<Schema$StartPageToken>): void;
getStartPageToken(params: Params$Resource$Changes$Getstartpagetoken, callback: BodyResponseCallback<Schema$StartPageToken>): void;
getStartPageToken(callback: BodyResponseCallback<Schema$StartPageToken>): void;
/**
* drive.changes.list
* @desc Lists the changes for a user or shared drive.
* @alias drive.changes.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
* @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
* @param {boolean=} params.includeDeleted Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
* @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.
* @param {boolean=} params.includeSubscribed Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.
* @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead.
* @param {integer=} params.maxResults Maximum number of changes to return.
* @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.
* @param {string=} params.spaces A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
* @param {string=} params.startChangeId Deprecated - use pageToken instead.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {string=} params.teamDriveId Deprecated use driveId instead.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Changes$List, options?: MethodOptions): GaxiosPromise<Schema$ChangeList>;
list(params: Params$Resource$Changes$List, options: MethodOptions | BodyResponseCallback<Schema$ChangeList>, callback: BodyResponseCallback<Schema$ChangeList>): void;
list(params: Params$Resource$Changes$List, callback: BodyResponseCallback<Schema$ChangeList>): void;
list(callback: BodyResponseCallback<Schema$ChangeList>): void;
/**
* drive.changes.watch
* @desc Subscribe to changes for a user.
* @alias drive.changes.watch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
* @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
* @param {boolean=} params.includeDeleted Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
* @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.
* @param {boolean=} params.includeSubscribed Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.
* @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead.
* @param {integer=} params.maxResults Maximum number of changes to return.
* @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.
* @param {string=} params.spaces A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
* @param {string=} params.startChangeId Deprecated - use pageToken instead.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {string=} params.teamDriveId Deprecated use driveId instead.
* @param {().Channel} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
watch(params?: Params$Resource$Changes$Watch, options?: MethodOptions): GaxiosPromise<Schema$Channel>;
watch(params: Params$Resource$Changes$Watch, options: MethodOptions | BodyResponseCallback<Schema$Channel>, callback: BodyResponseCallback<Schema$Channel>): void;
watch(params: Params$Resource$Changes$Watch, callback: BodyResponseCallback<Schema$Channel>): void;
watch(callback: BodyResponseCallback<Schema$Channel>): void;
}
export interface Params$Resource$Changes$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the change.
*/
changeId?: string;
/**
* The shared drive from which the change will be returned.
*/
driveId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Deprecated use driveId instead.
*/
teamDriveId?: string;
}
export interface Params$Resource$Changes$Getstartpagetoken extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.
*/
driveId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Deprecated use driveId instead.
*/
teamDriveId?: string;
}
export interface Params$Resource$Changes$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
*/
driveId?: string;
/**
* Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
*/
includeCorpusRemovals?: boolean;
/**
* Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
*/
includeDeleted?: boolean;
/**
* Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.
*/
includeItemsFromAllDrives?: boolean;
/**
* Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.
*/
includeSubscribed?: boolean;
/**
* Deprecated use includeItemsFromAllDrives instead.
*/
includeTeamDriveItems?: boolean;
/**
* Maximum number of changes to return.
*/
maxResults?: number;
/**
* The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.
*/
pageToken?: string;
/**
* A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
*/
spaces?: string;
/**
* Deprecated - use pageToken instead.
*/
startChangeId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Deprecated use driveId instead.
*/
teamDriveId?: string;
}
export interface Params$Resource$Changes$Watch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
*/
driveId?: string;
/**
* Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
*/
includeCorpusRemovals?: boolean;
/**
* Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
*/
includeDeleted?: boolean;
/**
* Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.
*/
includeItemsFromAllDrives?: boolean;
/**
* Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.
*/
includeSubscribed?: boolean;
/**
* Deprecated use includeItemsFromAllDrives instead.
*/
includeTeamDriveItems?: boolean;
/**
* Maximum number of changes to return.
*/
maxResults?: number;
/**
* The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.
*/
pageToken?: string;
/**
* A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
*/
spaces?: string;
/**
* Deprecated - use pageToken instead.
*/
startChangeId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Deprecated use driveId instead.
*/
teamDriveId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Channel;
}
export class Resource$Channels {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.channels.stop
* @desc Stop watching resources through this channel
* @alias drive.channels.stop
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Channel} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
stop(params?: Params$Resource$Channels$Stop, options?: MethodOptions): GaxiosPromise<void>;
stop(params: Params$Resource$Channels$Stop, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
stop(params: Params$Resource$Channels$Stop, callback: BodyResponseCallback<void>): void;
stop(callback: BodyResponseCallback<void>): void;
}
export interface Params$Resource$Channels$Stop extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$Channel;
}
export class Resource$Children {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.children.delete
* @desc Removes a child from a folder.
* @alias drive.children.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.childId The ID of the child.
* @param {string} params.folderId The ID of the folder.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Children$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Children$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Children$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* drive.children.get
* @desc Gets a specific child reference.
* @alias drive.children.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.childId The ID of the child.
* @param {string} params.folderId The ID of the folder.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Children$Get, options?: MethodOptions): GaxiosPromise<Schema$ChildReference>;
get(params: Params$Resource$Children$Get, options: MethodOptions | BodyResponseCallback<Schema$ChildReference>, callback: BodyResponseCallback<Schema$ChildReference>): void;
get(params: Params$Resource$Children$Get, callback: BodyResponseCallback<Schema$ChildReference>): void;
get(callback: BodyResponseCallback<Schema$ChildReference>): void;
/**
* drive.children.insert
* @desc Inserts a file into a folder.
* @alias drive.children.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.folderId The ID of the folder.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {().ChildReference} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Children$Insert, options?: MethodOptions): GaxiosPromise<Schema$ChildReference>;
insert(params: Params$Resource$Children$Insert, options: MethodOptions | BodyResponseCallback<Schema$ChildReference>, callback: BodyResponseCallback<Schema$ChildReference>): void;
insert(params: Params$Resource$Children$Insert, callback: BodyResponseCallback<Schema$ChildReference>): void;
insert(callback: BodyResponseCallback<Schema$ChildReference>): void;
/**
* drive.children.list
* @desc Lists a folder's children.
* @alias drive.children.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.folderId The ID of the folder.
* @param {integer=} params.maxResults Maximum number of children to return.
* @param {string=} params.orderBy A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
* @param {string=} params.pageToken Page token for children.
* @param {string=} params.q Query string for searching children.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Children$List, options?: MethodOptions): GaxiosPromise<Schema$ChildList>;
list(params: Params$Resource$Children$List, options: MethodOptions | BodyResponseCallback<Schema$ChildList>, callback: BodyResponseCallback<Schema$ChildList>): void;
list(params: Params$Resource$Children$List, callback: BodyResponseCallback<Schema$ChildList>): void;
list(callback: BodyResponseCallback<Schema$ChildList>): void;
}
export interface Params$Resource$Children$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the child.
*/
childId?: string;
/**
* The ID of the folder.
*/
folderId?: string;
}
export interface Params$Resource$Children$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the child.
*/
childId?: string;
/**
* The ID of the folder.
*/
folderId?: string;
}
export interface Params$Resource$Children$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the folder.
*/
folderId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$ChildReference;
}
export interface Params$Resource$Children$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the folder.
*/
folderId?: string;
/**
* Maximum number of children to return.
*/
maxResults?: number;
/**
* A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
*/
orderBy?: string;
/**
* Page token for children.
*/
pageToken?: string;
/**
* Query string for searching children.
*/
q?: string;
}
export class Resource$Comments {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.comments.delete
* @desc Deletes a comment.
* @alias drive.comments.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Comments$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Comments$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Comments$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* drive.comments.get
* @desc Gets a comment by ID.
* @alias drive.comments.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.includeDeleted If set, this will succeed when retrieving a deleted comment, and will include any deleted replies.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Comments$Get, options?: MethodOptions): GaxiosPromise<Schema$Comment>;
get(params: Params$Resource$Comments$Get, options: MethodOptions | BodyResponseCallback<Schema$Comment>, callback: BodyResponseCallback<Schema$Comment>): void;
get(params: Params$Resource$Comments$Get, callback: BodyResponseCallback<Schema$Comment>): void;
get(callback: BodyResponseCallback<Schema$Comment>): void;
/**
* drive.comments.insert
* @desc Creates a new comment on the given file.
* @alias drive.comments.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {().Comment} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Comments$Insert, options?: MethodOptions): GaxiosPromise<Schema$Comment>;
insert(params: Params$Resource$Comments$Insert, options: MethodOptions | BodyResponseCallback<Schema$Comment>, callback: BodyResponseCallback<Schema$Comment>): void;
insert(params: Params$Resource$Comments$Insert, callback: BodyResponseCallback<Schema$Comment>): void;
insert(callback: BodyResponseCallback<Schema$Comment>): void;
/**
* drive.comments.list
* @desc Lists a file's comments.
* @alias drive.comments.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.includeDeleted If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
* @param {integer=} params.maxResults The maximum number of discussions to include in the response, used for paging.
* @param {string=} params.pageToken The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
* @param {string=} params.updatedMin Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Comments$List, options?: MethodOptions): GaxiosPromise<Schema$CommentList>;
list(params: Params$Resource$Comments$List, options: MethodOptions | BodyResponseCallback<Schema$CommentList>, callback: BodyResponseCallback<Schema$CommentList>): void;
list(params: Params$Resource$Comments$List, callback: BodyResponseCallback<Schema$CommentList>): void;
list(callback: BodyResponseCallback<Schema$CommentList>): void;
/**
* drive.comments.patch
* @desc Updates an existing comment.
* @alias drive.comments.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {().Comment} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Comments$Patch, options?: MethodOptions): GaxiosPromise<Schema$Comment>;
patch(params: Params$Resource$Comments$Patch, options: MethodOptions | BodyResponseCallback<Schema$Comment>, callback: BodyResponseCallback<Schema$Comment>): void;
patch(params: Params$Resource$Comments$Patch, callback: BodyResponseCallback<Schema$Comment>): void;
patch(callback: BodyResponseCallback<Schema$Comment>): void;
/**
* drive.comments.update
* @desc Updates an existing comment.
* @alias drive.comments.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {().Comment} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Comments$Update, options?: MethodOptions): GaxiosPromise<Schema$Comment>;
update(params: Params$Resource$Comments$Update, options: MethodOptions | BodyResponseCallback<Schema$Comment>, callback: BodyResponseCallback<Schema$Comment>): void;
update(params: Params$Resource$Comments$Update, callback: BodyResponseCallback<Schema$Comment>): void;
update(callback: BodyResponseCallback<Schema$Comment>): void;
}
export interface Params$Resource$Comments$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the comment.
*/
commentId?: string;
/**
* The ID of the file.
*/
fileId?: string;
}
export interface Params$Resource$Comments$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the comment.
*/
commentId?: string;
/**
* The ID of the file.
*/
fileId?: string;
/**
* If set, this will succeed when retrieving a deleted comment, and will include any deleted replies.
*/
includeDeleted?: boolean;
}
export interface Params$Resource$Comments$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Comment;
}
export interface Params$Resource$Comments$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
*/
includeDeleted?: boolean;
/**
* The maximum number of discussions to include in the response, used for paging.
*/
maxResults?: number;
/**
* The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
/**
* Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.
*/
updatedMin?: string;
}
export interface Params$Resource$Comments$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the comment.
*/
commentId?: string;
/**
* The ID of the file.
*/
fileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Comment;
}
export interface Params$Resource$Comments$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the comment.
*/
commentId?: string;
/**
* The ID of the file.
*/
fileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Comment;
}
export class Resource$Drives {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.drives.delete
* @desc Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.
* @alias drive.drives.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.driveId The ID of the shared drive.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Drives$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Drives$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Drives$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* drive.drives.get
* @desc Gets a shared drive's metadata by ID.
* @alias drive.drives.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.driveId The ID of the shared drive.
* @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Drives$Get, options?: MethodOptions): GaxiosPromise<Schema$Drive>;
get(params: Params$Resource$Drives$Get, options: MethodOptions | BodyResponseCallback<Schema$Drive>, callback: BodyResponseCallback<Schema$Drive>): void;
get(params: Params$Resource$Drives$Get, callback: BodyResponseCallback<Schema$Drive>): void;
get(callback: BodyResponseCallback<Schema$Drive>): void;
/**
* drive.drives.hide
* @desc Hides a shared drive from the default view.
* @alias drive.drives.hide
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.driveId The ID of the shared drive.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
hide(params?: Params$Resource$Drives$Hide, options?: MethodOptions): GaxiosPromise<Schema$Drive>;
hide(params: Params$Resource$Drives$Hide, options: MethodOptions | BodyResponseCallback<Schema$Drive>, callback: BodyResponseCallback<Schema$Drive>): void;
hide(params: Params$Resource$Drives$Hide, callback: BodyResponseCallback<Schema$Drive>): void;
hide(callback: BodyResponseCallback<Schema$Drive>): void;
/**
* drive.drives.insert
* @desc Creates a new shared drive.
* @alias drive.drives.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.requestId An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.
* @param {().Drive} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Drives$Insert, options?: MethodOptions): GaxiosPromise<Schema$Drive>;
insert(params: Params$Resource$Drives$Insert, options: MethodOptions | BodyResponseCallback<Schema$Drive>, callback: BodyResponseCallback<Schema$Drive>): void;
insert(params: Params$Resource$Drives$Insert, callback: BodyResponseCallback<Schema$Drive>): void;
insert(callback: BodyResponseCallback<Schema$Drive>): void;
/**
* drive.drives.list
* @desc Lists the user's shared drives.
* @alias drive.drives.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {integer=} params.maxResults Maximum number of shared drives to return.
* @param {string=} params.pageToken Page token for shared drives.
* @param {string=} params.q Query string for searching shared drives.
* @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Drives$List, options?: MethodOptions): GaxiosPromise<Schema$DriveList>;
list(params: Params$Resource$Drives$List, options: MethodOptions | BodyResponseCallback<Schema$DriveList>, callback: BodyResponseCallback<Schema$DriveList>): void;
list(params: Params$Resource$Drives$List, callback: BodyResponseCallback<Schema$DriveList>): void;
list(callback: BodyResponseCallback<Schema$DriveList>): void;
/**
* drive.drives.unhide
* @desc Restores a shared drive to the default view.
* @alias drive.drives.unhide
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.driveId The ID of the shared drive.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
unhide(params?: Params$Resource$Drives$Unhide, options?: MethodOptions): GaxiosPromise<Schema$Drive>;
unhide(params: Params$Resource$Drives$Unhide, options: MethodOptions | BodyResponseCallback<Schema$Drive>, callback: BodyResponseCallback<Schema$Drive>): void;
unhide(params: Params$Resource$Drives$Unhide, callback: BodyResponseCallback<Schema$Drive>): void;
unhide(callback: BodyResponseCallback<Schema$Drive>): void;
/**
* drive.drives.update
* @desc Updates the metadata for a shared drive.
* @alias drive.drives.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.driveId The ID of the shared drive.
* @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.
* @param {().Drive} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Drives$Update, options?: MethodOptions): GaxiosPromise<Schema$Drive>;
update(params: Params$Resource$Drives$Update, options: MethodOptions | BodyResponseCallback<Schema$Drive>, callback: BodyResponseCallback<Schema$Drive>): void;
update(params: Params$Resource$Drives$Update, callback: BodyResponseCallback<Schema$Drive>): void;
update(callback: BodyResponseCallback<Schema$Drive>): void;
}
export interface Params$Resource$Drives$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the shared drive.
*/
driveId?: string;
}
export interface Params$Resource$Drives$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the shared drive.
*/
driveId?: string;
/**
* Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.
*/
useDomainAdminAccess?: boolean;
}
export interface Params$Resource$Drives$Hide extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the shared drive.
*/
driveId?: string;
}
export interface Params$Resource$Drives$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.
*/
requestId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Drive;
}
export interface Params$Resource$Drives$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of shared drives to return.
*/
maxResults?: number;
/**
* Page token for shared drives.
*/
pageToken?: string;
/**
* Query string for searching shared drives.
*/
q?: string;
/**
* Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.
*/
useDomainAdminAccess?: boolean;
}
export interface Params$Resource$Drives$Unhide extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the shared drive.
*/
driveId?: string;
}
export interface Params$Resource$Drives$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the shared drive.
*/
driveId?: string;
/**
* Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.
*/
useDomainAdminAccess?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Drive;
}
export class Resource$Files {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.files.copy
* @desc Creates a copy of the specified file.
* @alias drive.files.copy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.convert Whether to convert this file to the corresponding Google Docs format.
* @param {string} params.fileId The ID of the file to copy.
* @param {boolean=} params.ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
* @param {string=} params.ocrLanguage If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
* @param {boolean=} params.pinned Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {string=} params.timedTextLanguage The language of the timed text.
* @param {string=} params.timedTextTrackName The timed text track name.
* @param {string=} params.visibility The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false.
* @param {().File} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
copy(params?: Params$Resource$Files$Copy, options?: MethodOptions): GaxiosPromise<Schema$File>;
copy(params: Params$Resource$Files$Copy, options: MethodOptions | BodyResponseCallback<Schema$File>, callback: BodyResponseCallback<Schema$File>): void;
copy(params: Params$Resource$Files$Copy, callback: BodyResponseCallback<Schema$File>): void;
copy(callback: BodyResponseCallback<Schema$File>): void;
/**
* drive.files.delete
* @desc Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for shared drive files.
* @alias drive.files.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file to delete.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Files$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Files$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Files$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* drive.files.emptyTrash
* @desc Permanently deletes all of the user's trashed files.
* @alias drive.files.emptyTrash
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
emptyTrash(params?: Params$Resource$Files$Emptytrash, options?: MethodOptions): GaxiosPromise<void>;
emptyTrash(params: Params$Resource$Files$Emptytrash, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
emptyTrash(params: Params$Resource$Files$Emptytrash, callback: BodyResponseCallback<void>): void;
emptyTrash(callback: BodyResponseCallback<void>): void;
/**
* drive.files.export
* @desc Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.
* @alias drive.files.export
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {string} params.mimeType The MIME type of the format requested for this export.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
export(params?: Params$Resource$Files$Export, options?: MethodOptions): GaxiosPromise<void>;
export(params: Params$Resource$Files$Export, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
export(params: Params$Resource$Files$Export, callback: BodyResponseCallback<void>): void;
export(callback: BodyResponseCallback<void>): void;
/**
* drive.files.generateIds
* @desc Generates a set of file IDs which can be provided in insert or copy requests.
* @alias drive.files.generateIds
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {integer=} params.maxResults Maximum number of IDs to return.
* @param {string=} params.space The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
generateIds(params?: Params$Resource$Files$Generateids, options?: MethodOptions): GaxiosPromise<Schema$GeneratedIds>;
generateIds(params: Params$Resource$Files$Generateids, options: MethodOptions | BodyResponseCallback<Schema$GeneratedIds>, callback: BodyResponseCallback<Schema$GeneratedIds>): void;
generateIds(params: Params$Resource$Files$Generateids, callback: BodyResponseCallback<Schema$GeneratedIds>): void;
generateIds(callback: BodyResponseCallback<Schema$GeneratedIds>): void;
/**
* drive.files.get
* @desc Gets a file's metadata by ID.
* @alias drive.files.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.acknowledgeAbuse Whether the user is acknowledging the risk of downloading known malware or other abusive files.
* @param {string} params.fileId The ID for the file in question.
* @param {string=} params.projection This parameter is deprecated and has no function.
* @param {string=} params.revisionId Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {boolean=} params.updateViewedDate Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Files$Get, options?: MethodOptions): GaxiosPromise<Schema$File>;
get(params: Params$Resource$Files$Get, options: MethodOptions | BodyResponseCallback<Schema$File>, callback: BodyResponseCallback<Schema$File>): void;
get(params: Params$Resource$Files$Get, callback: BodyResponseCallback<Schema$File>): void;
get(callback: BodyResponseCallback<Schema$File>): void;
/**
* drive.files.insert
* @desc Insert a new file.
* @alias drive.files.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.convert Whether to convert this file to the corresponding Google Docs format.
* @param {boolean=} params.ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
* @param {string=} params.ocrLanguage If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
* @param {boolean=} params.pinned Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {string=} params.timedTextLanguage The language of the timed text.
* @param {string=} params.timedTextTrackName The timed text track name.
* @param {boolean=} params.useContentAsIndexableText Whether to use the content as indexable text.
* @param {string=} params.visibility The visibility of the new file. This parameter is only relevant when convert=false.
* @param {object} params.resource Media resource metadata
* @param {object} params.media Media object
* @param {string} params.media.mimeType Media mime-type
* @param {string|object} params.media.body Media body contents
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Files$Insert, options?: MethodOptions): GaxiosPromise<Schema$File>;
insert(params: Params$Resource$Files$Insert, options: MethodOptions | BodyResponseCallback<Schema$File>, callback: BodyResponseCallback<Schema$File>): void;
insert(params: Params$Resource$Files$Insert, callback: BodyResponseCallback<Schema$File>): void;
insert(callback: BodyResponseCallback<Schema$File>): void;
/**
* drive.files.list
* @desc Lists the user's files.
* @alias drive.files.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.corpora Bodies of items (files/documents) to which the query applies. Supported bodies are 'default', 'domain', 'drive' and 'allDrives'. Prefer 'default' or 'drive' to 'allDrives' for efficiency.
* @param {string=} params.corpus The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.
* @param {string=} params.driveId ID of the shared drive to search.
* @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.
* @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead.
* @param {integer=} params.maxResults The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.
* @param {string=} params.orderBy A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
* @param {string=} params.pageToken Page token for files.
* @param {string=} params.projection This parameter is deprecated and has no function.
* @param {string=} params.q Query string for searching files.
* @param {string=} params.spaces A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {string=} params.teamDriveId Deprecated use driveId instead.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Files$List, options?: MethodOptions): GaxiosPromise<Schema$FileList>;
list(params: Params$Resource$Files$List, options: MethodOptions | BodyResponseCallback<Schema$FileList>, callback: BodyResponseCallback<Schema$FileList>): void;
list(params: Params$Resource$Files$List, callback: BodyResponseCallback<Schema$FileList>): void;
list(callback: BodyResponseCallback<Schema$FileList>): void;
/**
* drive.files.patch
* @desc Updates file metadata and/or content. This method supports patch semantics.
* @alias drive.files.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.addParents Comma-separated list of parent IDs to add.
* @param {boolean=} params.convert This parameter is deprecated and has no function.
* @param {string} params.fileId The ID of the file to update.
* @param {string=} params.modifiedDateBehavior Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
* @param {boolean=} params.newRevision Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.
* @param {boolean=} params.ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
* @param {string=} params.ocrLanguage If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
* @param {boolean=} params.pinned Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
* @param {string=} params.removeParents Comma-separated list of parent IDs to remove.
* @param {boolean=} params.setModifiedDate Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {string=} params.timedTextLanguage The language of the timed text.
* @param {string=} params.timedTextTrackName The timed text track name.
* @param {boolean=} params.updateViewedDate Whether to update the view date after successfully updating the file.
* @param {boolean=} params.useContentAsIndexableText Whether to use the content as indexable text.
* @param {().File} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Files$Patch, options?: MethodOptions): GaxiosPromise<Schema$File>;
patch(params: Params$Resource$Files$Patch, options: MethodOptions | BodyResponseCallback<Schema$File>, callback: BodyResponseCallback<Schema$File>): void;
patch(params: Params$Resource$Files$Patch, callback: BodyResponseCallback<Schema$File>): void;
patch(callback: BodyResponseCallback<Schema$File>): void;
/**
* drive.files.touch
* @desc Set the file's updated time to the current server time.
* @alias drive.files.touch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file to update.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
touch(params?: Params$Resource$Files$Touch, options?: MethodOptions): GaxiosPromise<Schema$File>;
touch(params: Params$Resource$Files$Touch, options: MethodOptions | BodyResponseCallback<Schema$File>, callback: BodyResponseCallback<Schema$File>): void;
touch(params: Params$Resource$Files$Touch, callback: BodyResponseCallback<Schema$File>): void;
touch(callback: BodyResponseCallback<Schema$File>): void;
/**
* drive.files.trash
* @desc Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files.
* @alias drive.files.trash
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file to trash.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
trash(params?: Params$Resource$Files$Trash, options?: MethodOptions): GaxiosPromise<Schema$File>;
trash(params: Params$Resource$Files$Trash, options: MethodOptions | BodyResponseCallback<Schema$File>, callback: BodyResponseCallback<Schema$File>): void;
trash(params: Params$Resource$Files$Trash, callback: BodyResponseCallback<Schema$File>): void;
trash(callback: BodyResponseCallback<Schema$File>): void;
/**
* drive.files.untrash
* @desc Restores a file from the trash.
* @alias drive.files.untrash
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file to untrash.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
untrash(params?: Params$Resource$Files$Untrash, options?: MethodOptions): GaxiosPromise<Schema$File>;
untrash(params: Params$Resource$Files$Untrash, options: MethodOptions | BodyResponseCallback<Schema$File>, callback: BodyResponseCallback<Schema$File>): void;
untrash(params: Params$Resource$Files$Untrash, callback: BodyResponseCallback<Schema$File>): void;
untrash(callback: BodyResponseCallback<Schema$File>): void;
/**
* drive.files.update
* @desc Updates file metadata and/or content.
* @alias drive.files.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.addParents Comma-separated list of parent IDs to add.
* @param {boolean=} params.convert This parameter is deprecated and has no function.
* @param {string} params.fileId The ID of the file to update.
* @param {string=} params.modifiedDateBehavior Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
* @param {boolean=} params.newRevision Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.
* @param {boolean=} params.ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
* @param {string=} params.ocrLanguage If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
* @param {boolean=} params.pinned Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
* @param {string=} params.removeParents Comma-separated list of parent IDs to remove.
* @param {boolean=} params.setModifiedDate Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {string=} params.timedTextLanguage The language of the timed text.
* @param {string=} params.timedTextTrackName The timed text track name.
* @param {boolean=} params.updateViewedDate Whether to update the view date after successfully updating the file.
* @param {boolean=} params.useContentAsIndexableText Whether to use the content as indexable text.
* @param {object} params.resource Media resource metadata
* @param {object} params.media Media object
* @param {string} params.media.mimeType Media mime-type
* @param {string|object} params.media.body Media body contents
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Files$Update, options?: MethodOptions): GaxiosPromise<Schema$File>;
update(params: Params$Resource$Files$Update, options: MethodOptions | BodyResponseCallback<Schema$File>, callback: BodyResponseCallback<Schema$File>): void;
update(params: Params$Resource$Files$Update, callback: BodyResponseCallback<Schema$File>): void;
update(callback: BodyResponseCallback<Schema$File>): void;
/**
* drive.files.watch
* @desc Subscribe to changes on a file
* @alias drive.files.watch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.acknowledgeAbuse Whether the user is acknowledging the risk of downloading known malware or other abusive files.
* @param {string} params.fileId The ID for the file in question.
* @param {string=} params.projection This parameter is deprecated and has no function.
* @param {string=} params.revisionId Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {boolean=} params.updateViewedDate Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
* @param {().Channel} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
watch(params?: Params$Resource$Files$Watch, options?: MethodOptions): GaxiosPromise<Schema$Channel>;
watch(params: Params$Resource$Files$Watch, options: MethodOptions | BodyResponseCallback<Schema$Channel>, callback: BodyResponseCallback<Schema$Channel>): void;
watch(params: Params$Resource$Files$Watch, callback: BodyResponseCallback<Schema$Channel>): void;
watch(callback: BodyResponseCallback<Schema$Channel>): void;
}
export interface Params$Resource$Files$Copy extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to convert this file to the corresponding Google Docs format.
*/
convert?: boolean;
/**
* The ID of the file to copy.
*/
fileId?: string;
/**
* Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
*/
ocr?: boolean;
/**
* If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
*/
ocrLanguage?: string;
/**
* Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions.
*/
pinned?: boolean;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* The language of the timed text.
*/
timedTextLanguage?: string;
/**
* The timed text track name.
*/
timedTextTrackName?: string;
/**
* The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false.
*/
visibility?: string;
/**
* Request body metadata
*/
requestBody?: Schema$File;
}
export interface Params$Resource$Files$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file to delete.
*/
fileId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
}
export interface Params$Resource$Files$Emptytrash extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
export interface Params$Resource$Files$Export extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* The MIME type of the format requested for this export.
*/
mimeType?: string;
}
export interface Params$Resource$Files$Generateids extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of IDs to return.
*/
maxResults?: number;
/**
* The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.
*/
space?: string;
}
export interface Params$Resource$Files$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether the user is acknowledging the risk of downloading known malware or other abusive files.
*/
acknowledgeAbuse?: boolean;
/**
* The ID for the file in question.
*/
fileId?: string;
/**
* This parameter is deprecated and has no function.
*/
projection?: string;
/**
* Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
*/
revisionId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
*/
updateViewedDate?: boolean;
}
export interface Params$Resource$Files$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to convert this file to the corresponding Google Docs format.
*/
convert?: boolean;
/**
* Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
*/
ocr?: boolean;
/**
* If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
*/
ocrLanguage?: string;
/**
* Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions.
*/
pinned?: boolean;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* The language of the timed text.
*/
timedTextLanguage?: string;
/**
* The timed text track name.
*/
timedTextTrackName?: string;
/**
* Whether to use the content as indexable text.
*/
useContentAsIndexableText?: boolean;
/**
* The visibility of the new file. This parameter is only relevant when convert=false.
*/
visibility?: string;
/**
* Request body metadata
*/
requestBody?: Schema$File;
/**
* Media metadata
*/
media?: {
/**
* Media mime-type
*/
mimeType?: string;
/**
* Media body contents
*/
body?: any;
};
}
export interface Params$Resource$Files$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Bodies of items (files/documents) to which the query applies. Supported bodies are 'default', 'domain', 'drive' and 'allDrives'. Prefer 'default' or 'drive' to 'allDrives' for efficiency.
*/
corpora?: string;
/**
* The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.
*/
corpus?: string;
/**
* ID of the shared drive to search.
*/
driveId?: string;
/**
* Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.
*/
includeItemsFromAllDrives?: boolean;
/**
* Deprecated use includeItemsFromAllDrives instead.
*/
includeTeamDriveItems?: boolean;
/**
* The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.
*/
maxResults?: number;
/**
* A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
*/
orderBy?: string;
/**
* Page token for files.
*/
pageToken?: string;
/**
* This parameter is deprecated and has no function.
*/
projection?: string;
/**
* Query string for searching files.
*/
q?: string;
/**
* A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
*/
spaces?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Deprecated use driveId instead.
*/
teamDriveId?: string;
}
export interface Params$Resource$Files$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Comma-separated list of parent IDs to add.
*/
addParents?: string;
/**
* This parameter is deprecated and has no function.
*/
convert?: boolean;
/**
* The ID of the file to update.
*/
fileId?: string;
/**
* Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
*/
modifiedDateBehavior?: string;
/**
* Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.
*/
newRevision?: boolean;
/**
* Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
*/
ocr?: boolean;
/**
* If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
*/
ocrLanguage?: string;
/**
* Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
*/
pinned?: boolean;
/**
* Comma-separated list of parent IDs to remove.
*/
removeParents?: string;
/**
* Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.
*/
setModifiedDate?: boolean;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* The language of the timed text.
*/
timedTextLanguage?: string;
/**
* The timed text track name.
*/
timedTextTrackName?: string;
/**
* Whether to update the view date after successfully updating the file.
*/
updateViewedDate?: boolean;
/**
* Whether to use the content as indexable text.
*/
useContentAsIndexableText?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$File;
}
export interface Params$Resource$Files$Touch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file to update.
*/
fileId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
}
export interface Params$Resource$Files$Trash extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file to trash.
*/
fileId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
}
export interface Params$Resource$Files$Untrash extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file to untrash.
*/
fileId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
}
export interface Params$Resource$Files$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Comma-separated list of parent IDs to add.
*/
addParents?: string;
/**
* This parameter is deprecated and has no function.
*/
convert?: boolean;
/**
* The ID of the file to update.
*/
fileId?: string;
/**
* Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
*/
modifiedDateBehavior?: string;
/**
* Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.
*/
newRevision?: boolean;
/**
* Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
*/
ocr?: boolean;
/**
* If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
*/
ocrLanguage?: string;
/**
* Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
*/
pinned?: boolean;
/**
* Comma-separated list of parent IDs to remove.
*/
removeParents?: string;
/**
* Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.
*/
setModifiedDate?: boolean;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* The language of the timed text.
*/
timedTextLanguage?: string;
/**
* The timed text track name.
*/
timedTextTrackName?: string;
/**
* Whether to update the view date after successfully updating the file.
*/
updateViewedDate?: boolean;
/**
* Whether to use the content as indexable text.
*/
useContentAsIndexableText?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$File;
/**
* Media metadata
*/
media?: {
/**
* Media mime-type
*/
mimeType?: string;
/**
* Media body contents
*/
body?: any;
};
}
export interface Params$Resource$Files$Watch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether the user is acknowledging the risk of downloading known malware or other abusive files.
*/
acknowledgeAbuse?: boolean;
/**
* The ID for the file in question.
*/
fileId?: string;
/**
* This parameter is deprecated and has no function.
*/
projection?: string;
/**
* Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
*/
revisionId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
*/
updateViewedDate?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Channel;
}
export class Resource$Parents {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.parents.delete
* @desc Removes a parent from a file.
* @alias drive.parents.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {string} params.parentId The ID of the parent.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Parents$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Parents$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Parents$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* drive.parents.get
* @desc Gets a specific parent reference.
* @alias drive.parents.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {string} params.parentId The ID of the parent.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Parents$Get, options?: MethodOptions): GaxiosPromise<Schema$ParentReference>;
get(params: Params$Resource$Parents$Get, options: MethodOptions | BodyResponseCallback<Schema$ParentReference>, callback: BodyResponseCallback<Schema$ParentReference>): void;
get(params: Params$Resource$Parents$Get, callback: BodyResponseCallback<Schema$ParentReference>): void;
get(callback: BodyResponseCallback<Schema$ParentReference>): void;
/**
* drive.parents.insert
* @desc Adds a parent folder for a file.
* @alias drive.parents.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {().ParentReference} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Parents$Insert, options?: MethodOptions): GaxiosPromise<Schema$ParentReference>;
insert(params: Params$Resource$Parents$Insert, options: MethodOptions | BodyResponseCallback<Schema$ParentReference>, callback: BodyResponseCallback<Schema$ParentReference>): void;
insert(params: Params$Resource$Parents$Insert, callback: BodyResponseCallback<Schema$ParentReference>): void;
insert(callback: BodyResponseCallback<Schema$ParentReference>): void;
/**
* drive.parents.list
* @desc Lists a file's parents.
* @alias drive.parents.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Parents$List, options?: MethodOptions): GaxiosPromise<Schema$ParentList>;
list(params: Params$Resource$Parents$List, options: MethodOptions | BodyResponseCallback<Schema$ParentList>, callback: BodyResponseCallback<Schema$ParentList>): void;
list(params: Params$Resource$Parents$List, callback: BodyResponseCallback<Schema$ParentList>): void;
list(callback: BodyResponseCallback<Schema$ParentList>): void;
}
export interface Params$Resource$Parents$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* The ID of the parent.
*/
parentId?: string;
}
export interface Params$Resource$Parents$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* The ID of the parent.
*/
parentId?: string;
}
export interface Params$Resource$Parents$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$ParentReference;
}
export interface Params$Resource$Parents$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
}
export class Resource$Permissions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.permissions.delete
* @desc Deletes a permission from a file or shared drive.
* @alias drive.permissions.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID for the file or shared drive.
* @param {string} params.permissionId The ID for the permission.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Permissions$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Permissions$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Permissions$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* drive.permissions.get
* @desc Gets a permission by ID.
* @alias drive.permissions.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID for the file or shared drive.
* @param {string} params.permissionId The ID for the permission.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Permissions$Get, options?: MethodOptions): GaxiosPromise<Schema$Permission>;
get(params: Params$Resource$Permissions$Get, options: MethodOptions | BodyResponseCallback<Schema$Permission>, callback: BodyResponseCallback<Schema$Permission>): void;
get(params: Params$Resource$Permissions$Get, callback: BodyResponseCallback<Schema$Permission>): void;
get(callback: BodyResponseCallback<Schema$Permission>): void;
/**
* drive.permissions.getIdForEmail
* @desc Returns the permission ID for an email address.
* @alias drive.permissions.getIdForEmail
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.email The email address for which to return a permission ID
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getIdForEmail(params?: Params$Resource$Permissions$Getidforemail, options?: MethodOptions): GaxiosPromise<Schema$PermissionId>;
getIdForEmail(params: Params$Resource$Permissions$Getidforemail, options: MethodOptions | BodyResponseCallback<Schema$PermissionId>, callback: BodyResponseCallback<Schema$PermissionId>): void;
getIdForEmail(params: Params$Resource$Permissions$Getidforemail, callback: BodyResponseCallback<Schema$PermissionId>): void;
getIdForEmail(callback: BodyResponseCallback<Schema$PermissionId>): void;
/**
* drive.permissions.insert
* @desc Inserts a permission for a file or shared drive.
* @alias drive.permissions.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.emailMessage A plain text custom message to include in notification emails.
* @param {string} params.fileId The ID for the file or shared drive.
* @param {boolean=} params.sendNotificationEmails Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
* @param {().Permission} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Permissions$Insert, options?: MethodOptions): GaxiosPromise<Schema$Permission>;
insert(params: Params$Resource$Permissions$Insert, options: MethodOptions | BodyResponseCallback<Schema$Permission>, callback: BodyResponseCallback<Schema$Permission>): void;
insert(params: Params$Resource$Permissions$Insert, callback: BodyResponseCallback<Schema$Permission>): void;
insert(callback: BodyResponseCallback<Schema$Permission>): void;
/**
* drive.permissions.list
* @desc Lists a file's or shared drive's permissions.
* @alias drive.permissions.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID for the file or shared drive.
* @param {integer=} params.maxResults The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.
* @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Permissions$List, options?: MethodOptions): GaxiosPromise<Schema$PermissionList>;
list(params: Params$Resource$Permissions$List, options: MethodOptions | BodyResponseCallback<Schema$PermissionList>, callback: BodyResponseCallback<Schema$PermissionList>): void;
list(params: Params$Resource$Permissions$List, callback: BodyResponseCallback<Schema$PermissionList>): void;
list(callback: BodyResponseCallback<Schema$PermissionList>): void;
/**
* drive.permissions.patch
* @desc Updates a permission using patch semantics.
* @alias drive.permissions.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID for the file or shared drive.
* @param {string} params.permissionId The ID for the permission.
* @param {boolean=} params.removeExpiration Whether to remove the expiration date.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {boolean=} params.transferOwnership Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.
* @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
* @param {().Permission} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Permissions$Patch, options?: MethodOptions): GaxiosPromise<Schema$Permission>;
patch(params: Params$Resource$Permissions$Patch, options: MethodOptions | BodyResponseCallback<Schema$Permission>, callback: BodyResponseCallback<Schema$Permission>): void;
patch(params: Params$Resource$Permissions$Patch, callback: BodyResponseCallback<Schema$Permission>): void;
patch(callback: BodyResponseCallback<Schema$Permission>): void;
/**
* drive.permissions.update
* @desc Updates a permission.
* @alias drive.permissions.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID for the file or shared drive.
* @param {string} params.permissionId The ID for the permission.
* @param {boolean=} params.removeExpiration Whether to remove the expiration date.
* @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
* @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead.
* @param {boolean=} params.transferOwnership Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.
* @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
* @param {().Permission} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Permissions$Update, options?: MethodOptions): GaxiosPromise<Schema$Permission>;
update(params: Params$Resource$Permissions$Update, options: MethodOptions | BodyResponseCallback<Schema$Permission>, callback: BodyResponseCallback<Schema$Permission>): void;
update(params: Params$Resource$Permissions$Update, callback: BodyResponseCallback<Schema$Permission>): void;
update(callback: BodyResponseCallback<Schema$Permission>): void;
}
export interface Params$Resource$Permissions$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID for the file or shared drive.
*/
fileId?: string;
/**
* The ID for the permission.
*/
permissionId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
*/
useDomainAdminAccess?: boolean;
}
export interface Params$Resource$Permissions$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID for the file or shared drive.
*/
fileId?: string;
/**
* The ID for the permission.
*/
permissionId?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
*/
useDomainAdminAccess?: boolean;
}
export interface Params$Resource$Permissions$Getidforemail extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The email address for which to return a permission ID
*/
email?: string;
}
export interface Params$Resource$Permissions$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* A plain text custom message to include in notification emails.
*/
emailMessage?: string;
/**
* The ID for the file or shared drive.
*/
fileId?: string;
/**
* Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner.
*/
sendNotificationEmails?: boolean;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
*/
useDomainAdminAccess?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Permission;
}
export interface Params$Resource$Permissions$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID for the file or shared drive.
*/
fileId?: string;
/**
* The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.
*/
maxResults?: number;
/**
* The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
*/
pageToken?: string;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
*/
useDomainAdminAccess?: boolean;
}
export interface Params$Resource$Permissions$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID for the file or shared drive.
*/
fileId?: string;
/**
* The ID for the permission.
*/
permissionId?: string;
/**
* Whether to remove the expiration date.
*/
removeExpiration?: boolean;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.
*/
transferOwnership?: boolean;
/**
* Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
*/
useDomainAdminAccess?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Permission;
}
export interface Params$Resource$Permissions$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID for the file or shared drive.
*/
fileId?: string;
/**
* The ID for the permission.
*/
permissionId?: string;
/**
* Whether to remove the expiration date.
*/
removeExpiration?: boolean;
/**
* Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
*/
supportsAllDrives?: boolean;
/**
* Deprecated use supportsAllDrives instead.
*/
supportsTeamDrives?: boolean;
/**
* Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.
*/
transferOwnership?: boolean;
/**
* Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
*/
useDomainAdminAccess?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Permission;
}
export class Resource$Properties {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.properties.delete
* @desc Deletes a property.
* @alias drive.properties.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {string} params.propertyKey The key of the property.
* @param {string=} params.visibility The visibility of the property.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Properties$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Properties$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Properties$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* drive.properties.get
* @desc Gets a property by its key.
* @alias drive.properties.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {string} params.propertyKey The key of the property.
* @param {string=} params.visibility The visibility of the property.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Properties$Get, options?: MethodOptions): GaxiosPromise<Schema$Property>;
get(params: Params$Resource$Properties$Get, options: MethodOptions | BodyResponseCallback<Schema$Property>, callback: BodyResponseCallback<Schema$Property>): void;
get(params: Params$Resource$Properties$Get, callback: BodyResponseCallback<Schema$Property>): void;
get(callback: BodyResponseCallback<Schema$Property>): void;
/**
* drive.properties.insert
* @desc Adds a property to a file, or updates it if it already exists.
* @alias drive.properties.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {().Property} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Properties$Insert, options?: MethodOptions): GaxiosPromise<Schema$Property>;
insert(params: Params$Resource$Properties$Insert, options: MethodOptions | BodyResponseCallback<Schema$Property>, callback: BodyResponseCallback<Schema$Property>): void;
insert(params: Params$Resource$Properties$Insert, callback: BodyResponseCallback<Schema$Property>): void;
insert(callback: BodyResponseCallback<Schema$Property>): void;
/**
* drive.properties.list
* @desc Lists a file's properties.
* @alias drive.properties.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Properties$List, options?: MethodOptions): GaxiosPromise<Schema$PropertyList>;
list(params: Params$Resource$Properties$List, options: MethodOptions | BodyResponseCallback<Schema$PropertyList>, callback: BodyResponseCallback<Schema$PropertyList>): void;
list(params: Params$Resource$Properties$List, callback: BodyResponseCallback<Schema$PropertyList>): void;
list(callback: BodyResponseCallback<Schema$PropertyList>): void;
/**
* drive.properties.patch
* @desc Updates a property.
* @alias drive.properties.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {string} params.propertyKey The key of the property.
* @param {string=} params.visibility The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
* @param {().Property} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Properties$Patch, options?: MethodOptions): GaxiosPromise<Schema$Property>;
patch(params: Params$Resource$Properties$Patch, options: MethodOptions | BodyResponseCallback<Schema$Property>, callback: BodyResponseCallback<Schema$Property>): void;
patch(params: Params$Resource$Properties$Patch, callback: BodyResponseCallback<Schema$Property>): void;
patch(callback: BodyResponseCallback<Schema$Property>): void;
/**
* drive.properties.update
* @desc Updates a property.
* @alias drive.properties.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {string} params.propertyKey The key of the property.
* @param {string=} params.visibility The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
* @param {().Property} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Properties$Update, options?: MethodOptions): GaxiosPromise<Schema$Property>;
update(params: Params$Resource$Properties$Update, options: MethodOptions | BodyResponseCallback<Schema$Property>, callback: BodyResponseCallback<Schema$Property>): void;
update(params: Params$Resource$Properties$Update, callback: BodyResponseCallback<Schema$Property>): void;
update(callback: BodyResponseCallback<Schema$Property>): void;
}
export interface Params$Resource$Properties$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* The key of the property.
*/
propertyKey?: string;
/**
* The visibility of the property.
*/
visibility?: string;
}
export interface Params$Resource$Properties$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* The key of the property.
*/
propertyKey?: string;
/**
* The visibility of the property.
*/
visibility?: string;
}
export interface Params$Resource$Properties$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Property;
}
export interface Params$Resource$Properties$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
}
export interface Params$Resource$Properties$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* The key of the property.
*/
propertyKey?: string;
/**
* The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
*/
visibility?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Property;
}
export interface Params$Resource$Properties$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* The key of the property.
*/
propertyKey?: string;
/**
* The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
*/
visibility?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Property;
}
export class Resource$Realtime {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.realtime.get
* @desc Exports the contents of the Realtime API data model associated with this file as JSON.
* @alias drive.realtime.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file that the Realtime API data model is associated with.
* @param {integer=} params.revision The revision of the Realtime API data model to export. Revisions start at 1 (the initial empty data model) and are incremented with each change. If this parameter is excluded, the most recent data model will be returned.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Realtime$Get, options?: MethodOptions): GaxiosPromise<void>;
get(params: Params$Resource$Realtime$Get, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
get(params: Params$Resource$Realtime$Get, callback: BodyResponseCallback<void>): void;
get(callback: BodyResponseCallback<void>): void;
/**
* drive.realtime.update
* @desc Overwrites the Realtime API data model associated with this file with the provided JSON data model.
* @alias drive.realtime.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.baseRevision The revision of the model to diff the uploaded model against. If set, the uploaded model is diffed against the provided revision and those differences are merged with any changes made to the model after the provided revision. If not set, the uploaded model replaces the current model on the server.
* @param {string} params.fileId The ID of the file that the Realtime API data model is associated with.
* @param {object} params.media Media object
* @param {string} params.media.mimeType Media mime-type
* @param {string|object} params.media.body Media body contents
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Realtime$Update, options?: MethodOptions): GaxiosPromise<void>;
update(params: Params$Resource$Realtime$Update, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
update(params: Params$Resource$Realtime$Update, callback: BodyResponseCallback<void>): void;
update(callback: BodyResponseCallback<void>): void;
}
export interface Params$Resource$Realtime$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file that the Realtime API data model is associated with.
*/
fileId?: string;
/**
* The revision of the Realtime API data model to export. Revisions start at 1 (the initial empty data model) and are incremented with each change. If this parameter is excluded, the most recent data model will be returned.
*/
revision?: number;
}
export interface Params$Resource$Realtime$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The revision of the model to diff the uploaded model against. If set, the uploaded model is diffed against the provided revision and those differences are merged with any changes made to the model after the provided revision. If not set, the uploaded model replaces the current model on the server.
*/
baseRevision?: string;
/**
* The ID of the file that the Realtime API data model is associated with.
*/
fileId?: string;
/**
* Media metadata
*/
media?: {
/**
* Media mime-type
*/
mimeType?: string;
/**
* Media body contents
*/
body?: any;
};
}
export class Resource$Replies {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.replies.delete
* @desc Deletes a reply.
* @alias drive.replies.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {string} params.replyId The ID of the reply.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Replies$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Replies$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Replies$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* drive.replies.get
* @desc Gets a reply.
* @alias drive.replies.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.includeDeleted If set, this will succeed when retrieving a deleted reply.
* @param {string} params.replyId The ID of the reply.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Replies$Get, options?: MethodOptions): GaxiosPromise<Schema$CommentReply>;
get(params: Params$Resource$Replies$Get, options: MethodOptions | BodyResponseCallback<Schema$CommentReply>, callback: BodyResponseCallback<Schema$CommentReply>): void;
get(params: Params$Resource$Replies$Get, callback: BodyResponseCallback<Schema$CommentReply>): void;
get(callback: BodyResponseCallback<Schema$CommentReply>): void;
/**
* drive.replies.insert
* @desc Creates a new reply to the given comment.
* @alias drive.replies.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {().CommentReply} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Replies$Insert, options?: MethodOptions): GaxiosPromise<Schema$CommentReply>;
insert(params: Params$Resource$Replies$Insert, options: MethodOptions | BodyResponseCallback<Schema$CommentReply>, callback: BodyResponseCallback<Schema$CommentReply>): void;
insert(params: Params$Resource$Replies$Insert, callback: BodyResponseCallback<Schema$CommentReply>): void;
insert(callback: BodyResponseCallback<Schema$CommentReply>): void;
/**
* drive.replies.list
* @desc Lists all of the replies to a comment.
* @alias drive.replies.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.includeDeleted If set, all replies, including deleted replies (with content stripped) will be returned.
* @param {integer=} params.maxResults The maximum number of replies to include in the response, used for paging.
* @param {string=} params.pageToken The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Replies$List, options?: MethodOptions): GaxiosPromise<Schema$CommentReplyList>;
list(params: Params$Resource$Replies$List, options: MethodOptions | BodyResponseCallback<Schema$CommentReplyList>, callback: BodyResponseCallback<Schema$CommentReplyList>): void;
list(params: Params$Resource$Replies$List, callback: BodyResponseCallback<Schema$CommentReplyList>): void;
list(callback: BodyResponseCallback<Schema$CommentReplyList>): void;
/**
* drive.replies.patch
* @desc Updates an existing reply.
* @alias drive.replies.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {string} params.replyId The ID of the reply.
* @param {().CommentReply} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Replies$Patch, options?: MethodOptions): GaxiosPromise<Schema$CommentReply>;
patch(params: Params$Resource$Replies$Patch, options: MethodOptions | BodyResponseCallback<Schema$CommentReply>, callback: BodyResponseCallback<Schema$CommentReply>): void;
patch(params: Params$Resource$Replies$Patch, callback: BodyResponseCallback<Schema$CommentReply>): void;
patch(callback: BodyResponseCallback<Schema$CommentReply>): void;
/**
* drive.replies.update
* @desc Updates an existing reply.
* @alias drive.replies.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {string} params.replyId The ID of the reply.
* @param {().CommentReply} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Replies$Update, options?: MethodOptions): GaxiosPromise<Schema$CommentReply>;
update(params: Params$Resource$Replies$Update, options: MethodOptions | BodyResponseCallback<Schema$CommentReply>, callback: BodyResponseCallback<Schema$CommentReply>): void;
update(params: Params$Resource$Replies$Update, callback: BodyResponseCallback<Schema$CommentReply>): void;
update(callback: BodyResponseCallback<Schema$CommentReply>): void;
}
export interface Params$Resource$Replies$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the comment.
*/
commentId?: string;
/**
* The ID of the file.
*/
fileId?: string;
/**
* The ID of the reply.
*/
replyId?: string;
}
export interface Params$Resource$Replies$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the comment.
*/
commentId?: string;
/**
* The ID of the file.
*/
fileId?: string;
/**
* If set, this will succeed when retrieving a deleted reply.
*/
includeDeleted?: boolean;
/**
* The ID of the reply.
*/
replyId?: string;
}
export interface Params$Resource$Replies$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the comment.
*/
commentId?: string;
/**
* The ID of the file.
*/
fileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CommentReply;
}
export interface Params$Resource$Replies$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the comment.
*/
commentId?: string;
/**
* The ID of the file.
*/
fileId?: string;
/**
* If set, all replies, including deleted replies (with content stripped) will be returned.
*/
includeDeleted?: boolean;
/**
* The maximum number of replies to include in the response, used for paging.
*/
maxResults?: number;
/**
* The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
export interface Params$Resource$Replies$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the comment.
*/
commentId?: string;
/**
* The ID of the file.
*/
fileId?: string;
/**
* The ID of the reply.
*/
replyId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CommentReply;
}
export interface Params$Resource$Replies$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the comment.
*/
commentId?: string;
/**
* The ID of the file.
*/
fileId?: string;
/**
* The ID of the reply.
*/
replyId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CommentReply;
}
export class Resource$Revisions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.revisions.delete
* @desc Permanently deletes a file version. You can only delete revisions for files with binary content, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.
* @alias drive.revisions.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {string} params.revisionId The ID of the revision.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Revisions$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Revisions$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Revisions$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* drive.revisions.get
* @desc Gets a specific revision.
* @alias drive.revisions.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {string} params.revisionId The ID of the revision.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Revisions$Get, options?: MethodOptions): GaxiosPromise<Schema$Revision>;
get(params: Params$Resource$Revisions$Get, options: MethodOptions | BodyResponseCallback<Schema$Revision>, callback: BodyResponseCallback<Schema$Revision>): void;
get(params: Params$Resource$Revisions$Get, callback: BodyResponseCallback<Schema$Revision>): void;
get(callback: BodyResponseCallback<Schema$Revision>): void;
/**
* drive.revisions.list
* @desc Lists a file's revisions.
* @alias drive.revisions.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {integer=} params.maxResults Maximum number of revisions to return.
* @param {string=} params.pageToken Page token for revisions. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Revisions$List, options?: MethodOptions): GaxiosPromise<Schema$RevisionList>;
list(params: Params$Resource$Revisions$List, options: MethodOptions | BodyResponseCallback<Schema$RevisionList>, callback: BodyResponseCallback<Schema$RevisionList>): void;
list(params: Params$Resource$Revisions$List, callback: BodyResponseCallback<Schema$RevisionList>): void;
list(callback: BodyResponseCallback<Schema$RevisionList>): void;
/**
* drive.revisions.patch
* @desc Updates a revision.
* @alias drive.revisions.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID for the file.
* @param {string} params.revisionId The ID for the revision.
* @param {().Revision} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Revisions$Patch, options?: MethodOptions): GaxiosPromise<Schema$Revision>;
patch(params: Params$Resource$Revisions$Patch, options: MethodOptions | BodyResponseCallback<Schema$Revision>, callback: BodyResponseCallback<Schema$Revision>): void;
patch(params: Params$Resource$Revisions$Patch, callback: BodyResponseCallback<Schema$Revision>): void;
patch(callback: BodyResponseCallback<Schema$Revision>): void;
/**
* drive.revisions.update
* @desc Updates a revision.
* @alias drive.revisions.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID for the file.
* @param {string} params.revisionId The ID for the revision.
* @param {().Revision} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Revisions$Update, options?: MethodOptions): GaxiosPromise<Schema$Revision>;
update(params: Params$Resource$Revisions$Update, options: MethodOptions | BodyResponseCallback<Schema$Revision>, callback: BodyResponseCallback<Schema$Revision>): void;
update(params: Params$Resource$Revisions$Update, callback: BodyResponseCallback<Schema$Revision>): void;
update(callback: BodyResponseCallback<Schema$Revision>): void;
}
export interface Params$Resource$Revisions$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* The ID of the revision.
*/
revisionId?: string;
}
export interface Params$Resource$Revisions$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* The ID of the revision.
*/
revisionId?: string;
}
export interface Params$Resource$Revisions$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the file.
*/
fileId?: string;
/**
* Maximum number of revisions to return.
*/
maxResults?: number;
/**
* Page token for revisions. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
export interface Params$Resource$Revisions$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID for the file.
*/
fileId?: string;
/**
* The ID for the revision.
*/
revisionId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Revision;
}
export interface Params$Resource$Revisions$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID for the file.
*/
fileId?: string;
/**
* The ID for the revision.
*/
revisionId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Revision;
}
export class Resource$Teamdrives {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* drive.teamdrives.delete
* @desc Deprecated use drives.delete instead.
* @alias drive.teamdrives.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.teamDriveId The ID of the Team Drive
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Teamdrives$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Teamdrives$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Teamdrives$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* drive.teamdrives.get
* @desc Deprecated use drives.get instead.
* @alias drive.teamdrives.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.teamDriveId The ID of the Team Drive
* @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Teamdrives$Get, options?: MethodOptions): GaxiosPromise<Schema$TeamDrive>;
get(params: Params$Resource$Teamdrives$Get, options: MethodOptions | BodyResponseCallback<Schema$TeamDrive>, callback: BodyResponseCallback<Schema$TeamDrive>): void;
get(params: Params$Resource$Teamdrives$Get, callback: BodyResponseCallback<Schema$TeamDrive>): void;
get(callback: BodyResponseCallback<Schema$TeamDrive>): void;
/**
* drive.teamdrives.insert
* @desc Deprecated use drives.insert instead.
* @alias drive.teamdrives.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.requestId An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.
* @param {().TeamDrive} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Teamdrives$Insert, options?: MethodOptions): GaxiosPromise<Schema$TeamDrive>;
insert(params: Params$Resource$Teamdrives$Insert, options: MethodOptions | BodyResponseCallback<Schema$TeamDrive>, callback: BodyResponseCallback<Schema$TeamDrive>): void;
insert(params: Params$Resource$Teamdrives$Insert, callback: BodyResponseCallback<Schema$TeamDrive>): void;
insert(callback: BodyResponseCallback<Schema$TeamDrive>): void;
/**
* drive.teamdrives.list
* @desc Deprecated use drives.list instead.
* @alias drive.teamdrives.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {integer=} params.maxResults Maximum number of Team Drives to return.
* @param {string=} params.pageToken Page token for Team Drives.
* @param {string=} params.q Query string for searching Team Drives.
* @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Teamdrives$List, options?: MethodOptions): GaxiosPromise<Schema$TeamDriveList>;
list(params: Params$Resource$Teamdrives$List, options: MethodOptions | BodyResponseCallback<Schema$TeamDriveList>, callback: BodyResponseCallback<Schema$TeamDriveList>): void;
list(params: Params$Resource$Teamdrives$List, callback: BodyResponseCallback<Schema$TeamDriveList>): void;
list(callback: BodyResponseCallback<Schema$TeamDriveList>): void;
/**
* drive.teamdrives.update
* @desc Deprecated use drives.update instead.
* @alias drive.teamdrives.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.teamDriveId The ID of the Team Drive
* @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.
* @param {().TeamDrive} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Teamdrives$Update, options?: MethodOptions): GaxiosPromise<Schema$TeamDrive>;
update(params: Params$Resource$Teamdrives$Update, options: MethodOptions | BodyResponseCallback<Schema$TeamDrive>, callback: BodyResponseCallback<Schema$TeamDrive>): void;
update(params: Params$Resource$Teamdrives$Update, callback: BodyResponseCallback<Schema$TeamDrive>): void;
update(callback: BodyResponseCallback<Schema$TeamDrive>): void;
}
export interface Params$Resource$Teamdrives$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the Team Drive
*/
teamDriveId?: string;
}
export interface Params$Resource$Teamdrives$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the Team Drive
*/
teamDriveId?: string;
/**
* Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.
*/
useDomainAdminAccess?: boolean;
}
export interface Params$Resource$Teamdrives$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.
*/
requestId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TeamDrive;
}
export interface Params$Resource$Teamdrives$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of Team Drives to return.
*/
maxResults?: number;
/**
* Page token for Team Drives.
*/
pageToken?: string;
/**
* Query string for searching Team Drives.
*/
q?: string;
/**
* Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.
*/
useDomainAdminAccess?: boolean;
}
export interface Params$Resource$Teamdrives$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the Team Drive
*/
teamDriveId?: string;
/**
* Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.
*/
useDomainAdminAccess?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$TeamDrive;
}
export {};
}