v3.d.ts
164 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
/**
* 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 calendar_v3 {
export interface Options extends GlobalOptions {
version: 'v3';
}
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;
}
/**
* Calendar API
*
* Manipulates events and other calendar data.
*
* @example
* const {google} = require('googleapis');
* const calendar = google.calendar('v3');
*
* @namespace calendar
* @type {Function}
* @version v3
* @variation v3
* @param {object=} options Options for Calendar
*/
export class Calendar {
context: APIRequestContext;
acl: Resource$Acl;
calendarList: Resource$Calendarlist;
calendars: Resource$Calendars;
channels: Resource$Channels;
colors: Resource$Colors;
events: Resource$Events;
freebusy: Resource$Freebusy;
settings: Resource$Settings;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
export interface Schema$Acl {
/**
* ETag of the collection.
*/
etag?: string | null;
/**
* List of rules on the access control list.
*/
items?: Schema$AclRule[];
/**
* Type of the collection ("calendar#acl").
*/
kind?: string | null;
/**
* Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
*/
nextPageToken?: string | null;
/**
* Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
*/
nextSyncToken?: string | null;
}
export interface Schema$AclRule {
/**
* ETag of the resource.
*/
etag?: string | null;
/**
* Identifier of the ACL rule.
*/
id?: string | null;
/**
* Type of the resource ("calendar#aclRule").
*/
kind?: string | null;
/**
* The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
*/
role?: string | null;
/**
* The scope of the rule.
*/
scope?: {
type?: string;
value?: string;
} | null;
}
export interface Schema$Calendar {
/**
* Conferencing properties for this calendar, for example what types of conferences are allowed.
*/
conferenceProperties?: Schema$ConferenceProperties;
/**
* Description of the calendar. Optional.
*/
description?: string | null;
/**
* ETag of the resource.
*/
etag?: string | null;
/**
* Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
*/
id?: string | null;
/**
* Type of the resource ("calendar#calendar").
*/
kind?: string | null;
/**
* Geographic location of the calendar as free-form text. Optional.
*/
location?: string | null;
/**
* Title of the calendar.
*/
summary?: string | null;
/**
* The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
*/
timeZone?: string | null;
}
export interface Schema$CalendarList {
/**
* ETag of the collection.
*/
etag?: string | null;
/**
* Calendars that are present on the user's calendar list.
*/
items?: Schema$CalendarListEntry[];
/**
* Type of the collection ("calendar#calendarList").
*/
kind?: string | null;
/**
* Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
*/
nextPageToken?: string | null;
/**
* Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
*/
nextSyncToken?: string | null;
}
export interface Schema$CalendarListEntry {
/**
* The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
*/
accessRole?: string | null;
/**
* The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
*/
backgroundColor?: string | null;
/**
* The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
*/
colorId?: string | null;
/**
* Conferencing properties for this calendar, for example what types of conferences are allowed.
*/
conferenceProperties?: Schema$ConferenceProperties;
/**
* The default reminders that the authenticated user has for this calendar.
*/
defaultReminders?: Schema$EventReminder[];
/**
* Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
*/
deleted?: boolean | null;
/**
* Description of the calendar. Optional. Read-only.
*/
description?: string | null;
/**
* ETag of the resource.
*/
etag?: string | null;
/**
* The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
*/
foregroundColor?: string | null;
/**
* Whether the calendar has been hidden from the list. Optional. The default is False.
*/
hidden?: boolean | null;
/**
* Identifier of the calendar.
*/
id?: string | null;
/**
* Type of the resource ("calendar#calendarListEntry").
*/
kind?: string | null;
/**
* Geographic location of the calendar as free-form text. Optional. Read-only.
*/
location?: string | null;
/**
* The notifications that the authenticated user is receiving for this calendar.
*/
notificationSettings?: {
notifications?: Schema$CalendarNotification[];
} | null;
/**
* Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
*/
primary?: boolean | null;
/**
* Whether the calendar content shows up in the calendar UI. Optional. The default is False.
*/
selected?: boolean | null;
/**
* Title of the calendar. Read-only.
*/
summary?: string | null;
/**
* The summary that the authenticated user has set for this calendar. Optional.
*/
summaryOverride?: string | null;
/**
* The time zone of the calendar. Optional. Read-only.
*/
timeZone?: string | null;
}
export interface Schema$CalendarNotification {
/**
* The method used to deliver the notification. Possible values are: - "email" - Notifications are sent via email. - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See Google Calendar SMS notifications to be removed for more information. Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers. Required when adding a notification.
*/
method?: string | null;
/**
* The type of notification. Possible values are: - "eventCreation" - Notification sent when a new event is put on the calendar. - "eventChange" - Notification sent when an event is changed. - "eventCancellation" - Notification sent when an event is cancelled. - "eventResponse" - Notification sent when an attendee responds to the event invitation. - "agenda" - An agenda with the events of the day (sent out in the morning). Required when adding a notification.
*/
type?: string | null;
}
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;
}
export interface Schema$ColorDefinition {
/**
* The background color associated with this color definition.
*/
background?: string | null;
/**
* The foreground color that can be used to write on top of a background with 'background' color.
*/
foreground?: string | null;
}
export interface Schema$Colors {
/**
* A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its color field. Read-only.
*/
calendar?: {
[key: string]: Schema$ColorDefinition;
} | null;
/**
* A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its color field. Read-only.
*/
event?: {
[key: string]: Schema$ColorDefinition;
} | null;
/**
* Type of the resource ("calendar#colors").
*/
kind?: string | null;
/**
* Last modification time of the color palette (as a RFC3339 timestamp). Read-only.
*/
updated?: string | null;
}
export interface Schema$ConferenceData {
/**
* The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. Values for solution types: - "eventHangout": unset. - "eventNamedHangout": the name of the Hangout. - "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". - "addOn": defined by 3P conference provider. Optional.
*/
conferenceId?: string | null;
/**
* The conference solution, such as Hangouts or Hangouts Meet. Unset for a conference with a failed create request. Either conferenceSolution and at least one entryPoint, or createRequest is required.
*/
conferenceSolution?: Schema$ConferenceSolution;
/**
* A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. Either conferenceSolution and at least one entryPoint, or createRequest is required.
*/
createRequest?: Schema$CreateConferenceRequest;
/**
* Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. Either conferenceSolution and at least one entryPoint, or createRequest is required.
*/
entryPoints?: Schema$EntryPoint[];
/**
* Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
*/
notes?: string | null;
/**
* Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
*/
parameters?: Schema$ConferenceParameters;
/**
* The signature of the conference data. Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. Unset for a conference with a failed create request. Optional for a conference with a pending create request.
*/
signature?: string | null;
}
export interface Schema$ConferenceParameters {
/**
* Additional add-on specific data.
*/
addOnParameters?: Schema$ConferenceParametersAddOnParameters;
}
export interface Schema$ConferenceParametersAddOnParameters {
parameters?: {
[key: string]: string;
} | null;
}
export interface Schema$ConferenceProperties {
/**
* The types of conference solutions that are supported for this calendar. The possible values are: - "eventHangout" - "eventNamedHangout" - "hangoutsMeet" Optional.
*/
allowedConferenceSolutionTypes?: string[] | null;
}
export interface Schema$ConferenceRequestStatus {
/**
* The current status of the conference create request. Read-only. The possible values are: - "pending": the conference create request is still being processed. - "success": the conference create request succeeded, the entry points are populated. - "failure": the conference create request failed, there are no entry points.
*/
statusCode?: string | null;
}
export interface Schema$ConferenceSolution {
/**
* The user-visible icon for this solution.
*/
iconUri?: string | null;
/**
* The key which can uniquely identify the conference solution for this event.
*/
key?: Schema$ConferenceSolutionKey;
/**
* The user-visible name of this solution. Not localized.
*/
name?: string | null;
}
export interface Schema$ConferenceSolutionKey {
/**
* The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are: - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) - "addOn" for 3P conference providers
*/
type?: string | null;
}
export interface Schema$CreateConferenceRequest {
/**
* The conference solution, such as Hangouts or Hangouts Meet.
*/
conferenceSolutionKey?: Schema$ConferenceSolutionKey;
/**
* The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.
*/
requestId?: string | null;
/**
* The status of the conference create request.
*/
status?: Schema$ConferenceRequestStatus;
}
export interface Schema$EntryPoint {
/**
* The access code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional.
*/
accessCode?: string | null;
/**
* Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
*/
entryPointFeatures?: string[] | null;
/**
* The type of the conference entry point. Possible values are: - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.
*/
entryPointType?: string | null;
/**
* The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. Examples: - for video: meet.google.com/aaa-bbbb-ccc - for phone: +1 123 268 2601 - for sip: 12345678@altostrat.com - for more: should not be filled Optional.
*/
label?: string | null;
/**
* The meeting code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional.
*/
meetingCode?: string | null;
/**
* The passcode to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
*/
passcode?: string | null;
/**
* The password to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional.
*/
password?: string | null;
/**
* The PIN to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional.
*/
pin?: string | null;
/**
* The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. Calendar backend will populate this field only for EntryPointType.PHONE.
*/
regionCode?: string | null;
/**
* The URI of the entry point. The maximum length is 1300 characters. Format: - for video, http: or https: schema is required. - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. - for more, http: or https: schema is required.
*/
uri?: string | null;
}
export interface Schema$Error {
/**
* Domain, or broad category, of the error.
*/
domain?: string | null;
/**
* Specific reason for the error. Some of the possible values are: - "groupTooBig" - The group of users requested is too large for a single query. - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query. - "notFound" - The requested resource was not found. - "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.
*/
reason?: string | null;
}
export interface Schema$Event {
/**
* Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
*/
anyoneCanAddSelf?: boolean | null;
/**
* File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,
*/
attachments?: Schema$EventAttachment[];
/**
* The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
*/
attendees?: Schema$EventAttendee[];
/**
* Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
*/
attendeesOmitted?: boolean | null;
/**
* The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
*/
colorId?: string | null;
/**
* The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
*/
conferenceData?: Schema$ConferenceData;
/**
* Creation time of the event (as a RFC3339 timestamp). Read-only.
*/
created?: string | null;
/**
* The creator of the event. Read-only.
*/
creator?: {
displayName?: string;
email?: string;
id?: string;
self?: boolean;
} | null;
/**
* Description of the event. Optional.
*/
description?: string | null;
/**
* The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
*/
end?: Schema$EventDateTime;
/**
* Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
*/
endTimeUnspecified?: boolean | null;
/**
* ETag of the resource.
*/
etag?: string | null;
/**
* Extended properties of the event.
*/
extendedProperties?: {
private?: {
[key: string]: string;
};
shared?: {
[key: string]: string;
};
} | null;
/**
* A gadget that extends this event.
*/
gadget?: {
display?: string;
height?: number;
iconLink?: string;
link?: string;
preferences?: {
[key: string]: string;
};
title?: string;
type?: string;
width?: number;
} | null;
/**
* Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
*/
guestsCanInviteOthers?: boolean | null;
/**
* Whether attendees other than the organizer can modify the event. Optional. The default is False.
*/
guestsCanModify?: boolean | null;
/**
* Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
*/
guestsCanSeeOtherGuests?: boolean | null;
/**
* An absolute link to the Google+ hangout associated with this event. Read-only.
*/
hangoutLink?: string | null;
/**
* An absolute link to this event in the Google Calendar Web UI. Read-only.
*/
htmlLink?: string | null;
/**
* Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
*/
iCalUID?: string | null;
/**
* Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 - the length of the ID must be between 5 and 1024 characters - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
*/
id?: string | null;
/**
* Type of the resource ("calendar#event").
*/
kind?: string | null;
/**
* Geographic location of the event as free-form text. Optional.
*/
location?: string | null;
/**
* Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
*/
locked?: boolean | null;
/**
* The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.
*/
organizer?: {
displayName?: string;
email?: string;
id?: string;
self?: boolean;
} | null;
/**
* For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
*/
originalStartTime?: Schema$EventDateTime;
/**
* If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.
*/
privateCopy?: boolean | null;
/**
* List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.
*/
recurrence?: string[] | null;
/**
* For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
*/
recurringEventId?: string | null;
/**
* Information about the event's reminders for the authenticated user.
*/
reminders?: {
overrides?: Schema$EventReminder[];
useDefault?: boolean;
} | null;
/**
* Sequence number as per iCalendar.
*/
sequence?: number | null;
/**
* Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
*/
source?: {
title?: string;
url?: string;
} | null;
/**
* The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
*/
start?: Schema$EventDateTime;
/**
* Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type: - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.
*/
status?: string | null;
/**
* Title of the event.
*/
summary?: string | null;
/**
* Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
*/
transparency?: string | null;
/**
* Last modification time of the event (as a RFC3339 timestamp). Read-only.
*/
updated?: string | null;
/**
* Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.
*/
visibility?: string | null;
}
export interface Schema$EventAttachment {
/**
* ID of the attached file. Read-only. For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.
*/
fileId?: string | null;
/**
* URL link to the attachment. For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. Required when adding an attachment.
*/
fileUrl?: string | null;
/**
* URL link to the attachment's icon. Read-only.
*/
iconLink?: string | null;
/**
* Internet media type (MIME type) of the attachment.
*/
mimeType?: string | null;
/**
* Attachment title.
*/
title?: string | null;
}
export interface Schema$EventAttendee {
/**
* Number of additional guests. Optional. The default is 0.
*/
additionalGuests?: number | null;
/**
* The attendee's response comment. Optional.
*/
comment?: string | null;
/**
* The attendee's name, if available. Optional.
*/
displayName?: string | null;
/**
* The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. Required when adding an attendee.
*/
email?: string | null;
/**
* The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
*/
id?: string | null;
/**
* Whether this is an optional attendee. Optional. The default is False.
*/
optional?: boolean | null;
/**
* Whether the attendee is the organizer of the event. Read-only. The default is False.
*/
organizer?: boolean | null;
/**
* Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False.
*/
resource?: boolean | null;
/**
* The attendee's response status. Possible values are: - "needsAction" - The attendee has not responded to the invitation. - "declined" - The attendee has declined the invitation. - "tentative" - The attendee has tentatively accepted the invitation. - "accepted" - The attendee has accepted the invitation.
*/
responseStatus?: string | null;
/**
* Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
*/
self?: boolean | null;
}
export interface Schema$EventDateTime {
/**
* The date, in the format "yyyy-mm-dd", if this is an all-day event.
*/
date?: string | null;
/**
* The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone.
*/
dateTime?: string | null;
/**
* The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end.
*/
timeZone?: string | null;
}
export interface Schema$EventReminder {
/**
* The method used by this reminder. Possible values are: - "email" - Reminders are sent via email. - "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. - "popup" - Reminders are sent via a UI popup. Required when adding a reminder.
*/
method?: string | null;
/**
* Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). Required when adding a reminder.
*/
minutes?: number | null;
}
export interface Schema$Events {
/**
* The user's access role for this calendar. Read-only. Possible values are: - "none" - The user has no access. - "freeBusyReader" - The user has read access to free/busy information. - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
*/
accessRole?: string | null;
/**
* The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).
*/
defaultReminders?: Schema$EventReminder[];
/**
* Description of the calendar. Read-only.
*/
description?: string | null;
/**
* ETag of the collection.
*/
etag?: string | null;
/**
* List of events on the calendar.
*/
items?: Schema$Event[];
/**
* Type of the collection ("calendar#events").
*/
kind?: string | null;
/**
* Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
*/
nextPageToken?: string | null;
/**
* Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
*/
nextSyncToken?: string | null;
/**
* Title of the calendar. Read-only.
*/
summary?: string | null;
/**
* The time zone of the calendar. Read-only.
*/
timeZone?: string | null;
/**
* Last modification time of the calendar (as a RFC3339 timestamp). Read-only.
*/
updated?: string | null;
}
export interface Schema$FreeBusyCalendar {
/**
* List of time ranges during which this calendar should be regarded as busy.
*/
busy?: Schema$TimePeriod[];
/**
* Optional error(s) (if computation for the calendar failed).
*/
errors?: Schema$Error[];
}
export interface Schema$FreeBusyGroup {
/**
* List of calendars' identifiers within a group.
*/
calendars?: string[] | null;
/**
* Optional error(s) (if computation for the group failed).
*/
errors?: Schema$Error[];
}
export interface Schema$FreeBusyRequest {
/**
* Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.
*/
calendarExpansionMax?: number | null;
/**
* Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100.
*/
groupExpansionMax?: number | null;
/**
* List of calendars and/or groups to query.
*/
items?: Schema$FreeBusyRequestItem[];
/**
* The end of the interval for the query formatted as per RFC3339.
*/
timeMax?: string | null;
/**
* The start of the interval for the query formatted as per RFC3339.
*/
timeMin?: string | null;
/**
* Time zone used in the response. Optional. The default is UTC.
*/
timeZone?: string | null;
}
export interface Schema$FreeBusyRequestItem {
/**
* The identifier of a calendar or a group.
*/
id?: string | null;
}
export interface Schema$FreeBusyResponse {
/**
* List of free/busy information for calendars.
*/
calendars?: {
[key: string]: Schema$FreeBusyCalendar;
} | null;
/**
* Expansion of groups.
*/
groups?: {
[key: string]: Schema$FreeBusyGroup;
} | null;
/**
* Type of the resource ("calendar#freeBusy").
*/
kind?: string | null;
/**
* The end of the interval.
*/
timeMax?: string | null;
/**
* The start of the interval.
*/
timeMin?: string | null;
}
export interface Schema$Setting {
/**
* ETag of the resource.
*/
etag?: string | null;
/**
* The id of the user setting.
*/
id?: string | null;
/**
* Type of the resource ("calendar#setting").
*/
kind?: string | null;
/**
* Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.
*/
value?: string | null;
}
export interface Schema$Settings {
/**
* Etag of the collection.
*/
etag?: string | null;
/**
* List of user settings.
*/
items?: Schema$Setting[];
/**
* Type of the collection ("calendar#settings").
*/
kind?: string | null;
/**
* Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
*/
nextPageToken?: string | null;
/**
* Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
*/
nextSyncToken?: string | null;
}
export interface Schema$TimePeriod {
/**
* The (exclusive) end of the time period.
*/
end?: string | null;
/**
* The (inclusive) start of the time period.
*/
start?: string | null;
}
export class Resource$Acl {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* calendar.acl.delete
* @desc Deletes an access control rule.
* @alias calendar.acl.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {string} params.ruleId ACL rule identifier.
* @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$Acl$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Acl$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Acl$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* calendar.acl.get
* @desc Returns an access control rule.
* @alias calendar.acl.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {string} params.ruleId ACL rule identifier.
* @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$Acl$Get, options?: MethodOptions): GaxiosPromise<Schema$AclRule>;
get(params: Params$Resource$Acl$Get, options: MethodOptions | BodyResponseCallback<Schema$AclRule>, callback: BodyResponseCallback<Schema$AclRule>): void;
get(params: Params$Resource$Acl$Get, callback: BodyResponseCallback<Schema$AclRule>): void;
get(callback: BodyResponseCallback<Schema$AclRule>): void;
/**
* calendar.acl.insert
* @desc Creates an access control rule.
* @alias calendar.acl.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {boolean=} params.sendNotifications Whether to send notifications about the calendar sharing change. Optional. The default is True.
* @param {().AclRule} 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$Acl$Insert, options?: MethodOptions): GaxiosPromise<Schema$AclRule>;
insert(params: Params$Resource$Acl$Insert, options: MethodOptions | BodyResponseCallback<Schema$AclRule>, callback: BodyResponseCallback<Schema$AclRule>): void;
insert(params: Params$Resource$Acl$Insert, callback: BodyResponseCallback<Schema$AclRule>): void;
insert(callback: BodyResponseCallback<Schema$AclRule>): void;
/**
* calendar.acl.list
* @desc Returns the rules in the access control list for the calendar.
* @alias calendar.acl.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {integer=} params.maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
* @param {string=} params.pageToken Token specifying which result page to return. Optional.
* @param {boolean=} params.showDeleted Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
* @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
* @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$Acl$List, options?: MethodOptions): GaxiosPromise<Schema$Acl>;
list(params: Params$Resource$Acl$List, options: MethodOptions | BodyResponseCallback<Schema$Acl>, callback: BodyResponseCallback<Schema$Acl>): void;
list(params: Params$Resource$Acl$List, callback: BodyResponseCallback<Schema$Acl>): void;
list(callback: BodyResponseCallback<Schema$Acl>): void;
/**
* calendar.acl.patch
* @desc Updates an access control rule. This method supports patch semantics.
* @alias calendar.acl.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {string} params.ruleId ACL rule identifier.
* @param {boolean=} params.sendNotifications Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
* @param {().AclRule} 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$Acl$Patch, options?: MethodOptions): GaxiosPromise<Schema$AclRule>;
patch(params: Params$Resource$Acl$Patch, options: MethodOptions | BodyResponseCallback<Schema$AclRule>, callback: BodyResponseCallback<Schema$AclRule>): void;
patch(params: Params$Resource$Acl$Patch, callback: BodyResponseCallback<Schema$AclRule>): void;
patch(callback: BodyResponseCallback<Schema$AclRule>): void;
/**
* calendar.acl.update
* @desc Updates an access control rule.
* @alias calendar.acl.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {string} params.ruleId ACL rule identifier.
* @param {boolean=} params.sendNotifications Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
* @param {().AclRule} 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$Acl$Update, options?: MethodOptions): GaxiosPromise<Schema$AclRule>;
update(params: Params$Resource$Acl$Update, options: MethodOptions | BodyResponseCallback<Schema$AclRule>, callback: BodyResponseCallback<Schema$AclRule>): void;
update(params: Params$Resource$Acl$Update, callback: BodyResponseCallback<Schema$AclRule>): void;
update(callback: BodyResponseCallback<Schema$AclRule>): void;
/**
* calendar.acl.watch
* @desc Watch for changes to ACL resources.
* @alias calendar.acl.watch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {integer=} params.maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
* @param {string=} params.pageToken Token specifying which result page to return. Optional.
* @param {boolean=} params.showDeleted Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
* @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
* @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$Acl$Watch, options?: MethodOptions): GaxiosPromise<Schema$Channel>;
watch(params: Params$Resource$Acl$Watch, options: MethodOptions | BodyResponseCallback<Schema$Channel>, callback: BodyResponseCallback<Schema$Channel>): void;
watch(params: Params$Resource$Acl$Watch, callback: BodyResponseCallback<Schema$Channel>): void;
watch(callback: BodyResponseCallback<Schema$Channel>): void;
}
export interface Params$Resource$Acl$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* ACL rule identifier.
*/
ruleId?: string;
}
export interface Params$Resource$Acl$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* ACL rule identifier.
*/
ruleId?: string;
}
export interface Params$Resource$Acl$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Whether to send notifications about the calendar sharing change. Optional. The default is True.
*/
sendNotifications?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$AclRule;
}
export interface Params$Resource$Acl$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
*/
maxResults?: number;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
*/
showDeleted?: boolean;
/**
* Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
}
export interface Params$Resource$Acl$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* ACL rule identifier.
*/
ruleId?: string;
/**
* Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
*/
sendNotifications?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$AclRule;
}
export interface Params$Resource$Acl$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* ACL rule identifier.
*/
ruleId?: string;
/**
* Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
*/
sendNotifications?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$AclRule;
}
export interface Params$Resource$Acl$Watch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
*/
maxResults?: number;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
*/
showDeleted?: boolean;
/**
* Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Channel;
}
export class Resource$Calendarlist {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* calendar.calendarList.delete
* @desc Removes a calendar from the user's calendar list.
* @alias calendar.calendarList.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @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$Calendarlist$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Calendarlist$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Calendarlist$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* calendar.calendarList.get
* @desc Returns a calendar from the user's calendar list.
* @alias calendar.calendarList.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @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$Calendarlist$Get, options?: MethodOptions): GaxiosPromise<Schema$CalendarListEntry>;
get(params: Params$Resource$Calendarlist$Get, options: MethodOptions | BodyResponseCallback<Schema$CalendarListEntry>, callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
get(params: Params$Resource$Calendarlist$Get, callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
get(callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
/**
* calendar.calendarList.insert
* @desc Inserts an existing calendar into the user's calendar list.
* @alias calendar.calendarList.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.colorRgbFormat Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
* @param {().CalendarListEntry} 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$Calendarlist$Insert, options?: MethodOptions): GaxiosPromise<Schema$CalendarListEntry>;
insert(params: Params$Resource$Calendarlist$Insert, options: MethodOptions | BodyResponseCallback<Schema$CalendarListEntry>, callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
insert(params: Params$Resource$Calendarlist$Insert, callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
insert(callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
/**
* calendar.calendarList.list
* @desc Returns the calendars on the user's calendar list.
* @alias calendar.calendarList.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {integer=} params.maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
* @param {string=} params.minAccessRole The minimum access role for the user in the returned entries. Optional. The default is no restriction.
* @param {string=} params.pageToken Token specifying which result page to return. Optional.
* @param {boolean=} params.showDeleted Whether to include deleted calendar list entries in the result. Optional. The default is False.
* @param {boolean=} params.showHidden Whether to show hidden entries. Optional. The default is False.
* @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
* @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$Calendarlist$List, options?: MethodOptions): GaxiosPromise<Schema$CalendarList>;
list(params: Params$Resource$Calendarlist$List, options: MethodOptions | BodyResponseCallback<Schema$CalendarList>, callback: BodyResponseCallback<Schema$CalendarList>): void;
list(params: Params$Resource$Calendarlist$List, callback: BodyResponseCallback<Schema$CalendarList>): void;
list(callback: BodyResponseCallback<Schema$CalendarList>): void;
/**
* calendar.calendarList.patch
* @desc Updates an existing calendar on the user's calendar list. This method supports patch semantics.
* @alias calendar.calendarList.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {boolean=} params.colorRgbFormat Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
* @param {().CalendarListEntry} 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$Calendarlist$Patch, options?: MethodOptions): GaxiosPromise<Schema$CalendarListEntry>;
patch(params: Params$Resource$Calendarlist$Patch, options: MethodOptions | BodyResponseCallback<Schema$CalendarListEntry>, callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
patch(params: Params$Resource$Calendarlist$Patch, callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
patch(callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
/**
* calendar.calendarList.update
* @desc Updates an existing calendar on the user's calendar list.
* @alias calendar.calendarList.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {boolean=} params.colorRgbFormat Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
* @param {().CalendarListEntry} 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$Calendarlist$Update, options?: MethodOptions): GaxiosPromise<Schema$CalendarListEntry>;
update(params: Params$Resource$Calendarlist$Update, options: MethodOptions | BodyResponseCallback<Schema$CalendarListEntry>, callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
update(params: Params$Resource$Calendarlist$Update, callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
update(callback: BodyResponseCallback<Schema$CalendarListEntry>): void;
/**
* calendar.calendarList.watch
* @desc Watch for changes to CalendarList resources.
* @alias calendar.calendarList.watch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
* @param {string=} params.minAccessRole The minimum access role for the user in the returned entries. Optional. The default is no restriction.
* @param {string=} params.pageToken Token specifying which result page to return. Optional.
* @param {boolean=} params.showDeleted Whether to include deleted calendar list entries in the result. Optional. The default is False.
* @param {boolean=} params.showHidden Whether to show hidden entries. Optional. The default is False.
* @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
* @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$Calendarlist$Watch, options?: MethodOptions): GaxiosPromise<Schema$Channel>;
watch(params: Params$Resource$Calendarlist$Watch, options: MethodOptions | BodyResponseCallback<Schema$Channel>, callback: BodyResponseCallback<Schema$Channel>): void;
watch(params: Params$Resource$Calendarlist$Watch, callback: BodyResponseCallback<Schema$Channel>): void;
watch(callback: BodyResponseCallback<Schema$Channel>): void;
}
export interface Params$Resource$Calendarlist$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
}
export interface Params$Resource$Calendarlist$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
}
export interface Params$Resource$Calendarlist$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
*/
colorRgbFormat?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$CalendarListEntry;
}
export interface Params$Resource$Calendarlist$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
*/
maxResults?: number;
/**
* The minimum access role for the user in the returned entries. Optional. The default is no restriction.
*/
minAccessRole?: string;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* Whether to include deleted calendar list entries in the result. Optional. The default is False.
*/
showDeleted?: boolean;
/**
* Whether to show hidden entries. Optional. The default is False.
*/
showHidden?: boolean;
/**
* Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
}
export interface Params$Resource$Calendarlist$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
*/
colorRgbFormat?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$CalendarListEntry;
}
export interface Params$Resource$Calendarlist$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
*/
colorRgbFormat?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$CalendarListEntry;
}
export interface Params$Resource$Calendarlist$Watch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
*/
maxResults?: number;
/**
* The minimum access role for the user in the returned entries. Optional. The default is no restriction.
*/
minAccessRole?: string;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* Whether to include deleted calendar list entries in the result. Optional. The default is False.
*/
showDeleted?: boolean;
/**
* Whether to show hidden entries. Optional. The default is False.
*/
showHidden?: boolean;
/**
* Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Channel;
}
export class Resource$Calendars {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* calendar.calendars.clear
* @desc Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
* @alias calendar.calendars.clear
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @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
*/
clear(params?: Params$Resource$Calendars$Clear, options?: MethodOptions): GaxiosPromise<void>;
clear(params: Params$Resource$Calendars$Clear, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
clear(params: Params$Resource$Calendars$Clear, callback: BodyResponseCallback<void>): void;
clear(callback: BodyResponseCallback<void>): void;
/**
* calendar.calendars.delete
* @desc Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
* @alias calendar.calendars.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @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$Calendars$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Calendars$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Calendars$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* calendar.calendars.get
* @desc Returns metadata for a calendar.
* @alias calendar.calendars.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @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$Calendars$Get, options?: MethodOptions): GaxiosPromise<Schema$Calendar>;
get(params: Params$Resource$Calendars$Get, options: MethodOptions | BodyResponseCallback<Schema$Calendar>, callback: BodyResponseCallback<Schema$Calendar>): void;
get(params: Params$Resource$Calendars$Get, callback: BodyResponseCallback<Schema$Calendar>): void;
get(callback: BodyResponseCallback<Schema$Calendar>): void;
/**
* calendar.calendars.insert
* @desc Creates a secondary calendar.
* @alias calendar.calendars.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Calendar} 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$Calendars$Insert, options?: MethodOptions): GaxiosPromise<Schema$Calendar>;
insert(params: Params$Resource$Calendars$Insert, options: MethodOptions | BodyResponseCallback<Schema$Calendar>, callback: BodyResponseCallback<Schema$Calendar>): void;
insert(params: Params$Resource$Calendars$Insert, callback: BodyResponseCallback<Schema$Calendar>): void;
insert(callback: BodyResponseCallback<Schema$Calendar>): void;
/**
* calendar.calendars.patch
* @desc Updates metadata for a calendar. This method supports patch semantics.
* @alias calendar.calendars.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {().Calendar} 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$Calendars$Patch, options?: MethodOptions): GaxiosPromise<Schema$Calendar>;
patch(params: Params$Resource$Calendars$Patch, options: MethodOptions | BodyResponseCallback<Schema$Calendar>, callback: BodyResponseCallback<Schema$Calendar>): void;
patch(params: Params$Resource$Calendars$Patch, callback: BodyResponseCallback<Schema$Calendar>): void;
patch(callback: BodyResponseCallback<Schema$Calendar>): void;
/**
* calendar.calendars.update
* @desc Updates metadata for a calendar.
* @alias calendar.calendars.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {().Calendar} 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$Calendars$Update, options?: MethodOptions): GaxiosPromise<Schema$Calendar>;
update(params: Params$Resource$Calendars$Update, options: MethodOptions | BodyResponseCallback<Schema$Calendar>, callback: BodyResponseCallback<Schema$Calendar>): void;
update(params: Params$Resource$Calendars$Update, callback: BodyResponseCallback<Schema$Calendar>): void;
update(callback: BodyResponseCallback<Schema$Calendar>): void;
}
export interface Params$Resource$Calendars$Clear extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
}
export interface Params$Resource$Calendars$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
}
export interface Params$Resource$Calendars$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
}
export interface Params$Resource$Calendars$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$Calendar;
}
export interface Params$Resource$Calendars$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Calendar;
}
export interface Params$Resource$Calendars$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Calendar;
}
export class Resource$Channels {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* calendar.channels.stop
* @desc Stop watching resources through this channel
* @alias calendar.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$Colors {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* calendar.colors.get
* @desc Returns the color definitions for calendars and events.
* @alias calendar.colors.get
* @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
*/
get(params?: Params$Resource$Colors$Get, options?: MethodOptions): GaxiosPromise<Schema$Colors>;
get(params: Params$Resource$Colors$Get, options: MethodOptions | BodyResponseCallback<Schema$Colors>, callback: BodyResponseCallback<Schema$Colors>): void;
get(params: Params$Resource$Colors$Get, callback: BodyResponseCallback<Schema$Colors>): void;
get(callback: BodyResponseCallback<Schema$Colors>): void;
}
export interface Params$Resource$Colors$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
export class Resource$Events {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* calendar.events.delete
* @desc Deletes an event.
* @alias calendar.events.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {string} params.eventId Event identifier.
* @param {boolean=} params.sendNotifications Deprecated. Please use sendUpdates instead. Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.
* @param {string=} params.sendUpdates Guests who should receive notifications about the deletion of the event.
* @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$Events$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Events$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Events$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* calendar.events.get
* @desc Returns an event.
* @alias calendar.events.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.alwaysIncludeEmail Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {string} params.eventId Event identifier.
* @param {integer=} params.maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
* @param {string=} params.timeZone Time zone used in the response. Optional. The default is the time zone of the calendar.
* @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$Events$Get, options?: MethodOptions): GaxiosPromise<Schema$Event>;
get(params: Params$Resource$Events$Get, options: MethodOptions | BodyResponseCallback<Schema$Event>, callback: BodyResponseCallback<Schema$Event>): void;
get(params: Params$Resource$Events$Get, callback: BodyResponseCallback<Schema$Event>): void;
get(callback: BodyResponseCallback<Schema$Event>): void;
/**
* calendar.events.import
* @desc Imports an event. This operation is used to add a private copy of an existing event to a calendar.
* @alias calendar.events.import
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {integer=} params.conferenceDataVersion Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
* @param {boolean=} params.supportsAttachments Whether API client performing operation supports event attachments. Optional. The default is False.
* @param {().Event} 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
*/
import(params?: Params$Resource$Events$Import, options?: MethodOptions): GaxiosPromise<Schema$Event>;
import(params: Params$Resource$Events$Import, options: MethodOptions | BodyResponseCallback<Schema$Event>, callback: BodyResponseCallback<Schema$Event>): void;
import(params: Params$Resource$Events$Import, callback: BodyResponseCallback<Schema$Event>): void;
import(callback: BodyResponseCallback<Schema$Event>): void;
/**
* calendar.events.insert
* @desc Creates an event.
* @alias calendar.events.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {integer=} params.conferenceDataVersion Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
* @param {integer=} params.maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
* @param {boolean=} params.sendNotifications Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.
* @param {string=} params.sendUpdates Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.
* @param {boolean=} params.supportsAttachments Whether API client performing operation supports event attachments. Optional. The default is False.
* @param {().Event} 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$Events$Insert, options?: MethodOptions): GaxiosPromise<Schema$Event>;
insert(params: Params$Resource$Events$Insert, options: MethodOptions | BodyResponseCallback<Schema$Event>, callback: BodyResponseCallback<Schema$Event>): void;
insert(params: Params$Resource$Events$Insert, callback: BodyResponseCallback<Schema$Event>): void;
insert(callback: BodyResponseCallback<Schema$Event>): void;
/**
* calendar.events.instances
* @desc Returns instances of the specified recurring event.
* @alias calendar.events.instances
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.alwaysIncludeEmail Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {string} params.eventId Recurring event identifier.
* @param {integer=} params.maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
* @param {integer=} params.maxResults Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
* @param {string=} params.originalStart The original start time of the instance in the result. Optional.
* @param {string=} params.pageToken Token specifying which result page to return. Optional.
* @param {boolean=} params.showDeleted Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.
* @param {string=} params.timeMax Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.
* @param {string=} params.timeMin Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.
* @param {string=} params.timeZone Time zone used in the response. Optional. The default is the time zone of the calendar.
* @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
*/
instances(params?: Params$Resource$Events$Instances, options?: MethodOptions): GaxiosPromise<Schema$Events>;
instances(params: Params$Resource$Events$Instances, options: MethodOptions | BodyResponseCallback<Schema$Events>, callback: BodyResponseCallback<Schema$Events>): void;
instances(params: Params$Resource$Events$Instances, callback: BodyResponseCallback<Schema$Events>): void;
instances(callback: BodyResponseCallback<Schema$Events>): void;
/**
* calendar.events.list
* @desc Returns events on the specified calendar.
* @alias calendar.events.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.alwaysIncludeEmail Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {string=} params.iCalUID Specifies event ID in the iCalendar format to be included in the response. Optional.
* @param {integer=} params.maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
* @param {integer=} params.maxResults Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
* @param {string=} params.orderBy The order of the events returned in the result. Optional. The default is an unspecified, stable order.
* @param {string=} params.pageToken Token specifying which result page to return. Optional.
* @param {string=} params.privateExtendedProperty Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.
* @param {string=} params.q Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
* @param {string=} params.sharedExtendedProperty Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.
* @param {boolean=} params.showDeleted Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
* @param {boolean=} params.showHiddenInvitations Whether to include hidden invitations in the result. Optional. The default is False.
* @param {boolean=} params.singleEvents Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
* @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
* @param {string=} params.timeMax Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
* @param {string=} params.timeMin Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
* @param {string=} params.timeZone Time zone used in the response. Optional. The default is the time zone of the calendar.
* @param {string=} params.updatedMin Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.
* @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$Events$List, options?: MethodOptions): GaxiosPromise<Schema$Events>;
list(params: Params$Resource$Events$List, options: MethodOptions | BodyResponseCallback<Schema$Events>, callback: BodyResponseCallback<Schema$Events>): void;
list(params: Params$Resource$Events$List, callback: BodyResponseCallback<Schema$Events>): void;
list(callback: BodyResponseCallback<Schema$Events>): void;
/**
* calendar.events.move
* @desc Moves an event to another calendar, i.e. changes an event's organizer.
* @alias calendar.events.move
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier of the source calendar where the event currently is on.
* @param {string} params.destination Calendar identifier of the target calendar where the event is to be moved to.
* @param {string} params.eventId Event identifier.
* @param {boolean=} params.sendNotifications Deprecated. Please use sendUpdates instead. Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.
* @param {string=} params.sendUpdates Guests who should receive notifications about the change of the event's organizer.
* @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
*/
move(params?: Params$Resource$Events$Move, options?: MethodOptions): GaxiosPromise<Schema$Event>;
move(params: Params$Resource$Events$Move, options: MethodOptions | BodyResponseCallback<Schema$Event>, callback: BodyResponseCallback<Schema$Event>): void;
move(params: Params$Resource$Events$Move, callback: BodyResponseCallback<Schema$Event>): void;
move(callback: BodyResponseCallback<Schema$Event>): void;
/**
* calendar.events.patch
* @desc Updates an event. This method supports patch semantics.
* @alias calendar.events.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.alwaysIncludeEmail Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {integer=} params.conferenceDataVersion Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
* @param {string} params.eventId Event identifier.
* @param {integer=} params.maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
* @param {boolean=} params.sendNotifications Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.
* @param {string=} params.sendUpdates Guests who should receive notifications about the event update (for example, title changes, etc.).
* @param {boolean=} params.supportsAttachments Whether API client performing operation supports event attachments. Optional. The default is False.
* @param {().Event} 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$Events$Patch, options?: MethodOptions): GaxiosPromise<Schema$Event>;
patch(params: Params$Resource$Events$Patch, options: MethodOptions | BodyResponseCallback<Schema$Event>, callback: BodyResponseCallback<Schema$Event>): void;
patch(params: Params$Resource$Events$Patch, callback: BodyResponseCallback<Schema$Event>): void;
patch(callback: BodyResponseCallback<Schema$Event>): void;
/**
* calendar.events.quickAdd
* @desc Creates an event based on a simple text string.
* @alias calendar.events.quickAdd
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {boolean=} params.sendNotifications Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.
* @param {string=} params.sendUpdates Guests who should receive notifications about the creation of the new event.
* @param {string} params.text The text describing the event to be created.
* @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
*/
quickAdd(params?: Params$Resource$Events$Quickadd, options?: MethodOptions): GaxiosPromise<Schema$Event>;
quickAdd(params: Params$Resource$Events$Quickadd, options: MethodOptions | BodyResponseCallback<Schema$Event>, callback: BodyResponseCallback<Schema$Event>): void;
quickAdd(params: Params$Resource$Events$Quickadd, callback: BodyResponseCallback<Schema$Event>): void;
quickAdd(callback: BodyResponseCallback<Schema$Event>): void;
/**
* calendar.events.update
* @desc Updates an event.
* @alias calendar.events.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.alwaysIncludeEmail Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {integer=} params.conferenceDataVersion Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
* @param {string} params.eventId Event identifier.
* @param {integer=} params.maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
* @param {boolean=} params.sendNotifications Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.
* @param {string=} params.sendUpdates Guests who should receive notifications about the event update (for example, title changes, etc.).
* @param {boolean=} params.supportsAttachments Whether API client performing operation supports event attachments. Optional. The default is False.
* @param {().Event} 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$Events$Update, options?: MethodOptions): GaxiosPromise<Schema$Event>;
update(params: Params$Resource$Events$Update, options: MethodOptions | BodyResponseCallback<Schema$Event>, callback: BodyResponseCallback<Schema$Event>): void;
update(params: Params$Resource$Events$Update, callback: BodyResponseCallback<Schema$Event>): void;
update(callback: BodyResponseCallback<Schema$Event>): void;
/**
* calendar.events.watch
* @desc Watch for changes to Events resources.
* @alias calendar.events.watch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.alwaysIncludeEmail Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
* @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
* @param {string=} params.iCalUID Specifies event ID in the iCalendar format to be included in the response. Optional.
* @param {integer=} params.maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
* @param {integer=} params.maxResults Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
* @param {string=} params.orderBy The order of the events returned in the result. Optional. The default is an unspecified, stable order.
* @param {string=} params.pageToken Token specifying which result page to return. Optional.
* @param {string=} params.privateExtendedProperty Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.
* @param {string=} params.q Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
* @param {string=} params.sharedExtendedProperty Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.
* @param {boolean=} params.showDeleted Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
* @param {boolean=} params.showHiddenInvitations Whether to include hidden invitations in the result. Optional. The default is False.
* @param {boolean=} params.singleEvents Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
* @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
* @param {string=} params.timeMax Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
* @param {string=} params.timeMin Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
* @param {string=} params.timeZone Time zone used in the response. Optional. The default is the time zone of the calendar.
* @param {string=} params.updatedMin Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.
* @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$Events$Watch, options?: MethodOptions): GaxiosPromise<Schema$Channel>;
watch(params: Params$Resource$Events$Watch, options: MethodOptions | BodyResponseCallback<Schema$Channel>, callback: BodyResponseCallback<Schema$Channel>): void;
watch(params: Params$Resource$Events$Watch, callback: BodyResponseCallback<Schema$Channel>): void;
watch(callback: BodyResponseCallback<Schema$Channel>): void;
}
export interface Params$Resource$Events$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Event identifier.
*/
eventId?: string;
/**
* Deprecated. Please use sendUpdates instead. Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.
*/
sendNotifications?: boolean;
/**
* Guests who should receive notifications about the deletion of the event.
*/
sendUpdates?: string;
}
export interface Params$Resource$Events$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
*/
alwaysIncludeEmail?: boolean;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Event identifier.
*/
eventId?: string;
/**
* The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
* Time zone used in the response. Optional. The default is the time zone of the calendar.
*/
timeZone?: string;
}
export interface Params$Resource$Events$Import extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
*/
conferenceDataVersion?: number;
/**
* Whether API client performing operation supports event attachments. Optional. The default is False.
*/
supportsAttachments?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Event;
}
export interface Params$Resource$Events$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
*/
conferenceDataVersion?: number;
/**
* The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
* Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.
*/
sendNotifications?: boolean;
/**
* Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.
*/
sendUpdates?: string;
/**
* Whether API client performing operation supports event attachments. Optional. The default is False.
*/
supportsAttachments?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Event;
}
export interface Params$Resource$Events$Instances extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
*/
alwaysIncludeEmail?: boolean;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Recurring event identifier.
*/
eventId?: string;
/**
* The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
* Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
*/
maxResults?: number;
/**
* The original start time of the instance in the result. Optional.
*/
originalStart?: string;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.
*/
showDeleted?: boolean;
/**
* Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.
*/
timeMax?: string;
/**
* Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.
*/
timeMin?: string;
/**
* Time zone used in the response. Optional. The default is the time zone of the calendar.
*/
timeZone?: string;
}
export interface Params$Resource$Events$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
*/
alwaysIncludeEmail?: boolean;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Specifies event ID in the iCalendar format to be included in the response. Optional.
*/
iCalUID?: string;
/**
* The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
* Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
*/
maxResults?: number;
/**
* The order of the events returned in the result. Optional. The default is an unspecified, stable order.
*/
orderBy?: string;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.
*/
privateExtendedProperty?: string[];
/**
* Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
*/
q?: string;
/**
* Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.
*/
sharedExtendedProperty?: string[];
/**
* Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
*/
showDeleted?: boolean;
/**
* Whether to include hidden invitations in the result. Optional. The default is False.
*/
showHiddenInvitations?: boolean;
/**
* Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
*/
singleEvents?: boolean;
/**
* Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
/**
* Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
*/
timeMax?: string;
/**
* Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
*/
timeMin?: string;
/**
* Time zone used in the response. Optional. The default is the time zone of the calendar.
*/
timeZone?: string;
/**
* Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.
*/
updatedMin?: string;
}
export interface Params$Resource$Events$Move extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier of the source calendar where the event currently is on.
*/
calendarId?: string;
/**
* Calendar identifier of the target calendar where the event is to be moved to.
*/
destination?: string;
/**
* Event identifier.
*/
eventId?: string;
/**
* Deprecated. Please use sendUpdates instead. Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.
*/
sendNotifications?: boolean;
/**
* Guests who should receive notifications about the change of the event's organizer.
*/
sendUpdates?: string;
}
export interface Params$Resource$Events$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
*/
alwaysIncludeEmail?: boolean;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
*/
conferenceDataVersion?: number;
/**
* Event identifier.
*/
eventId?: string;
/**
* The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
* Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.
*/
sendNotifications?: boolean;
/**
* Guests who should receive notifications about the event update (for example, title changes, etc.).
*/
sendUpdates?: string;
/**
* Whether API client performing operation supports event attachments. Optional. The default is False.
*/
supportsAttachments?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Event;
}
export interface Params$Resource$Events$Quickadd extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.
*/
sendNotifications?: boolean;
/**
* Guests who should receive notifications about the creation of the new event.
*/
sendUpdates?: string;
/**
* The text describing the event to be created.
*/
text?: string;
}
export interface Params$Resource$Events$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
*/
alwaysIncludeEmail?: boolean;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
*/
conferenceDataVersion?: number;
/**
* Event identifier.
*/
eventId?: string;
/**
* The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
* Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.
*/
sendNotifications?: boolean;
/**
* Guests who should receive notifications about the event update (for example, title changes, etc.).
*/
sendUpdates?: string;
/**
* Whether API client performing operation supports event attachments. Optional. The default is False.
*/
supportsAttachments?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Event;
}
export interface Params$Resource$Events$Watch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
*/
alwaysIncludeEmail?: boolean;
/**
* Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
*/
calendarId?: string;
/**
* Specifies event ID in the iCalendar format to be included in the response. Optional.
*/
iCalUID?: string;
/**
* The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
*/
maxAttendees?: number;
/**
* Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
*/
maxResults?: number;
/**
* The order of the events returned in the result. Optional. The default is an unspecified, stable order.
*/
orderBy?: string;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.
*/
privateExtendedProperty?: string[];
/**
* Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
*/
q?: string;
/**
* Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.
*/
sharedExtendedProperty?: string[];
/**
* Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
*/
showDeleted?: boolean;
/**
* Whether to include hidden invitations in the result. Optional. The default is False.
*/
showHiddenInvitations?: boolean;
/**
* Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
*/
singleEvents?: boolean;
/**
* Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
/**
* Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.
*/
timeMax?: string;
/**
* Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.
*/
timeMin?: string;
/**
* Time zone used in the response. Optional. The default is the time zone of the calendar.
*/
timeZone?: string;
/**
* Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.
*/
updatedMin?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Channel;
}
export class Resource$Freebusy {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* calendar.freebusy.query
* @desc Returns free/busy information for a set of calendars.
* @alias calendar.freebusy.query
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().FreeBusyRequest} 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
*/
query(params?: Params$Resource$Freebusy$Query, options?: MethodOptions): GaxiosPromise<Schema$FreeBusyResponse>;
query(params: Params$Resource$Freebusy$Query, options: MethodOptions | BodyResponseCallback<Schema$FreeBusyResponse>, callback: BodyResponseCallback<Schema$FreeBusyResponse>): void;
query(params: Params$Resource$Freebusy$Query, callback: BodyResponseCallback<Schema$FreeBusyResponse>): void;
query(callback: BodyResponseCallback<Schema$FreeBusyResponse>): void;
}
export interface Params$Resource$Freebusy$Query extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$FreeBusyRequest;
}
export class Resource$Settings {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* calendar.settings.get
* @desc Returns a single user setting.
* @alias calendar.settings.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.setting The id of the user setting.
* @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$Settings$Get, options?: MethodOptions): GaxiosPromise<Schema$Setting>;
get(params: Params$Resource$Settings$Get, options: MethodOptions | BodyResponseCallback<Schema$Setting>, callback: BodyResponseCallback<Schema$Setting>): void;
get(params: Params$Resource$Settings$Get, callback: BodyResponseCallback<Schema$Setting>): void;
get(callback: BodyResponseCallback<Schema$Setting>): void;
/**
* calendar.settings.list
* @desc Returns all user settings for the authenticated user.
* @alias calendar.settings.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {integer=} params.maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
* @param {string=} params.pageToken Token specifying which result page to return. Optional.
* @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
* @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$Settings$List, options?: MethodOptions): GaxiosPromise<Schema$Settings>;
list(params: Params$Resource$Settings$List, options: MethodOptions | BodyResponseCallback<Schema$Settings>, callback: BodyResponseCallback<Schema$Settings>): void;
list(params: Params$Resource$Settings$List, callback: BodyResponseCallback<Schema$Settings>): void;
list(callback: BodyResponseCallback<Schema$Settings>): void;
/**
* calendar.settings.watch
* @desc Watch for changes to Settings resources.
* @alias calendar.settings.watch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
* @param {string=} params.pageToken Token specifying which result page to return. Optional.
* @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
* @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$Settings$Watch, options?: MethodOptions): GaxiosPromise<Schema$Channel>;
watch(params: Params$Resource$Settings$Watch, options: MethodOptions | BodyResponseCallback<Schema$Channel>, callback: BodyResponseCallback<Schema$Channel>): void;
watch(params: Params$Resource$Settings$Watch, callback: BodyResponseCallback<Schema$Channel>): void;
watch(callback: BodyResponseCallback<Schema$Channel>): void;
}
export interface Params$Resource$Settings$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The id of the user setting.
*/
setting?: string;
}
export interface Params$Resource$Settings$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
*/
maxResults?: number;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
}
export interface Params$Resource$Settings$Watch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
*/
maxResults?: number;
/**
* Token specifying which result page to return. Optional.
*/
pageToken?: string;
/**
* Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
*/
syncToken?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Channel;
}
export {};
}