Classroom

import { Classroom } from "https://googleapis.deno.dev/v1/classroom:v1.ts";

Manages classes, rosters, and invitations in Google Classroom.

class Classroom {

constructor(client?: CredentialsClient, baseUrl?: string);

async coursesAliasesCreate(courseId: string, req: CourseAlias): Promise<CourseAlias>;

async coursesAliasesDelete(alias: string, courseId: string): Promise<Empty>;

async coursesAliasesList(courseId: string, opts?: CoursesAliasesListOptions): Promise<ListCourseAliasesResponse>;

async coursesAnnouncementsCreate(courseId: string, req: Announcement): Promise<Announcement>;

async coursesAnnouncementsDelete(courseId: string, id: string): Promise<Empty>;

async coursesAnnouncementsGet(courseId: string, id: string): Promise<Announcement>;

async coursesAnnouncementsList(courseId: string, opts?: CoursesAnnouncementsListOptions): Promise<ListAnnouncementsResponse>;

async coursesAnnouncementsModifyAssignees(

courseId: string,

id: string,

req: ModifyAnnouncementAssigneesRequest,

): Promise<Announcement>;

async coursesAnnouncementsPatch(

courseId: string,

id: string,

req: Announcement,

opts?: CoursesAnnouncementsPatchOptions,

): Promise<Announcement>;

async coursesCourseWorkCreate(courseId: string, req: CourseWork): Promise<CourseWork>;

async coursesCourseWorkDelete(courseId: string, id: string): Promise<Empty>;

async coursesCourseWorkGet(courseId: string, id: string): Promise<CourseWork>;

async coursesCourseWorkList(courseId: string, opts?: CoursesCourseWorkListOptions): Promise<ListCourseWorkResponse>;

async coursesCourseWorkMaterialsCreate(courseId: string, req: CourseWorkMaterial): Promise<CourseWorkMaterial>;

async coursesCourseWorkMaterialsDelete(courseId: string, id: string): Promise<Empty>;

async coursesCourseWorkMaterialsGet(courseId: string, id: string): Promise<CourseWorkMaterial>;

async coursesCourseWorkMaterialsList(courseId: string, opts?: CoursesCourseWorkMaterialsListOptions): Promise<ListCourseWorkMaterialResponse>;

async coursesCourseWorkMaterialsPatch(

courseId: string,

id: string,

req: CourseWorkMaterial,

opts?: CoursesCourseWorkMaterialsPatchOptions,

): Promise<CourseWorkMaterial>;

async coursesCourseWorkModifyAssignees(

courseId: string,

id: string,

req: ModifyCourseWorkAssigneesRequest,

): Promise<CourseWork>;

async coursesCourseWorkPatch(

courseId: string,

id: string,

req: CourseWork,

opts?: CoursesCourseWorkPatchOptions,

): Promise<CourseWork>;

async coursesCourseWorkStudentSubmissionsGet(

courseId: string,

courseWorkId: string,

id: string,

): Promise<StudentSubmission>;

async coursesCourseWorkStudentSubmissionsList(

courseId: string,

courseWorkId: string,

opts?: CoursesCourseWorkStudentSubmissionsListOptions,

): Promise<ListStudentSubmissionsResponse>;

async coursesCourseWorkStudentSubmissionsModifyAttachments(

courseId: string,

courseWorkId: string,

id: string,

req: ModifyAttachmentsRequest,

): Promise<StudentSubmission>;

async coursesCourseWorkStudentSubmissionsPatch(

courseId: string,

courseWorkId: string,

id: string,

req: StudentSubmission,

opts?: CoursesCourseWorkStudentSubmissionsPatchOptions,

): Promise<StudentSubmission>;

async coursesCourseWorkStudentSubmissionsReclaim(

courseId: string,

courseWorkId: string,

id: string,

req: ReclaimStudentSubmissionRequest,

): Promise<Empty>;

async coursesCourseWorkStudentSubmissionsReturn(

courseId: string,

courseWorkId: string,

id: string,

req: ReturnStudentSubmissionRequest,

): Promise<Empty>;

async coursesCourseWorkStudentSubmissionsTurnIn(

courseId: string,

courseWorkId: string,

id: string,

req: TurnInStudentSubmissionRequest,

): Promise<Empty>;

async coursesCreate(req: Course): Promise<Course>;

async coursesDelete(id: string): Promise<Empty>;

async coursesGet(id: string): Promise<Course>;

async coursesList(opts?: CoursesListOptions): Promise<ListCoursesResponse>;

async coursesPatch(

id: string,

req: Course,

opts?: CoursesPatchOptions,

): Promise<Course>;

async coursesStudentsCreate(

courseId: string,

req: Student,

opts?: CoursesStudentsCreateOptions,

): Promise<Student>;

async coursesStudentsDelete(courseId: string, userId: string): Promise<Empty>;

async coursesStudentsGet(courseId: string, userId: string): Promise<Student>;

async coursesStudentsList(courseId: string, opts?: CoursesStudentsListOptions): Promise<ListStudentsResponse>;

async coursesTeachersCreate(courseId: string, req: Teacher): Promise<Teacher>;

async coursesTeachersDelete(courseId: string, userId: string): Promise<Empty>;

async coursesTeachersGet(courseId: string, userId: string): Promise<Teacher>;

async coursesTeachersList(courseId: string, opts?: CoursesTeachersListOptions): Promise<ListTeachersResponse>;

async coursesTopicsCreate(courseId: string, req: Topic): Promise<Topic>;

async coursesTopicsDelete(courseId: string, id: string): Promise<Empty>;

async coursesTopicsGet(courseId: string, id: string): Promise<Topic>;

async coursesTopicsList(courseId: string, opts?: CoursesTopicsListOptions): Promise<ListTopicResponse>;

async coursesTopicsPatch(

courseId: string,

id: string,

req: Topic,

opts?: CoursesTopicsPatchOptions,

): Promise<Topic>;

async coursesUpdate(id: string, req: Course): Promise<Course>;

async invitationsAccept(id: string): Promise<Empty>;

async invitationsCreate(req: Invitation): Promise<Invitation>;

async invitationsDelete(id: string): Promise<Empty>;

async invitationsGet(id: string): Promise<Invitation>;

async invitationsList(opts?: InvitationsListOptions): Promise<ListInvitationsResponse>;

async registrationsCreate(req: Registration): Promise<Registration>;

async registrationsDelete(registrationId: string): Promise<Empty>;

async userProfilesGet(userId: string): Promise<UserProfile>;

async userProfilesGuardianInvitationsCreate(studentId: string, req: GuardianInvitation): Promise<GuardianInvitation>;

async userProfilesGuardianInvitationsGet(invitationId: string, studentId: string): Promise<GuardianInvitation>;

async userProfilesGuardianInvitationsList(studentId: string, opts?: UserProfilesGuardianInvitationsListOptions): Promise<ListGuardianInvitationsResponse>;

async userProfilesGuardianInvitationsPatch(

invitationId: string,

studentId: string,

req: GuardianInvitation,

opts?: UserProfilesGuardianInvitationsPatchOptions,

): Promise<GuardianInvitation>;

async userProfilesGuardiansDelete(guardianId: string, studentId: string): Promise<Empty>;

async userProfilesGuardiansGet(guardianId: string, studentId: string): Promise<Guardian>;

async userProfilesGuardiansList(studentId: string, opts?: UserProfilesGuardiansListOptions): Promise<ListGuardiansResponse>;

}

