gas-types-detailed/apis/classroom_v1.d.ts

Detailed Google Apps Script Type Definitions. Forked from Definitely Typed @types/google-apps-script. Adds full documentation and urls.

// Type definitions for Google Apps Script 2020-02-03
// Project: https://developers.google.com/apps-script/
// Generator: https://github.com/grant/google-apps-script-dts
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

declare namespace GoogleAppsScript {
    namespace Classroom {
        namespace Collection {
            namespace Courses {
                namespace CourseWork {
                    interface StudentSubmissionsCollection {
                        // 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.
                        get(courseId: string, courseWorkId: string, id: string): Classroom.Schema.StudentSubmission;
                        // 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.
                        list(courseId: string, courseWorkId: string): Classroom.Schema.ListStudentSubmissionsResponse;
                        // 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.
                        list(
                            courseId: string,
                            courseWorkId: string,
                            optionalArgs: object,
                        ): Classroom.Schema.ListStudentSubmissionsResponse;
                        // 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.
                        modifyAttachments(
                            resource: Schema.ModifyAttachmentsRequest,
                            courseId: string,
                            courseWorkId: string,
                            id: string,
                        ): Classroom.Schema.StudentSubmission;
                        // 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.
                        patch(
                            resource: Schema.StudentSubmission,
                            courseId: string,
                            courseWorkId: string,
                            id: string,
                        ): Classroom.Schema.StudentSubmission;
                        // 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.
                        patch(
                            resource: Schema.StudentSubmission,
                            courseId: string,
                            courseWorkId: string,
                            id: string,
                            optionalArgs: object,
                        ): Classroom.Schema.StudentSubmission;
                        // 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.
                        reclaim(courseId: string, courseWorkId: string, id: string): void;
                        // 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.
                        return(rcourseId: string, courseWorkId: string, id: string): void;
                        // 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.
                        turnIn(courseId: string, courseWorkId: string, id: string): void;
                    }
                }
                interface AliasesCollection {
                    // 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).
                    create(resource: Schema.CourseAlias, courseId: string): Classroom.Schema.CourseAlias;
                    // 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.
                    list(courseId: string): Classroom.Schema.ListCourseAliasesResponse;
                    // 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.
                    list(courseId: string, optionalArgs: object): Classroom.Schema.ListCourseAliasesResponse;
                    // 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).
                    remove(courseId: string, alias: string): void;
                }
                interface AnnouncementsCollection {
                    // 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
                    create(resource: Schema.Announcement, courseId: string): Classroom.Schema.Announcement;
                    // 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.
                    get(courseId: string, id: string): Classroom.Schema.Announcement;
                    // 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.
                    list(courseId: string): Classroom.Schema.ListAnnouncementsResponse;
                    // 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.
                    list(courseId: string, optionalArgs: object): Classroom.Schema.ListAnnouncementsResponse;
                    // 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.
                    modifyAssignees(
                        resource: Schema.ModifyAnnouncementAssigneesRequest,
                        courseId: string,
                        id: string,
                    ): Classroom.Schema.Announcement;
                    // 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
                    patch(resource: Schema.Announcement, courseId: string, id: string): Classroom.Schema.Announcement;
                    // 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
                    patch(
                        resource: Schema.Announcement,
                        courseId: string,
                        id: string,
                        optionalArgs: object,
                    ): Classroom.Schema.Announcement;
                    // 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.
                    remove(courseId: string, id: string): void;
                }
                interface CourseWorkCollection {
                    StudentSubmissions?: Classroom.Collection.Courses.CourseWork.StudentSubmissionsCollection | undefined;
                    // 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
                    create(resource: Schema.CourseWork, courseId: string): Classroom.Schema.CourseWork;
                    // 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.
                    get(courseId: string, id: string): Classroom.Schema.CourseWork;
                    // 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.
                    list(courseId: string): Classroom.Schema.ListCourseWorkResponse;
                    // 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.
                    list(courseId: string, optionalArgs: object): Classroom.Schema.ListCourseWorkResponse;
                    // 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.
                    modifyAssignees(
                        resource: Schema.ModifyCourseWorkAssigneesRequest,
                        courseId: string,
                        id: string,
                    ): Classroom.Schema.CourseWork;
                    // 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.
                    patch(resource: Schema.CourseWork, courseId: string, id: string): Classroom.Schema.CourseWork;
                    // 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.
                    patch(
                        resource: Schema.CourseWork,
                        courseId: string,
                        id: string,
                        optionalArgs: object,
                    ): Classroom.Schema.CourseWork;
                    // 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.
                    remove(courseId: string, id: string): void;
                }
                interface CourseWorkMaterialsCollection {
                    // Creates a course work material. This method returns the following error codes:
                    // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work material in the requested course, share a Drive attachment, or for access errors.
                    // *`INVALID_ARGUMENT` if the request is malformed or if more than 20 * materials are provided.
                    // *`NOT_FOUND` if the requested course does not exist.
                    // *`FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible
                    create(resource: Schema.CourseWorkMaterial, courseId: string): Classroom.Schema.CourseWorkMaterial;
                    // Returns a course work material. This method returns the following error codes:
                    // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work material, or for access errors.
                    // *`INVALID_ARGUMENT` if the request is malformed.
                    // *`NOT_FOUND` if the requested course or course work material does not exist.
                    get(courseId: string, id: string): Classroom.Schema.CourseWorkMaterial;
                    // Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. 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.
                    list(courseId: string): Classroom.Schema.ListCourseWorkMaterialResponse;
                    // Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. 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.
                    list(courseId: string, optionalArgs: object): Classroom.Schema.ListCourseWorkMaterialResponse;
                    // Updates one or more fields of a course work material. This method returns the following error codes:
                    // *`PERMISSION_DENIED` if the requesting developer project for access errors.
                    // *`INVALID_ARGUMENT` if the request is malformed.
                    // *`FAILED_PRECONDITION` if the requested course work material has already been deleted.
                    // *`NOT_FOUND` if the requested course or course work material does not exist
                    patch(
                        resource: Schema.CourseWorkMaterial,
                        courseId: string,
                        id: string,
                    ): Classroom.Schema.CourseWorkMaterial;
                    // Updates one or more fields of a course work material. This method returns the following error codes:
                    // *`PERMISSION_DENIED` if the requesting developer project for access errors.
                    // *`INVALID_ARGUMENT` if the request is malformed.
                    // *`FAILED_PRECONDITION` if the requested course work material has already been deleted.
                    // *`NOT_FOUND` if the requested course or course work material does not exist
                    patch(
                        resource: Schema.CourseWorkMaterial,
                        courseId: string,
                        id: string,
                        optionalArgs: object,
                    ): Classroom.Schema.CourseWorkMaterial;
                    // Deletes a course work material. 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 material item. This method returns the following error codes:
                    // *`PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors.
                    // *`FAILED_PRECONDITION` if the requested course work material has already been deleted.
                    // *`NOT_FOUND` if no course exists with the requested ID.
                    remove(courseId: string, id: string): void;
                }
                interface StudentsCollection {
                    // 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.
                    create(resource: Schema.Student, courseId: string): Classroom.Schema.Student;
                    // 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.
                    create(resource: Schema.Student, courseId: string, optionalArgs: object): Classroom.Schema.Student;
                    // 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.
                    get(courseId: string, userId: string): Classroom.Schema.Student;
                    // 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.
                    list(courseId: string): Classroom.Schema.ListStudentsResponse;
                    // 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.
                    list(courseId: string, optionalArgs: object): Classroom.Schema.ListStudentsResponse;
                    // 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.
                    remove(courseId: string, userId: string): void;
                }
                interface TeachersCollection {
                    // 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.
                    create(resource: Schema.Teacher, courseId: string): Classroom.Schema.Teacher;
                    // 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.
                    get(courseId: string, userId: string): Classroom.Schema.Teacher;
                    // 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.
                    list(courseId: string): Classroom.Schema.ListTeachersResponse;
                    // 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.
                    list(courseId: string, optionalArgs: object): Classroom.Schema.ListTeachersResponse;
                    // 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.
                    remove(courseId: string, userId: string): void;
                }
                interface TopicsCollection {
                    // 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.
                    create(resource: Schema.Topic, courseId: string): Classroom.Schema.Topic;
                    // 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.
                    get(courseId: string, id: string): Classroom.Schema.Topic;
                    // 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.
                    list(courseId: string): Classroom.Schema.ListTopicResponse;
                    // 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.
                    list(courseId: string, optionalArgs: object): Classroom.Schema.ListTopicResponse;
                    // 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
                    patch(resource: Schema.Topic, courseId: string, id: string): Classroom.Schema.Topic;
                    // 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
                    patch(
                        resource: Schema.Topic,
                        courseId: string,
                        id: string,
                        optionalArgs: object,
                    ): Classroom.Schema.Topic;
                    // 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.
                    remove(courseId: string, id: string): void;
                }
            }
            namespace UserProfiles {
                interface GuardianInvitationsCollection {
                    // 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.
                    create(resource: Schema.GuardianInvitation, studentId: string): Classroom.Schema.GuardianInvitation;
                    // 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.
                    get(studentId: string, invitationId: string): Classroom.Schema.GuardianInvitation;
                    // 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.
                    list(studentId: string): Classroom.Schema.ListGuardianInvitationsResponse;
                    // 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.
                    list(studentId: string, optionalArgs: object): Classroom.Schema.ListGuardianInvitationsResponse;
                    // 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.
                    patch(
                        resource: Schema.GuardianInvitation,
                        studentId: string,
                        invitationId: string,
                    ): Classroom.Schema.GuardianInvitation;
                    // 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.
                    patch(
                        resource: Schema.GuardianInvitation,
                        studentId: string,
                        invitationId: string,
                        optionalArgs: object,
                    ): Classroom.Schema.GuardianInvitation;
                }
                interface GuardiansCollection {
                    // 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`.
                    get(studentId: string, guardianId: string): Classroom.Schema.Guardian;
                    // 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.
                    list(studentId: string): Classroom.Schema.ListGuardiansResponse;
                    // 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.
                    list(studentId: string, optionalArgs: object): Classroom.Schema.ListGuardiansResponse;
                    // 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 qu