diff --git a/discovery/classroom-v1.json b/discovery/classroom-v1.json index 8bcf18a5ffd..9d0b8dd5f5b 100644 --- a/discovery/classroom-v1.json +++ b/discovery/classroom-v1.json @@ -164,7 +164,7 @@ "courses": { "methods": { "create": { - "description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists.", + "description": "Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.", "flatPath": "v1/courses", "httpMethod": "POST", "id": "classroom.courses.create", @@ -182,7 +182,7 @@ ] }, "delete": { - "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.", + "description": "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.", "flatPath": "v1/courses/{id}", "httpMethod": "DELETE", "id": "classroom.courses.delete", @@ -191,7 +191,7 @@ ], "parameters": { "id": { - "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -206,7 +206,7 @@ ] }, "get": { - "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.", + "description": "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.", "flatPath": "v1/courses/{id}", "httpMethod": "GET", "id": "classroom.courses.get", @@ -215,7 +215,7 @@ ], "parameters": { "id": { - "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -231,14 +231,14 @@ ] }, "list": { - "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request. Returned courses are ordered by\ncreation time, with the most recently created coming first.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist.", + "description": "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.", "flatPath": "v1/courses", "httpMethod": "GET", "id": "classroom.courses.list", "parameterOrder": [], "parameters": { "courseStates": { - "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.", + "description": "Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.", "enum": [ "COURSE_STATE_UNSPECIFIED", "ACTIVE", @@ -247,28 +247,36 @@ "DECLINED", "SUSPENDED" ], + "enumDescriptions": [ + "No course state. No returned Course message will use this value.", + "The course is active.", + "The course has been archived. You cannot modify it except to change it to a different state.", + "The course has been created, but not yet activated. It is accessible by the primary teacher and domain administrators, who may modify it or change it to the `ACTIVE` or `DECLINED` states. A course may only be changed to `PROVISIONED` if it is in the `DECLINED` state.", + "The course has been created, but declined. It is accessible by the course owner and domain administrators, though it will not be displayed in the web UI. You cannot modify the course except to change it to the `PROVISIONED` state. A course may only be changed to `DECLINED` if it is in the `PROVISIONED` state.", + "The course has been suspended. You cannot modify the course, and only the user identified by the `owner_id` can view the course. A course may be placed in this state if it potentially violates the Terms of Service." + ], "location": "query", "repeated": true, "type": "string" }, "pageSize": { - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.", + "description": "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.", "location": "query", "type": "string" }, "studentId": { - "description": "Restricts returned courses to those having a student with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "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", "location": "query", "type": "string" }, "teacherId": { - "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "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", "location": "query", "type": "string" } @@ -283,7 +291,7 @@ ] }, "patch": { - "description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable", + "description": "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", "flatPath": "v1/courses/{id}", "httpMethod": "PATCH", "id": "classroom.courses.patch", @@ -292,13 +300,13 @@ ], "parameters": { "id": { - "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "updateMask": { - "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n* `ownerId`\n\nNote: patches to ownerId are treated as being effective immediately, but in\npractice it may take some time for the ownership transfer of all affected\nresources to complete.\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=,,...`", + "description": "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=,,...`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -316,7 +324,7 @@ ] }, "update": { - "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable", + "description": "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", "flatPath": "v1/courses/{id}", "httpMethod": "PUT", "id": "classroom.courses.update", @@ -325,7 +333,7 @@ ], "parameters": { "id": { - "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -347,7 +355,7 @@ "aliases": { "methods": { "create": { - "description": "Creates an alias for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create the\nalias or for access errors.\n* `NOT_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already exists.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to access a domain-scoped alias).", + "description": "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).", "flatPath": "v1/courses/{courseId}/aliases", "httpMethod": "POST", "id": "classroom.courses.aliases.create", @@ -356,7 +364,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -374,7 +382,7 @@ ] }, "delete": { - "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias).", + "description": "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).", "flatPath": "v1/courses/{courseId}/aliases/{alias}", "httpMethod": "DELETE", "id": "classroom.courses.aliases.delete", @@ -384,13 +392,13 @@ ], "parameters": { "alias": { - "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.", + "description": "Alias to delete. This may not be the Classroom-assigned identifier.", "location": "path", "required": true, "type": "string" }, "courseId": { - "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -405,7 +413,7 @@ ] }, "list": { - "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/aliases", "httpMethod": "GET", "id": "classroom.courses.aliases.list", @@ -414,19 +422,19 @@ ], "parameters": { "courseId": { - "description": "The identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "pageSize": { - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", + "description": "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.", "location": "query", "type": "string" } @@ -445,7 +453,7 @@ "announcements": { "methods": { "create": { - "description": "Creates an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create announcements in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible", + "description": "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", "flatPath": "v1/courses/{courseId}/announcements", "httpMethod": "POST", "id": "classroom.courses.announcements.create", @@ -454,7 +462,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -472,7 +480,7 @@ ] }, "delete": { - "description": "Deletes an announcement.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding announcement item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding announcement, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested announcement has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.", + "description": "Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.", "flatPath": "v1/courses/{courseId}/announcements/{id}", "httpMethod": "DELETE", "id": "classroom.courses.announcements.delete", @@ -482,13 +490,13 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "id": { - "description": "Identifier of the announcement to delete.\nThis identifier is a Classroom-assigned identifier.", + "description": "Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.", "location": "path", "required": true, "type": "string" @@ -503,7 +511,7 @@ ] }, "get": { - "description": "Returns an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or announcement, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or announcement does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/announcements/{id}", "httpMethod": "GET", "id": "classroom.courses.announcements.get", @@ -513,7 +521,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -535,7 +543,7 @@ ] }, "list": { - "description": "Returns a list of announcements that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` announcements. Course teachers\nand domain administrators may view all announcements.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/announcements", "httpMethod": "GET", "id": "classroom.courses.announcements.list", @@ -544,36 +552,42 @@ ], "parameters": { "announcementStates": { - "description": "Restriction on the `state` of announcements returned.\nIf this argument is left unspecified, the default value is `PUBLISHED`.", + "description": "Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`.", "enum": [ "ANNOUNCEMENT_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ], + "enumDescriptions": [ + "No state specified. This is never returned.", + "Status for announcement that has been published. This is the default state.", + "Status for an announcement that is not yet published. Announcement in this state is visible only to course teachers and domain administrators.", + "Status for announcement that was published but is now deleted. Announcement in this state is visible only to course teachers and domain administrators. Announcement in this state is deleted after some time." + ], "location": "query", "repeated": true, "type": "string" }, "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "orderBy": { - "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported field is `updateTime`.\nSupported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `updateTime asc`, `updateTime`", + "description": "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`", "location": "query", "type": "string" }, "pageSize": { - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", + "description": "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.", "location": "query", "type": "string" } @@ -588,7 +602,7 @@ ] }, "modifyAssignees": { - "description": "Modifies assignee mode and options of an announcement.\n\nOnly a teacher of the course that contains the announcement may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees", "httpMethod": "POST", "id": "classroom.courses.announcements.modifyAssignees", @@ -598,7 +612,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -622,7 +636,7 @@ ] }, "patch": { - "description": "Updates one or more fields of an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding announcement or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested announcement has already been\ndeleted.\n* `NOT_FOUND` if the requested course or announcement does not exist", + "description": "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", "flatPath": "v1/courses/{courseId}/announcements/{id}", "httpMethod": "PATCH", "id": "classroom.courses.announcements.patch", @@ -632,7 +646,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -644,7 +658,7 @@ "type": "string" }, "updateMask": { - "description": "Mask that identifies which fields on the announcement to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the Announcement object. If\na field that does not support empty values is included in the update mask\nand not set in the Announcement object, an `INVALID_ARGUMENT` error is\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `text`\n* `state`\n* `scheduled_time`", + "description": "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`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -666,7 +680,7 @@ "courseWork": { "methods": { "create": { - "description": "Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible", + "description": "Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible", "flatPath": "v1/courses/{courseId}/courseWork", "httpMethod": "POST", "id": "classroom.courses.courseWork.create", @@ -675,7 +689,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -693,7 +707,7 @@ ] }, "delete": { - "description": "Deletes a course work.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.", + "description": "Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.", "flatPath": "v1/courses/{courseId}/courseWork/{id}", "httpMethod": "DELETE", "id": "classroom.courses.courseWork.delete", @@ -703,13 +717,13 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "id": { - "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.", + "description": "Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.", "location": "path", "required": true, "type": "string" @@ -724,7 +738,7 @@ ] }, "get": { - "description": "Returns course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/courseWork/{id}", "httpMethod": "GET", "id": "classroom.courses.courseWork.get", @@ -734,7 +748,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -758,7 +772,7 @@ ] }, "list": { - "description": "Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/courseWork", "httpMethod": "GET", "id": "classroom.courses.courseWork.list", @@ -767,36 +781,42 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "courseWorkStates": { - "description": "Restriction on the work status to return. Only courseWork that matches\nis returned. If unspecified, items with a work status of `PUBLISHED`\nis returned.", + "description": "Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.", "enum": [ "COURSE_WORK_STATE_UNSPECIFIED", "PUBLISHED", "DRAFT", "DELETED" ], + "enumDescriptions": [ + "No state specified. This is never returned.", + "Status for work that has been published. This is the default state.", + "Status for work that is not yet published. Work in this state is visible only to course teachers and domain administrators.", + "Status for work that was published but is now deleted. Work in this state is visible only to course teachers and domain administrators. Work in this state is deleted after some time." + ], "location": "query", "repeated": true, "type": "string" }, "orderBy": { - "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`", + "description": "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`", "location": "query", "type": "string" }, "pageSize": { - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", + "description": "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.", "location": "query", "type": "string" } @@ -813,7 +833,7 @@ ] }, "modifyAssignees": { - "description": "Modifies assignee mode and options of a coursework.\n\nOnly a teacher of the course that contains the coursework may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees", "httpMethod": "POST", "id": "classroom.courses.courseWork.modifyAssignees", @@ -823,7 +843,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -847,7 +867,7 @@ ] }, "patch": { - "description": "Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", + "description": "Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", "flatPath": "v1/courses/{courseId}/courseWork/{id}", "httpMethod": "PATCH", "id": "classroom.courses.courseWork.patch", @@ -857,7 +877,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -869,7 +889,7 @@ "type": "string" }, "updateMask": { - "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error is\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `scheduled_time`\n* `submission_modification_mode`\n* `topic_id`", + "description": "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`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -891,7 +911,7 @@ "studentSubmissions": { "methods": { "get": { - "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", "httpMethod": "GET", "id": "classroom.courses.courseWork.studentSubmissions.get", @@ -902,7 +922,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -934,7 +954,7 @@ ] }, "list": { - "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions", "httpMethod": "GET", "id": "classroom.courses.courseWork.studentSubmissions.list", @@ -944,40 +964,45 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "courseWorkId": { - "description": "Identifier of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.", + "description": "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.", "location": "path", "required": true, "type": "string" }, "late": { - "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.", + "description": "Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.", "enum": [ "LATE_VALUES_UNSPECIFIED", "LATE_ONLY", "NOT_LATE_ONLY" ], + "enumDescriptions": [ + "No restriction on submission late values specified.", + "Return StudentSubmissions where late is true.", + "Return StudentSubmissions where late is false." + ], "location": "query", "type": "string" }, "pageSize": { - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", + "description": "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.", "location": "query", "type": "string" }, "states": { - "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.", + "description": "Requested submission states. If specified, returned student submissions match one of the specified submission states.", "enum": [ "SUBMISSION_STATE_UNSPECIFIED", "NEW", @@ -986,12 +1011,20 @@ "RETURNED", "RECLAIMED_BY_STUDENT" ], + "enumDescriptions": [ + "No state specified. This should never be returned.", + "The student has never accessed this submission. Attachments are not returned and timestamps is not set.", + "Has been created.", + "Has been turned in to the teacher.", + "Has been returned to the student.", + "Student chose to \"unsubmit\" the assignment." + ], "location": "query", "repeated": true, "type": "string" }, "userId": { - "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "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", "location": "query", "type": "string" } @@ -1010,7 +1043,7 @@ ] }, "modifyAttachments": { - "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requested student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", + "description": "Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments", "httpMethod": "POST", "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments", @@ -1021,7 +1054,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -1052,7 +1085,7 @@ ] }, "patch": { - "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", + "description": "Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", "httpMethod": "PATCH", "id": "classroom.courses.courseWork.studentSubmissions.patch", @@ -1063,7 +1096,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -1081,7 +1114,7 @@ "type": "string" }, "updateMask": { - "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n\n* `draft_grade`\n* `assigned_grade`", + "description": "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`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1100,7 +1133,7 @@ ] }, "reclaim": { - "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and updates the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", + "description": "Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim", "httpMethod": "POST", "id": "classroom.courses.courseWork.studentSubmissions.reclaim", @@ -1111,7 +1144,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -1141,7 +1174,7 @@ ] }, "return": { - "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", + "description": "Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return", "httpMethod": "POST", "id": "classroom.courses.courseWork.studentSubmissions.return", @@ -1152,7 +1185,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -1182,7 +1215,7 @@ ] }, "turnIn": { - "description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", + "description": "Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn", "httpMethod": "POST", "id": "classroom.courses.courseWork.studentSubmissions.turnIn", @@ -1193,7 +1226,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -1229,7 +1262,7 @@ "students": { "methods": { "create": { - "description": "Adds a user as a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse.", + "description": "Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.", "flatPath": "v1/courses/{courseId}/students", "httpMethod": "POST", "id": "classroom.courses.students.create", @@ -1238,13 +1271,13 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "enrollmentCode": { - "description": "Enrollment code of the course to create the student in.\nThis code is required if userId\ncorresponds to the requesting user; it may be omitted if the requesting\nuser has administrative permissions to create students for any user.", + "description": "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.", "location": "query", "type": "string" } @@ -1263,7 +1296,7 @@ ] }, "delete": { - "description": "Deletes a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/students/{userId}", "httpMethod": "DELETE", "id": "classroom.courses.students.delete", @@ -1273,13 +1306,13 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "userId": { - "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "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", "location": "path", "required": true, "type": "string" @@ -1294,7 +1327,7 @@ ] }, "get": { - "description": "Returns a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/students/{userId}", "httpMethod": "GET", "id": "classroom.courses.students.get", @@ -1304,13 +1337,13 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "userId": { - "description": "Identifier of the student to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "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", "location": "path", "required": true, "type": "string" @@ -1328,7 +1361,7 @@ ] }, "list": { - "description": "Returns a list of students of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.", + "description": "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.", "flatPath": "v1/courses/{courseId}/students", "httpMethod": "GET", "id": "classroom.courses.students.list", @@ -1337,19 +1370,19 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "pageSize": { - "description": "Maximum number of items to return. The default is 30 if unspecified or `0`.\n\nThe server may return fewer than the specified number of results.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.", + "description": "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.", "location": "query", "type": "string" } @@ -1370,7 +1403,7 @@ "teachers": { "methods": { "create": { - "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.", + "description": "Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.", "flatPath": "v1/courses/{courseId}/teachers", "httpMethod": "POST", "id": "classroom.courses.teachers.create", @@ -1379,7 +1412,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -1399,7 +1432,7 @@ ] }, "delete": { - "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.", + "description": "Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.", "flatPath": "v1/courses/{courseId}/teachers/{userId}", "httpMethod": "DELETE", "id": "classroom.courses.teachers.delete", @@ -1409,13 +1442,13 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "userId": { - "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "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", "location": "path", "required": true, "type": "string" @@ -1430,7 +1463,7 @@ ] }, "get": { - "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/teachers/{userId}", "httpMethod": "GET", "id": "classroom.courses.teachers.get", @@ -1440,13 +1473,13 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "userId": { - "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "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", "location": "path", "required": true, "type": "string" @@ -1464,7 +1497,7 @@ ] }, "list": { - "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.", + "description": "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.", "flatPath": "v1/courses/{courseId}/teachers", "httpMethod": "GET", "id": "classroom.courses.teachers.list", @@ -1473,19 +1506,19 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "pageSize": { - "description": "Maximum number of items to return. The default is 30 if unspecified or `0`.\n\nThe server may return fewer than the specified number of results.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.", + "description": "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.", "location": "query", "type": "string" } @@ -1506,7 +1539,7 @@ "topics": { "methods": { "create": { - "description": "Creates a topic.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create a topic in the requested course,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/topics", "httpMethod": "POST", "id": "classroom.courses.topics.create", @@ -1515,7 +1548,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -1533,7 +1566,7 @@ ] }, "delete": { - "description": "Deletes a topic.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not allowed to delete the\nrequested topic or for access errors.\n* `FAILED_PRECONDITION` if the requested topic has already been\ndeleted.\n* `NOT_FOUND` if no course or topic exists with the requested ID.", + "description": "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.", "flatPath": "v1/courses/{courseId}/topics/{id}", "httpMethod": "DELETE", "id": "classroom.courses.topics.delete", @@ -1543,7 +1576,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -1564,7 +1597,7 @@ ] }, "get": { - "description": "Returns a topic.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or topic, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or topic does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/topics/{id}", "httpMethod": "GET", "id": "classroom.courses.topics.get", @@ -1596,7 +1629,7 @@ ] }, "list": { - "description": "Returns the list of topics that the requester is permitted to view.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.", + "description": "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.", "flatPath": "v1/courses/{courseId}/topics", "httpMethod": "GET", "id": "classroom.courses.topics.list", @@ -1605,19 +1638,19 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" }, "pageSize": { - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", + "description": "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.", "location": "query", "type": "string" } @@ -1632,7 +1665,7 @@ ] }, "patch": { - "description": "Updates one or more fields of a topic.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding topic or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or topic does not exist", + "description": "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", "flatPath": "v1/courses/{courseId}/topics/{id}", "httpMethod": "PATCH", "id": "classroom.courses.topics.patch", @@ -1642,7 +1675,7 @@ ], "parameters": { "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.", "location": "path", "required": true, "type": "string" @@ -1654,7 +1687,7 @@ "type": "string" }, "updateMask": { - "description": "Mask that identifies which fields on the topic to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the Topic object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the Topic object, an `INVALID_ARGUMENT` error is\nreturned.\n\nThe following fields may be specified:\n\n* `name`", + "description": "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`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1678,7 +1711,7 @@ "invitations": { "methods": { "accept": { - "description": "Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID.", + "description": "Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.", "flatPath": "v1/invitations/{id}:accept", "httpMethod": "POST", "id": "classroom.invitations.accept", @@ -1702,7 +1735,7 @@ ] }, "create": { - "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.", + "description": "Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.", "flatPath": "v1/invitations", "httpMethod": "POST", "id": "classroom.invitations.create", @@ -1720,7 +1753,7 @@ ] }, "delete": { - "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.", + "description": "Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.", "flatPath": "v1/invitations/{id}", "httpMethod": "DELETE", "id": "classroom.invitations.delete", @@ -1744,7 +1777,7 @@ ] }, "get": { - "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.", + "description": "Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.", "flatPath": "v1/invitations/{id}", "httpMethod": "GET", "id": "classroom.invitations.get", @@ -1769,30 +1802,30 @@ ] }, "list": { - "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.", + "description": "Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.", "flatPath": "v1/invitations", "httpMethod": "GET", "id": "classroom.invitations.list", "parameterOrder": [], "parameters": { "courseId": { - "description": "Restricts returned invitations to those for a course with the specified\nidentifier.", + "description": "Restricts returned invitations to those for a course with the specified identifier.", "location": "query", "type": "string" }, "pageSize": { - "description": "Maximum number of items to return. The default is 500 if unspecified or\n`0`.\n\nThe server may return fewer than the specified number of results.", + "description": "Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating\nthat the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.", + "description": "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.", "location": "query", "type": "string" }, "userId": { - "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user", "location": "query", "type": "string" } @@ -1811,7 +1844,7 @@ "registrations": { "methods": { "create": { - "description": "Creates a `Registration`, causing Classroom to start sending notifications\nfrom the provided `feed` to the destination provided in `cloudPubSubTopic`.\n\nReturns the created `Registration`. Currently, this will be the same as\nthe argument, but with server-assigned fields such as `expiry_time` and\n`id` filled in.\n\nNote that any value specified for the `expiry_time` or `id` fields will be\nignored.\n\nWhile Classroom may validate the `cloudPubSubTopic` and return errors on a\nbest effort basis, it is the caller's responsibility to ensure that it\nexists and that Classroom has permission to publish to it.\n\nThis method may return the following error codes:\n\n* `PERMISSION_DENIED` if:\n * the authenticated user does not have permission to receive\n notifications from the requested field; or\n * the current user has not granted access to the current Cloud project\n with the appropriate scope for the requested feed. Note that\n domain-wide delegation of authority is not currently supported for\n this purpose. If the request has the appropriate scope, but no grant\n exists, a Request Errors is returned.\n * another access error is encountered.\n* `INVALID_ARGUMENT` if:\n * no `cloudPubsubTopic` is specified, or the specified\n `cloudPubsubTopic` is not valid; or\n * no `feed` is specified, or the specified `feed` is not valid.\n* `NOT_FOUND` if:\n * the specified `feed` cannot be located, or the requesting user does\n not have permission to determine whether or not it exists; or\n * the specified `cloudPubsubTopic` cannot be located, or Classroom has\n not been granted permission to publish to it.", + "description": "Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it.", "flatPath": "v1/registrations", "httpMethod": "POST", "id": "classroom.registrations.create", @@ -1829,7 +1862,7 @@ ] }, "delete": { - "description": "Deletes a `Registration`, causing Classroom to stop sending notifications\nfor that `Registration`.", + "description": "Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`.", "flatPath": "v1/registrations/{registrationId}", "httpMethod": "DELETE", "id": "classroom.registrations.delete", @@ -1857,7 +1890,7 @@ "userProfiles": { "methods": { "get": { - "description": "Returns a user profile.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the requested ID, or for\naccess errors.", + "description": "Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.", "flatPath": "v1/userProfiles/{userId}", "httpMethod": "GET", "id": "classroom.userProfiles.get", @@ -1866,7 +1899,7 @@ ], "parameters": { "userId": { - "description": "Identifier of the profile to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user", "location": "path", "required": true, "type": "string" @@ -1888,7 +1921,7 @@ "guardianInvitations": { "methods": { "create": { - "description": "Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user.", + "description": "Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.", "flatPath": "v1/userProfiles/{studentId}/guardianInvitations", "httpMethod": "POST", "id": "classroom.userProfiles.guardianInvitations.create", @@ -1915,7 +1948,7 @@ ] }, "get": { - "description": "Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student.", + "description": "Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.", "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}", "httpMethod": "GET", "id": "classroom.userProfiles.guardianInvitations.get", @@ -1947,7 +1980,7 @@ ] }, "list": { - "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.", + "description": "Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `\"-\"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.", "flatPath": "v1/userProfiles/{studentId}/guardianInvitations", "httpMethod": "GET", "id": "classroom.userProfiles.guardianInvitations.list", @@ -1956,34 +1989,39 @@ ], "parameters": { "invitedEmailAddress": { - "description": "If specified, only results with the specified `invited_email_address`\nare returned.", + "description": "If specified, only results with the specified `invited_email_address` are returned.", "location": "query", "type": "string" }, "pageSize": { - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist\ncall, indicating that the subsequent page of results should be returned.\n\nThe list\nrequest must be otherwise identical to the one that resulted in this token.", + "description": "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.", "location": "query", "type": "string" }, "states": { - "description": "If specified, only results with the specified `state` values are\nreturned. Otherwise, results with a `state` of `PENDING` are returned.", + "description": "If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned.", "enum": [ "GUARDIAN_INVITATION_STATE_UNSPECIFIED", "PENDING", "COMPLETE" ], + "enumDescriptions": [ + "Should never be returned.", + "The invitation is active and awaiting a response.", + "The invitation is no longer active. It may have been accepted, declined, withdrawn or it may have expired." + ], "location": "query", "repeated": true, "type": "string" }, "studentId": { - "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations.", + "description": "The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.", "location": "path", "required": true, "type": "string" @@ -1999,7 +2037,7 @@ ] }, "patch": { - "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.", + "description": "Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.", "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}", "httpMethod": "PATCH", "id": "classroom.userProfiles.guardianInvitations.patch", @@ -2021,7 +2059,7 @@ "type": "string" }, "updateMask": { - "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. The following fields are valid:\n\n* `state`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=,,...`", + "description": "Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2043,7 +2081,7 @@ "guardians": { "methods": { "delete": { - "description": "Deletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian\nwill no longer be accessible via the API.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to manage guardians for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FOUND` if the requesting user is permitted to modify guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student with the provided `guardian_id`.", + "description": "Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`.", "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}", "httpMethod": "DELETE", "id": "classroom.userProfiles.guardians.delete", @@ -2059,7 +2097,7 @@ "type": "string" }, "studentId": { - "description": "The student whose guardian is to be deleted. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user", "location": "path", "required": true, "type": "string" @@ -2074,7 +2112,7 @@ ] }, "get": { - "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`.", + "description": "Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`.", "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}", "httpMethod": "GET", "id": "classroom.userProfiles.guardians.get", @@ -2090,7 +2128,7 @@ "type": "string" }, "studentId": { - "description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user", "location": "path", "required": true, "type": "string" @@ -2107,7 +2145,7 @@ ] }, "list": { - "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.", + "description": "Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `\"-\"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.", "flatPath": "v1/userProfiles/{studentId}/guardians", "httpMethod": "GET", "id": "classroom.userProfiles.guardians.list", @@ -2116,23 +2154,23 @@ ], "parameters": { "invitedEmailAddress": { - "description": "Filter results by the email address that the original invitation was sent\nto, resulting in this guardian link.\nThis filter can only be used by domain administrators.", + "description": "Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.", "location": "query", "type": "string" }, "pageSize": { - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", + "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", + "description": "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.", "location": "query", "type": "string" }, "studentId": { - "description": "Filter results by the student who the guardian is linked to.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user has access to view.", + "description": "Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user has access to view.", "location": "path", "required": true, "type": "string" @@ -2153,7 +2191,7 @@ } } }, - "revision": "20200714", + "revision": "20200801", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "Announcement": { @@ -2161,11 +2199,11 @@ "id": "Announcement", "properties": { "alternateLink": { - "description": "Absolute link to this announcement in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.", + "description": "Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.", "type": "string" }, "assigneeMode": { - "description": "Assignee mode of the announcement.\nIf unspecified, the default value is `ALL_STUDENTS`.", + "description": "Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.", "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", @@ -2173,34 +2211,34 @@ ], "enumDescriptions": [ "No mode specified. This is never returned.", - "All students can see the item.\nThis is the default state.", + "All students can see the item. This is the default state.", "A subset of the students can see the item." ], "type": "string" }, "courseId": { - "description": "Identifier of the course.\n\nRead-only.", + "description": "Identifier of the course. Read-only.", "type": "string" }, "creationTime": { - "description": "Timestamp when this announcement was created.\n\nRead-only.", + "description": "Timestamp when this announcement was created. Read-only.", "format": "google-datetime", "type": "string" }, "creatorUserId": { - "description": "Identifier for the user that created the announcement.\n\nRead-only.", + "description": "Identifier for the user that created the announcement. Read-only.", "type": "string" }, "id": { - "description": "Classroom-assigned identifier of this announcement, unique per course.\n\nRead-only.", + "description": "Classroom-assigned identifier of this announcement, unique per course. Read-only.", "type": "string" }, "individualStudentsOptions": { "$ref": "IndividualStudentsOptions", - "description": "Identifiers of students with access to the announcement.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students\nspecified in this field can see the announcement." + "description": "Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement." }, "materials": { - "description": "Additional materials.\n\nAnnouncements must have no more than 20 material items.", + "description": "Additional materials. Announcements must have no more than 20 material items.", "items": { "$ref": "Material" }, @@ -2212,7 +2250,7 @@ "type": "string" }, "state": { - "description": "Status of this announcement.\nIf unspecified, the default state is `DRAFT`.", + "description": "Status of this announcement. If unspecified, the default state is `DRAFT`.", "enum": [ "ANNOUNCEMENT_STATE_UNSPECIFIED", "PUBLISHED", @@ -2221,18 +2259,18 @@ ], "enumDescriptions": [ "No state specified. This is never returned.", - "Status for announcement that has been published.\nThis is the default state.", - "Status for an announcement that is not yet published.\nAnnouncement in this state is visible only to course teachers and domain\nadministrators.", - "Status for announcement that was published but is now deleted.\nAnnouncement in this state is visible only to course teachers and domain\nadministrators.\nAnnouncement in this state is deleted after some time." + "Status for announcement that has been published. This is the default state.", + "Status for an announcement that is not yet published. Announcement in this state is visible only to course teachers and domain administrators.", + "Status for announcement that was published but is now deleted. Announcement in this state is visible only to course teachers and domain administrators. Announcement in this state is deleted after some time." ], "type": "string" }, "text": { - "description": "Description of this announcement.\nThe text must be a valid UTF-8 string containing no more\nthan 30,000 characters.", + "description": "Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.", "type": "string" }, "updateTime": { - "description": "Timestamp of the most recent change to this announcement.\n\nRead-only.", + "description": "Timestamp of the most recent change to this announcement. Read-only.", "format": "google-datetime", "type": "string" } @@ -2245,7 +2283,7 @@ "properties": { "studentWorkFolder": { "$ref": "DriveFolder", - "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers and administrators." + "description": "Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators." } }, "type": "object" @@ -2255,7 +2293,7 @@ "id": "AssignmentSubmission", "properties": { "attachments": { - "description": "Attachments added by the student.\nDrive files that correspond to materials with a share mode of\nSTUDENT_COPY may not exist yet if the student has not accessed the\nassignment in Classroom.\n\nSome attachment metadata is only populated if the requesting user has\npermission to access it. Identifier and alternate_link fields are always\navailable, but others (for example, title) may not be.", + "description": "Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (for example, title) may not be.", "items": { "$ref": "Attachment" }, @@ -2265,7 +2303,7 @@ "type": "object" }, "Attachment": { - "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.", + "description": "Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.", "id": "Attachment", "properties": { "driveFile": { @@ -2288,11 +2326,11 @@ "type": "object" }, "CloudPubsubTopic": { - "description": "A reference to a Cloud Pub/Sub topic.\n\nTo register for notifications, the owner of the topic must grant\n`classroom-notifications@system.gserviceaccount.com` the\n `projects.topics.publish` permission.", + "description": "A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant `classroom-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.", "id": "CloudPubsubTopic", "properties": { "topicName": { - "description": "The `name` field of a Cloud Pub/Sub\n[Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).", + "description": "The `name` field of a Cloud Pub/Sub [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).", "type": "string" } }, @@ -2303,26 +2341,26 @@ "id": "Course", "properties": { "alternateLink": { - "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.", + "description": "Absolute link to this course in the Classroom web UI. Read-only.", "type": "string" }, "calendarId": { - "description": "The Calendar ID for a calendar that all course members can see, to which\nClassroom adds events for course work and announcements in the course.\n\nRead-only.", + "description": "The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.", "type": "string" }, "courseGroupEmail": { - "description": "The email address of a Google group containing all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.", + "description": "The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.", "type": "string" }, "courseMaterialSets": { - "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.", + "description": "Sets of materials that appear on the \"about\" page of this course. Read-only.", "items": { "$ref": "CourseMaterialSet" }, "type": "array" }, "courseState": { - "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.", + "description": "State of the course. If unspecified, the default state is `PROVISIONED`.", "enum": [ "COURSE_STATE_UNSPECIFIED", "ACTIVE", @@ -2334,64 +2372,64 @@ "enumDescriptions": [ "No course state. No returned Course message will use this value.", "The course is active.", - "The course has been archived. You cannot modify it except to change it\nto a different state.", - "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be changed to `PROVISIONED` if it is in the `DECLINED`\nstate.", - "The course has been created, but declined. It is accessible by the\ncourse owner and domain administrators, though it will not be\ndisplayed in the web UI. You cannot modify the course except to change it\nto the `PROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `PROVISIONED`\nstate.", - "The course has been suspended. You cannot modify the course, and only the\nuser identified by the `owner_id` can view the course.\nA course may be placed in this state if it potentially violates the\nTerms of Service." + "The course has been archived. You cannot modify it except to change it to a different state.", + "The course has been created, but not yet activated. It is accessible by the primary teacher and domain administrators, who may modify it or change it to the `ACTIVE` or `DECLINED` states. A course may only be changed to `PROVISIONED` if it is in the `DECLINED` state.", + "The course has been created, but declined. It is accessible by the course owner and domain administrators, though it will not be displayed in the web UI. You cannot modify the course except to change it to the `PROVISIONED` state. A course may only be changed to `DECLINED` if it is in the `PROVISIONED` state.", + "The course has been suspended. You cannot modify the course, and only the user identified by the `owner_id` can view the course. A course may be placed in this state if it potentially violates the Terms of Service." ], "type": "string" }, "creationTime": { - "description": "Creation time of the course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.", + "description": "Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.", "format": "google-datetime", "type": "string" }, "description": { - "description": "Optional description.\nFor example, \"We'll be learning about the structure of living\ncreatures from a combination of textbooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field must be a valid UTF-8 string and no longer than 30,000\ncharacters.", + "description": "Optional description. For example, \"We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!\" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.", "type": "string" }, "descriptionHeading": { - "description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.", + "description": "Optional heading for the description. For example, \"Welcome to 10th Grade Biology.\" If set, this field must be a valid UTF-8 string and no longer than 3600 characters.", "type": "string" }, "enrollmentCode": { - "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.", + "description": "Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.", "type": "string" }, "guardiansEnabled": { - "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.", + "description": "Whether or not guardian notifications are enabled for this course. Read-only.", "type": "boolean" }, "id": { - "description": "Identifier for this course assigned by Classroom.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\nalias string in the\nrequest to create a corresponding alias. The `id` is still assigned by\nClassroom and cannot be updated after the course is created.\n\nSpecifying this field in a course update mask results in an error.", + "description": "Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.", "type": "string" }, "name": { - "description": "Name of the course.\nFor example, \"10th Grade Biology\".\nThe name is required. It must be between 1 and 750 characters and a valid\nUTF-8 string.", + "description": "Name of the course. For example, \"10th Grade Biology\". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.", "type": "string" }, "ownerId": { - "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Admins can also specify this field\nin a patch course request to\ntransfer ownership. In other contexts, it is read-only.", + "description": "The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.", "type": "string" }, "room": { - "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters.", + "description": "Optional room location. For example, \"301\". If set, this field must be a valid UTF-8 string and no longer than 650 characters.", "type": "string" }, "section": { - "description": "Section of the course.\nFor example, \"Period 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\ncharacters.", + "description": "Section of the course. For example, \"Period 2\". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.", "type": "string" }, "teacherFolder": { "$ref": "DriveFolder", - "description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain\nadministrators.\n\nRead-only." + "description": "Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only." }, "teacherGroupEmail": { - "description": "The email address of a Google group containing all teachers of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.", + "description": "The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.", "type": "string" }, "updateTime": { - "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.", + "description": "Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.", "format": "google-datetime", "type": "string" } @@ -2399,11 +2437,11 @@ "type": "object" }, "CourseAlias": { - "description": "Alternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the\nfollowing scopes:\n\n* domain: A domain-scoped alias is visible to all users within the alias\ncreator's domain and can be created only by a domain admin. A domain-scoped\nalias is often used when a course has an identifier external to Classroom.\n\n* project: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alternative identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREADY_EXISTS` if a previous one has succeeded.", + "description": "Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.", "id": "CourseAlias", "properties": { "alias": { - "description": "Alias string. The format of the string indicates the desired alias scoping.\n\n* `d:` indicates a domain-scoped alias.\n Example: `d:math_101`\n* `p:` indicates a project-scoped alias.\n Example: `p:abc123`\n\nThis field has a maximum length of 256 characters.", + "description": "Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.", "type": "string" } }, @@ -2433,7 +2471,7 @@ "type": "object" }, "CourseMaterialSet": { - "description": "A set of materials that appears on the \"About\" page of the course.\nThese materials might include a syllabus, schedule, or other background\ninformation relating to the course as a whole.", + "description": "A set of materials that appears on the \"About\" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.", "id": "CourseMaterialSet", "properties": { "materials": { @@ -2466,11 +2504,11 @@ "id": "CourseWork", "properties": { "alternateLink": { - "description": "Absolute link to this course work in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.", + "description": "Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.", "type": "string" }, "assigneeMode": { - "description": "Assignee mode of the coursework.\nIf unspecified, the default value is `ALL_STUDENTS`.", + "description": "Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`.", "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", @@ -2478,67 +2516,67 @@ ], "enumDescriptions": [ "No mode specified. This is never returned.", - "All students can see the item.\nThis is the default state.", + "All students can see the item. This is the default state.", "A subset of the students can see the item." ], "type": "string" }, "assignment": { "$ref": "Assignment", - "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only." + "description": "Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only." }, "associatedWithDeveloper": { - "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee CreateCourseWork for more\ndetails.\n\nRead-only.", + "description": "Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.", "type": "boolean" }, "courseId": { - "description": "Identifier of the course.\n\nRead-only.", + "description": "Identifier of the course. Read-only.", "type": "string" }, "creationTime": { - "description": "Timestamp when this course work was created.\n\nRead-only.", + "description": "Timestamp when this course work was created. Read-only.", "format": "google-datetime", "type": "string" }, "creatorUserId": { - "description": "Identifier for the user that created the coursework.\n\nRead-only.", + "description": "Identifier for the user that created the coursework. Read-only.", "type": "string" }, "description": { - "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters.", + "description": "Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.", "type": "string" }, "dueDate": { "$ref": "Date", - "description": "Optional date, in UTC, that submissions for this course work are due.\nThis must be specified if `due_time` is specified." + "description": "Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified." }, "dueTime": { "$ref": "TimeOfDay", - "description": "Optional time of day, in UTC, that submissions for this course work\nare due.\nThis must be specified if `due_date` is specified." + "description": "Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified." }, "id": { - "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.", + "description": "Classroom-assigned identifier of this course work, unique per course. Read-only.", "type": "string" }, "individualStudentsOptions": { "$ref": "IndividualStudentsOptions", - "description": "Identifiers of students with access to the coursework.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students\nspecified in this field are assigned the coursework." + "description": "Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework." }, "materials": { - "description": "Additional materials.\n\nCourseWork must have no more than 20 material items.", + "description": "Additional materials. CourseWork must have no more than 20 material items.", "items": { "$ref": "Material" }, "type": "array" }, "maxPoints": { - "description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.", + "description": "Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.", "format": "double", "type": "number" }, "multipleChoiceQuestion": { "$ref": "MultipleChoiceQuestion", - "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise." + "description": "Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise." }, "scheduledTime": { "description": "Optional timestamp when this course work is scheduled to be published.", @@ -2546,7 +2584,7 @@ "type": "string" }, "state": { - "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.", + "description": "Status of this course work. If unspecified, the default state is `DRAFT`.", "enum": [ "COURSE_WORK_STATE_UNSPECIFIED", "PUBLISHED", @@ -2555,14 +2593,14 @@ ], "enumDescriptions": [ "No state specified. This is never returned.", - "Status for work that has been published.\nThis is the default state.", - "Status for work that is not yet published.\nWork in this state is visible only to course teachers and domain\nadministrators.", - "Status for work that was published but is now deleted.\nWork in this state is visible only to course teachers and domain\nadministrators.\nWork in this state is deleted after some time." + "Status for work that has been published. This is the default state.", + "Status for work that is not yet published. Work in this state is visible only to course teachers and domain administrators.", + "Status for work that was published but is now deleted. Work in this state is visible only to course teachers and domain administrators. Work in this state is deleted after some time." ], "type": "string" }, "submissionModificationMode": { - "description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.", + "description": "Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.", "enum": [ "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED", "MODIFIABLE_UNTIL_TURNED_IN", @@ -2576,20 +2614,20 @@ "type": "string" }, "title": { - "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.", + "description": "Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.", "type": "string" }, "topicId": { - "description": "Identifier for the topic that this coursework is associated with.\nMust match an existing topic in the course.", + "description": "Identifier for the topic that this coursework is associated with. Must match an existing topic in the course.", "type": "string" }, "updateTime": { - "description": "Timestamp of the most recent change to this course work.\n\nRead-only.", + "description": "Timestamp of the most recent change to this course work. Read-only.", "format": "google-datetime", "type": "string" }, "workType": { - "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.", + "description": "Type of this course work. The type is set when the course work is created and cannot be changed.", "enum": [ "COURSE_WORK_TYPE_UNSPECIFIED", "ASSIGNMENT", @@ -2619,21 +2657,21 @@ "type": "object" }, "Date": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day\nand time zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. This can represent:\n\n* A full date, with non-zero year, month and day values\n* A month and day value, with a zero year, e.g. an anniversary\n* A year on its own, with zero month and day values\n* A year and month value, with a zero day, e.g. a credit card expiration date\n\nRelated types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "Date", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year by itself or a year and month where the day is not\nsignificant.", + "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a\nmonth and day.", + "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.", + "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", "format": "int32", "type": "integer" } @@ -2645,7 +2683,7 @@ "id": "DriveFile", "properties": { "alternateLink": { - "description": "URL that can be used to access the Drive item.\n\nRead-only.", + "description": "URL that can be used to access the Drive item. Read-only.", "type": "string" }, "id": { @@ -2653,11 +2691,11 @@ "type": "string" }, "thumbnailUrl": { - "description": "URL of a thumbnail image of the Drive item.\n\nRead-only.", + "description": "URL of a thumbnail image of the Drive item. Read-only.", "type": "string" }, "title": { - "description": "Title of the Drive item.\n\nRead-only.", + "description": "Title of the Drive item. Read-only.", "type": "string" } }, @@ -2668,7 +2706,7 @@ "id": "DriveFolder", "properties": { "alternateLink": { - "description": "URL that can be used to access the Drive folder.\n\nRead-only.", + "description": "URL that can be used to access the Drive folder. Read-only.", "type": "string" }, "id": { @@ -2676,29 +2714,29 @@ "type": "string" }, "title": { - "description": "Title of the Drive folder.\n\nRead-only.", + "description": "Title of the Drive folder. Read-only.", "type": "string" } }, "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, "Feed": { - "description": "A class of notifications that an application can register to receive.\nFor example: \"all roster changes for a domain\".", + "description": "A class of notifications that an application can register to receive. For example: \"all roster changes for a domain\".", "id": "Feed", "properties": { "courseRosterChangesInfo": { "$ref": "CourseRosterChangesInfo", - "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.\nThis field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`." + "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. This field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`." }, "courseWorkChangesInfo": { "$ref": "CourseWorkChangesInfo", - "description": "Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`.\nThis field must be specified if `feed_type` is `COURSE_WORK_CHANGES`." + "description": "Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`. This field must be specified if `feed_type` is `COURSE_WORK_CHANGES`." }, "feedType": { "description": "The type of feed.", @@ -2710,9 +2748,9 @@ ], "enumDescriptions": [ "Should never be returned or provided.", - "All roster changes for a particular domain.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation.", - "All roster changes for a particular course.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation.", - "All course work activity for a particular course.\n\nNotifications will be generated when a CourseWork or\nStudentSubmission object is created or modified. No notification will be\ngenerated when a StudentSubmission object is created in connection with\nthe creation or modification of its parent CourseWork object (but a\nnotification will be generated for that CourseWork object's creation or\nmodification)." + "All roster changes for a particular domain. Notifications will be generated whenever a user joins or leaves a course. No notifications will be generated when an invitation is created or deleted, but notifications will be generated when a user joins a course by accepting an invitation.", + "All roster changes for a particular course. Notifications will be generated whenever a user joins or leaves a course. No notifications will be generated when an invitation is created or deleted, but notifications will be generated when a user joins a course by accepting an invitation.", + "All course work activity for a particular course. Notifications will be generated when a CourseWork or StudentSubmission object is created or modified. No notification will be generated when a StudentSubmission object is created in connection with the creation or modification of its parent CourseWork object (but a notification will be generated for that CourseWork object's creation or modification)." ], "type": "string" } @@ -2728,15 +2766,15 @@ "type": "string" }, "responseUrl": { - "description": "URL of the form responses document.\nOnly set if respsonses have been recorded and only when the\nrequesting user is an editor of the form.\n\nRead-only.", + "description": "URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.", "type": "string" }, "thumbnailUrl": { - "description": "URL of a thumbnail image of the Form.\n\nRead-only.", + "description": "URL of a thumbnail image of the Form. Read-only.", "type": "string" }, "title": { - "description": "Title of the Form.\n\nRead-only.", + "description": "Title of the Form. Read-only.", "type": "string" } }, @@ -2753,7 +2791,7 @@ "CREATE_COURSE" ], "enumDescriptions": [ - "No permission is specified. This is not returned and is not a\nvalid value.", + "No permission is specified. This is not returned and is not a valid value.", "User is permitted to create a course." ], "type": "string" @@ -2791,7 +2829,7 @@ "type": "string" }, "maxPoints": { - "description": "The denominator of the grade at this time in the submission grade\nhistory.", + "description": "The denominator of the grade at this time in the submission grade history.", "format": "double", "type": "number" }, @@ -2804,7 +2842,7 @@ "type": "object" }, "Guardian": { - "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work.", + "description": "Association between a student and a guardian of that student. The guardian may receive information about the student's course work.", "id": "Guardian", "properties": { "guardianId": { @@ -2816,7 +2854,7 @@ "description": "User profile for the guardian." }, "invitedEmailAddress": { - "description": "The email address to which the initial guardian invitation was sent.\nThis field is only visible to domain administrators.", + "description": "The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.", "type": "string" }, "studentId": { @@ -2827,20 +2865,20 @@ "type": "object" }, "GuardianInvitation": { - "description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.", + "description": "An invitation to become the guardian of a specified user, sent to a specified email address.", "id": "GuardianInvitation", "properties": { "creationTime": { - "description": "The time that this invitation was created.\n\nRead-only.", + "description": "The time that this invitation was created. Read-only.", "format": "google-datetime", "type": "string" }, "invitationId": { - "description": "Unique identifier for this invitation.\n\nRead-only.", + "description": "Unique identifier for this invitation. Read-only.", "type": "string" }, "invitedEmailAddress": { - "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.", + "description": "Email address that the invitation was sent to. This field is only visible to domain administrators.", "type": "string" }, "state": { @@ -2853,7 +2891,7 @@ "enumDescriptions": [ "Should never be returned.", "The invitation is active and awaiting a response.", - "The invitation is no longer active. It may have been accepted, declined,\nwithdrawn or it may have expired." + "The invitation is no longer active. It may have been accepted, declined, withdrawn or it may have expired." ], "type": "string" }, @@ -2865,11 +2903,11 @@ "type": "object" }, "IndividualStudentsOptions": { - "description": "Assignee details about a coursework/announcement.\nThis field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.", + "description": "Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.", "id": "IndividualStudentsOptions", "properties": { "studentIds": { - "description": "Identifiers for the students that have access to the\ncoursework/announcement.", + "description": "Identifiers for the students that have access to the coursework/announcement.", "items": { "type": "string" }, @@ -2887,11 +2925,11 @@ "type": "string" }, "id": { - "description": "Identifier assigned by Classroom.\n\nRead-only.", + "description": "Identifier assigned by Classroom. Read-only.", "type": "string" }, "role": { - "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.", + "description": "Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.", "enum": [ "COURSE_ROLE_UNSPECIFIED", "STUDENT", @@ -2907,7 +2945,7 @@ "type": "string" }, "userId": { - "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user", "type": "string" } }, @@ -2918,15 +2956,15 @@ "id": "Link", "properties": { "thumbnailUrl": { - "description": "URL of a thumbnail image of the target URL.\n\nRead-only.", + "description": "URL of a thumbnail image of the target URL. Read-only.", "type": "string" }, "title": { - "description": "Title of the target of the URL.\n\nRead-only.", + "description": "Title of the target of the URL. Read-only.", "type": "string" }, "url": { - "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.", + "description": "URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.", "type": "string" } }, @@ -2944,7 +2982,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } }, @@ -2962,7 +3000,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } }, @@ -2980,7 +3018,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } }, @@ -2998,7 +3036,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } }, @@ -3016,7 +3054,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } }, @@ -3027,14 +3065,14 @@ "id": "ListGuardiansResponse", "properties": { "guardians": { - "description": "Guardians on this page of results that met the criteria specified in\nthe request.", + "description": "Guardians on this page of results that met the criteria specified in the request.", "items": { "$ref": "Guardian" }, "type": "array" }, "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } }, @@ -3052,7 +3090,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" } }, @@ -3063,7 +3101,7 @@ "id": "ListStudentSubmissionsResponse", "properties": { "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" }, "studentSubmissions": { @@ -3081,7 +3119,7 @@ "id": "ListStudentsResponse", "properties": { "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" }, "students": { @@ -3099,7 +3137,7 @@ "id": "ListTeachersResponse", "properties": { "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" }, "teachers": { @@ -3117,7 +3155,7 @@ "id": "ListTopicResponse", "properties": { "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "description": "Token identifying the next page of results to return. If empty, no further results are available.", "type": "string" }, "topic": { @@ -3131,7 +3169,7 @@ "type": "object" }, "Material": { - "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.", + "description": "Material attached to course work. When creating attachments, setting the `form` field is not supported.", "id": "Material", "properties": { "driveFile": { @@ -3144,7 +3182,7 @@ }, "link": { "$ref": "Link", - "description": "Link material. On creation, this is upgraded to a more appropriate type\nif possible, and this is reflected in the response." + "description": "Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response." }, "youtubeVideo": { "$ref": "YouTubeVideo", @@ -3158,7 +3196,7 @@ "id": "ModifyAnnouncementAssigneesRequest", "properties": { "assigneeMode": { - "description": "Mode of the announcement describing whether it is accessible by all\nstudents or specified individual students.", + "description": "Mode of the announcement describing whether it is accessible by all students or specified individual students.", "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", @@ -3166,14 +3204,14 @@ ], "enumDescriptions": [ "No mode specified. This is never returned.", - "All students can see the item.\nThis is the default state.", + "All students can see the item. This is the default state.", "A subset of the students can see the item." ], "type": "string" }, "modifyIndividualStudentsOptions": { "$ref": "ModifyIndividualStudentsOptions", - "description": "Set which students can view or cannot view the announcement.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`." + "description": "Set which students can view or cannot view the announcement. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`." } }, "type": "object" @@ -3183,7 +3221,7 @@ "id": "ModifyAttachmentsRequest", "properties": { "addAttachments": { - "description": "Attachments to add.\nA student submission may not have more than 20 attachments.\n\nForm attachments are not supported.", + "description": "Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported.", "items": { "$ref": "Attachment" }, @@ -3197,7 +3235,7 @@ "id": "ModifyCourseWorkAssigneesRequest", "properties": { "assigneeMode": { - "description": "Mode of the coursework describing whether it will be assigned to all\nstudents or specified individual students.", + "description": "Mode of the coursework describing whether it will be assigned to all students or specified individual students.", "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", "ALL_STUDENTS", @@ -3205,31 +3243,31 @@ ], "enumDescriptions": [ "No mode specified. This is never returned.", - "All students can see the item.\nThis is the default state.", + "All students can see the item. This is the default state.", "A subset of the students can see the item." ], "type": "string" }, "modifyIndividualStudentsOptions": { "$ref": "ModifyIndividualStudentsOptions", - "description": "Set which students are assigned or not assigned to the coursework.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`." + "description": "Set which students are assigned or not assigned to the coursework. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`." } }, "type": "object" }, "ModifyIndividualStudentsOptions": { - "description": "Contains fields to add or remove students from a course work or announcement\nwhere the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.", + "description": "Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.", "id": "ModifyIndividualStudentsOptions", "properties": { "addStudentIds": { - "description": "IDs of students to be added as having access to this\ncoursework/announcement.", + "description": "IDs of students to be added as having access to this coursework/announcement.", "items": { "type": "string" }, "type": "array" }, "removeStudentIds": { - "description": "IDs of students to be removed from having access to this\ncoursework/announcement.", + "description": "IDs of students to be removed from having access to this coursework/announcement.", "items": { "type": "string" }, @@ -3268,15 +3306,15 @@ "id": "Name", "properties": { "familyName": { - "description": "The user's last name.\n\nRead-only.", + "description": "The user's last name. Read-only.", "type": "string" }, "fullName": { - "description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only.", + "description": "The user's full name formed by concatenating the first and last name values. Read-only.", "type": "string" }, "givenName": { - "description": "The user's first name.\n\nRead-only.", + "description": "The user's first name. Read-only.", "type": "string" } }, @@ -3289,7 +3327,7 @@ "type": "object" }, "Registration": { - "description": "An instruction to Classroom to send notifications from the `feed` to the\nprovided destination.", + "description": "An instruction to Classroom to send notifications from the `feed` to the provided destination.", "id": "Registration", "properties": { "cloudPubsubTopic": { @@ -3297,16 +3335,16 @@ "description": "The Cloud Pub/Sub topic that notifications are to be sent to." }, "expiryTime": { - "description": "The time until which the `Registration` is effective.\n\nThis is a read-only field assigned by the server.", + "description": "The time until which the `Registration` is effective. This is a read-only field assigned by the server.", "format": "google-datetime", "type": "string" }, "feed": { "$ref": "Feed", - "description": "Specification for the class of notifications that Classroom should deliver\nto the destination." + "description": "Specification for the class of notifications that Classroom should deliver to the destination." }, "registrationId": { - "description": "A server-generated unique identifier for this `Registration`.\n\nRead-only.", + "description": "A server-generated unique identifier for this `Registration`. Read-only.", "type": "string" } }, @@ -3377,10 +3415,10 @@ "enumDescriptions": [ "No state specified. This should never be returned.", "The Submission has been created.", - "The student has turned in an assigned document, which may or may not be\na template.", + "The student has turned in an assigned document, which may or may not be a template.", "The teacher has returned the assigned document to the student.", - "The student turned in the assigned document, and then chose to\n\"unsubmit\" the assignment, giving the student control again as the\nowner.", - "The student edited their submission after turning it in. Currently,\nonly used by Questions, when the student edits their answer." + "The student turned in the assigned document, and then chose to \"unsubmit\" the assignment, giving the student control again as the owner.", + "The student edited their submission after turning it in. Currently, only used by Questions, when the student edits their answer." ], "type": "string" }, @@ -3397,55 +3435,55 @@ "id": "Student", "properties": { "courseId": { - "description": "Identifier of the course.\n\nRead-only.", + "description": "Identifier of the course. Read-only.", "type": "string" }, "profile": { "$ref": "UserProfile", - "description": "Global user information for the student.\n\nRead-only." + "description": "Global user information for the student. Read-only." }, "studentWorkFolder": { "$ref": "DriveFolder", - "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only." + "description": "Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only." }, "userId": { - "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user", "type": "string" } }, "type": "object" }, "StudentSubmission": { - "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.", + "description": "Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.", "id": "StudentSubmission", "properties": { "alternateLink": { - "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.", + "description": "Absolute link to the submission in the Classroom web UI. Read-only.", "type": "string" }, "assignedGrade": { - "description": "Optional grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (that is, non-integer) values are\nallowed, but are rounded to two decimal places.\n\nThis may be modified only by course teachers.", + "description": "Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This may be modified only by course teachers.", "format": "double", "type": "number" }, "assignmentSubmission": { "$ref": "AssignmentSubmission", - "description": "Submission content when course_work_type is ASSIGNMENT.\n\nStudents can modify this content using\nModifyAttachments." + "description": "Submission content when course_work_type is ASSIGNMENT. Students can modify this content using ModifyAttachments." }, "associatedWithDeveloper": { - "description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee CreateCourseWork for more\ndetails.\n\nRead-only.", + "description": "Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.", "type": "boolean" }, "courseId": { - "description": "Identifier of the course.\n\nRead-only.", + "description": "Identifier of the course. Read-only.", "type": "string" }, "courseWorkId": { - "description": "Identifier for the course work this corresponds to.\n\nRead-only.", + "description": "Identifier for the course work this corresponds to. Read-only.", "type": "string" }, "courseWorkType": { - "description": "Type of course work this submission is for.\n\nRead-only.", + "description": "Type of course work this submission is for. Read-only.", "enum": [ "COURSE_WORK_TYPE_UNSPECIFIED", "ASSIGNMENT", @@ -3461,21 +3499,21 @@ "type": "string" }, "creationTime": { - "description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.", + "description": "Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.", "format": "google-datetime", "type": "string" }, "draftGrade": { - "description": "Optional pending grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (that is, non-integer) values are\nallowed, but are rounded to two decimal places.\n\nThis is only visible to and modifiable by course teachers.", + "description": "Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This is only visible to and modifiable by course teachers.", "format": "double", "type": "number" }, "id": { - "description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only.", + "description": "Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.", "type": "string" }, "late": { - "description": "Whether this submission is late.\n\nRead-only.", + "description": "Whether this submission is late. Read-only.", "type": "boolean" }, "multipleChoiceSubmission": { @@ -3487,7 +3525,7 @@ "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION." }, "state": { - "description": "State of this submission.\n\nRead-only.", + "description": "State of this submission. Read-only.", "enum": [ "SUBMISSION_STATE_UNSPECIFIED", "NEW", @@ -3498,7 +3536,7 @@ ], "enumDescriptions": [ "No state specified. This should never be returned.", - "The student has never accessed this submission. Attachments are not\nreturned and timestamps is not set.", + "The student has never accessed this submission. Attachments are not returned and timestamps is not set.", "Has been created.", "Has been turned in to the teacher.", "Has been returned to the student.", @@ -3507,26 +3545,26 @@ "type": "string" }, "submissionHistory": { - "description": "The history of the submission (includes state and grade histories).\n\nRead-only.", + "description": "The history of the submission (includes state and grade histories). Read-only.", "items": { "$ref": "SubmissionHistory" }, "type": "array" }, "updateTime": { - "description": "Last update time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.", + "description": "Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.", "format": "google-datetime", "type": "string" }, "userId": { - "description": "Identifier for the student that owns this submission.\n\nRead-only.", + "description": "Identifier for the student that owns this submission. Read-only.", "type": "string" } }, "type": "object" }, "SubmissionHistory": { - "description": "The history of the submission. This currently includes state and grade\nhistories.", + "description": "The history of the submission. This currently includes state and grade histories.", "id": "SubmissionHistory", "properties": { "gradeHistory": { @@ -3545,26 +3583,26 @@ "id": "Teacher", "properties": { "courseId": { - "description": "Identifier of the course.\n\nRead-only.", + "description": "Identifier of the course. Read-only.", "type": "string" }, "profile": { "$ref": "UserProfile", - "description": "Global user information for the teacher.\n\nRead-only." + "description": "Global user information for the teacher. Read-only." }, "userId": { - "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "description": "Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user", "type": "string" } }, "type": "object" }, "TimeOfDay": { - "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.", + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", "properties": { "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, @@ -3579,7 +3617,7 @@ "type": "integer" }, "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.", + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } @@ -3591,19 +3629,19 @@ "id": "Topic", "properties": { "courseId": { - "description": "Identifier of the course.\n\nRead-only.", + "description": "Identifier of the course. Read-only.", "type": "string" }, "name": { - "description": "The name of the topic, generated by the user.\nLeading and trailing whitespaces, if any, are trimmed. Also, multiple\nconsecutive whitespaces are collapsed into one inside the name. The\nresult must be a non-empty string. Topic names are case sensitive, and must\nbe no longer than 100 characters.", + "description": "The name of the topic, generated by the user. Leading and trailing whitespaces, if any, are trimmed. Also, multiple consecutive whitespaces are collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters.", "type": "string" }, "topicId": { - "description": "Unique identifier for the topic.\n\nRead-only.", + "description": "Unique identifier for the topic. Read-only.", "type": "string" }, "updateTime": { - "description": "The time the topic was last updated by the system.\n\nRead-only.", + "description": "The time the topic was last updated by the system. Read-only.", "format": "google-datetime", "type": "string" } @@ -3621,30 +3659,30 @@ "id": "UserProfile", "properties": { "emailAddress": { - "description": "Email address of the user.\n\nRead-only.", + "description": "Email address of the user. Read-only.", "type": "string" }, "id": { - "description": "Identifier of the user.\n\nRead-only.", + "description": "Identifier of the user. Read-only.", "type": "string" }, "name": { "$ref": "Name", - "description": "Name of the user.\n\nRead-only." + "description": "Name of the user. Read-only." }, "permissions": { - "description": "Global permissions of the user.\n\nRead-only.", + "description": "Global permissions of the user. Read-only.", "items": { "$ref": "GlobalPermission" }, "type": "array" }, "photoUrl": { - "description": "URL of user's profile photo.\n\nRead-only.", + "description": "URL of user's profile photo. Read-only.", "type": "string" }, "verifiedTeacher": { - "description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field is always false.\n\nRead-only", + "description": "Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only", "type": "boolean" } }, @@ -3655,7 +3693,7 @@ "id": "YouTubeVideo", "properties": { "alternateLink": { - "description": "URL that can be used to view the YouTube video.\n\nRead-only.", + "description": "URL that can be used to view the YouTube video. Read-only.", "type": "string" }, "id": { @@ -3663,11 +3701,11 @@ "type": "string" }, "thumbnailUrl": { - "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.", + "description": "URL of a thumbnail image of the YouTube video. Read-only.", "type": "string" }, "title": { - "description": "Title of the YouTube video.\n\nRead-only.", + "description": "Title of the YouTube video. Read-only.", "type": "string" } }, diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index 6e95dcbfa06..5267ea2c266 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -138,7 +138,7 @@ export namespace classroom_v1 { */ export interface Schema$Announcement { /** - * Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. + * Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. */ alternateLink?: string | null; /** @@ -146,19 +146,19 @@ export namespace classroom_v1 { */ assigneeMode?: string | null; /** - * Identifier of the course. Read-only. + * Identifier of the course. Read-only. */ courseId?: string | null; /** - * Timestamp when this announcement was created. Read-only. + * Timestamp when this announcement was created. Read-only. */ creationTime?: string | null; /** - * Identifier for the user that created the announcement. Read-only. + * Identifier for the user that created the announcement. Read-only. */ creatorUserId?: string | null; /** - * Classroom-assigned identifier of this announcement, unique per course. Read-only. + * Classroom-assigned identifier of this announcement, unique per course. Read-only. */ id?: string | null; /** @@ -166,7 +166,7 @@ export namespace classroom_v1 { */ individualStudentsOptions?: Schema$IndividualStudentsOptions; /** - * Additional materials. Announcements must have no more than 20 material items. + * Additional materials. Announcements must have no more than 20 material items. */ materials?: Schema$Material[]; /** @@ -182,7 +182,7 @@ export namespace classroom_v1 { */ text?: string | null; /** - * Timestamp of the most recent change to this announcement. Read-only. + * Timestamp of the most recent change to this announcement. Read-only. */ updateTime?: string | null; } @@ -200,12 +200,12 @@ export namespace classroom_v1 { */ export interface Schema$AssignmentSubmission { /** - * Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (for example, title) may not be. + * Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (for example, title) may not be. */ attachments?: Schema$Attachment[]; } /** - * Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported. + * Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported. */ export interface Schema$Attachment { /** @@ -226,7 +226,7 @@ export namespace classroom_v1 { youTubeVideo?: Schema$YouTubeVideo; } /** - * A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant `classroom-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission. + * A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant `classroom-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission. */ export interface Schema$CloudPubsubTopic { /** @@ -239,19 +239,19 @@ export namespace classroom_v1 { */ export interface Schema$Course { /** - * Absolute link to this course in the Classroom web UI. Read-only. + * Absolute link to this course in the Classroom web UI. Read-only. */ alternateLink?: string | null; /** - * The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only. + * The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only. */ calendarId?: string | null; /** - * The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. + * The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. */ courseGroupEmail?: string | null; /** - * Sets of materials that appear on the "about" page of this course. Read-only. + * Sets of materials that appear on the "about" page of this course. Read-only. */ courseMaterialSets?: Schema$CourseMaterialSet[]; /** @@ -259,7 +259,7 @@ export namespace classroom_v1 { */ courseState?: string | null; /** - * Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. + * Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. */ creationTime?: string | null; /** @@ -271,15 +271,15 @@ export namespace classroom_v1 { */ descriptionHeading?: string | null; /** - * Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. + * Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. */ enrollmentCode?: string | null; /** - * Whether or not guardian notifications are enabled for this course. Read-only. + * Whether or not guardian notifications are enabled for this course. Read-only. */ guardiansEnabled?: boolean | null; /** - * Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. + * Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. */ id?: string | null; /** @@ -287,7 +287,7 @@ export namespace classroom_v1 { */ name?: string | null; /** - * The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. + * The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. */ ownerId?: string | null; /** @@ -299,24 +299,24 @@ export namespace classroom_v1 { */ section?: string | null; /** - * Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only. + * Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only. */ teacherFolder?: Schema$DriveFolder; /** - * The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. + * The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only. */ teacherGroupEmail?: string | null; /** - * Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. + * Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. */ updateTime?: string | null; } /** - * Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded. + * Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded. */ export interface Schema$CourseAlias { /** - * Alias string. The format of the string indicates the desired alias scoping. * `d:<name>` indicates a domain-scoped alias. Example: `d:math_101` * `p:<name>` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters. + * Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters. */ alias?: string | null; } @@ -368,7 +368,7 @@ export namespace classroom_v1 { */ export interface Schema$CourseWork { /** - * Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. + * Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. */ alternateLink?: string | null; /** @@ -376,23 +376,23 @@ export namespace classroom_v1 { */ assigneeMode?: string | null; /** - * Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. + * Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. */ assignment?: Schema$Assignment; /** - * Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. + * Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. */ associatedWithDeveloper?: boolean | null; /** - * Identifier of the course. Read-only. + * Identifier of the course. Read-only. */ courseId?: string | null; /** - * Timestamp when this course work was created. Read-only. + * Timestamp when this course work was created. Read-only. */ creationTime?: string | null; /** - * Identifier for the user that created the coursework. Read-only. + * Identifier for the user that created the coursework. Read-only. */ creatorUserId?: string | null; /** @@ -408,7 +408,7 @@ export namespace classroom_v1 { */ dueTime?: Schema$TimeOfDay; /** - * Classroom-assigned identifier of this course work, unique per course. Read-only. + * Classroom-assigned identifier of this course work, unique per course. Read-only. */ id?: string | null; /** @@ -416,7 +416,7 @@ export namespace classroom_v1 { */ individualStudentsOptions?: Schema$IndividualStudentsOptions; /** - * Additional materials. CourseWork must have no more than 20 material items. + * Additional materials. CourseWork must have no more than 20 material items. */ materials?: Schema$Material[]; /** @@ -448,11 +448,11 @@ export namespace classroom_v1 { */ topicId?: string | null; /** - * Timestamp of the most recent change to this course work. Read-only. + * Timestamp of the most recent change to this course work. Read-only. */ updateTime?: string | null; /** - * Type of this course work. The type is set when the course work is created and cannot be changed. + * Type of this course work. The type is set when the course work is created and cannot be changed. */ workType?: string | null; } @@ -466,7 +466,7 @@ export namespace classroom_v1 { courseId?: string | null; } /** - * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. */ export interface Schema$Date { /** @@ -487,7 +487,7 @@ export namespace classroom_v1 { */ export interface Schema$DriveFile { /** - * URL that can be used to access the Drive item. Read-only. + * URL that can be used to access the Drive item. Read-only. */ alternateLink?: string | null; /** @@ -495,11 +495,11 @@ export namespace classroom_v1 { */ id?: string | null; /** - * URL of a thumbnail image of the Drive item. Read-only. + * URL of a thumbnail image of the Drive item. Read-only. */ thumbnailUrl?: string | null; /** - * Title of the Drive item. Read-only. + * Title of the Drive item. Read-only. */ title?: string | null; } @@ -508,7 +508,7 @@ export namespace classroom_v1 { */ export interface Schema$DriveFolder { /** - * URL that can be used to access the Drive folder. Read-only. + * URL that can be used to access the Drive folder. Read-only. */ alternateLink?: string | null; /** @@ -516,12 +516,12 @@ export namespace classroom_v1 { */ id?: string | null; /** - * Title of the Drive folder. Read-only. + * Title of the Drive folder. Read-only. */ title?: string | null; } /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** @@ -550,15 +550,15 @@ export namespace classroom_v1 { */ formUrl?: string | null; /** - * URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only. + * URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only. */ responseUrl?: string | null; /** - * URL of a thumbnail image of the Form. Read-only. + * URL of a thumbnail image of the Form. Read-only. */ thumbnailUrl?: string | null; /** - * Title of the Form. Read-only. + * Title of the Form. Read-only. */ title?: string | null; } @@ -622,11 +622,11 @@ export namespace classroom_v1 { */ export interface Schema$GuardianInvitation { /** - * The time that this invitation was created. Read-only. + * The time that this invitation was created. Read-only. */ creationTime?: string | null; /** - * Unique identifier for this invitation. Read-only. + * Unique identifier for this invitation. Read-only. */ invitationId?: string | null; /** @@ -660,7 +660,7 @@ export namespace classroom_v1 { */ courseId?: string | null; /** - * Identifier assigned by Classroom. Read-only. + * Identifier assigned by Classroom. Read-only. */ id?: string | null; /** @@ -668,7 +668,7 @@ export namespace classroom_v1 { */ role?: string | null; /** - * Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string | null; } @@ -677,11 +677,11 @@ export namespace classroom_v1 { */ export interface Schema$Link { /** - * URL of a thumbnail image of the target URL. Read-only. + * URL of a thumbnail image of the target URL. Read-only. */ thumbnailUrl?: string | null; /** - * Title of the target of the URL. Read-only. + * Title of the target of the URL. Read-only. */ title?: string | null; /** @@ -833,7 +833,7 @@ export namespace classroom_v1 { topic?: Schema$Topic[]; } /** - * Material attached to course work. When creating attachments, setting the `form` field is not supported. + * Material attached to course work. When creating attachments, setting the `form` field is not supported. */ export interface Schema$Material { /** @@ -871,7 +871,7 @@ export namespace classroom_v1 { */ export interface Schema$ModifyAttachmentsRequest { /** - * Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported. + * Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported. */ addAttachments?: Schema$Attachment[]; } @@ -924,15 +924,15 @@ export namespace classroom_v1 { */ export interface Schema$Name { /** - * The user's last name. Read-only. + * The user's last name. Read-only. */ familyName?: string | null; /** - * The user's full name formed by concatenating the first and last name values. Read-only. + * The user's full name formed by concatenating the first and last name values. Read-only. */ fullName?: string | null; /** - * The user's first name. Read-only. + * The user's first name. Read-only. */ givenName?: string | null; } @@ -949,7 +949,7 @@ export namespace classroom_v1 { */ cloudPubsubTopic?: Schema$CloudPubsubTopic; /** - * The time until which the `Registration` is effective. This is a read-only field assigned by the server. + * The time until which the `Registration` is effective. This is a read-only field assigned by the server. */ expiryTime?: string | null; /** @@ -957,7 +957,7 @@ export namespace classroom_v1 { */ feed?: Schema$Feed; /** - * A server-generated unique identifier for this `Registration`. Read-only. + * A server-generated unique identifier for this `Registration`. Read-only. */ registrationId?: string | null; } @@ -1009,68 +1009,68 @@ export namespace classroom_v1 { */ export interface Schema$Student { /** - * Identifier of the course. Read-only. + * Identifier of the course. Read-only. */ courseId?: string | null; /** - * Global user information for the student. Read-only. + * Global user information for the student. Read-only. */ profile?: Schema$UserProfile; /** - * Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only. + * Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only. */ studentWorkFolder?: Schema$DriveFolder; /** - * Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string | null; } /** - * Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time. + * Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time. */ export interface Schema$StudentSubmission { /** - * Absolute link to the submission in the Classroom web UI. Read-only. + * Absolute link to the submission in the Classroom web UI. Read-only. */ alternateLink?: string | null; /** - * Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This may be modified only by course teachers. + * Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This may be modified only by course teachers. */ assignedGrade?: number | null; /** - * Submission content when course_work_type is ASSIGNMENT. Students can modify this content using ModifyAttachments. + * Submission content when course_work_type is ASSIGNMENT. Students can modify this content using ModifyAttachments. */ assignmentSubmission?: Schema$AssignmentSubmission; /** - * Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. + * Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. */ associatedWithDeveloper?: boolean | null; /** - * Identifier of the course. Read-only. + * Identifier of the course. Read-only. */ courseId?: string | null; /** - * Identifier for the course work this corresponds to. Read-only. + * Identifier for the course work this corresponds to. Read-only. */ courseWorkId?: string | null; /** - * Type of course work this submission is for. Read-only. + * Type of course work this submission is for. Read-only. */ courseWorkType?: string | null; /** - * Creation time of this submission. This may be unset if the student has not accessed this item. Read-only. + * Creation time of this submission. This may be unset if the student has not accessed this item. Read-only. */ creationTime?: string | null; /** - * Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This is only visible to and modifiable by course teachers. + * Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This is only visible to and modifiable by course teachers. */ draftGrade?: number | null; /** - * Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only. + * Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only. */ id?: string | null; /** - * Whether this submission is late. Read-only. + * Whether this submission is late. Read-only. */ late?: boolean | null; /** @@ -1082,19 +1082,19 @@ export namespace classroom_v1 { */ shortAnswerSubmission?: Schema$ShortAnswerSubmission; /** - * State of this submission. Read-only. + * State of this submission. Read-only. */ state?: string | null; /** - * The history of the submission (includes state and grade histories). Read-only. + * The history of the submission (includes state and grade histories). Read-only. */ submissionHistory?: Schema$SubmissionHistory[]; /** - * Last update time of this submission. This may be unset if the student has not accessed this item. Read-only. + * Last update time of this submission. This may be unset if the student has not accessed this item. Read-only. */ updateTime?: string | null; /** - * Identifier for the student that owns this submission. Read-only. + * Identifier for the student that owns this submission. Read-only. */ userId?: string | null; } @@ -1116,15 +1116,15 @@ export namespace classroom_v1 { */ export interface Schema$Teacher { /** - * Identifier of the course. Read-only. + * Identifier of the course. Read-only. */ courseId?: string | null; /** - * Global user information for the teacher. Read-only. + * Global user information for the teacher. Read-only. */ profile?: Schema$UserProfile; /** - * Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string | null; } @@ -1154,7 +1154,7 @@ export namespace classroom_v1 { */ export interface Schema$Topic { /** - * Identifier of the course. Read-only. + * Identifier of the course. Read-only. */ courseId?: string | null; /** @@ -1162,11 +1162,11 @@ export namespace classroom_v1 { */ name?: string | null; /** - * Unique identifier for the topic. Read-only. + * Unique identifier for the topic. Read-only. */ topicId?: string | null; /** - * The time the topic was last updated by the system. Read-only. + * The time the topic was last updated by the system. Read-only. */ updateTime?: string | null; } @@ -1179,27 +1179,27 @@ export namespace classroom_v1 { */ export interface Schema$UserProfile { /** - * Email address of the user. Read-only. + * Email address of the user. Read-only. */ emailAddress?: string | null; /** - * Identifier of the user. Read-only. + * Identifier of the user. Read-only. */ id?: string | null; /** - * Name of the user. Read-only. + * Name of the user. Read-only. */ name?: Schema$Name; /** - * Global permissions of the user. Read-only. + * Global permissions of the user. Read-only. */ permissions?: Schema$GlobalPermission[]; /** - * URL of user's profile photo. Read-only. + * URL of user's profile photo. Read-only. */ photoUrl?: string | null; /** - * Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only + * Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only */ verifiedTeacher?: boolean | null; } @@ -1208,7 +1208,7 @@ export namespace classroom_v1 { */ export interface Schema$YouTubeVideo { /** - * URL that can be used to view the YouTube video. Read-only. + * URL that can be used to view the YouTube video. Read-only. */ alternateLink?: string | null; /** @@ -1216,11 +1216,11 @@ export namespace classroom_v1 { */ id?: string | null; /** - * URL of a thumbnail image of the YouTube video. Read-only. + * URL of a thumbnail image of the YouTube video. Read-only. */ thumbnailUrl?: string | null; /** - * Title of the YouTube video. Read-only. + * Title of the YouTube video. Read-only. */ title?: string | null; } @@ -1245,7 +1245,7 @@ export namespace classroom_v1 { /** * classroom.courses.create - * @desc Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists. + * @desc Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists. * @example * // Before running the sample: * // - Enable the API at: @@ -1411,7 +1411,7 @@ export namespace classroom_v1 { /** * classroom.courses.delete - * @desc Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. + * @desc Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * @example * // Before running the sample: * // - Enable the API at: @@ -1436,9 +1436,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.delete({ - * // Identifier of the course to delete. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias. * id: 'placeholder-value', * }); * console.log(res.data); @@ -1538,7 +1536,7 @@ export namespace classroom_v1 { /** * classroom.courses.get - * @desc Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. + * @desc Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * @example * // Before running the sample: * // - Enable the API at: @@ -1566,9 +1564,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.get({ - * // Identifier of the course to return. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias. * id: 'placeholder-value', * }); * console.log(res.data); @@ -1687,7 +1683,7 @@ export namespace classroom_v1 { /** * classroom.courses.list - * @desc Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist. + * @desc Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -1715,35 +1711,15 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.list({ - * // Restricts returned courses to those in one of the specified states - * // The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. + * // Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. * courseStates: 'placeholder-value', - * // 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. + * // Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. * pageSize: 'placeholder-value', - * // 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. + * // nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * pageToken: 'placeholder-value', - * // 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 + * // Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * studentId: 'placeholder-value', - * // 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 + * // Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * teacherId: 'placeholder-value', * }); * console.log(res.data); @@ -1765,10 +1741,10 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string=} params.courseStates Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. - * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. - * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. - * @param {string=} params.studentId Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user - * @param {string=} params.teacherId Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * @param {string=} params.studentId Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * @param {string=} params.teacherId Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1853,7 +1829,7 @@ export namespace classroom_v1 { /** * classroom.courses.patch - * @desc Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable + * @desc Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * @example * // Before running the sample: * // - Enable the API at: @@ -1878,29 +1854,9 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.patch({ - * // Identifier of the course to update. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. * id: 'placeholder-value', - * // 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=,,...` + * // 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=,,...` * updateMask: 'placeholder-value', * * // Request body metadata @@ -1963,7 +1919,7 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string} params.id Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. - * @param {string=} params.updateMask Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...` + * @param {string=} params.updateMask Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...` * @param {().Course} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2046,7 +2002,7 @@ export namespace classroom_v1 { /** * classroom.courses.update - * @desc Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable + * @desc Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * @example * // Before running the sample: * // - Enable the API at: @@ -2071,9 +2027,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.update({ - * // Identifier of the course to update. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. * id: 'placeholder-value', * * // Request body metadata @@ -2241,19 +2195,19 @@ export namespace classroom_v1 { */ courseStates?: string[]; /** - * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; /** - * Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ studentId?: string; /** - * Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ teacherId?: string; } @@ -2263,7 +2217,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...` + * 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=,,...` */ updateMask?: string; @@ -2292,7 +2246,7 @@ export namespace classroom_v1 { /** * classroom.courses.aliases.create - * @desc Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias). + * @desc Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias). * @example * // Before running the sample: * // - Enable the API at: @@ -2317,9 +2271,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.aliases.create({ - * // Identifier of the course to alias. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * * // Request body metadata @@ -2434,7 +2386,7 @@ export namespace classroom_v1 { /** * classroom.courses.aliases.delete - * @desc Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias). + * @desc Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias). * @example * // Before running the sample: * // - Enable the API at: @@ -2459,12 +2411,9 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.aliases.delete({ - * // Alias to delete. - * // This may not be the Classroom-assigned identifier. + * // Alias to delete. This may not be the Classroom-assigned identifier. * alias: 'placeholder-value', - * // Identifier of the course whose alias should be deleted. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * }); * console.log(res.data); @@ -2569,7 +2518,7 @@ export namespace classroom_v1 { /** * classroom.courses.aliases.list - * @desc Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist. + * @desc Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -2597,22 +2546,11 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.aliases.list({ - * // The identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // 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. + * // Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. * pageSize: 'placeholder-value', - * // 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. + * // nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -2634,8 +2572,8 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string} params.courseId The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. - * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. - * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2757,11 +2695,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; } @@ -2774,7 +2712,7 @@ export namespace classroom_v1 { /** * classroom.courses.announcements.create - * @desc Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible + * @desc Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible * @example * // Before running the sample: * // - Enable the API at: @@ -2799,9 +2737,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.announcements.create({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * * // Request body metadata @@ -2938,7 +2874,7 @@ export namespace classroom_v1 { /** * classroom.courses.announcements.delete - * @desc Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID. + * @desc Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID. * @example * // Before running the sample: * // - Enable the API at: @@ -2963,12 +2899,9 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.announcements.delete({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // Identifier of the announcement to delete. - * // This identifier is a Classroom-assigned identifier. + * // Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier. * id: 'placeholder-value', * }); * console.log(res.data); @@ -3072,7 +3005,7 @@ export namespace classroom_v1 { /** * classroom.courses.announcements.get - * @desc Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist. + * @desc Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -3100,9 +3033,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.announcements.get({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the announcement. * id: 'placeholder-value', @@ -3221,7 +3152,7 @@ export namespace classroom_v1 { /** * classroom.courses.announcements.list - * @desc Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. + * @desc Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -3249,31 +3180,15 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.announcements.list({ - * // Restriction on the `state` of announcements returned. - * // If this argument is left unspecified, the default value is `PUBLISHED`. + * // Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`. * announcementStates: 'placeholder-value', - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // 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` + * // Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime` * orderBy: 'placeholder-value', - * // 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. + * // Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. * pageSize: 'placeholder-value', - * // 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. + * // nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -3297,8 +3212,8 @@ export namespace classroom_v1 { * @param {string=} params.announcementStates Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`. * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * @param {string=} params.orderBy Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime` - * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. - * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3391,7 +3306,7 @@ export namespace classroom_v1 { /** * classroom.courses.announcements.modifyAssignees - * @desc Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. + * @desc Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -3416,9 +3331,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.announcements.modifyAssignees({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the announcement. * id: 'placeholder-value', @@ -3548,7 +3461,7 @@ export namespace classroom_v1 { /** * classroom.courses.announcements.patch - * @desc Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist + * @desc Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist * @example * // Before running the sample: * // - Enable the API at: @@ -3573,25 +3486,11 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.announcements.patch({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the announcement. * id: 'placeholder-value', - * // 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` + * // 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` * updateMask: 'placeholder-value', * * // Request body metadata @@ -3643,7 +3542,7 @@ export namespace classroom_v1 { * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * @param {string} params.id Identifier of the announcement. - * @param {string=} params.updateMask Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time` + * @param {string=} params.updateMask Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time` * @param {().Announcement} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3777,11 +3676,11 @@ export namespace classroom_v1 { */ orderBy?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; } @@ -3812,7 +3711,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time` + * 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` */ updateMask?: string; @@ -3834,7 +3733,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.create - * @desc Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible + * @desc Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible * @example * // Before running the sample: * // - Enable the API at: @@ -3859,9 +3758,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.courseWork.create({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * * // Request body metadata @@ -4018,7 +3915,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.delete - * @desc Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID. + * @desc Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID. * @example * // Before running the sample: * // - Enable the API at: @@ -4043,12 +3940,9 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.courseWork.delete({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // Identifier of the course work to delete. - * // This identifier is a Classroom-assigned identifier. + * // Identifier of the course work to delete. This identifier is a Classroom-assigned identifier. * id: 'placeholder-value', * }); * console.log(res.data); @@ -4153,7 +4047,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.get - * @desc Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. + * @desc Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -4183,9 +4077,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.courseWork.get({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the course work. * id: 'placeholder-value', @@ -4315,7 +4207,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.list - * @desc Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. + * @desc Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -4345,32 +4237,15 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.courseWork.list({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // Restriction on the work status to return. Only courseWork that matches - * // is returned. If unspecified, items with a work status of `PUBLISHED` - * // is returned. + * // Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned. * courseWorkStates: 'placeholder-value', - * // 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` + * // Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc` * orderBy: 'placeholder-value', - * // 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. + * // Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. * pageSize: 'placeholder-value', - * // 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. + * // nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -4394,8 +4269,8 @@ export namespace classroom_v1 { * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * @param {string=} params.courseWorkStates Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned. * @param {string=} params.orderBy Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc` - * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. - * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4486,7 +4361,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.modifyAssignees - * @desc Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. + * @desc Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -4511,9 +4386,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.courseWork.modifyAssignees({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the coursework. * id: 'placeholder-value', @@ -4652,7 +4525,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.patch - * @desc Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. + * @desc Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -4677,31 +4550,11 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.courseWork.patch({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the course work. * id: 'placeholder-value', - * // 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` + * // 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` * updateMask: 'placeholder-value', * * // Request body metadata @@ -4773,7 +4626,7 @@ export namespace classroom_v1 { * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * @param {string} params.id Identifier of the course work. - * @param {string=} params.updateMask Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error 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` + * @param {string=} params.updateMask Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error 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` * @param {().CourseWork} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4908,11 +4761,11 @@ export namespace classroom_v1 { */ orderBy?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; } @@ -4943,7 +4796,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error 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` + * 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` */ updateMask?: string; @@ -4961,7 +4814,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.get - * @desc Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. + * @desc Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -4993,9 +4846,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.courseWork.studentSubmissions.get({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the course work. * courseWorkId: 'placeholder-value', @@ -5126,7 +4977,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.list - * @desc Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. + * @desc Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -5158,41 +5009,19 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.courseWork.studentSubmissions.list({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // 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. + * // Identifier of the student work to request. This may be set to the string literal `"-"` to request student work for all course work in the specified course. * courseWorkId: 'placeholder-value', - * // Requested lateness value. If specified, returned student submissions are - * // restricted by the requested value. - * // If unspecified, submissions are returned regardless of `late` value. + * // Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value. * late: 'placeholder-value', - * // 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. + * // Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. * pageSize: 'placeholder-value', - * // 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. + * // nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * pageToken: 'placeholder-value', - * // Requested submission states. If specified, returned student submissions - * // match one of the specified submission states. + * // Requested submission states. If specified, returned student submissions match one of the specified submission states. * states: 'placeholder-value', - * // 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 + * // Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * userId: 'placeholder-value', * }); * console.log(res.data); @@ -5216,10 +5045,10 @@ export namespace classroom_v1 { * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * @param {string} params.courseWorkId Identifier of the student work to request. This may be set to the string literal `"-"` to request student work for all course work in the specified course. * @param {string=} params.late Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value. - * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. - * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * @param {string=} params.states Requested submission states. If specified, returned student submissions match one of the specified submission states. - * @param {string=} params.userId Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * @param {string=} params.userId Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5314,7 +5143,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.modifyAttachments - * @desc Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. + * @desc Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -5343,9 +5172,7 @@ export namespace classroom_v1 { * // Do the magic * const res = await classroom.courses.courseWork.studentSubmissions.modifyAttachments( * { - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the course work. * courseWorkId: 'placeholder-value', @@ -5488,7 +5315,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.patch - * @desc Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. + * @desc Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -5516,22 +5343,13 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.courseWork.studentSubmissions.patch({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the course work. * courseWorkId: 'placeholder-value', * // Identifier of the student submission. * id: 'placeholder-value', - * // 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` + * // Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade` * updateMask: 'placeholder-value', * * // Request body metadata @@ -5594,7 +5412,7 @@ export namespace classroom_v1 { * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * @param {string} params.courseWorkId Identifier of the course work. * @param {string} params.id Identifier of the student submission. - * @param {string=} params.updateMask Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade` + * @param {string=} params.updateMask Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade` * @param {().StudentSubmission} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5684,7 +5502,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.reclaim - * @desc Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. + * @desc Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -5709,9 +5527,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.courseWork.studentSubmissions.reclaim({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the course work. * courseWorkId: 'placeholder-value', @@ -5828,7 +5644,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.return - * @desc Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. + * @desc Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -5853,9 +5669,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.courseWork.studentSubmissions.return({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the course work. * courseWorkId: 'placeholder-value', @@ -5972,7 +5786,7 @@ export namespace classroom_v1 { /** * classroom.courses.courseWork.studentSubmissions.turnIn - * @desc Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. + * @desc Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -5997,9 +5811,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.courseWork.studentSubmissions.turnIn({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the course work. * courseWorkId: 'placeholder-value', @@ -6145,11 +5957,11 @@ export namespace classroom_v1 { */ late?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; /** @@ -6157,7 +5969,7 @@ export namespace classroom_v1 { */ states?: string[]; /** - * Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -6196,7 +6008,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade` + * Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade` */ updateMask?: string; @@ -6274,7 +6086,7 @@ export namespace classroom_v1 { /** * classroom.courses.students.create - * @desc Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course. + * @desc Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course. * @example * // Before running the sample: * // - Enable the API at: @@ -6303,14 +6115,9 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.students.create({ - * // Identifier of the course to create the student in. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // 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. + * // Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user. * enrollmentCode: 'placeholder-value', * * // Request body metadata @@ -6432,7 +6239,7 @@ export namespace classroom_v1 { /** * classroom.courses.students.delete - * @desc Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist. + * @desc Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -6457,16 +6264,9 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.students.delete({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // 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 + * // Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * userId: 'placeholder-value', * }); * console.log(res.data); @@ -6485,7 +6285,7 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. - * @param {string} params.userId Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * @param {string} params.userId Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6571,7 +6371,7 @@ export namespace classroom_v1 { /** * classroom.courses.students.get - * @desc Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist. + * @desc Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -6601,16 +6401,9 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.students.get({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // 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 + * // Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * userId: 'placeholder-value', * }); * console.log(res.data); @@ -6634,7 +6427,7 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. - * @param {string} params.userId Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * @param {string} params.userId Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6720,7 +6513,7 @@ export namespace classroom_v1 { /** * classroom.courses.students.list - * @desc Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors. + * @desc Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors. * @example * // Before running the sample: * // - Enable the API at: @@ -6750,21 +6543,11 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.students.list({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // 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. + * // 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. * pageSize: 'placeholder-value', - * // 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. + * // nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -6786,8 +6569,8 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. - * @param {integer=} params.pageSize Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results. - * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * @param {integer=} params.pageSize 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. + * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6900,7 +6683,7 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -6911,7 +6694,7 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -6922,11 +6705,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * 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. + * 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. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; } @@ -6939,7 +6722,7 @@ export namespace classroom_v1 { /** * classroom.courses.teachers.create - * @desc Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course. + * @desc Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course. * @example * // Before running the sample: * // - Enable the API at: @@ -6968,9 +6751,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.teachers.create({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * * // Request body metadata @@ -7089,7 +6870,7 @@ export namespace classroom_v1 { /** * classroom.courses.teachers.delete - * @desc Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course. + * @desc Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course. * @example * // Before running the sample: * // - Enable the API at: @@ -7114,16 +6895,9 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.teachers.delete({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // 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 + * // Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * userId: 'placeholder-value', * }); * console.log(res.data); @@ -7142,7 +6916,7 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. - * @param {string} params.userId Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * @param {string} params.userId Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7228,7 +7002,7 @@ export namespace classroom_v1 { /** * classroom.courses.teachers.get - * @desc Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. + * @desc Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -7258,16 +7032,9 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.teachers.get({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // 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 + * // Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * userId: 'placeholder-value', * }); * console.log(res.data); @@ -7290,7 +7057,7 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. - * @param {string} params.userId Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * @param {string} params.userId Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7376,7 +7143,7 @@ export namespace classroom_v1 { /** * classroom.courses.teachers.list - * @desc Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors. + * @desc Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors. * @example * // Before running the sample: * // - Enable the API at: @@ -7406,21 +7173,11 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.teachers.list({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // 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. + * // 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. * pageSize: 'placeholder-value', - * // 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. + * // nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -7442,8 +7199,8 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. - * @param {integer=} params.pageSize Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results. - * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * @param {integer=} params.pageSize 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. + * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7552,7 +7309,7 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -7563,7 +7320,7 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -7574,11 +7331,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * 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. + * 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. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; } @@ -7591,7 +7348,7 @@ export namespace classroom_v1 { /** * classroom.courses.topics.create - * @desc Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. + * @desc Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -7616,9 +7373,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.topics.create({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * * // Request body metadata @@ -7739,7 +7494,7 @@ export namespace classroom_v1 { /** * classroom.courses.topics.delete - * @desc Deletes a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID. + * @desc Deletes a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID. * @example * // Before running the sample: * // - Enable the API at: @@ -7764,9 +7519,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.topics.delete({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the topic to delete. * id: 'placeholder-value', @@ -7873,7 +7626,7 @@ export namespace classroom_v1 { /** * classroom.courses.topics.get - * @desc Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist. + * @desc Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -8013,7 +7766,7 @@ export namespace classroom_v1 { /** * classroom.courses.topics.list - * @desc Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. + * @desc Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * @example * // Before running the sample: * // - Enable the API at: @@ -8041,22 +7794,11 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.topics.list({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', - * // 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. + * // Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. * pageSize: 'placeholder-value', - * // 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. + * // nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -8078,8 +7820,8 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. - * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. - * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -8168,7 +7910,7 @@ export namespace classroom_v1 { /** * classroom.courses.topics.patch - * @desc Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist + * @desc Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist * @example * // Before running the sample: * // - Enable the API at: @@ -8193,23 +7935,11 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.courses.topics.patch({ - * // Identifier of the course. - * // This identifier can be either the Classroom-assigned identifier or an - * // alias. + * // Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * courseId: 'placeholder-value', * // Identifier of the topic. * id: 'placeholder-value', - * // 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` + * // 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` * updateMask: 'placeholder-value', * * // Request body metadata @@ -8245,7 +7975,7 @@ export namespace classroom_v1 { * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * @param {string} params.id Identifier of the topic. - * @param {string=} params.updateMask Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified: * `name` + * @param {string=} params.updateMask Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified: * `name` * @param {().Topic} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8372,11 +8102,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; } @@ -8391,7 +8121,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified: * `name` + * 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` */ updateMask?: string; @@ -8409,7 +8139,7 @@ export namespace classroom_v1 { /** * classroom.invitations.accept - * @desc Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID. + * @desc Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID. * @example * // Before running the sample: * // - Enable the API at: @@ -8538,7 +8268,7 @@ export namespace classroom_v1 { /** * classroom.invitations.create - * @desc Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists. + * @desc Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists. * @example * // Before running the sample: * // - Enable the API at: @@ -8677,7 +8407,7 @@ export namespace classroom_v1 { /** * classroom.invitations.delete - * @desc Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID. + * @desc Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID. * @example * // Before running the sample: * // - Enable the API at: @@ -8806,7 +8536,7 @@ export namespace classroom_v1 { /** * classroom.invitations.get - * @desc Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID. + * @desc Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID. * @example * // Before running the sample: * // - Enable the API at: @@ -8942,7 +8672,7 @@ export namespace classroom_v1 { /** * classroom.invitations.list - * @desc Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. + * @desc Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * @example * // Before running the sample: * // - Enable the API at: @@ -8970,28 +8700,13 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.invitations.list({ - * // Restricts returned invitations to those for a course with the specified - * // identifier. + * // Restricts returned invitations to those for a course with the specified identifier. * courseId: 'placeholder-value', - * // Maximum number of items to return. The default is 500 if unspecified or - * // `0`. - * // - * // The server may return fewer than the specified number of results. + * // Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results. * pageSize: 'placeholder-value', - * // 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. + * // nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * pageToken: 'placeholder-value', - * // Restricts returned invitations to those for a specific user. The identifier - * // can be one of the following: - * // - * // * the numeric identifier for the user - * // * the email address of the user - * // * the string literal `"me"`, indicating the requesting user + * // Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * userId: 'placeholder-value', * }); * console.log(res.data); @@ -9013,9 +8728,9 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string=} params.courseId Restricts returned invitations to those for a course with the specified identifier. - * @param {integer=} params.pageSize Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results. - * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. - * @param {string=} params.userId Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * @param {integer=} params.pageSize Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results. + * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * @param {string=} params.userId Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9134,15 +8849,15 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results. + * Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; /** - * Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -9155,7 +8870,7 @@ export namespace classroom_v1 { /** * classroom.registrations.create - * @desc Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it. + * @desc Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it. * @example * // Before running the sample: * // - Enable the API at: @@ -9451,7 +9166,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.get - * @desc Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors. + * @desc Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors. * @example * // Before running the sample: * // - Enable the API at: @@ -9481,12 +9196,7 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.userProfiles.get({ - * // Identifier of the profile to return. The identifier can be one of the - * // following: - * // - * // * the numeric identifier for the user - * // * the email address of the user - * // * the string literal `"me"`, indicating the requesting user + * // Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * userId: 'placeholder-value', * }); * console.log(res.data); @@ -9511,7 +9221,7 @@ export namespace classroom_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * @param {string} params.userId Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9597,7 +9307,7 @@ export namespace classroom_v1 { export interface Params$Resource$Userprofiles$Get extends StandardParameters { /** - * Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ userId?: string; } @@ -9610,7 +9320,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardianInvitations.create - * @desc Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user. + * @desc Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user. * @example * // Before running the sample: * // - Enable the API at: @@ -9762,7 +9472,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardianInvitations.get - * @desc Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student. + * @desc Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student. * @example * // Before running the sample: * // - Enable the API at: @@ -9906,7 +9616,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardianInvitations.list - * @desc Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student. + * @desc Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student. * @example * // Before running the sample: * // - Enable the API at: @@ -9934,34 +9644,15 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.userProfiles.guardianInvitations.list({ - * // If specified, only results with the specified `invited_email_address` - * // are returned. + * // If specified, only results with the specified `invited_email_address` are returned. * invitedEmailAddress: 'placeholder-value', - * // 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. + * // Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. * pageSize: 'placeholder-value', - * // 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. + * // nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * pageToken: 'placeholder-value', - * // If specified, only results with the specified `state` values are - * // returned. Otherwise, results with a `state` of `PENDING` are returned. + * // If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned. * states: 'placeholder-value', - * // The ID of the student whose guardian invitations are to be returned. - * // The identifier can be one of the following: - * // - * // * the numeric identifier for the user - * // * the email address of the user - * // * the string literal `"me"`, indicating the requesting user - * // * the string literal `"-"`, indicating that results should be returned for - * // all students that the requesting user is permitted to view guardian - * // invitations. + * // The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations. * studentId: 'placeholder-value', * }); * console.log(res.data); @@ -9983,10 +9674,10 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string=} params.invitedEmailAddress If specified, only results with the specified `invited_email_address` are returned. - * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. - * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * @param {string=} params.states If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned. - * @param {string} params.studentId The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations. + * @param {string} params.studentId The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10080,7 +9771,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardianInvitations.patch - * @desc Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom. + * @desc Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom. * @example * // Before running the sample: * // - Enable the API at: @@ -10111,15 +9802,7 @@ export namespace classroom_v1 { * invitationId: 'placeholder-value', * // The ID of the student whose guardian invitation is to be modified. * studentId: 'placeholder-value', - * // Mask that identifies which fields on the course to update. - * // This field is required to do an update. The update fails if invalid - * // fields are specified. The following fields are valid: - * // - * // * `state` - * // - * // When set in a query parameter, this field should be specified as - * // - * // `updateMask=,,...` + * // Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...` * updateMask: 'placeholder-value', * * // Request body metadata @@ -10157,7 +9840,7 @@ export namespace classroom_v1 { * @param {object} params Parameters for request * @param {string} params.invitationId The `id` field of the `GuardianInvitation` to be modified. * @param {string} params.studentId The ID of the student whose guardian invitation is to be modified. - * @param {string=} params.updateMask Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...` + * @param {string=} params.updateMask Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...` * @param {().GuardianInvitation} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -10276,11 +9959,11 @@ export namespace classroom_v1 { */ invitedEmailAddress?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; /** @@ -10288,7 +9971,7 @@ export namespace classroom_v1 { */ states?: string[]; /** - * The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations. + * The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations. */ studentId?: string; } @@ -10303,7 +9986,7 @@ export namespace classroom_v1 { */ studentId?: string; /** - * Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...` + * Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...` */ updateMask?: string; @@ -10321,7 +10004,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardians.delete - * @desc Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`. + * @desc Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`. * @example * // Before running the sample: * // - Enable the API at: @@ -10350,11 +10033,7 @@ export namespace classroom_v1 { * const res = await classroom.userProfiles.guardians.delete({ * // The `id` field from a `Guardian`. * guardianId: 'placeholder-value', - * // The student whose guardian is to be deleted. One of the following: - * // - * // * the numeric identifier for the user - * // * the email address of the user - * // * the string literal `"me"`, indicating the requesting user + * // The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * studentId: 'placeholder-value', * }); * console.log(res.data); @@ -10373,7 +10052,7 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string} params.guardianId The `id` field from a `Guardian`. - * @param {string} params.studentId The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * @param {string} params.studentId The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10458,7 +10137,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardians.get - * @desc Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`. + * @desc Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`. * @example * // Before running the sample: * // - Enable the API at: @@ -10489,11 +10168,7 @@ export namespace classroom_v1 { * const res = await classroom.userProfiles.guardians.get({ * // The `id` field from a `Guardian`. * guardianId: 'placeholder-value', - * // The student whose guardian is being requested. One of the following: - * // - * // * the numeric identifier for the user - * // * the email address of the user - * // * the string literal `"me"`, indicating the requesting user + * // The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * studentId: 'placeholder-value', * }); * console.log(res.data); @@ -10517,7 +10192,7 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string} params.guardianId The `id` field from a `Guardian`. - * @param {string} params.studentId The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * @param {string} params.studentId The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10602,7 +10277,7 @@ export namespace classroom_v1 { /** * classroom.userProfiles.guardians.list - * @desc Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student. + * @desc Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student. * @example * // Before running the sample: * // - Enable the API at: @@ -10631,31 +10306,13 @@ export namespace classroom_v1 { * * // Do the magic * const res = await classroom.userProfiles.guardians.list({ - * // Filter results by the email address that the original invitation was sent - * // to, resulting in this guardian link. - * // This filter can only be used by domain administrators. + * // Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators. * invitedEmailAddress: 'placeholder-value', - * // 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. + * // Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. * pageSize: 'placeholder-value', - * // 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. + * // nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. * pageToken: 'placeholder-value', - * // Filter results by the student who the guardian is linked to. - * // The identifier can be one of the following: - * // - * // * the numeric identifier for the user - * // * the email address of the user - * // * the string literal `"me"`, indicating the requesting user - * // * the string literal `"-"`, indicating that results should be returned for - * // all students that the requesting user has access to view. + * // Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view. * studentId: 'placeholder-value', * }); * console.log(res.data); @@ -10677,9 +10334,9 @@ export namespace classroom_v1 { * * @param {object} params Parameters for request * @param {string=} params.invitedEmailAddress Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators. - * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. - * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. - * @param {string} params.studentId Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view. + * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * @param {string} params.studentId Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -10776,7 +10433,7 @@ export namespace classroom_v1 { */ guardianId?: string; /** - * The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ studentId?: string; } @@ -10787,7 +10444,7 @@ export namespace classroom_v1 { */ guardianId?: string; /** - * The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + * The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user */ studentId?: string; } @@ -10798,15 +10455,15 @@ export namespace classroom_v1 { */ invitedEmailAddress?: string; /** - * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. + * Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. */ pageSize?: number; /** - * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. + * nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. */ pageToken?: string; /** - * Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view. + * Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view. */ studentId?: string; }