§Constructors

new Classroom(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

coursesAliasesCreate(courseId: string, req: CourseAlias): Promise<CourseAlias>

[src]

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).

@param courseId

Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.

coursesAliasesDelete(alias: string, courseId: string): Promise<Empty>

[src]

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).

@param alias

Alias to delete. This may not be the Classroom-assigned identifier.

@param courseId

Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.

coursesAliasesList(courseId: string, opts?: CoursesAliasesListOptions): Promise<ListCourseAliasesResponse>

[src]

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.

@param courseId

The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

coursesAnnouncementsCreate(courseId: string, req: Announcement): Promise<Announcement>

[src]

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

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

coursesAnnouncementsDelete(courseId: string, id: string): Promise<Empty>

[src]

Deletes an announcement. This request must be made by the Developer Console project of the OAuth client ID 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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param id

Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.

coursesAnnouncementsGet(courseId: string, id: string): Promise<Announcement>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param id

Identifier of the announcement.

coursesAnnouncementsList(courseId: string, opts?: CoursesAnnouncementsListOptions): Promise<ListAnnouncementsResponse>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

coursesAnnouncementsModifyAssignees(courseId: string, id: string, req: ModifyAnnouncementAssigneesRequest): Promise<Announcement>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param id

Identifier of the announcement.

coursesAnnouncementsPatch(courseId: string, id: string, req: Announcement, opts?: CoursesAnnouncementsPatchOptions): Promise<Announcement>

[src]

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

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param id

Identifier of the announcement.

coursesCourseWorkCreate(courseId: string, req: CourseWork): Promise<CourseWork>

[src]

Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the OAuth client ID 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

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

