/
v1.ts
6441 lines (6057 loc) · 251 KB
/
v1.ts
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
/**
* Copyright 2015 Google Inc. All Rights Reserved.
*
* 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 {AxiosPromise} from 'axios';
import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library';
import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from '../../shared/src';
// tslint:disable: no-any
// tslint:disable: class-name
// tslint:disable: variable-name
// tslint:disable: jsdoc-format
// tslint:disable: no-namespace
export namespace classroom_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
/**
* 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 {
_options: GlobalOptions;
google?: GoogleConfigurable;
root = this;
courses: Resource$Courses;
invitations: Resource$Invitations;
registrations: Resource$Registrations;
userProfiles: Resource$Userprofiles;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this._options = options || {};
this.google = google;
this.getRoot.bind(this);
this.courses = new Resource$Courses(this);
this.invitations = new Resource$Invitations(this);
this.registrations = new Resource$Registrations(this);
this.userProfiles = new Resource$Userprofiles(this);
}
getRoot() {
return this.root;
}
}
/**
* 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;
/**
* Assignee mode of the announcement. If unspecified, the default value is
* `ALL_STUDENTS`.
*/
assigneeMode?: string;
/**
* Identifier of the course. Read-only.
*/
courseId?: string;
/**
* Timestamp when this announcement was created. Read-only.
*/
creationTime?: string;
/**
* Identifier for the user that created the announcement. Read-only.
*/
creatorUserId?: string;
/**
* Classroom-assigned identifier of this announcement, unique per course.
* Read-only.
*/
id?: string;
/**
* 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;
/**
* Status of this announcement. If unspecified, the default state is
* `DRAFT`.
*/
state?: string;
/**
* Description of this announcement. The text must be a valid UTF-8 string
* containing no more than 30,000 characters.
*/
text?: string;
/**
* Timestamp of the most recent change to this announcement. Read-only.
*/
updateTime?: string;
}
/**
* 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;
}
/**
* A Course in Classroom.
*/
export interface Schema$Course {
/**
* Absolute link to this course in the Classroom web UI. Read-only.
*/
alternateLink?: string;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* Creation time of the course. Specifying this field in a course update
* mask results in an error. Read-only.
*/
creationTime?: string;
/**
* 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;
/**
* 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;
/**
* Enrollment code to use when joining this course. Specifying this field in
* a course update mask results in an error. Read-only.
*/
enrollmentCode?: string;
/**
* Whether or not guardian notifications are enabled for this course.
* Read-only.
*/
guardiansEnabled?: boolean;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
/**
* Assignee mode of the coursework. If unspecified, the default value is
* `ALL_STUDENTS`.
*/
assigneeMode?: string;
/**
* 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;
/**
* Identifier of the course. Read-only.
*/
courseId?: string;
/**
* Timestamp when this course work was created. Read-only.
*/
creationTime?: string;
/**
* Identifier for the user that created the coursework. Read-only.
*/
creatorUserId?: string;
/**
* 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;
/**
* Optional date, in UTC, that submissions for this 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 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;
/**
* 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;
/**
* 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;
/**
* Status of this course work. If unspecified, the default state is `DRAFT`.
*/
state?: string;
/**
* Setting to determine when students are allowed to modify submissions. If
* unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
*/
submissionModificationMode?: string;
/**
* Title of this course work. The title must be a valid UTF-8 string
* containing between 1 and 3000 characters.
*/
title?: string;
/**
* Timestamp of the most recent change to this course work. Read-only.
*/
updateTime?: string;
/**
* Type of this course work. The type is set when the course work is
* created and cannot be changed.
*/
workType?: string;
}
/**
* Represents a whole calendar date, e.g. date of birth. The time of day and
* time zone are either specified elsewhere or are not significant. The date
* is relative to the Proleptic Gregorian Calendar. The day may be 0 to
* represent a year and month where the day is not significant, e.g. credit
* card expiration date. The year may be 0 to represent a month and day
* independent of year, e.g. anniversary 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/month where the day is not significant.
*/
day?: number;
/**
* Month of year. Must be from 1 to 12, or 0 if specifying a date without a
* month.
*/
month?: number;
/**
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without a
* year.
*/
year?: number;
}
/**
* Representation of a Google Drive file.
*/
export interface Schema$DriveFile {
/**
* URL that can be used to access the Drive item. Read-only.
*/
alternateLink?: string;
/**
* Drive API resource ID.
*/
id?: string;
/**
* URL of a thumbnail image of the Drive item. Read-only.
*/
thumbnailUrl?: string;
/**
* Title of the Drive item. Read-only.
*/
title?: string;
}
/**
* Representation of a Google Drive folder.
*/
export interface Schema$DriveFolder {
/**
* URL that can be used to access the Drive folder. Read-only.
*/
alternateLink?: string;
/**
* Drive API resource ID.
*/
id?: string;
/**
* Title of the Drive folder. Read-only.
*/
title?: string;
}
/**
* 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;
/**
* The type of feed.
*/
feedType?: string;
}
/**
* Google Forms item.
*/
export interface Schema$Form {
/**
* URL of the form.
*/
formUrl?: string;
/**
* 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;
/**
* URL of a thumbnail image of the Form. Read-only.
*/
thumbnailUrl?: string;
/**
* Title of the Form. Read-only.
*/
title?: string;
}
/**
* Global user permission description.
*/
export interface Schema$GlobalPermission {
/**
* Permission value.
*/
permission?: string;
}
/**
* The history of each grade on this submission.
*/
export interface Schema$GradeHistory {
/**
* The teacher who made the grade change.
*/
actorUserId?: string;
/**
* The type of grade change at this time in the submission grade history.
*/
gradeChangeType?: string;
/**
* When the grade of the submission was changed.
*/
gradeTimestamp?: string;
/**
* The denominator of the grade at this time in the submission grade
* history.
*/
maxPoints?: number;
/**
* The numerator of the grade at this time in the submission grade history.
*/
pointsEarned?: number;
}
/**
* 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;
/**
* 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;
/**
* Identifier for the student to whom the guardian relationship applies.
*/
studentId?: string;
}
/**
* 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;
/**
* Unique identifier for this invitation. Read-only.
*/
invitationId?: string;
/**
* Email address that the invitation was sent to. This field is only visible
* to domain administrators.
*/
invitedEmailAddress?: string;
/**
* The state that this invitation is in.
*/
state?: string;
/**
* ID of the student (in standard format)
*/
studentId?: string;
}
/**
* 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[];
}
/**
* An invitation to join a course.
*/
export interface Schema$Invitation {
/**
* Identifier of the course to invite the user to.
*/
courseId?: string;
/**
* Identifier assigned by Classroom. Read-only.
*/
id?: string;
/**
* Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
*/
role?: string;
/**
* 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;
}
/**
* URL item.
*/
export interface Schema$Link {
/**
* URL of a thumbnail image of the target URL. Read-only.
*/
thumbnailUrl?: string;
/**
* Title of the target of the URL. Read-only.
*/
title?: string;
/**
* URL to link to. This must be a valid UTF-8 string containing between 1
* and 2024 characters.
*/
url?: string;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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;
/**
* 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;
/**
* 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;
/**
* Teachers who match the list request.
*/
teachers?: Schema$Teacher[];
}
/**
* 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;
/**
* 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;
/**
* 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[];
/**
* Ids of students to be removed from having access to this
* coursework/announcement.
*/
removeStudentIds?: string[];
}
/**
* Additional details for multiple-choice questions.
*/
export interface Schema$MultipleChoiceQuestion {
/**
* Possible choices.
*/
choices?: string[];
}
/**
* Student work for a multiple-choice question.
*/
export interface Schema$MultipleChoiceSubmission {
/**
* Student's select choice.
*/
answer?: string;
}
/**
* Details of the user's name.
*/
export interface Schema$Name {
/**
* The user's last name. Read-only.
*/
familyName?: string;
/**
* The user's full name formed by concatenating the first and last name
* values. Read-only.
*/
fullName?: string;
/**
* The user's first name. Read-only.
*/
givenName?: string;
}
/**
* 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;
/**