docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/classroom_v1.userProfiles.guardians.html b/docs/dyn/classroom_v1.userProfiles.guardians.html
index c40d3a2..7357929 100644
--- a/docs/dyn/classroom_v1.userProfiles.guardians.html
+++ b/docs/dyn/classroom_v1.userProfiles.guardians.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(studentId, guardianId, x__xgafv=None)</a></code></p>
<p class="firstline">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`.</p>
<p class="toc_element">
- <code><a href="#list">list(studentId, pageToken=None, pageSize=None, invitedEmailAddress=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(studentId, pageSize=None, invitedEmailAddress=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -131,36 +131,36 @@
{ # Association between a student and a guardian of that student. The guardian may receive information about the student's course work.
"guardianProfile": { # Global information for a user. # User profile for the guardian.
+ "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.
+ },
"verifiedTeacher": True or False, # 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
- "emailAddress": "A String", # Email address of the user. 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.
"permissions": [ # Global permissions of the user. Read-only.
{ # Global user permission description.
"permission": "A String", # Permission value.
},
],
- "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.
- "familyName": "A String", # The user's last name. Read-only.
- "givenName": "A String", # The user's first name. Read-only.
- },
},
- "guardianId": "A String", # Identifier for the guardian.
"invitedEmailAddress": "A String", # The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.
"studentId": "A String", # Identifier for the student to whom the guardian relationship applies.
+ "guardianId": "A String", # Identifier for the guardian.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(studentId, pageToken=None, pageSize=None, invitedEmailAddress=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(studentId, pageSize=None, invitedEmailAddress=None, pageToken=None, x__xgafv=None)</code>
<pre>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.
Args:
studentId: 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. (required)
- 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.
pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
invitedEmailAddress: string, 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.
+ 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -170,30 +170,30 @@
An object of the form:
{ # Response when listing guardians.
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
"guardians": [ # Guardians on this page of results that met the criteria specified in the request.
{ # Association between a student and a guardian of that student. The guardian may receive information about the student's course work.
"guardianProfile": { # Global information for a user. # User profile for the guardian.
+ "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.
+ },
"verifiedTeacher": True or False, # 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
- "emailAddress": "A String", # Email address of the user. 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.
"permissions": [ # Global permissions of the user. Read-only.
{ # Global user permission description.
"permission": "A String", # Permission value.
},
],
- "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.
- "familyName": "A String", # The user's last name. Read-only.
- "givenName": "A String", # The user's first name. Read-only.
- },
},
- "guardianId": "A String", # Identifier for the guardian.
"invitedEmailAddress": "A String", # The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.
"studentId": "A String", # Identifier for the student to whom the guardian relationship applies.
+ "guardianId": "A String", # Identifier for the guardian.
},
],
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
}</pre>
</div>