Updated docs
diff --git a/docs/dyn/classroom_v1.courses.students.html b/docs/dyn/classroom_v1.courses.students.html
index 2a5957b..4c346d0 100644
--- a/docs/dyn/classroom_v1.courses.students.html
+++ b/docs/dyn/classroom_v1.courses.students.html
@@ -76,83 +76,83 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(courseId, body, enrollmentCode=None, x__xgafv=None)</a></code></p>
-<p class="firstline">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. * `NOT_FOUND` if the requested course ID does not exist. * `ALREADY_EXISTS` if the user is already a student or student in the course.</p>
+<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#delete">delete(courseId, userId, x__xgafv=None)</a></code></p>
-<p class="firstline">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. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.</p>
+<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#get">get(courseId, userId, x__xgafv=None)</a></code></p>
-<p class="firstline">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. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.</p>
+<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#list">list(courseId, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
-<p class="firstline">Returns a list of students of this course that the requester is permitted to view. Fails with `NOT_FOUND` if the course does not exist.</p>
+<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(courseId, body, enrollmentCode=None, x__xgafv=None)</code>
- <pre>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. * `NOT_FOUND` if the requested course ID does not exist. * `ALREADY_EXISTS` if the user is already a student or student in the course.
+ <pre>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.
Args:
- courseId: string, Identifier of the course to create the student in. This may either be the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Student in a course.
- "courseId": "A String", # Unique identifier of the course. Read-only
- "profile": { # Global information for a user. # Global user information for the student. Read-only
- "permissions": [ # Global permissions of the user. Read-only
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "profile": { # Global information for a user. # Global user information for the student. Read-only.
+ "permissions": [ # Global permissions of the user. Read-only.
{ # Global user permission description.
"permission": "A String", # Permission value.
},
],
- "photoUrl": "A String", # Url of user's profile photo. Read-only
- "emailAddress": "A String", # E-mail address of the user. Read-only
- "id": "A String", # Unique identifier of the user. Read-only
- "name": { # Details of the user's name. # Name of the user. Read-only
- "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only
- "givenName": "A String", # The user's first name. Read-only
- "familyName": "A String", # The user's last name. Read-only
+ "photoUrl": "A String", # URL of user's profile photo. Read-only.
+ "emailAddress": "A String", # Email address of the user. Read-only.
+ "id": "A String", # Identifier of the user. Read-only.
+ "name": { # Details of the user's name. # Name of the user. Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+ "givenName": "A String", # The user's first name. Read-only.
+ "familyName": "A String", # The user's last name. Read-only.
},
},
- "userId": "A String", # The identifier of the user. When specified as a parameter of request, this field may be set to an alias that identifies the student. The following are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user
+ "userId": "A String", # 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
}
- enrollmentCode: string, Enrollment code of the course to create the student in. This is required if [userId][google.classroom.v1.Student.user_id] corresponds to the requesting user; this may be omitted if the requesting user has administrative permissions to create students for any user.
+ enrollmentCode: string, 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.
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # Student in a course.
- "courseId": "A String", # Unique identifier of the course. Read-only
- "profile": { # Global information for a user. # Global user information for the student. Read-only
- "permissions": [ # Global permissions of the user. Read-only
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "profile": { # Global information for a user. # Global user information for the student. Read-only.
+ "permissions": [ # Global permissions of the user. Read-only.
{ # Global user permission description.
"permission": "A String", # Permission value.
},
],
- "photoUrl": "A String", # Url of user's profile photo. Read-only
- "emailAddress": "A String", # E-mail address of the user. Read-only
- "id": "A String", # Unique identifier of the user. Read-only
- "name": { # Details of the user's name. # Name of the user. Read-only
- "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only
- "givenName": "A String", # The user's first name. Read-only
- "familyName": "A String", # The user's last name. Read-only
+ "photoUrl": "A String", # URL of user's profile photo. Read-only.
+ "emailAddress": "A String", # Email address of the user. Read-only.
+ "id": "A String", # Identifier of the user. Read-only.
+ "name": { # Details of the user's name. # Name of the user. Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+ "givenName": "A String", # The user's first name. Read-only.
+ "familyName": "A String", # The user's last name. Read-only.
},
},
- "userId": "A String", # The identifier of the user. When specified as a parameter of request, this field may be set to an alias that identifies the student. The following are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user
+ "userId": "A String", # 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
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(courseId, userId, x__xgafv=None)</code>
- <pre>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. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
+ <pre>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.
Args:
- courseId: string, Unique identifier of the course. This may either be the Classroom-assigned identifier or an alias. (required)
- userId: string, Identifier of the student to delete, or an alias the identifies the user. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user (required)
+ courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ userId: 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 (required)
x__xgafv: string, V1 error format.
Returns:
@@ -164,70 +164,70 @@
<div class="method">
<code class="details" id="get">get(courseId, userId, x__xgafv=None)</code>
- <pre>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. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
+ <pre>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.
Args:
- courseId: string, Unique identifier of the course. This may either be the Classroom-assigned identifier or an alias. (required)
- userId: string, Identifier of the student to return, or an alias the identifies the user. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user (required)
+ courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ userId: 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 (required)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # Student in a course.
- "courseId": "A String", # Unique identifier of the course. Read-only
- "profile": { # Global information for a user. # Global user information for the student. Read-only
- "permissions": [ # Global permissions of the user. Read-only
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "profile": { # Global information for a user. # Global user information for the student. Read-only.
+ "permissions": [ # Global permissions of the user. Read-only.
{ # Global user permission description.
"permission": "A String", # Permission value.
},
],
- "photoUrl": "A String", # Url of user's profile photo. Read-only
- "emailAddress": "A String", # E-mail address of the user. Read-only
- "id": "A String", # Unique identifier of the user. Read-only
- "name": { # Details of the user's name. # Name of the user. Read-only
- "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only
- "givenName": "A String", # The user's first name. Read-only
- "familyName": "A String", # The user's last name. Read-only
+ "photoUrl": "A String", # URL of user's profile photo. Read-only.
+ "emailAddress": "A String", # Email address of the user. Read-only.
+ "id": "A String", # Identifier of the user. Read-only.
+ "name": { # Details of the user's name. # Name of the user. Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+ "givenName": "A String", # The user's first name. Read-only.
+ "familyName": "A String", # The user's last name. Read-only.
},
},
- "userId": "A String", # The identifier of the user. When specified as a parameter of request, this field may be set to an alias that identifies the student. The following are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user
+ "userId": "A String", # 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
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(courseId, pageSize=None, x__xgafv=None, pageToken=None)</code>
- <pre>Returns a list of students of this course that the requester is permitted to view. Fails with `NOT_FOUND` if the course does not exist.
+ <pre>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.
Args:
- courseId: string, Unique identifier of the course. This may either be the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
pageSize: integer, Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
x__xgafv: string, V1 error format.
- pageToken: string, [nextPageToken][google.classroom.v1.ListStudentsResponse.next_page_token] value returned from a previous [list][google.classroom.v1.Users.ListStudents] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Users.ListStudents] request must be identical to the one which resulted in this token.
+ pageToken: string, 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.
Returns:
An object of the form:
{ # Response when listing students.
- "students": [ # The students who match the list request.
+ "students": [ # Students who match the list request.
{ # Student in a course.
- "courseId": "A String", # Unique identifier of the course. Read-only
- "profile": { # Global information for a user. # Global user information for the student. Read-only
- "permissions": [ # Global permissions of the user. Read-only
+ "courseId": "A String", # Identifier of the course. Read-only.
+ "profile": { # Global information for a user. # Global user information for the student. Read-only.
+ "permissions": [ # Global permissions of the user. Read-only.
{ # Global user permission description.
"permission": "A String", # Permission value.
},
],
- "photoUrl": "A String", # Url of user's profile photo. Read-only
- "emailAddress": "A String", # E-mail address of the user. Read-only
- "id": "A String", # Unique identifier of the user. Read-only
- "name": { # Details of the user's name. # Name of the user. Read-only
- "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only
- "givenName": "A String", # The user's first name. Read-only
- "familyName": "A String", # The user's last name. Read-only
+ "photoUrl": "A String", # URL of user's profile photo. Read-only.
+ "emailAddress": "A String", # Email address of the user. Read-only.
+ "id": "A String", # Identifier of the user. Read-only.
+ "name": { # Details of the user's name. # Name of the user. Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+ "givenName": "A String", # The user's first name. Read-only.
+ "familyName": "A String", # The user's last name. Read-only.
},
},
- "userId": "A String", # The identifier of the user. When specified as a parameter of request, this field may be set to an alias that identifies the student. The following are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user
+ "userId": "A String", # 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
},
],
"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.