docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/gmail_v1.users.html b/docs/dyn/gmail_v1.users.html
index 882446b..bf34430 100644
--- a/docs/dyn/gmail_v1.users.html
+++ b/docs/dyn/gmail_v1.users.html
@@ -105,93 +105,68 @@
<p class="firstline">Returns the threads Resource.</p>
<p class="toc_element">
- <code><a href="#getProfile">getProfile(userId, x__xgafv=None)</a></code></p>
+ <code><a href="#getProfile">getProfile(userId)</a></code></p>
<p class="firstline">Gets the current user's Gmail profile.</p>
<p class="toc_element">
- <code><a href="#stop">stop(userId, x__xgafv=None)</a></code></p>
+ <code><a href="#stop">stop(userId)</a></code></p>
<p class="firstline">Stop receiving push notifications for the given user mailbox.</p>
<p class="toc_element">
- <code><a href="#watch">watch(userId, body=None, x__xgafv=None)</a></code></p>
+ <code><a href="#watch">watch(userId, body=None)</a></code></p>
<p class="firstline">Set up or update a push notification watch on the given user mailbox.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="getProfile">getProfile(userId, x__xgafv=None)</code>
- <pre>Gets the current user's Gmail profile.
+ <code class="details" id="getProfile">getProfile(userId)</code>
+ <pre>Gets the current user's Gmail profile.
Args:
- userId: string, The user's email address. The special value <code>me</code>
-can be used to indicate the authenticated user. (required)
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
+ userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
Returns:
An object of the form:
{ # Profile for a Gmail user.
- "messagesTotal": 42, # The total number of messages in the mailbox.
- "emailAddress": "A String", # The user's email address.
- "historyId": "A String", # The ID of the mailbox's current history record.
- "threadsTotal": 42, # The total number of threads in the mailbox.
+ "emailAddress": "A String", # The user's email address.
+ "historyId": "A String", # The ID of the mailbox's current history record.
+ "messagesTotal": 42, # The total number of messages in the mailbox.
+ "threadsTotal": 42, # The total number of threads in the mailbox.
}</pre>
</div>
<div class="method">
- <code class="details" id="stop">stop(userId, x__xgafv=None)</code>
+ <code class="details" id="stop">stop(userId)</code>
<pre>Stop receiving push notifications for the given user mailbox.
Args:
- userId: string, The user's email address. The special value <code>me</code>
-can be used to indicate the authenticated user. (required)
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
+ userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
</pre>
</div>
<div class="method">
- <code class="details" id="watch">watch(userId, body=None, x__xgafv=None)</code>
+ <code class="details" id="watch">watch(userId, body=None)</code>
<pre>Set up or update a push notification watch on the given user mailbox.
Args:
- userId: string, The user's email address. The special value <code>me</code>
-can be used to indicate the authenticated user. (required)
+ userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
body: object, The request body.
The object takes the form of:
-{ # Set up or update a new push notification watch on this user's mailbox.
- "labelIds": [ # List of label_ids to restrict notifications about. By default,
- # if unspecified, all changes are pushed out. If specified then
- # dictates which labels are required for a push notification to
- # be generated.
- "A String",
+{ # Set up or update a new push notification watch on this user's mailbox.
+ "labelFilterAction": "A String", # Filtering behavior of labelIds list specified.
+ "labelIds": [ # List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.
+ "A String",
],
- "topicName": "A String", # A fully qualified Google Cloud Pub/Sub API topic name to publish the
- # events to. This topic name **must** already exist in Cloud Pub/Sub and
- # you **must** have already granted gmail "publish" permission on it.
- # For example, "projects/my-project-identifier/topics/my-topic-name"
- # (using the Cloud Pub/Sub "v1" topic naming format).
+ "topicName": "A String", # A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name **must** already exist in Cloud Pub/Sub and you **must** have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format).
#
- # Note that the "my-project-identifier" portion must exactly match your
- # Google developer project id (the one executing this watch request).
- "labelFilterAction": "A String", # Filtering behavior of labelIds list specified.
+ # Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request).
}
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
Returns:
An object of the form:
{ # Push notification watch response.
- "expiration": "A String", # When Gmail will stop sending notifications for mailbox updates
- # (epoch millis). Call <code>watch</code> again before this time to renew
- # the watch.
- "historyId": "A String", # The ID of the mailbox's current history record.
+ "expiration": "A String", # When Gmail will stop sending notifications for mailbox updates (epoch millis). Call watch again before this time to renew the watch.
+ "historyId": "A String", # The ID of the mailbox's current history record.
}</pre>
</div>