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.guardianInvitations.html b/docs/dyn/classroom_v1.userProfiles.guardianInvitations.html
index 7ad5e6f..4230e60 100644
--- a/docs/dyn/classroom_v1.userProfiles.guardianInvitations.html
+++ b/docs/dyn/classroom_v1.userProfiles.guardianInvitations.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(studentId, invitationId, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
- <code><a href="#list">list(studentId, pageSize=None, pageToken=None, invitedEmailAddress=None, states=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(studentId, invitedEmailAddress=None, pageToken=None, pageSize=None, states=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -108,12 +108,12 @@
The object takes the form of:
{ # An invitation to become the guardian of a specified user, sent to a specified email address.
- "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
- "invitationId": "A String", # Unique identifier for this invitation. Read-only.
- "creationTime": "A String", # The time that this invitation was created. Read-only.
- "studentId": "A String", # ID of the student (in standard format)
- "state": "A String", # The state that this invitation is in.
-}
+ "creationTime": "A String", # The time that this invitation was created. Read-only.
+ "state": "A String", # The state that this invitation is in.
+ "invitationId": "A String", # Unique identifier for this invitation. Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
+ "studentId": "A String", # ID of the student (in standard format)
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -124,12 +124,12 @@
An object of the form:
{ # An invitation to become the guardian of a specified user, sent to a specified email address.
- "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
- "invitationId": "A String", # Unique identifier for this invitation. Read-only.
- "creationTime": "A String", # The time that this invitation was created. Read-only.
- "studentId": "A String", # ID of the student (in standard format)
- "state": "A String", # The state that this invitation is in.
- }</pre>
+ "creationTime": "A String", # The time that this invitation was created. Read-only.
+ "state": "A String", # The state that this invitation is in.
+ "invitationId": "A String", # Unique identifier for this invitation. Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
+ "studentId": "A String", # ID of the student (in standard format)
+ }</pre>
</div>
<div class="method">
@@ -148,23 +148,23 @@
An object of the form:
{ # An invitation to become the guardian of a specified user, sent to a specified email address.
- "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
- "invitationId": "A String", # Unique identifier for this invitation. Read-only.
- "creationTime": "A String", # The time that this invitation was created. Read-only.
- "studentId": "A String", # ID of the student (in standard format)
- "state": "A String", # The state that this invitation is in.
- }</pre>
+ "creationTime": "A String", # The time that this invitation was created. Read-only.
+ "state": "A String", # The state that this invitation is in.
+ "invitationId": "A String", # Unique identifier for this invitation. Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
+ "studentId": "A String", # ID of the student (in standard format)
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(studentId, pageSize=None, pageToken=None, invitedEmailAddress=None, states=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(studentId, invitedEmailAddress=None, pageToken=None, pageSize=None, states=None, x__xgafv=None)</code>
<pre>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.
Args:
studentId: 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. (required)
- 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.
- 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.
invitedEmailAddress: string, If specified, only results with the specified `invited_email_address` are returned.
+ 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.
states: string, If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned. (repeated)
Allowed values
GUARDIAN_INVITATION_STATE_UNSPECIFIED - Should never be returned.
@@ -179,16 +179,16 @@
An object of the form:
{ # Response when listing guardian invitations.
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
"guardianInvitations": [ # Guardian invitations that matched the list request.
{ # An invitation to become the guardian of a specified user, sent to a specified email address.
- "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
- "invitationId": "A String", # Unique identifier for this invitation. Read-only.
- "creationTime": "A String", # The time that this invitation was created. Read-only.
- "studentId": "A String", # ID of the student (in standard format)
- "state": "A String", # The state that this invitation is in.
- },
+ "creationTime": "A String", # The time that this invitation was created. Read-only.
+ "state": "A String", # The state that this invitation is in.
+ "invitationId": "A String", # Unique identifier for this invitation. Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
+ "studentId": "A String", # ID of the student (in standard format)
+ },
],
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
}</pre>
</div>
@@ -217,12 +217,12 @@
The object takes the form of:
{ # An invitation to become the guardian of a specified user, sent to a specified email address.
- "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
- "invitationId": "A String", # Unique identifier for this invitation. Read-only.
- "creationTime": "A String", # The time that this invitation was created. Read-only.
- "studentId": "A String", # ID of the student (in standard format)
- "state": "A String", # The state that this invitation is in.
-}
+ "creationTime": "A String", # The time that this invitation was created. Read-only.
+ "state": "A String", # The state that this invitation is in.
+ "invitationId": "A String", # Unique identifier for this invitation. Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
+ "studentId": "A String", # ID of the student (in standard format)
+ }
updateMask: 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=,,...`
x__xgafv: string, V1 error format.
@@ -234,12 +234,12 @@
An object of the form:
{ # An invitation to become the guardian of a specified user, sent to a specified email address.
- "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
- "invitationId": "A String", # Unique identifier for this invitation. Read-only.
- "creationTime": "A String", # The time that this invitation was created. Read-only.
- "studentId": "A String", # ID of the student (in standard format)
- "state": "A String", # The state that this invitation is in.
- }</pre>
+ "creationTime": "A String", # The time that this invitation was created. Read-only.
+ "state": "A String", # The state that this invitation is in.
+ "invitationId": "A String", # Unique identifier for this invitation. Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to. This field is only visible to domain administrators.
+ "studentId": "A String", # ID of the student (in standard format)
+ }</pre>
</div>
</body></html>
\ No newline at end of file