v1.d.ts
195 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
/**
* 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 classroom_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Google Classroom API
*
* Manages classes, rosters, and invitations in Google Classroom.
*
* @example
* const {google} = require('googleapis');
* const classroom = google.classroom('v1');
*
* @namespace classroom
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Classroom
*/
export class Classroom {
context: APIRequestContext;
courses: Resource$Courses;
invitations: Resource$Invitations;
registrations: Resource$Registrations;
userProfiles: Resource$Userprofiles;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Announcement created by a teacher for students of the course
*/
export interface Schema$Announcement {
/**
* Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
*/
alternateLink?: string | null;
/**
* Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
*/
assigneeMode?: string | null;
/**
* Identifier of the course. Read-only.
*/
courseId?: string | null;
/**
* Timestamp when this announcement was created. Read-only.
*/
creationTime?: string | null;
/**
* Identifier for the user that created the announcement. Read-only.
*/
creatorUserId?: string | null;
/**
* Classroom-assigned identifier of this announcement, unique per course. Read-only.
*/
id?: string | null;
/**
* Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field will be able to see the announcement.
*/
individualStudentsOptions?: Schema$IndividualStudentsOptions;
/**
* Additional materials. Announcements must have no more than 20 material items.
*/
materials?: Schema$Material[];
/**
* Optional timestamp when this announcement is scheduled to be published.
*/
scheduledTime?: string | null;
/**
* Status of this announcement. If unspecified, the default state is `DRAFT`.
*/
state?: string | null;
/**
* Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
*/
text?: string | null;
/**
* Timestamp of the most recent change to this announcement. Read-only.
*/
updateTime?: string | null;
}
/**
* Additional details for assignments.
*/
export interface Schema$Assignment {
/**
* Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators.
*/
studentWorkFolder?: Schema$DriveFolder;
}
/**
* Student work for an assignment.
*/
export interface Schema$AssignmentSubmission {
/**
* Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (e.g. title) may not be.
*/
attachments?: Schema$Attachment[];
}
/**
* Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.
*/
export interface Schema$Attachment {
/**
* Google Drive file attachment.
*/
driveFile?: Schema$DriveFile;
/**
* Google Forms attachment.
*/
form?: Schema$Form;
/**
* Link attachment.
*/
link?: Schema$Link;
/**
* Youtube video attachment.
*/
youTubeVideo?: Schema$YouTubeVideo;
}
/**
* A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant `classroom-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.
*/
export interface Schema$CloudPubsubTopic {
/**
* The `name` field of a Cloud Pub/Sub [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
*/
topicName?: string | null;
}
/**
* A Course in Classroom.
*/
export interface Schema$Course {
/**
* Absolute link to this course in the Classroom web UI. Read-only.
*/
alternateLink?: string | null;
/**
* The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.
*/
calendarId?: string | null;
/**
* The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
*/
courseGroupEmail?: string | null;
/**
* Sets of materials that appear on the "about" page of this course. Read-only.
*/
courseMaterialSets?: Schema$CourseMaterialSet[];
/**
* State of the course. If unspecified, the default state is `PROVISIONED`.
*/
courseState?: string | null;
/**
* Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
*/
creationTime?: string | null;
/**
* Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
*/
description?: string | null;
/**
* Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
*/
descriptionHeading?: string | null;
/**
* Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
*/
enrollmentCode?: string | null;
/**
* Whether or not guardian notifications are enabled for this course. Read-only.
*/
guardiansEnabled?: boolean | null;
/**
* Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
*/
id?: string | null;
/**
* Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
*/
name?: string | null;
/**
* The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.
*/
ownerId?: string | null;
/**
* Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
*/
room?: string | null;
/**
* Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
*/
section?: string | null;
/**
* Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
*/
teacherFolder?: Schema$DriveFolder;
/**
* The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
*/
teacherGroupEmail?: string | null;
/**
* Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
*/
updateTime?: string | null;
}
/**
* Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.
*/
export interface Schema$CourseAlias {
/**
* Alias string. The format of the string indicates the desired alias scoping. * `d:<name>` indicates a domain-scoped alias. Example: `d:math_101` * `p:<name>` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
*/
alias?: string | null;
}
/**
* A material attached to a course as part of a material set.
*/
export interface Schema$CourseMaterial {
/**
* Google Drive file attachment.
*/
driveFile?: Schema$DriveFile;
/**
* Google Forms attachment.
*/
form?: Schema$Form;
/**
* Link atatchment.
*/
link?: Schema$Link;
/**
* Youtube video attachment.
*/
youTubeVideo?: Schema$YouTubeVideo;
}
/**
* A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
*/
export interface Schema$CourseMaterialSet {
/**
* Materials attached to this set.
*/
materials?: Schema$CourseMaterial[];
/**
* Title for this set.
*/
title?: string | null;
}
/**
* Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.
*/
export interface Schema$CourseRosterChangesInfo {
/**
* The `course_id` of the course to subscribe to roster changes for.
*/
courseId?: string | null;
}
/**
* Course work created by a teacher for students of the course.
*/
export interface Schema$CourseWork {
/**
* Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
*/
alternateLink?: string | null;
/**
* Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`.
*/
assigneeMode?: string | null;
/**
* Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only.
*/
assignment?: Schema$Assignment;
/**
* Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
*/
associatedWithDeveloper?: boolean | null;
/**
* Identifier of the course. Read-only.
*/
courseId?: string | null;
/**
* Timestamp when this course work was created. Read-only.
*/
creationTime?: string | null;
/**
* Identifier for the user that created the coursework. Read-only.
*/
creatorUserId?: string | null;
/**
* Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
*/
description?: string | null;
/**
* Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified.
*/
dueDate?: Schema$Date;
/**
* Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified.
*/
dueTime?: Schema$TimeOfDay;
/**
* Classroom-assigned identifier of this course work, unique per course. Read-only.
*/
id?: string | null;
/**
* Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field will be assigned the coursework.
*/
individualStudentsOptions?: Schema$IndividualStudentsOptions;
/**
* Additional materials. CourseWork must have no more than 20 material items.
*/
materials?: Schema$Material[];
/**
* Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
*/
maxPoints?: number | null;
/**
* Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.
*/
multipleChoiceQuestion?: Schema$MultipleChoiceQuestion;
/**
* Optional timestamp when this course work is scheduled to be published.
*/
scheduledTime?: string | null;
/**
* Status of this course work. If unspecified, the default state is `DRAFT`.
*/
state?: string | null;
/**
* Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
*/
submissionModificationMode?: string | null;
/**
* Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
*/
title?: string | null;
/**
* Identifier for the topic that this coursework is associated with. Must match an existing topic in the course.
*/
topicId?: string | null;
/**
* Timestamp of the most recent change to this course work. Read-only.
*/
updateTime?: string | null;
/**
* Type of this course work. The type is set when the course work is created and cannot be changed.
*/
workType?: string | null;
}
/**
* Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`.
*/
export interface Schema$CourseWorkChangesInfo {
/**
* The `course_id` of the course to subscribe to work changes for.
*/
courseId?: string | null;
}
/**
* Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
export interface Schema$Date {
/**
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
*/
day?: number | null;
/**
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
*/
month?: number | null;
/**
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
*/
year?: number | null;
}
/**
* Representation of a Google Drive file.
*/
export interface Schema$DriveFile {
/**
* URL that can be used to access the Drive item. Read-only.
*/
alternateLink?: string | null;
/**
* Drive API resource ID.
*/
id?: string | null;
/**
* URL of a thumbnail image of the Drive item. Read-only.
*/
thumbnailUrl?: string | null;
/**
* Title of the Drive item. Read-only.
*/
title?: string | null;
}
/**
* Representation of a Google Drive folder.
*/
export interface Schema$DriveFolder {
/**
* URL that can be used to access the Drive folder. Read-only.
*/
alternateLink?: string | null;
/**
* Drive API resource ID.
*/
id?: string | null;
/**
* Title of the Drive folder. Read-only.
*/
title?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {
}
/**
* A class of notifications that an application can register to receive. For example: "all roster changes for a domain".
*/
export interface Schema$Feed {
/**
* Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. This field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`.
*/
courseRosterChangesInfo?: Schema$CourseRosterChangesInfo;
/**
* Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`. This field must be specified if `feed_type` is `COURSE_WORK_CHANGES`.
*/
courseWorkChangesInfo?: Schema$CourseWorkChangesInfo;
/**
* The type of feed.
*/
feedType?: string | null;
}
/**
* Google Forms item.
*/
export interface Schema$Form {
/**
* URL of the form.
*/
formUrl?: string | null;
/**
* URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
*/
responseUrl?: string | null;
/**
* URL of a thumbnail image of the Form. Read-only.
*/
thumbnailUrl?: string | null;
/**
* Title of the Form. Read-only.
*/
title?: string | null;
}
/**
* Global user permission description.
*/
export interface Schema$GlobalPermission {
/**
* Permission value.
*/
permission?: string | null;
}
/**
* The history of each grade on this submission.
*/
export interface Schema$GradeHistory {
/**
* The teacher who made the grade change.
*/
actorUserId?: string | null;
/**
* The type of grade change at this time in the submission grade history.
*/
gradeChangeType?: string | null;
/**
* When the grade of the submission was changed.
*/
gradeTimestamp?: string | null;
/**
* The denominator of the grade at this time in the submission grade history.
*/
maxPoints?: number | null;
/**
* The numerator of the grade at this time in the submission grade history.
*/
pointsEarned?: number | null;
}
/**
* Association between a student and a guardian of that student. The guardian may receive information about the student's course work.
*/
export interface Schema$Guardian {
/**
* Identifier for the guardian.
*/
guardianId?: string | null;
/**
* User profile for the guardian.
*/
guardianProfile?: Schema$UserProfile;
/**
* The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.
*/
invitedEmailAddress?: string | null;
/**
* Identifier for the student to whom the guardian relationship applies.
*/
studentId?: string | null;
}
/**
* An invitation to become the guardian of a specified user, sent to a specified email address.
*/
export interface Schema$GuardianInvitation {
/**
* The time that this invitation was created. Read-only.
*/
creationTime?: string | null;
/**
* Unique identifier for this invitation. Read-only.
*/
invitationId?: string | null;
/**
* Email address that the invitation was sent to. This field is only visible to domain administrators.
*/
invitedEmailAddress?: string | null;
/**
* The state that this invitation is in.
*/
state?: string | null;
/**
* ID of the student (in standard format)
*/
studentId?: string | null;
}
/**
* Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
*/
export interface Schema$IndividualStudentsOptions {
/**
* Identifiers for the students that have access to the coursework/announcement.
*/
studentIds?: string[] | null;
}
/**
* An invitation to join a course.
*/
export interface Schema$Invitation {
/**
* Identifier of the course to invite the user to.
*/
courseId?: string | null;
/**
* Identifier assigned by Classroom. Read-only.
*/
id?: string | null;
/**
* Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
*/
role?: string | null;
/**
* Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string | null;
}
/**
* URL item.
*/
export interface Schema$Link {
/**
* URL of a thumbnail image of the target URL. Read-only.
*/
thumbnailUrl?: string | null;
/**
* Title of the target of the URL. Read-only.
*/
title?: string | null;
/**
* URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
*/
url?: string | null;
}
/**
* Response when listing course work.
*/
export interface Schema$ListAnnouncementsResponse {
/**
* Announcement items that match the request.
*/
announcements?: Schema$Announcement[];
/**
* Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string | null;
}
/**
* Response when listing course aliases.
*/
export interface Schema$ListCourseAliasesResponse {
/**
* The course aliases.
*/
aliases?: Schema$CourseAlias[];
/**
* Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string | null;
}
/**
* Response when listing courses.
*/
export interface Schema$ListCoursesResponse {
/**
* Courses that match the list request.
*/
courses?: Schema$Course[];
/**
* Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string | null;
}
/**
* Response when listing course work.
*/
export interface Schema$ListCourseWorkResponse {
/**
* Course work items that match the request.
*/
courseWork?: Schema$CourseWork[];
/**
* Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string | null;
}
/**
* Response when listing guardian invitations.
*/
export interface Schema$ListGuardianInvitationsResponse {
/**
* Guardian invitations that matched the list request.
*/
guardianInvitations?: Schema$GuardianInvitation[];
/**
* Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string | null;
}
/**
* Response when listing guardians.
*/
export interface Schema$ListGuardiansResponse {
/**
* Guardians on this page of results that met the criteria specified in the request.
*/
guardians?: Schema$Guardian[];
/**
* Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string | null;
}
/**
* Response when listing invitations.
*/
export interface Schema$ListInvitationsResponse {
/**
* Invitations that match the list request.
*/
invitations?: Schema$Invitation[];
/**
* Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string | null;
}
/**
* Response when listing students.
*/
export interface Schema$ListStudentsResponse {
/**
* Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string | null;
/**
* Students who match the list request.
*/
students?: Schema$Student[];
}
/**
* Response when listing student submissions.
*/
export interface Schema$ListStudentSubmissionsResponse {
/**
* Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string | null;
/**
* Student work that matches the request.
*/
studentSubmissions?: Schema$StudentSubmission[];
}
/**
* Response when listing teachers.
*/
export interface Schema$ListTeachersResponse {
/**
* Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string | null;
/**
* Teachers who match the list request.
*/
teachers?: Schema$Teacher[];
}
/**
* Response when listing topics.
*/
export interface Schema$ListTopicResponse {
/**
* Token identifying the next page of results to return. If empty, no further results are available.
*/
nextPageToken?: string | null;
/**
* Topic items that match the request.
*/
topic?: Schema$Topic[];
}
/**
* Material attached to course work. When creating attachments, setting the `form` field is not supported.
*/
export interface Schema$Material {
/**
* Google Drive file material.
*/
driveFile?: Schema$SharedDriveFile;
/**
* Google Forms material.
*/
form?: Schema$Form;
/**
* Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the response.
*/
link?: Schema$Link;
/**
* YouTube video material.
*/
youtubeVideo?: Schema$YouTubeVideo;
}
/**
* Request to modify assignee mode and options of an announcement.
*/
export interface Schema$ModifyAnnouncementAssigneesRequest {
/**
* Mode of the announcement describing whether it will be accessible by all students or specified individual students.
*/
assigneeMode?: string | null;
/**
* Set which students can view or cannot view the announcement. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.
*/
modifyIndividualStudentsOptions?: Schema$ModifyIndividualStudentsOptions;
}
/**
* Request to modify the attachments of a student submission.
*/
export interface Schema$ModifyAttachmentsRequest {
/**
* Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported.
*/
addAttachments?: Schema$Attachment[];
}
/**
* Request to modify assignee mode and options of a coursework.
*/
export interface Schema$ModifyCourseWorkAssigneesRequest {
/**
* Mode of the coursework describing whether it will be assigned to all students or specified individual students.
*/
assigneeMode?: string | null;
/**
* Set which students are assigned or not assigned to the coursework. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.
*/
modifyIndividualStudentsOptions?: Schema$ModifyIndividualStudentsOptions;
}
/**
* Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.
*/
export interface Schema$ModifyIndividualStudentsOptions {
/**
* Ids of students to be added as having access to this coursework/announcement.
*/
addStudentIds?: string[] | null;
/**
* Ids of students to be removed from having access to this coursework/announcement.
*/
removeStudentIds?: string[] | null;
}
/**
* Additional details for multiple-choice questions.
*/
export interface Schema$MultipleChoiceQuestion {
/**
* Possible choices.
*/
choices?: string[] | null;
}
/**
* Student work for a multiple-choice question.
*/
export interface Schema$MultipleChoiceSubmission {
/**
* Student's select choice.
*/
answer?: string | null;
}
/**
* Details of the user's name.
*/
export interface Schema$Name {
/**
* The user's last name. Read-only.
*/
familyName?: string | null;
/**
* The user's full name formed by concatenating the first and last name values. Read-only.
*/
fullName?: string | null;
/**
* The user's first name. Read-only.
*/
givenName?: string | null;
}
/**
* Request to reclaim a student submission.
*/
export interface Schema$ReclaimStudentSubmissionRequest {
}
/**
* An instruction to Classroom to send notifications from the `feed` to the provided destination.
*/
export interface Schema$Registration {
/**
* The Cloud Pub/Sub topic that notifications are to be sent to.
*/
cloudPubsubTopic?: Schema$CloudPubsubTopic;
/**
* The time until which the `Registration` is effective. This is a read-only field assigned by the server.
*/
expiryTime?: string | null;
/**
* Specification for the class of notifications that Classroom should deliver to the destination.
*/
feed?: Schema$Feed;
/**
* A server-generated unique identifier for this `Registration`. Read-only.
*/
registrationId?: string | null;
}
/**
* Request to return a student submission.
*/
export interface Schema$ReturnStudentSubmissionRequest {
}
/**
* Drive file that is used as material for course work.
*/
export interface Schema$SharedDriveFile {
/**
* Drive file details.
*/
driveFile?: Schema$DriveFile;
/**
* Mechanism by which students access the Drive item.
*/
shareMode?: string | null;
}
/**
* Student work for a short answer question.
*/
export interface Schema$ShortAnswerSubmission {
/**
* Student response to a short-answer question.
*/
answer?: string | null;
}
/**
* The history of each state this submission has been in.
*/
export interface Schema$StateHistory {
/**
* The teacher or student who made the change
*/
actorUserId?: string | null;
/**
* The workflow pipeline stage.
*/
state?: string | null;
/**
* When the submission entered this state.
*/
stateTimestamp?: string | null;
}
/**
* Student in a course.
*/
export interface Schema$Student {
/**
* Identifier of the course. Read-only.
*/
courseId?: string | null;
/**
* Global user information for the student. Read-only.
*/
profile?: Schema$UserProfile;
/**
* Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
*/
studentWorkFolder?: Schema$DriveFolder;
/**
* Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string | null;
}
/**
* Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
*/
export interface Schema$StudentSubmission {
/**
* Absolute link to the submission in the Classroom web UI. Read-only.
*/
alternateLink?: string | null;
/**
* Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This may be modified only by course teachers.
*/
assignedGrade?: number | null;
/**
* Submission content when course_work_type is ASSIGNMENT. Students can modify this content using google.classroom.Work.ModifyAttachments.
*/
assignmentSubmission?: Schema$AssignmentSubmission;
/**
* Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
*/
associatedWithDeveloper?: boolean | null;
/**
* Identifier of the course. Read-only.
*/
courseId?: string | null;
/**
* Identifier for the course work this corresponds to. Read-only.
*/
courseWorkId?: string | null;
/**
* Type of course work this submission is for. Read-only.
*/
courseWorkType?: string | null;
/**
* Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
*/
creationTime?: string | null;
/**
* Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This is only visible to and modifiable by course teachers.
*/
draftGrade?: number | null;
/**
* Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
*/
id?: string | null;
/**
* Whether this submission is late. Read-only.
*/
late?: boolean | null;
/**
* Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
*/
multipleChoiceSubmission?: Schema$MultipleChoiceSubmission;
/**
* Submission content when course_work_type is SHORT_ANSWER_QUESTION.
*/
shortAnswerSubmission?: Schema$ShortAnswerSubmission;
/**
* State of this submission. Read-only.
*/
state?: string | null;
/**
* The history of the submission (includes state and grade histories). Read-only.
*/
submissionHistory?: Schema$SubmissionHistory[];
/**
* Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
*/
updateTime?: string | null;
/**
* Identifier for the student that owns this submission. Read-only.
*/
userId?: string | null;
}
/**
* The history of the submission. This currently includes state and grade histories.
*/
export interface Schema$SubmissionHistory {
/**
* The grade history information of the submission, if present.
*/
gradeHistory?: Schema$GradeHistory;
/**
* The state history information of the submission, if present.
*/
stateHistory?: Schema$StateHistory;
}
/**
* Teacher of a course.
*/
export interface Schema$Teacher {
/**
* Identifier of the course. Read-only.
*/
courseId?: string | null;
/**
* Global user information for the teacher. Read-only.
*/
profile?: Schema$UserProfile;
/**
* Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string | null;
}
/**
* Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
*/
export interface Schema$TimeOfDay {
/**
* Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
*/
hours?: number | null;
/**
* Minutes of hour of day. Must be from 0 to 59.
*/
minutes?: number | null;
/**
* Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
*/
nanos?: number | null;
/**
* Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
*/
seconds?: number | null;
}
/**
* Topic created by a teacher for the course
*/
export interface Schema$Topic {
/**
* Identifier of the course. Read-only.
*/
courseId?: string | null;
/**
* The name of the topic, generated by the user. Leading and trailing whitespaces, if any, will be trimmed. Also, multiple consecutive whitespaces will be collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters.
*/
name?: string | null;
/**
* Unique identifier for the topic. Read-only.
*/
topicId?: string | null;
/**
* The time the topic was last updated by the system. Read-only.
*/
updateTime?: string | null;
}
/**
* Request to turn in a student submission.
*/
export interface Schema$TurnInStudentSubmissionRequest {
}
/**
* Global information for a user.
*/
export interface Schema$UserProfile {
/**
* Email address of the user. Read-only.
*/
emailAddress?: string | null;
/**
* Identifier of the user. Read-only.
*/
id?: string | null;
/**
* Name of the user. Read-only.
*/
name?: Schema$Name;
/**
* Global permissions of the user. Read-only.
*/
permissions?: Schema$GlobalPermission[];
/**
* URL of user's profile photo. Read-only.
*/
photoUrl?: string | null;
/**
* Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field will always be false. Read-only
*/
verifiedTeacher?: boolean | null;
}
/**
* YouTube video item.
*/
export interface Schema$YouTubeVideo {
/**
* URL that can be used to view the YouTube video. Read-only.
*/
alternateLink?: string | null;
/**
* YouTube API resource ID.
*/
id?: string | null;
/**
* URL of a thumbnail image of the YouTube video. Read-only.
*/
thumbnailUrl?: string | null;
/**
* Title of the YouTube video. Read-only.
*/
title?: string | null;
}
export class Resource$Courses {
context: APIRequestContext;
aliases: Resource$Courses$Aliases;
announcements: Resource$Courses$Announcements;
courseWork: Resource$Courses$Coursework;
students: Resource$Courses$Students;
teachers: Resource$Courses$Teachers;
topics: Resource$Courses$Topics;
constructor(context: APIRequestContext);
/**
* classroom.courses.create
* @desc Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.
* @alias classroom.courses.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Course} 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
*/
create(params?: Params$Resource$Courses$Create, options?: MethodOptions): GaxiosPromise<Schema$Course>;
create(params: Params$Resource$Courses$Create, options: MethodOptions | BodyResponseCallback<Schema$Course>, callback: BodyResponseCallback<Schema$Course>): void;
create(params: Params$Resource$Courses$Create, callback: BodyResponseCallback<Schema$Course>): void;
create(callback: BodyResponseCallback<Schema$Course>): void;
/**
* classroom.courses.delete
* @desc Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.
* @alias classroom.courses.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.
* @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$Courses$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Courses$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Courses$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* classroom.courses.get
* @desc Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.
* @alias classroom.courses.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.
* @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$Courses$Get, options?: MethodOptions): GaxiosPromise<Schema$Course>;
get(params: Params$Resource$Courses$Get, options: MethodOptions | BodyResponseCallback<Schema$Course>, callback: BodyResponseCallback<Schema$Course>): void;
get(params: Params$Resource$Courses$Get, callback: BodyResponseCallback<Schema$Course>): void;
get(callback: BodyResponseCallback<Schema$Course>): void;
/**
* classroom.courses.list
* @desc Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.
* @alias classroom.courses.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.courseStates Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
* @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
* @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
* @param {string=} params.studentId Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
* @param {string=} params.teacherId Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
* @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$Courses$List, options?: MethodOptions): GaxiosPromise<Schema$ListCoursesResponse>;
list(params: Params$Resource$Courses$List, options: MethodOptions | BodyResponseCallback<Schema$ListCoursesResponse>, callback: BodyResponseCallback<Schema$ListCoursesResponse>): void;
list(params: Params$Resource$Courses$List, callback: BodyResponseCallback<Schema$ListCoursesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCoursesResponse>): void;
/**
* classroom.courses.patch
* @desc Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
* @alias classroom.courses.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string=} params.updateMask Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=<field1>,<field2>,...`
* @param {().Course} 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$Courses$Patch, options?: MethodOptions): GaxiosPromise<Schema$Course>;
patch(params: Params$Resource$Courses$Patch, options: MethodOptions | BodyResponseCallback<Schema$Course>, callback: BodyResponseCallback<Schema$Course>): void;
patch(params: Params$Resource$Courses$Patch, callback: BodyResponseCallback<Schema$Course>): void;
patch(callback: BodyResponseCallback<Schema$Course>): void;
/**
* classroom.courses.update
* @desc Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
* @alias classroom.courses.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {().Course} 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$Courses$Update, options?: MethodOptions): GaxiosPromise<Schema$Course>;
update(params: Params$Resource$Courses$Update, options: MethodOptions | BodyResponseCallback<Schema$Course>, callback: BodyResponseCallback<Schema$Course>): void;
update(params: Params$Resource$Courses$Update, callback: BodyResponseCallback<Schema$Course>): void;
update(callback: BodyResponseCallback<Schema$Course>): void;
}
export interface Params$Resource$Courses$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$Course;
}
export interface Params$Resource$Courses$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.
*/
id?: string;
}
export interface Params$Resource$Courses$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.
*/
id?: string;
}
export interface Params$Resource$Courses$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
*/
courseStates?: string[];
/**
* Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
* nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
/**
* Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
studentId?: string;
/**
* Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
teacherId?: string;
}
export interface Params$Resource$Courses$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
*/
id?: string;
/**
* Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=<field1>,<field2>,...`
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Course;
}
export interface Params$Resource$Courses$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
*/
id?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Course;
}
export class Resource$Courses$Aliases {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* classroom.courses.aliases.create
* @desc Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).
* @alias classroom.courses.aliases.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {().CourseAlias} 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
*/
create(params?: Params$Resource$Courses$Aliases$Create, options?: MethodOptions): GaxiosPromise<Schema$CourseAlias>;
create(params: Params$Resource$Courses$Aliases$Create, options: MethodOptions | BodyResponseCallback<Schema$CourseAlias>, callback: BodyResponseCallback<Schema$CourseAlias>): void;
create(params: Params$Resource$Courses$Aliases$Create, callback: BodyResponseCallback<Schema$CourseAlias>): void;
create(callback: BodyResponseCallback<Schema$CourseAlias>): void;
/**
* classroom.courses.aliases.delete
* @desc Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).
* @alias classroom.courses.aliases.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.alias Alias to delete. This may not be the Classroom-assigned identifier.
* @param {string} params.courseId Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.
* @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$Courses$Aliases$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Courses$Aliases$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Courses$Aliases$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* classroom.courses.aliases.list
* @desc Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.
* @alias classroom.courses.aliases.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
* @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
* @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$Courses$Aliases$List, options?: MethodOptions): GaxiosPromise<Schema$ListCourseAliasesResponse>;
list(params: Params$Resource$Courses$Aliases$List, options: MethodOptions | BodyResponseCallback<Schema$ListCourseAliasesResponse>, callback: BodyResponseCallback<Schema$ListCourseAliasesResponse>): void;
list(params: Params$Resource$Courses$Aliases$List, callback: BodyResponseCallback<Schema$ListCourseAliasesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCourseAliasesResponse>): void;
}
export interface Params$Resource$Courses$Aliases$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CourseAlias;
}
export interface Params$Resource$Courses$Aliases$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Alias to delete. This may not be the Classroom-assigned identifier.
*/
alias?: string;
/**
* Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
}
export interface Params$Resource$Courses$Aliases$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
* nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
}
export class Resource$Courses$Announcements {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* classroom.courses.announcements.create
* @desc Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible
* @alias classroom.courses.announcements.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {().Announcement} 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
*/
create(params?: Params$Resource$Courses$Announcements$Create, options?: MethodOptions): GaxiosPromise<Schema$Announcement>;
create(params: Params$Resource$Courses$Announcements$Create, options: MethodOptions | BodyResponseCallback<Schema$Announcement>, callback: BodyResponseCallback<Schema$Announcement>): void;
create(params: Params$Resource$Courses$Announcements$Create, callback: BodyResponseCallback<Schema$Announcement>): void;
create(callback: BodyResponseCallback<Schema$Announcement>): void;
/**
* classroom.courses.announcements.delete
* @desc Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.
* @alias classroom.courses.announcements.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.id Identifier of the announcement to delete. This identifier is a Classroom-assigned 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$Courses$Announcements$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Courses$Announcements$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Courses$Announcements$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* classroom.courses.announcements.get
* @desc Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.
* @alias classroom.courses.announcements.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.id Identifier of the announcement.
* @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$Courses$Announcements$Get, options?: MethodOptions): GaxiosPromise<Schema$Announcement>;
get(params: Params$Resource$Courses$Announcements$Get, options: MethodOptions | BodyResponseCallback<Schema$Announcement>, callback: BodyResponseCallback<Schema$Announcement>): void;
get(params: Params$Resource$Courses$Announcements$Get, callback: BodyResponseCallback<Schema$Announcement>): void;
get(callback: BodyResponseCallback<Schema$Announcement>): void;
/**
* classroom.courses.announcements.list
* @desc Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
* @alias classroom.courses.announcements.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.announcementStates Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`.
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string=} params.orderBy Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`
* @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
* @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
* @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$Courses$Announcements$List, options?: MethodOptions): GaxiosPromise<Schema$ListAnnouncementsResponse>;
list(params: Params$Resource$Courses$Announcements$List, options: MethodOptions | BodyResponseCallback<Schema$ListAnnouncementsResponse>, callback: BodyResponseCallback<Schema$ListAnnouncementsResponse>): void;
list(params: Params$Resource$Courses$Announcements$List, callback: BodyResponseCallback<Schema$ListAnnouncementsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAnnouncementsResponse>): void;
/**
* classroom.courses.announcements.modifyAssignees
* @desc Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
* @alias classroom.courses.announcements.modifyAssignees
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.id Identifier of the announcement.
* @param {().ModifyAnnouncementAssigneesRequest} 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
*/
modifyAssignees(params?: Params$Resource$Courses$Announcements$Modifyassignees, options?: MethodOptions): GaxiosPromise<Schema$Announcement>;
modifyAssignees(params: Params$Resource$Courses$Announcements$Modifyassignees, options: MethodOptions | BodyResponseCallback<Schema$Announcement>, callback: BodyResponseCallback<Schema$Announcement>): void;
modifyAssignees(params: Params$Resource$Courses$Announcements$Modifyassignees, callback: BodyResponseCallback<Schema$Announcement>): void;
modifyAssignees(callback: BodyResponseCallback<Schema$Announcement>): void;
/**
* classroom.courses.announcements.patch
* @desc Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist
* @alias classroom.courses.announcements.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.id Identifier of the announcement.
* @param {string=} params.updateMask Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time`
* @param {().Announcement} 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$Courses$Announcements$Patch, options?: MethodOptions): GaxiosPromise<Schema$Announcement>;
patch(params: Params$Resource$Courses$Announcements$Patch, options: MethodOptions | BodyResponseCallback<Schema$Announcement>, callback: BodyResponseCallback<Schema$Announcement>): void;
patch(params: Params$Resource$Courses$Announcements$Patch, callback: BodyResponseCallback<Schema$Announcement>): void;
patch(callback: BodyResponseCallback<Schema$Announcement>): void;
}
export interface Params$Resource$Courses$Announcements$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Announcement;
}
export interface Params$Resource$Courses$Announcements$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.
*/
id?: string;
}
export interface Params$Resource$Courses$Announcements$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the announcement.
*/
id?: string;
}
export interface Params$Resource$Courses$Announcements$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`.
*/
announcementStates?: string[];
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`
*/
orderBy?: string;
/**
* Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
* nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
}
export interface Params$Resource$Courses$Announcements$Modifyassignees extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the announcement.
*/
id?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ModifyAnnouncementAssigneesRequest;
}
export interface Params$Resource$Courses$Announcements$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the announcement.
*/
id?: string;
/**
* Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time`
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Announcement;
}
export class Resource$Courses$Coursework {
context: APIRequestContext;
studentSubmissions: Resource$Courses$Coursework$Studentsubmissions;
constructor(context: APIRequestContext);
/**
* classroom.courses.courseWork.create
* @desc Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible
* @alias classroom.courses.courseWork.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {().CourseWork} 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
*/
create(params?: Params$Resource$Courses$Coursework$Create, options?: MethodOptions): GaxiosPromise<Schema$CourseWork>;
create(params: Params$Resource$Courses$Coursework$Create, options: MethodOptions | BodyResponseCallback<Schema$CourseWork>, callback: BodyResponseCallback<Schema$CourseWork>): void;
create(params: Params$Resource$Courses$Coursework$Create, callback: BodyResponseCallback<Schema$CourseWork>): void;
create(callback: BodyResponseCallback<Schema$CourseWork>): void;
/**
* classroom.courses.courseWork.delete
* @desc Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.
* @alias classroom.courses.courseWork.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.id Identifier of the course work to delete. This identifier is a Classroom-assigned 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$Courses$Coursework$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Courses$Coursework$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Courses$Coursework$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* classroom.courses.courseWork.get
* @desc Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
* @alias classroom.courses.courseWork.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.id Identifier of the course work.
* @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$Courses$Coursework$Get, options?: MethodOptions): GaxiosPromise<Schema$CourseWork>;
get(params: Params$Resource$Courses$Coursework$Get, options: MethodOptions | BodyResponseCallback<Schema$CourseWork>, callback: BodyResponseCallback<Schema$CourseWork>): void;
get(params: Params$Resource$Courses$Coursework$Get, callback: BodyResponseCallback<Schema$CourseWork>): void;
get(callback: BodyResponseCallback<Schema$CourseWork>): void;
/**
* classroom.courses.courseWork.list
* @desc Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
* @alias classroom.courses.courseWork.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string=} params.courseWorkStates Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.
* @param {string=} params.orderBy Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`
* @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
* @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
* @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$Courses$Coursework$List, options?: MethodOptions): GaxiosPromise<Schema$ListCourseWorkResponse>;
list(params: Params$Resource$Courses$Coursework$List, options: MethodOptions | BodyResponseCallback<Schema$ListCourseWorkResponse>, callback: BodyResponseCallback<Schema$ListCourseWorkResponse>): void;
list(params: Params$Resource$Courses$Coursework$List, callback: BodyResponseCallback<Schema$ListCourseWorkResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCourseWorkResponse>): void;
/**
* classroom.courses.courseWork.modifyAssignees
* @desc Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
* @alias classroom.courses.courseWork.modifyAssignees
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.id Identifier of the coursework.
* @param {().ModifyCourseWorkAssigneesRequest} 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
*/
modifyAssignees(params?: Params$Resource$Courses$Coursework$Modifyassignees, options?: MethodOptions): GaxiosPromise<Schema$CourseWork>;
modifyAssignees(params: Params$Resource$Courses$Coursework$Modifyassignees, options: MethodOptions | BodyResponseCallback<Schema$CourseWork>, callback: BodyResponseCallback<Schema$CourseWork>): void;
modifyAssignees(params: Params$Resource$Courses$Coursework$Modifyassignees, callback: BodyResponseCallback<Schema$CourseWork>): void;
modifyAssignees(callback: BodyResponseCallback<Schema$CourseWork>): void;
/**
* classroom.courses.courseWork.patch
* @desc Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.id Identifier of the course work.
* @param {string=} params.updateMask Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id`
* @param {().CourseWork} 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$Courses$Coursework$Patch, options?: MethodOptions): GaxiosPromise<Schema$CourseWork>;
patch(params: Params$Resource$Courses$Coursework$Patch, options: MethodOptions | BodyResponseCallback<Schema$CourseWork>, callback: BodyResponseCallback<Schema$CourseWork>): void;
patch(params: Params$Resource$Courses$Coursework$Patch, callback: BodyResponseCallback<Schema$CourseWork>): void;
patch(callback: BodyResponseCallback<Schema$CourseWork>): void;
}
export interface Params$Resource$Courses$Coursework$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CourseWork;
}
export interface Params$Resource$Courses$Coursework$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.
*/
id?: string;
}
export interface Params$Resource$Courses$Coursework$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the course work.
*/
id?: string;
}
export interface Params$Resource$Courses$Coursework$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.
*/
courseWorkStates?: string[];
/**
* Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`
*/
orderBy?: string;
/**
* Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
* nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
}
export interface Params$Resource$Courses$Coursework$Modifyassignees extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the coursework.
*/
id?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ModifyCourseWorkAssigneesRequest;
}
export interface Params$Resource$Courses$Coursework$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the course work.
*/
id?: string;
/**
* Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id`
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CourseWork;
}
export class Resource$Courses$Coursework$Studentsubmissions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* classroom.courses.courseWork.studentSubmissions.get
* @desc Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.courseWorkId Identifier of the course work.
* @param {string} params.id Identifier of the student submission.
* @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$Courses$Coursework$Studentsubmissions$Get, options?: MethodOptions): GaxiosPromise<Schema$StudentSubmission>;
get(params: Params$Resource$Courses$Coursework$Studentsubmissions$Get, options: MethodOptions | BodyResponseCallback<Schema$StudentSubmission>, callback: BodyResponseCallback<Schema$StudentSubmission>): void;
get(params: Params$Resource$Courses$Coursework$Studentsubmissions$Get, callback: BodyResponseCallback<Schema$StudentSubmission>): void;
get(callback: BodyResponseCallback<Schema$StudentSubmission>): void;
/**
* classroom.courses.courseWork.studentSubmissions.list
* @desc Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.courseWorkId Identifier of the student work to request. This may be set to the string literal `"-"` to request student work for all course work in the specified course.
* @param {string=} params.late Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.
* @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
* @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
* @param {string=} params.states Requested submission states. If specified, returned student submissions match one of the specified submission states.
* @param {string=} params.userId Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
* @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$Courses$Coursework$Studentsubmissions$List, options?: MethodOptions): GaxiosPromise<Schema$ListStudentSubmissionsResponse>;
list(params: Params$Resource$Courses$Coursework$Studentsubmissions$List, options: MethodOptions | BodyResponseCallback<Schema$ListStudentSubmissionsResponse>, callback: BodyResponseCallback<Schema$ListStudentSubmissionsResponse>): void;
list(params: Params$Resource$Courses$Coursework$Studentsubmissions$List, callback: BodyResponseCallback<Schema$ListStudentSubmissionsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListStudentSubmissionsResponse>): void;
/**
* classroom.courses.courseWork.studentSubmissions.modifyAttachments
* @desc Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.modifyAttachments
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.courseWorkId Identifier of the course work.
* @param {string} params.id Identifier of the student submission.
* @param {().ModifyAttachmentsRequest} 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
*/
modifyAttachments(params?: Params$Resource$Courses$Coursework$Studentsubmissions$Modifyattachments, options?: MethodOptions): GaxiosPromise<Schema$StudentSubmission>;
modifyAttachments(params: Params$Resource$Courses$Coursework$Studentsubmissions$Modifyattachments, options: MethodOptions | BodyResponseCallback<Schema$StudentSubmission>, callback: BodyResponseCallback<Schema$StudentSubmission>): void;
modifyAttachments(params: Params$Resource$Courses$Coursework$Studentsubmissions$Modifyattachments, callback: BodyResponseCallback<Schema$StudentSubmission>): void;
modifyAttachments(callback: BodyResponseCallback<Schema$StudentSubmission>): void;
/**
* classroom.courses.courseWork.studentSubmissions.patch
* @desc Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.courseWorkId Identifier of the course work.
* @param {string} params.id Identifier of the student submission.
* @param {string=} params.updateMask Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade`
* @param {().StudentSubmission} 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$Courses$Coursework$Studentsubmissions$Patch, options?: MethodOptions): GaxiosPromise<Schema$StudentSubmission>;
patch(params: Params$Resource$Courses$Coursework$Studentsubmissions$Patch, options: MethodOptions | BodyResponseCallback<Schema$StudentSubmission>, callback: BodyResponseCallback<Schema$StudentSubmission>): void;
patch(params: Params$Resource$Courses$Coursework$Studentsubmissions$Patch, callback: BodyResponseCallback<Schema$StudentSubmission>): void;
patch(callback: BodyResponseCallback<Schema$StudentSubmission>): void;
/**
* classroom.courses.courseWork.studentSubmissions.reclaim
* @desc Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.reclaim
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.courseWorkId Identifier of the course work.
* @param {string} params.id Identifier of the student submission.
* @param {().ReclaimStudentSubmissionRequest} 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
*/
reclaim(params?: Params$Resource$Courses$Coursework$Studentsubmissions$Reclaim, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
reclaim(params: Params$Resource$Courses$Coursework$Studentsubmissions$Reclaim, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
reclaim(params: Params$Resource$Courses$Coursework$Studentsubmissions$Reclaim, callback: BodyResponseCallback<Schema$Empty>): void;
reclaim(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* classroom.courses.courseWork.studentSubmissions.return
* @desc Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.return
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.courseWorkId Identifier of the course work.
* @param {string} params.id Identifier of the student submission.
* @param {().ReturnStudentSubmissionRequest} 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
*/
return(params?: Params$Resource$Courses$Coursework$Studentsubmissions$Return, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
return(params: Params$Resource$Courses$Coursework$Studentsubmissions$Return, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
return(params: Params$Resource$Courses$Coursework$Studentsubmissions$Return, callback: BodyResponseCallback<Schema$Empty>): void;
return(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* classroom.courses.courseWork.studentSubmissions.turnIn
* @desc Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
* @alias classroom.courses.courseWork.studentSubmissions.turnIn
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.courseWorkId Identifier of the course work.
* @param {string} params.id Identifier of the student submission.
* @param {().TurnInStudentSubmissionRequest} 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
*/
turnIn(params?: Params$Resource$Courses$Coursework$Studentsubmissions$Turnin, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
turnIn(params: Params$Resource$Courses$Coursework$Studentsubmissions$Turnin, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
turnIn(params: Params$Resource$Courses$Coursework$Studentsubmissions$Turnin, callback: BodyResponseCallback<Schema$Empty>): void;
turnIn(callback: BodyResponseCallback<Schema$Empty>): void;
}
export interface Params$Resource$Courses$Coursework$Studentsubmissions$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the course work.
*/
courseWorkId?: string;
/**
* Identifier of the student submission.
*/
id?: string;
}
export interface Params$Resource$Courses$Coursework$Studentsubmissions$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the student work to request. This may be set to the string literal `"-"` to request student work for all course work in the specified course.
*/
courseWorkId?: string;
/**
* Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.
*/
late?: string;
/**
* Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
* nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
/**
* Requested submission states. If specified, returned student submissions match one of the specified submission states.
*/
states?: string[];
/**
* Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
export interface Params$Resource$Courses$Coursework$Studentsubmissions$Modifyattachments extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the course work.
*/
courseWorkId?: string;
/**
* Identifier of the student submission.
*/
id?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ModifyAttachmentsRequest;
}
export interface Params$Resource$Courses$Coursework$Studentsubmissions$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the course work.
*/
courseWorkId?: string;
/**
* Identifier of the student submission.
*/
id?: string;
/**
* Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade`
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$StudentSubmission;
}
export interface Params$Resource$Courses$Coursework$Studentsubmissions$Reclaim extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the course work.
*/
courseWorkId?: string;
/**
* Identifier of the student submission.
*/
id?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ReclaimStudentSubmissionRequest;
}
export interface Params$Resource$Courses$Coursework$Studentsubmissions$Return extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the course work.
*/
courseWorkId?: string;
/**
* Identifier of the student submission.
*/
id?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ReturnStudentSubmissionRequest;
}
export interface Params$Resource$Courses$Coursework$Studentsubmissions$Turnin extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the course work.
*/
courseWorkId?: string;
/**
* Identifier of the student submission.
*/
id?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TurnInStudentSubmissionRequest;
}
export class Resource$Courses$Students {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* classroom.courses.students.create
* @desc Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.
* @alias classroom.courses.students.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string=} params.enrollmentCode Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.
* @param {().Student} 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
*/
create(params?: Params$Resource$Courses$Students$Create, options?: MethodOptions): GaxiosPromise<Schema$Student>;
create(params: Params$Resource$Courses$Students$Create, options: MethodOptions | BodyResponseCallback<Schema$Student>, callback: BodyResponseCallback<Schema$Student>): void;
create(params: Params$Resource$Courses$Students$Create, callback: BodyResponseCallback<Schema$Student>): void;
create(callback: BodyResponseCallback<Schema$Student>): void;
/**
* classroom.courses.students.delete
* @desc Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
* @alias classroom.courses.students.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.userId Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
* @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$Courses$Students$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Courses$Students$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Courses$Students$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* classroom.courses.students.get
* @desc Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
* @alias classroom.courses.students.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.userId Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
* @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$Courses$Students$Get, options?: MethodOptions): GaxiosPromise<Schema$Student>;
get(params: Params$Resource$Courses$Students$Get, options: MethodOptions | BodyResponseCallback<Schema$Student>, callback: BodyResponseCallback<Schema$Student>): void;
get(params: Params$Resource$Courses$Students$Get, callback: BodyResponseCallback<Schema$Student>): void;
get(callback: BodyResponseCallback<Schema$Student>): void;
/**
* classroom.courses.students.list
* @desc Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.
* @alias classroom.courses.students.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {integer=} params.pageSize Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
* @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
* @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$Courses$Students$List, options?: MethodOptions): GaxiosPromise<Schema$ListStudentsResponse>;
list(params: Params$Resource$Courses$Students$List, options: MethodOptions | BodyResponseCallback<Schema$ListStudentsResponse>, callback: BodyResponseCallback<Schema$ListStudentsResponse>): void;
list(params: Params$Resource$Courses$Students$List, callback: BodyResponseCallback<Schema$ListStudentsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListStudentsResponse>): void;
}
export interface Params$Resource$Courses$Students$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.
*/
enrollmentCode?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Student;
}
export interface Params$Resource$Courses$Students$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
export interface Params$Resource$Courses$Students$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
export interface Params$Resource$Courses$Students$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
* nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
}
export class Resource$Courses$Teachers {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* classroom.courses.teachers.create
* @desc Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.
* @alias classroom.courses.teachers.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {().Teacher} 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
*/
create(params?: Params$Resource$Courses$Teachers$Create, options?: MethodOptions): GaxiosPromise<Schema$Teacher>;
create(params: Params$Resource$Courses$Teachers$Create, options: MethodOptions | BodyResponseCallback<Schema$Teacher>, callback: BodyResponseCallback<Schema$Teacher>): void;
create(params: Params$Resource$Courses$Teachers$Create, callback: BodyResponseCallback<Schema$Teacher>): void;
create(callback: BodyResponseCallback<Schema$Teacher>): void;
/**
* classroom.courses.teachers.delete
* @desc Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.
* @alias classroom.courses.teachers.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.userId Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
* @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$Courses$Teachers$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Courses$Teachers$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Courses$Teachers$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* classroom.courses.teachers.get
* @desc Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.
* @alias classroom.courses.teachers.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.userId Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
* @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$Courses$Teachers$Get, options?: MethodOptions): GaxiosPromise<Schema$Teacher>;
get(params: Params$Resource$Courses$Teachers$Get, options: MethodOptions | BodyResponseCallback<Schema$Teacher>, callback: BodyResponseCallback<Schema$Teacher>): void;
get(params: Params$Resource$Courses$Teachers$Get, callback: BodyResponseCallback<Schema$Teacher>): void;
get(callback: BodyResponseCallback<Schema$Teacher>): void;
/**
* classroom.courses.teachers.list
* @desc Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.
* @alias classroom.courses.teachers.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {integer=} params.pageSize Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
* @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
* @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$Courses$Teachers$List, options?: MethodOptions): GaxiosPromise<Schema$ListTeachersResponse>;
list(params: Params$Resource$Courses$Teachers$List, options: MethodOptions | BodyResponseCallback<Schema$ListTeachersResponse>, callback: BodyResponseCallback<Schema$ListTeachersResponse>): void;
list(params: Params$Resource$Courses$Teachers$List, callback: BodyResponseCallback<Schema$ListTeachersResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTeachersResponse>): void;
}
export interface Params$Resource$Courses$Teachers$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Teacher;
}
export interface Params$Resource$Courses$Teachers$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
export interface Params$Resource$Courses$Teachers$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
export interface Params$Resource$Courses$Teachers$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
* nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
}
export class Resource$Courses$Topics {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* classroom.courses.topics.create
* @desc Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
* @alias classroom.courses.topics.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {().Topic} 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
*/
create(params?: Params$Resource$Courses$Topics$Create, options?: MethodOptions): GaxiosPromise<Schema$Topic>;
create(params: Params$Resource$Courses$Topics$Create, options: MethodOptions | BodyResponseCallback<Schema$Topic>, callback: BodyResponseCallback<Schema$Topic>): void;
create(params: Params$Resource$Courses$Topics$Create, callback: BodyResponseCallback<Schema$Topic>): void;
create(callback: BodyResponseCallback<Schema$Topic>): void;
/**
* classroom.courses.topics.delete
* @desc Deletes a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID.
* @alias classroom.courses.topics.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.id Identifier of the topic to delete.
* @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$Courses$Topics$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Courses$Topics$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Courses$Topics$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* classroom.courses.topics.get
* @desc Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist.
* @alias classroom.courses.topics.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course.
* @param {string} params.id Identifier of the topic.
* @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$Courses$Topics$Get, options?: MethodOptions): GaxiosPromise<Schema$Topic>;
get(params: Params$Resource$Courses$Topics$Get, options: MethodOptions | BodyResponseCallback<Schema$Topic>, callback: BodyResponseCallback<Schema$Topic>): void;
get(params: Params$Resource$Courses$Topics$Get, callback: BodyResponseCallback<Schema$Topic>): void;
get(callback: BodyResponseCallback<Schema$Topic>): void;
/**
* classroom.courses.topics.list
* @desc Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
* @alias classroom.courses.topics.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
* @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
* @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$Courses$Topics$List, options?: MethodOptions): GaxiosPromise<Schema$ListTopicResponse>;
list(params: Params$Resource$Courses$Topics$List, options: MethodOptions | BodyResponseCallback<Schema$ListTopicResponse>, callback: BodyResponseCallback<Schema$ListTopicResponse>): void;
list(params: Params$Resource$Courses$Topics$List, callback: BodyResponseCallback<Schema$ListTopicResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTopicResponse>): void;
/**
* classroom.courses.topics.patch
* @desc Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist
* @alias classroom.courses.topics.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
* @param {string} params.id Identifier of the topic.
* @param {string=} params.updateMask Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified: * `name`
* @param {().Topic} 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$Courses$Topics$Patch, options?: MethodOptions): GaxiosPromise<Schema$Topic>;
patch(params: Params$Resource$Courses$Topics$Patch, options: MethodOptions | BodyResponseCallback<Schema$Topic>, callback: BodyResponseCallback<Schema$Topic>): void;
patch(params: Params$Resource$Courses$Topics$Patch, callback: BodyResponseCallback<Schema$Topic>): void;
patch(callback: BodyResponseCallback<Schema$Topic>): void;
}
export interface Params$Resource$Courses$Topics$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Topic;
}
export interface Params$Resource$Courses$Topics$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the topic to delete.
*/
id?: string;
}
export interface Params$Resource$Courses$Topics$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course.
*/
courseId?: string;
/**
* Identifier of the topic.
*/
id?: string;
}
export interface Params$Resource$Courses$Topics$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
* nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
}
export interface Params$Resource$Courses$Topics$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
*/
courseId?: string;
/**
* Identifier of the topic.
*/
id?: string;
/**
* Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified: * `name`
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Topic;
}
export class Resource$Invitations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* classroom.invitations.accept
* @desc Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.
* @alias classroom.invitations.accept
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Identifier of the invitation to accept.
* @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
*/
accept(params?: Params$Resource$Invitations$Accept, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
accept(params: Params$Resource$Invitations$Accept, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
accept(params: Params$Resource$Invitations$Accept, callback: BodyResponseCallback<Schema$Empty>): void;
accept(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* classroom.invitations.create
* @desc Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.
* @alias classroom.invitations.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Invitation} 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
*/
create(params?: Params$Resource$Invitations$Create, options?: MethodOptions): GaxiosPromise<Schema$Invitation>;
create(params: Params$Resource$Invitations$Create, options: MethodOptions | BodyResponseCallback<Schema$Invitation>, callback: BodyResponseCallback<Schema$Invitation>): void;
create(params: Params$Resource$Invitations$Create, callback: BodyResponseCallback<Schema$Invitation>): void;
create(callback: BodyResponseCallback<Schema$Invitation>): void;
/**
* classroom.invitations.delete
* @desc Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.
* @alias classroom.invitations.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Identifier of the invitation to delete.
* @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$Invitations$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Invitations$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Invitations$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* classroom.invitations.get
* @desc Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.
* @alias classroom.invitations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Identifier of the invitation to return.
* @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$Invitations$Get, options?: MethodOptions): GaxiosPromise<Schema$Invitation>;
get(params: Params$Resource$Invitations$Get, options: MethodOptions | BodyResponseCallback<Schema$Invitation>, callback: BodyResponseCallback<Schema$Invitation>): void;
get(params: Params$Resource$Invitations$Get, callback: BodyResponseCallback<Schema$Invitation>): void;
get(callback: BodyResponseCallback<Schema$Invitation>): void;
/**
* classroom.invitations.list
* @desc Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.
* @alias classroom.invitations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.courseId Restricts returned invitations to those for a course with the specified identifier.
* @param {integer=} params.pageSize Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
* @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
* @param {string=} params.userId Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
* @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$Invitations$List, options?: MethodOptions): GaxiosPromise<Schema$ListInvitationsResponse>;
list(params: Params$Resource$Invitations$List, options: MethodOptions | BodyResponseCallback<Schema$ListInvitationsResponse>, callback: BodyResponseCallback<Schema$ListInvitationsResponse>): void;
list(params: Params$Resource$Invitations$List, callback: BodyResponseCallback<Schema$ListInvitationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListInvitationsResponse>): void;
}
export interface Params$Resource$Invitations$Accept extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the invitation to accept.
*/
id?: string;
}
export interface Params$Resource$Invitations$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$Invitation;
}
export interface Params$Resource$Invitations$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the invitation to delete.
*/
id?: string;
}
export interface Params$Resource$Invitations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the invitation to return.
*/
id?: string;
}
export interface Params$Resource$Invitations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Restricts returned invitations to those for a course with the specified identifier.
*/
courseId?: string;
/**
* Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
* nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
/**
* Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
export class Resource$Registrations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* classroom.registrations.create
* @desc Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the credential provided does not include the appropriate scope for the requested feed. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it.
* @alias classroom.registrations.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Registration} 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
*/
create(params?: Params$Resource$Registrations$Create, options?: MethodOptions): GaxiosPromise<Schema$Registration>;
create(params: Params$Resource$Registrations$Create, options: MethodOptions | BodyResponseCallback<Schema$Registration>, callback: BodyResponseCallback<Schema$Registration>): void;
create(params: Params$Resource$Registrations$Create, callback: BodyResponseCallback<Schema$Registration>): void;
create(callback: BodyResponseCallback<Schema$Registration>): void;
/**
* classroom.registrations.delete
* @desc Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`.
* @alias classroom.registrations.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.registrationId The `registration_id` of the `Registration` to be deleted.
* @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$Registrations$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Registrations$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Registrations$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
}
export interface Params$Resource$Registrations$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$Registration;
}
export interface Params$Resource$Registrations$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The `registration_id` of the `Registration` to be deleted.
*/
registrationId?: string;
}
export class Resource$Userprofiles {
context: APIRequestContext;
guardianInvitations: Resource$Userprofiles$Guardianinvitations;
guardians: Resource$Userprofiles$Guardians;
constructor(context: APIRequestContext);
/**
* classroom.userProfiles.get
* @desc Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.
* @alias classroom.userProfiles.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.userId Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
* @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$Userprofiles$Get, options?: MethodOptions): GaxiosPromise<Schema$UserProfile>;
get(params: Params$Resource$Userprofiles$Get, options: MethodOptions | BodyResponseCallback<Schema$UserProfile>, callback: BodyResponseCallback<Schema$UserProfile>): void;
get(params: Params$Resource$Userprofiles$Get, callback: BodyResponseCallback<Schema$UserProfile>): void;
get(callback: BodyResponseCallback<Schema$UserProfile>): void;
}
export interface Params$Resource$Userprofiles$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
userId?: string;
}
export class Resource$Userprofiles$Guardianinvitations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* classroom.userProfiles.guardianInvitations.create
* @desc Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.
* @alias classroom.userProfiles.guardianInvitations.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.studentId ID of the student (in standard format)
* @param {().GuardianInvitation} 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
*/
create(params?: Params$Resource$Userprofiles$Guardianinvitations$Create, options?: MethodOptions): GaxiosPromise<Schema$GuardianInvitation>;
create(params: Params$Resource$Userprofiles$Guardianinvitations$Create, options: MethodOptions | BodyResponseCallback<Schema$GuardianInvitation>, callback: BodyResponseCallback<Schema$GuardianInvitation>): void;
create(params: Params$Resource$Userprofiles$Guardianinvitations$Create, callback: BodyResponseCallback<Schema$GuardianInvitation>): void;
create(callback: BodyResponseCallback<Schema$GuardianInvitation>): void;
/**
* classroom.userProfiles.guardianInvitations.get
* @desc Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.
* @alias classroom.userProfiles.guardianInvitations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.invitationId The `id` field of the `GuardianInvitation` being requested.
* @param {string} params.studentId The ID of the student whose guardian invitation is being requested.
* @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$Userprofiles$Guardianinvitations$Get, options?: MethodOptions): GaxiosPromise<Schema$GuardianInvitation>;
get(params: Params$Resource$Userprofiles$Guardianinvitations$Get, options: MethodOptions | BodyResponseCallback<Schema$GuardianInvitation>, callback: BodyResponseCallback<Schema$GuardianInvitation>): void;
get(params: Params$Resource$Userprofiles$Guardianinvitations$Get, callback: BodyResponseCallback<Schema$GuardianInvitation>): void;
get(callback: BodyResponseCallback<Schema$GuardianInvitation>): void;
/**
* classroom.userProfiles.guardianInvitations.list
* @desc Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.
* @alias classroom.userProfiles.guardianInvitations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.invitedEmailAddress If specified, only results with the specified `invited_email_address` will be returned.
* @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
* @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
* @param {string=} params.states If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned.
* @param {string} params.studentId The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.
* @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$Userprofiles$Guardianinvitations$List, options?: MethodOptions): GaxiosPromise<Schema$ListGuardianInvitationsResponse>;
list(params: Params$Resource$Userprofiles$Guardianinvitations$List, options: MethodOptions | BodyResponseCallback<Schema$ListGuardianInvitationsResponse>, callback: BodyResponseCallback<Schema$ListGuardianInvitationsResponse>): void;
list(params: Params$Resource$Userprofiles$Guardianinvitations$List, callback: BodyResponseCallback<Schema$ListGuardianInvitationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListGuardianInvitationsResponse>): void;
/**
* classroom.userProfiles.guardianInvitations.patch
* @desc Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.
* @alias classroom.userProfiles.guardianInvitations.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.invitationId The `id` field of the `GuardianInvitation` to be modified.
* @param {string} params.studentId The ID of the student whose guardian invitation is to be modified.
* @param {string=} params.updateMask Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=<field1>,<field2>,...`
* @param {().GuardianInvitation} 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$Userprofiles$Guardianinvitations$Patch, options?: MethodOptions): GaxiosPromise<Schema$GuardianInvitation>;
patch(params: Params$Resource$Userprofiles$Guardianinvitations$Patch, options: MethodOptions | BodyResponseCallback<Schema$GuardianInvitation>, callback: BodyResponseCallback<Schema$GuardianInvitation>): void;
patch(params: Params$Resource$Userprofiles$Guardianinvitations$Patch, callback: BodyResponseCallback<Schema$GuardianInvitation>): void;
patch(callback: BodyResponseCallback<Schema$GuardianInvitation>): void;
}
export interface Params$Resource$Userprofiles$Guardianinvitations$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* ID of the student (in standard format)
*/
studentId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GuardianInvitation;
}
export interface Params$Resource$Userprofiles$Guardianinvitations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The `id` field of the `GuardianInvitation` being requested.
*/
invitationId?: string;
/**
* The ID of the student whose guardian invitation is being requested.
*/
studentId?: string;
}
export interface Params$Resource$Userprofiles$Guardianinvitations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If specified, only results with the specified `invited_email_address` will be returned.
*/
invitedEmailAddress?: string;
/**
* Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
* nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
/**
* If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned.
*/
states?: string[];
/**
* The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.
*/
studentId?: string;
}
export interface Params$Resource$Userprofiles$Guardianinvitations$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The `id` field of the `GuardianInvitation` to be modified.
*/
invitationId?: string;
/**
* The ID of the student whose guardian invitation is to be modified.
*/
studentId?: string;
/**
* Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=<field1>,<field2>,...`
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GuardianInvitation;
}
export class Resource$Userprofiles$Guardians {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* classroom.userProfiles.guardians.delete
* @desc Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`.
* @alias classroom.userProfiles.guardians.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.guardianId The `id` field from a `Guardian`.
* @param {string} params.studentId The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
* @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$Userprofiles$Guardians$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Userprofiles$Guardians$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Userprofiles$Guardians$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* classroom.userProfiles.guardians.get
* @desc Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`.
* @alias classroom.userProfiles.guardians.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.guardianId The `id` field from a `Guardian`.
* @param {string} params.studentId The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
* @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$Userprofiles$Guardians$Get, options?: MethodOptions): GaxiosPromise<Schema$Guardian>;
get(params: Params$Resource$Userprofiles$Guardians$Get, options: MethodOptions | BodyResponseCallback<Schema$Guardian>, callback: BodyResponseCallback<Schema$Guardian>): void;
get(params: Params$Resource$Userprofiles$Guardians$Get, callback: BodyResponseCallback<Schema$Guardian>): void;
get(callback: BodyResponseCallback<Schema$Guardian>): void;
/**
* classroom.userProfiles.guardians.list
* @desc Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.
* @alias classroom.userProfiles.guardians.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.invitedEmailAddress Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.
* @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
* @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
* @param {string} params.studentId Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view.
* @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$Userprofiles$Guardians$List, options?: MethodOptions): GaxiosPromise<Schema$ListGuardiansResponse>;
list(params: Params$Resource$Userprofiles$Guardians$List, options: MethodOptions | BodyResponseCallback<Schema$ListGuardiansResponse>, callback: BodyResponseCallback<Schema$ListGuardiansResponse>): void;
list(params: Params$Resource$Userprofiles$Guardians$List, callback: BodyResponseCallback<Schema$ListGuardiansResponse>): void;
list(callback: BodyResponseCallback<Schema$ListGuardiansResponse>): void;
}
export interface Params$Resource$Userprofiles$Guardians$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The `id` field from a `Guardian`.
*/
guardianId?: string;
/**
* The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
studentId?: string;
}
export interface Params$Resource$Userprofiles$Guardians$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The `id` field from a `Guardian`.
*/
guardianId?: string;
/**
* The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
*/
studentId?: string;
}
export interface Params$Resource$Userprofiles$Guardians$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.
*/
invitedEmailAddress?: string;
/**
* Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
*/
pageSize?: number;
/**
* nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
*/
pageToken?: string;
/**
* Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view.
*/
studentId?: string;
}
export {};
}