coursesCourseWorkDelete(courseId: string, id: string): Promise<Empty>

[src]

Deletes a course work. This request must be made by the Developer Console project of the OAuth client ID 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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param id

Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.

coursesCourseWorkGet(courseId: string, id: string): Promise<CourseWork>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param id

Identifier of the course work.

coursesCourseWorkList(courseId: string, opts?: CoursesCourseWorkListOptions): Promise<ListCourseWorkResponse>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

coursesCourseWorkMaterialsCreate(courseId: string, req: CourseWorkMaterial): Promise<CourseWorkMaterial>

[src]

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

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

coursesCourseWorkMaterialsDelete(courseId: string, id: string): Promise<Empty>

[src]

Deletes a course work material. This request must be made by the Developer Console project of the OAuth client ID 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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param id

Identifier of the course work material to delete. This identifier is a Classroom-assigned identifier.

coursesCourseWorkMaterialsGet(courseId: string, id: string): Promise<CourseWorkMaterial>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param id

Identifier of the course work material.

coursesCourseWorkMaterialsList(courseId: string, opts?: CoursesCourseWorkMaterialsListOptions): Promise<ListCourseWorkMaterialResponse>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

coursesCourseWorkMaterialsPatch(courseId: string, id: string, req: CourseWorkMaterial, opts?: CoursesCourseWorkMaterialsPatchOptions): Promise<CourseWorkMaterial>

[src]

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

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param id

Identifier of the course work material.

coursesCourseWorkModifyAssignees(courseId: string, id: string, req: ModifyCourseWorkAssigneesRequest): Promise<CourseWork>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param id

Identifier of the coursework.

coursesCourseWorkPatch(courseId: string, id: string, req: CourseWork, opts?: CoursesCourseWorkPatchOptions): Promise<CourseWork>

[src]

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 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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param id

Identifier of the course work.

coursesCourseWorkStudentSubmissionsGet(courseId: string, courseWorkId: string, id: string): Promise<StudentSubmission>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param courseWorkId

Identifier of the course work.

@param id

Identifier of the student submission.

coursesCourseWorkStudentSubmissionsList(courseId: string, courseWorkId: string, opts?: CoursesCourseWorkStudentSubmissionsListOptions): Promise<ListStudentSubmissionsResponse>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param 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.

coursesCourseWorkStudentSubmissionsModifyAttachments(courseId: string, courseWorkId: string, id: string, req: ModifyAttachmentsRequest): Promise<StudentSubmission>

[src]

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 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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param courseWorkId

Identifier of the course work.

@param id

Identifier of the student submission.

coursesCourseWorkStudentSubmissionsPatch(courseId: string, courseWorkId: string, id: string, req: StudentSubmission, opts?: CoursesCourseWorkStudentSubmissionsPatchOptions): Promise<StudentSubmission>

[src]

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 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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param courseWorkId

Identifier of the course work.

@param id

Identifier of the student submission.

coursesCourseWorkStudentSubmissionsReclaim(courseId: string, courseWorkId: string, id: string, req: ReclaimStudentSubmissionRequest): Promise<Empty>

[src]

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 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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param courseWorkId

Identifier of the course work.

@param id

Identifier of the student submission.

coursesCourseWorkStudentSubmissionsReturn(courseId: string, courseWorkId: string, id: string, req: ReturnStudentSubmissionRequest): Promise<Empty>

[src]

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 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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param courseWorkId

Identifier of the course work.

@param id

Identifier of the student submission.

coursesCourseWorkStudentSubmissionsTurnIn(courseId: string, courseWorkId: string, id: string, req: TurnInStudentSubmissionRequest): Promise<Empty>

[src]

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 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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param courseWorkId

Identifier of the course work.

@param id

Identifier of the student submission.

coursesCreate(req: Course): Promise<Course>

[src]

Creates a course. The user specified in ownerId is the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. 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: * UserCannotOwnCourse * UserGroupsMembershipLimitReached * ALREADY_EXISTS if an alias was specified in the id and already exists.

coursesDelete(id: string): Promise<Empty>

[src]

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.

@param id

Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.

coursesGet(id: string): Promise<Course>

[src]

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.

@param id

Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.

coursesList(opts?: CoursesListOptions): Promise<ListCoursesResponse>

[src]

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.

coursesPatch(id: string, req: Course, opts?: CoursesPatchOptions): Promise<Course>

[src]

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 * InactiveCourseOwner * IneligibleOwner

@param id

Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.

coursesStudentsCreate(courseId: string, req: Student, opts?: CoursesStudentsCreateOptions): Promise<Student>

[src]

