chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/classroom_v1.userProfiles.guardianInvitations.html b/docs/dyn/classroom_v1.userProfiles.guardianInvitations.html
index addfa91..4a0741e 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, pageToken=None, states=None, invitedEmailAddress=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(studentId, pageSize=None, states=None, pageToken=None, invitedEmailAddress=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,10 +108,10 @@
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.
"studentId": "A String", # ID of the student (in standard format)
"creationTime": "A String", # The time that this invitation was created. Read-only.
"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.
"state": "A String", # The state that this invitation is in.
}
@@ -124,10 +124,10 @@
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.
"studentId": "A String", # ID of the student (in standard format)
"creationTime": "A String", # The time that this invitation was created. Read-only.
"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.
"state": "A String", # The state that this invitation is in.
}</pre>
</div>
@@ -148,28 +148,28 @@
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.
"studentId": "A String", # ID of the student (in standard format)
"creationTime": "A String", # The time that this invitation was created. Read-only.
"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.
"state": "A String", # The state that this invitation is in.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(studentId, pageToken=None, states=None, invitedEmailAddress=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(studentId, pageSize=None, states=None, pageToken=None, invitedEmailAddress=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)
- 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.
PENDING - The invitation is active and awaiting a response.
COMPLETE - The invitation is no longer active. It may have been accepted, declined, withdrawn or it may have expired.
+ 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.
- 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -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.
"studentId": "A String", # ID of the student (in standard format)
"creationTime": "A String", # The time that this invitation was created. Read-only.
"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.
"state": "A String", # The state that this invitation is in.
},
],
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
}</pre>
</div>
@@ -217,10 +217,10 @@
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.
"studentId": "A String", # ID of the student (in standard format)
"creationTime": "A String", # The time that this invitation was created. Read-only.
"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.
"state": "A String", # The state that this invitation is in.
}
@@ -234,10 +234,10 @@
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.
"studentId": "A String", # ID of the student (in standard format)
"creationTime": "A String", # The time that this invitation was created. Read-only.
"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.
"state": "A String", # The state that this invitation is in.
}</pre>
</div>