View Source GoogleApi.Classroom.V1.Api.Courses (google_api_classroom v0.21.2)

API calls for all endpoints tagged Courses.

Summary

Functions

classroom_courses_aliases_create(connection, course_id, optional_params \\ [], opts \\ [])

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

classroom_courses_aliases_delete(connection, course_id, alias, optional_params \\ [], opts \\ [])

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

classroom_courses_aliases_list(connection, course_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_announcements_add_on_attachments_create(connection, course_id, item_id, optional_params \\ [], opts \\ [])

Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_announcements_add_on_attachments_delete(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_announcements_add_on_attachments_get(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_announcements_add_on_attachments_list(connection, course_id, item_id, optional_params \\ [], opts \\ [])

Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_announcements_add_on_attachments_patch(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_announcements_create(connection, course_id, optional_params \\ [], opts \\ [])

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

classroom_courses_announcements_delete(connection, course_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_announcements_get(connection, course_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_announcements_get_add_on_context(connection, course_id, item_id, optional_params \\ [], opts \\ [])

Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an iframe. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_announcements_list(connection, course_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_announcements_modify_assignees(connection, course_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_announcements_patch(connection, course_id, id, optional_params \\ [], opts \\ [])

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

classroom_courses_course_work_add_on_attachments_create(connection, course_id, item_id, optional_params \\ [], opts \\ [])

Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_add_on_attachments_delete(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_add_on_attachments_get(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_add_on_attachments_list(connection, course_id, item_id, optional_params \\ [], opts \\ [])

Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_add_on_attachments_patch(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_add_on_attachments_student_submissions_get(connection, course_id, item_id, attachment_id, submission_id, optional_params \\ [], opts \\ [])

Returns a student submission for an add-on attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_add_on_attachments_student_submissions_patch(connection, course_id, item_id, attachment_id, submission_id, optional_params \\ [], opts \\ [])

Updates data associated with an add-on attachment submission. Requires the add-on to have been the original creator of the attachment and the attachment to have a positive max_points value set. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_create(connection, course_id, optional_params \\ [], opts \\ [])

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

classroom_courses_course_work_delete(connection, course_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_course_work_get(connection, course_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_course_work_get_add_on_context(connection, course_id, item_id, optional_params \\ [], opts \\ [])

Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an iframe. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_list(connection, course_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_course_work_materials_add_on_attachments_create(connection, course_id, item_id, optional_params \\ [], opts \\ [])

Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_materials_add_on_attachments_delete(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_materials_add_on_attachments_get(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_materials_add_on_attachments_list(connection, course_id, item_id, optional_params \\ [], opts \\ [])

Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_materials_add_on_attachments_patch(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_materials_create(connection, course_id, optional_params \\ [], opts \\ [])

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

classroom_courses_course_work_materials_delete(connection, course_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_course_work_materials_get(connection, course_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_course_work_materials_get_add_on_context(connection, course_id, item_id, optional_params \\ [], opts \\ [])

Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an iframe. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_course_work_materials_list(connection, course_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_course_work_materials_patch(connection, course_id, id, optional_params \\ [], opts \\ [])

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

classroom_courses_course_work_modify_assignees(connection, course_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_course_work_patch(connection, course_id, id, optional_params \\ [], opts \\ [])

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 or course work does not exist.

classroom_courses_course_work_student_submissions_get(connection, course_id, course_work_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_course_work_student_submissions_list(connection, course_id, course_work_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_course_work_student_submissions_modify_attachments(connection, course_id, course_work_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_course_work_student_submissions_patch(connection, course_id, course_work_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_course_work_student_submissions_reclaim(connection, course_id, course_work_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_course_work_student_submissions_return(connection, course_id, course_work_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_course_work_student_submissions_turn_in(connection, course_id, course_work_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_create(connection, optional_params \\ [], opts \\ [])

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.

classroom_courses_delete(connection, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_get(connection, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_list(connection, optional_params \\ [], opts \\ [])

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.

classroom_courses_patch(connection, id, optional_params \\ [], opts \\ [])

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

classroom_courses_posts_add_on_attachments_create(connection, course_id, post_id, optional_params \\ [], opts \\ [])

Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_posts_add_on_attachments_delete(connection, course_id, post_id, attachment_id, optional_params \\ [], opts \\ [])

Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_posts_add_on_attachments_get(connection, course_id, post_id, attachment_id, optional_params \\ [], opts \\ [])

Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_posts_add_on_attachments_list(connection, course_id, post_id, optional_params \\ [], opts \\ [])

Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_posts_add_on_attachments_patch(connection, course_id, post_id, attachment_id, optional_params \\ [], opts \\ [])

Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_posts_add_on_attachments_student_submissions_get(connection, course_id, post_id, attachment_id, submission_id, optional_params \\ [], opts \\ [])

Returns a student submission for an add-on attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_posts_add_on_attachments_student_submissions_patch(connection, course_id, post_id, attachment_id, submission_id, optional_params \\ [], opts \\ [])

Updates data associated with an add-on attachment submission. Requires the add-on to have been the original creator of the attachment and the attachment to have a positive max_points value set. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_posts_get_add_on_context(connection, course_id, post_id, optional_params \\ [], opts \\ [])

Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an iframe. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

classroom_courses_students_create(connection, course_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_students_delete(connection, course_id, user_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_students_get(connection, course_id, user_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_students_list(connection, course_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_teachers_create(connection, course_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_teachers_delete(connection, course_id, user_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_teachers_get(connection, course_id, user_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_teachers_list(connection, course_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_topics_create(connection, course_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_topics_delete(connection, course_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_topics_get(connection, course_id, id, optional_params \\ [], opts \\ [])

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.

classroom_courses_topics_list(connection, course_id, optional_params \\ [], opts \\ [])

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.

classroom_courses_topics_patch(connection, course_id, id, optional_params \\ [], opts \\ [])

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

classroom_courses_update(connection, id, optional_params \\ [], opts \\ [])

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

Functions

Link to this function

classroom_courses_aliases_create(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_aliases_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.CourseAlias.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.CourseAlias.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.CourseAlias{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_aliases_delete(connection, course_id, alias, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_aliases_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.
  • alias (type: String.t) - Alias to delete. This may not be the Classroom-assigned identifier.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_aliases_list(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_aliases_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.ListCourseAliasesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
    • :pageToken (type: String.t) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.ListCourseAliasesResponse{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_announcements_add_on_attachments_create(connection, course_id, item_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_announcements_add_on_attachments_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :addOnToken (type: String.t) - Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match.
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
    • :body (type: GoogleApi.Classroom.V1.Model.AddOnAttachment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachment{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_announcements_add_on_attachments_delete(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_announcements_add_on_attachments_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_announcements_add_on_attachments_get(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_announcements_add_on_attachments_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachment{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_announcements_add_on_attachments_list(connection, course_id, item_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_announcements_add_on_attachments_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.ListAddOnAttachmentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20.
    • :pageToken (type: String.t) - A page token, received from a previous ListAddOnAttachments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAddOnAttachments must match the call that provided the page token.
    • :postId (type: String.t) - Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.ListAddOnAttachmentsResponse{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_announcements_add_on_attachments_patch(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_announcements_add_on_attachments_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the post under which the attachment is attached.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :postId (type: String.t) - Required. Identifier of the post under which the attachment is attached.
    • :updateMask (type: String.t) - Required. Mask that identifies which fields on the attachment to update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the AddOnAttachment object. If a field that does not support empty values is included in the update mask and not set in the AddOnAttachment object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: title teacher_view_uri student_view_uri student_work_review_uri due_date due_time * max_points
    • :body (type: GoogleApi.Classroom.V1.Model.AddOnAttachment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachment{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_announcements_create(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_announcements_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Announcement.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.Announcement.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Announcement{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_announcements_delete(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_announcements_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • id (type: String.t) - Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_announcements_get(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_announcements_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Announcement.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • id (type: String.t) - Identifier of the announcement.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Announcement{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_announcements_get_add_on_context(connection, course_id, item_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_announcements_get_add_on_context(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnContext.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an iframe. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :addOnToken (type: String.t) - Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: The add-on has attachments on the post. The developer project issuing the request is the same project that created the post.
    • :attachmentId (type: String.t) - Optional. The identifier of the attachment. This field is required for all requests except when the user is in the Attachment Discovery iframe.
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnContext{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_announcements_list(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_announcements_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.ListAnnouncementsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :announcementStates (type: list(String.t)) - Restriction on the state of announcements returned. If this argument is left unspecified, the default value is PUBLISHED.
    • :orderBy (type: String.t) - Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is updateTime. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: updateTime asc, updateTime
    • :pageSize (type: integer()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
    • :pageToken (type: String.t) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.ListAnnouncementsResponse{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_announcements_modify_assignees(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_announcements_modify_assignees(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Announcement.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • id (type: String.t) - Identifier of the announcement.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.ModifyAnnouncementAssigneesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Announcement{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_announcements_patch(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_announcements_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Announcement.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • id (type: String.t) - Identifier of the announcement.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: text state * scheduled_time
    • :body (type: GoogleApi.Classroom.V1.Model.Announcement.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Announcement{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_add_on_attachments_create(connection, course_id, item_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_add_on_attachments_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :addOnToken (type: String.t) - Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match.
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
    • :body (type: GoogleApi.Classroom.V1.Model.AddOnAttachment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachment{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_add_on_attachments_delete(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_add_on_attachments_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_add_on_attachments_get(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_add_on_attachments_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachment{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_add_on_attachments_list(connection, course_id, item_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_add_on_attachments_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.ListAddOnAttachmentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20.
    • :pageToken (type: String.t) - A page token, received from a previous ListAddOnAttachments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAddOnAttachments must match the call that provided the page token.
    • :postId (type: String.t) - Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.ListAddOnAttachmentsResponse{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_add_on_attachments_patch(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_add_on_attachments_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the post under which the attachment is attached.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :postId (type: String.t) - Required. Identifier of the post under which the attachment is attached.
    • :updateMask (type: String.t) - Required. Mask that identifies which fields on the attachment to update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the AddOnAttachment object. If a field that does not support empty values is included in the update mask and not set in the AddOnAttachment object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: title teacher_view_uri student_view_uri student_work_review_uri due_date due_time * max_points
    • :body (type: GoogleApi.Classroom.V1.Model.AddOnAttachment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachment{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_add_on_attachments_student_submissions_get(connection, course_id, item_id, attachment_id, submission_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_add_on_attachments_student_submissions_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachmentStudentSubmission.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns a student submission for an add-on attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • submission_id (type: String.t) - Required. Identifier of the student’s submission.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachmentStudentSubmission{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_add_on_attachments_student_submissions_patch(connection, course_id, item_id, attachment_id, submission_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_add_on_attachments_student_submissions_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachmentStudentSubmission.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates data associated with an add-on attachment submission. Requires the add-on to have been the original creator of the attachment and the attachment to have a positive max_points value set. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • submission_id (type: String.t) - Required. Identifier of the student's submission.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
    • :updateMask (type: String.t) - Required. Mask that identifies which fields on the attachment to update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the AddOnAttachmentStudentSubmission object. The following fields may be specified by teachers: * points_earned
    • :body (type: GoogleApi.Classroom.V1.Model.AddOnAttachmentStudentSubmission.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachmentStudentSubmission{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_create(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.CourseWork.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.CourseWork.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.CourseWork{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_delete(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • id (type: String.t) - Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_get(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.CourseWork.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • id (type: String.t) - Identifier of the course work.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.CourseWork{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_get_add_on_context(connection, course_id, item_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_get_add_on_context(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnContext.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an iframe. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :addOnToken (type: String.t) - Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: The add-on has attachments on the post. The developer project issuing the request is the same project that created the post.
    • :attachmentId (type: String.t) - Optional. The identifier of the attachment. This field is required for all requests except when the user is in the Attachment Discovery iframe.
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnContext{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_list(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.ListCourseWorkResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :courseWorkStates (type: list(String.t)) - Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of PUBLISHED is returned.
    • :orderBy (type: String.t) - Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are updateTime and dueDate. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: dueDate asc,updateTime desc, updateTime,dueDate desc
    • :pageSize (type: integer()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
    • :pageToken (type: String.t) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.ListCourseWorkResponse{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_materials_add_on_attachments_create(connection, course_id, item_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_materials_add_on_attachments_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :addOnToken (type: String.t) - Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match.
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
    • :body (type: GoogleApi.Classroom.V1.Model.AddOnAttachment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachment{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_materials_add_on_attachments_delete(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_materials_add_on_attachments_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_materials_add_on_attachments_get(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_materials_add_on_attachments_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachment{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_materials_add_on_attachments_list(connection, course_id, item_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_materials_add_on_attachments_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.ListAddOnAttachmentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20.
    • :pageToken (type: String.t) - A page token, received from a previous ListAddOnAttachments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAddOnAttachments must match the call that provided the page token.
    • :postId (type: String.t) - Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.ListAddOnAttachmentsResponse{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_materials_add_on_attachments_patch(connection, course_id, item_id, attachment_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_materials_add_on_attachments_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the post under which the attachment is attached.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :postId (type: String.t) - Required. Identifier of the post under which the attachment is attached.
    • :updateMask (type: String.t) - Required. Mask that identifies which fields on the attachment to update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the AddOnAttachment object. If a field that does not support empty values is included in the update mask and not set in the AddOnAttachment object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: title teacher_view_uri student_view_uri student_work_review_uri due_date due_time * max_points
    • :body (type: GoogleApi.Classroom.V1.Model.AddOnAttachment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachment{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_materials_create(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_materials_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.CourseWorkMaterial.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.CourseWorkMaterial.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.CourseWorkMaterial{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_materials_delete(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_materials_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • id (type: String.t) - Identifier of the course work material to delete. This identifier is a Classroom-assigned identifier.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_materials_get(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_materials_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.CourseWorkMaterial.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • id (type: String.t) - Identifier of the course work material.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.CourseWorkMaterial{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_materials_get_add_on_context(connection, course_id, item_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_materials_get_add_on_context(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnContext.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an iframe. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • item_id (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :addOnToken (type: String.t) - Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: The add-on has attachments on the post. The developer project issuing the request is the same project that created the post.
    • :attachmentId (type: String.t) - Optional. The identifier of the attachment. This field is required for all requests except when the user is in the Attachment Discovery iframe.
    • :postId (type: String.t) - Optional. Deprecated, use item_id instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnContext{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_materials_list(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_materials_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.ListCourseWorkMaterialResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :courseWorkMaterialStates (type: list(String.t)) - Restriction on the work status to return. Only course work material that matches is returned. If unspecified, items with a work status of PUBLISHED is returned.
    • :materialDriveId (type: String.t) - Optional filtering for course work material with at least one Drive material whose ID matches the provided string. If material_link is also specified, course work material must have materials matching both filters.
    • :materialLink (type: String.t) - Optional filtering for course work material with at least one link material whose URL partially matches the provided string.
    • :orderBy (type: String.t) - Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is updateTime. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: updateTime asc, updateTime
    • :pageSize (type: integer()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
    • :pageToken (type: String.t) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.ListCourseWorkMaterialResponse{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_materials_patch(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_materials_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.CourseWorkMaterial.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • id (type: String.t) - Identifier of the course work material.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: title description state scheduled_time * topic_id
    • :body (type: GoogleApi.Classroom.V1.Model.CourseWorkMaterial.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.CourseWorkMaterial{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_modify_assignees(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_modify_assignees(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.CourseWork.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • id (type: String.t) - Identifier of the coursework.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.ModifyCourseWorkAssigneesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.CourseWork{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_patch(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.CourseWork.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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 or course work does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • id (type: String.t) - Identifier of the course work.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: title description state due_date due_time max_points scheduled_time submission_modification_mode topic_id grading_period_id Available in V1_20240401_PREVIEW and later.
    • :body (type: GoogleApi.Classroom.V1.Model.CourseWork.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.CourseWork{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_student_submissions_get(connection, course_id, course_work_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_student_submissions_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.StudentSubmission.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • course_work_id (type: String.t) - Identifier of the course work.
  • id (type: String.t) - Identifier of the student submission.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.StudentSubmission{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_student_submissions_list(connection, course_id, course_work_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_student_submissions_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.ListStudentSubmissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • course_work_id (type: String.t) - 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.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :late (type: String.t) - Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of late value.
    • :pageSize (type: integer()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
    • :pageToken (type: String.t) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
    • :states (type: list(String.t)) - Requested submission states. If specified, returned student submissions match one of the specified submission states.
    • :userId (type: String.t) - Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: the numeric identifier for the user the email address of the user * the string literal "me", indicating the requesting user
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.ListStudentSubmissionsResponse{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_student_submissions_modify_attachments(connection, course_id, course_work_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_student_submissions_modify_attachments(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.StudentSubmission.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • course_work_id (type: String.t) - Identifier of the course work.
  • id (type: String.t) - Identifier of the student submission.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.ModifyAttachmentsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.StudentSubmission{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_student_submissions_patch(connection, course_id, course_work_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_student_submissions_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.StudentSubmission.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • course_work_id (type: String.t) - Identifier of the course work.
  • id (type: String.t) - Identifier of the student submission.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: draft_grade assigned_grade
    • :body (type: GoogleApi.Classroom.V1.Model.StudentSubmission.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.StudentSubmission{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_student_submissions_reclaim(connection, course_id, course_work_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_student_submissions_reclaim(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • course_work_id (type: String.t) - Identifier of the course work.
  • id (type: String.t) - Identifier of the student submission.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.ReclaimStudentSubmissionRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_student_submissions_return(connection, course_id, course_work_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_student_submissions_return(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • course_work_id (type: String.t) - Identifier of the course work.
  • id (type: String.t) - Identifier of the student submission.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.ReturnStudentSubmissionRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_course_work_student_submissions_turn_in(connection, course_id, course_work_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_course_work_student_submissions_turn_in(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • course_work_id (type: String.t) - Identifier of the course work.
  • id (type: String.t) - Identifier of the student submission.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.TurnInStudentSubmissionRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_create(connection, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Classroom.V1.Model.Course.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.Course.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Course{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_delete(connection, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • id (type: String.t) - Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_get(connection, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Classroom.V1.Model.Course.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • id (type: String.t) - Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Course{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_list(connection, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Classroom.V1.Model.ListCoursesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :courseStates (type: list(String.t)) - Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
    • :pageSize (type: integer()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
    • :pageToken (type: String.t) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
    • :studentId (type: String.t) - Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: the numeric identifier for the user the email address of the user * the string literal "me", indicating the requesting user
    • :teacherId (type: String.t) - Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: the numeric identifier for the user the email address of the user * the string literal "me", indicating the requesting user
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.ListCoursesResponse{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_patch(connection, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Classroom.V1.Model.Course.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • id (type: String.t) - Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: name section descriptionHeading description room courseState * ownerId Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as updateMask=,,...
    • :body (type: GoogleApi.Classroom.V1.Model.Course.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Course{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_posts_add_on_attachments_create(connection, course_id, post_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_posts_add_on_attachments_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • post_id (type: String.t) - Optional. Deprecated, use item_id instead.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :addOnToken (type: String.t) - Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match.
    • :itemId (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.
    • :body (type: GoogleApi.Classroom.V1.Model.AddOnAttachment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachment{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_posts_add_on_attachments_delete(connection, course_id, post_id, attachment_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_posts_add_on_attachments_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • post_id (type: String.t) - Optional. Deprecated, use item_id instead.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :itemId (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_posts_add_on_attachments_get(connection, course_id, post_id, attachment_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_posts_add_on_attachments_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • post_id (type: String.t) - Optional. Deprecated, use item_id instead.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :itemId (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachment{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_posts_add_on_attachments_list(connection, course_id, post_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_posts_add_on_attachments_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.ListAddOnAttachmentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • post_id (type: String.t) - Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :itemId (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.
    • :pageSize (type: integer()) - The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20.
    • :pageToken (type: String.t) - A page token, received from a previous ListAddOnAttachments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAddOnAttachments must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.ListAddOnAttachmentsResponse{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_posts_add_on_attachments_patch(connection, course_id, post_id, attachment_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_posts_add_on_attachments_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • post_id (type: String.t) - Required. Identifier of the post under which the attachment is attached.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :itemId (type: String.t) - Identifier of the post under which the attachment is attached.
    • :updateMask (type: String.t) - Required. Mask that identifies which fields on the attachment to update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the AddOnAttachment object. If a field that does not support empty values is included in the update mask and not set in the AddOnAttachment object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: title teacher_view_uri student_view_uri student_work_review_uri due_date due_time * max_points
    • :body (type: GoogleApi.Classroom.V1.Model.AddOnAttachment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachment{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_posts_add_on_attachments_student_submissions_get(connection, course_id, post_id, attachment_id, submission_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_posts_add_on_attachments_student_submissions_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachmentStudentSubmission.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns a student submission for an add-on attachment. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • post_id (type: String.t) - Optional. Deprecated, use item_id instead.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • submission_id (type: String.t) - Required. Identifier of the student’s submission.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :itemId (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachmentStudentSubmission{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_posts_add_on_attachments_student_submissions_patch(connection, course_id, post_id, attachment_id, submission_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_posts_add_on_attachments_student_submissions_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnAttachmentStudentSubmission.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates data associated with an add-on attachment submission. Requires the add-on to have been the original creator of the attachment and the attachment to have a positive max_points value set. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • post_id (type: String.t) - Optional. Deprecated, use item_id instead.
  • attachment_id (type: String.t) - Required. Identifier of the attachment.
  • submission_id (type: String.t) - Required. Identifier of the student's submission.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :itemId (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
    • :updateMask (type: String.t) - Required. Mask that identifies which fields on the attachment to update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the AddOnAttachmentStudentSubmission object. The following fields may be specified by teachers: * points_earned
    • :body (type: GoogleApi.Classroom.V1.Model.AddOnAttachmentStudentSubmission.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnAttachmentStudentSubmission{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_posts_get_add_on_context(connection, course_id, post_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_posts_get_add_on_context(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.AddOnContext.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an iframe. This method returns the following error codes: PERMISSION_DENIED for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Required. Identifier of the course.
  • post_id (type: String.t) - Optional. Deprecated, use item_id instead.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :addOnToken (type: String.t) - Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: The add-on has attachments on the post. The developer project issuing the request is the same project that created the post.
    • :attachmentId (type: String.t) - Optional. The identifier of the attachment. This field is required for all requests except when the user is in the Attachment Discovery iframe.
    • :itemId (type: String.t) - Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.AddOnContext{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_students_create(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_students_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Student.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :enrollmentCode (type: String.t) - Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.
    • :body (type: GoogleApi.Classroom.V1.Model.Student.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Student{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_students_delete(connection, course_id, user_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_students_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • user_id (type: String.t) - 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
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_students_get(connection, course_id, user_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_students_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Student.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • user_id (type: String.t) - 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
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Student{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_students_list(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_students_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.ListStudentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Maximum number of items to return. The default is 30 if unspecified or 0. The server may return fewer than the specified number of results.
    • :pageToken (type: String.t) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.ListStudentsResponse{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_teachers_create(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_teachers_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Teacher.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.Teacher.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Teacher{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_teachers_delete(connection, course_id, user_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_teachers_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • user_id (type: String.t) - 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
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_teachers_get(connection, course_id, user_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_teachers_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Teacher.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • user_id (type: String.t) - 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
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Teacher{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_teachers_list(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_teachers_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.ListTeachersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Maximum number of items to return. The default is 30 if unspecified or 0. The server may return fewer than the specified number of results.
    • :pageToken (type: String.t) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.ListTeachersResponse{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_topics_create(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_topics_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Topic.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.Topic.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Topic{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_topics_delete(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_topics_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • id (type: String.t) - Identifier of the topic to delete.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_topics_get(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_topics_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Topic.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course.
  • id (type: String.t) - Identifier of the topic.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Topic{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_topics_list(connection, course_id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_topics_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.ListTopicResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
    • :pageToken (type: String.t) - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.ListTopicResponse{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_topics_patch(connection, course_id, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_topics_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Classroom.V1.Model.Topic.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • course_id (type: String.t) - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
  • id (type: String.t) - Identifier of the topic.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an INVALID_ARGUMENT error is returned. The following fields may be specified: * name
    • :body (type: GoogleApi.Classroom.V1.Model.Topic.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Topic{}} on success
  • {:error, info} on failure
Link to this function

classroom_courses_update(connection, id, optional_params \\ [], opts \\ [])

View Source 
@spec classroom_courses_update(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Classroom.V1.Model.Course.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Classroom.V1.Connection.t) - Connection to server
  • id (type: String.t) - Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Classroom.V1.Model.Course.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Classroom.V1.Model.Course{}} on success
  • {:error, info} on failure