Adds a user as a student of a course. Domain administrators are permitted to directly add users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. 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 * InactiveCourseOwner * ALREADY_EXISTS if the user is already a student or teacher in the course.

@param courseId

Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.

coursesStudentsDelete(courseId: string, userId: string): Promise<Empty>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param 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

coursesStudentsGet(courseId: string, userId: string): Promise<Student>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param 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

coursesStudentsList(courseId: string, opts?: CoursesStudentsListOptions): Promise<ListStudentsResponse>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

coursesTeachersCreate(courseId: string, req: Teacher): Promise<Teacher>

[src]

Creates a teacher of a course. Domain administrators are permitted to directly add users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. 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 * InactiveCourseOwner * ALREADY_EXISTS if the user is already a teacher or student in the course.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

coursesTeachersDelete(courseId: string, userId: string): Promise<Empty>

[src]

Removes the specified teacher from the specified 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. * FAILED_PRECONDITION if the requested ID belongs to the owner of the course Drive folder. * FAILED_PRECONDITION if the course no longer has an active owner.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param 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

coursesTeachersGet(courseId: string, userId: string): Promise<Teacher>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param 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

coursesTeachersList(courseId: string, opts?: CoursesTeachersListOptions): Promise<ListTeachersResponse>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

coursesTopicsCreate(courseId: string, req: Topic): Promise<Topic>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

coursesTopicsDelete(courseId: string, id: string): Promise<Empty>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param id

Identifier of the topic to delete.

coursesTopicsGet(courseId: string, id: string): Promise<Topic>

[src]

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.

@param courseId

Identifier of the course.

@param id

Identifier of the topic.

coursesTopicsList(courseId: string, opts?: CoursesTopicsListOptions): Promise<ListTopicResponse>

[src]

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.

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

coursesTopicsPatch(courseId: string, id: string, req: Topic, opts?: CoursesTopicsPatchOptions): Promise<Topic>

[src]

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

@param courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

@param id

Identifier of the topic.

coursesUpdate(id: string, req: Course): Promise<Course>

[src]

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

@param id

Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.

invitationsAccept(id: string): Promise<Empty>

[src]

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.

@param id

Identifier of the invitation to accept.

invitationsCreate(req: Invitation): Promise<Invitation>

[src]

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. * if the user already has this role or a role with greater permissions. * for the following request errors: * IneligibleOwner * ALREADY_EXISTS if an invitation for the specified user and course already exists.

invitationsDelete(id: string): Promise<Empty>

[src]

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.

@param id

Identifier of the invitation to delete.

invitationsGet(id: string): Promise<Invitation>

[src]

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.

@param id

Identifier of the invitation to return.

invitationsList(opts?: InvitationsListOptions): Promise<ListInvitationsResponse>

[src]

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.

registrationsCreate(req: Registration): Promise<Registration>

[src]

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 current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * 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.

registrationsDelete(registrationId: string): Promise<Empty>

[src]

Deletes a Registration, causing Classroom to stop sending notifications for that Registration.

@param registrationId

The registration_id of the Registration to be deleted.

userProfilesGet(userId: string): Promise<UserProfile>

[src]

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.

@param 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

userProfilesGuardianInvitationsCreate(studentId: string, req: GuardianInvitation): Promise<GuardianInvitation>

[src]

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.

@param studentId

ID of the student (in standard format)

userProfilesGuardianInvitationsGet(invitationId: string, studentId: string): Promise<GuardianInvitation>

[src]

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.

@param invitationId

The id field of the GuardianInvitation being requested.

@param studentId

The ID of the student whose guardian invitation is being requested.

userProfilesGuardianInvitationsList(studentId: string, opts?: UserProfilesGuardianInvitationsListOptions): Promise<ListGuardianInvitationsResponse>

[src]

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.

@param 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.

userProfilesGuardianInvitationsPatch(invitationId: string, studentId: string, req: GuardianInvitation, opts?: UserProfilesGuardianInvitationsPatchOptions): Promise<GuardianInvitation>

[src]

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.

@param invitationId

The id field of the GuardianInvitation to be modified.

@param studentId

The ID of the student whose guardian invitation is to be modified.

userProfilesGuardiansDelete(guardianId: string, studentId: string): Promise<Empty>

[src]

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.

@param guardianId

The id field from a Guardian.

@param 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

userProfilesGuardiansGet(guardianId: string, studentId: string): Promise<Guardian>

[src]

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.

@param guardianId

The id field from a Guardian.

@param 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

userProfilesGuardiansList(studentId: string, opts?: UserProfilesGuardiansListOptions): Promise<ListGuardiansResponse>

[src]

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.

@param 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.