docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/people_v1.contactGroups.html b/docs/dyn/people_v1.contactGroups.html
index 4815e81..c0d5904 100644
--- a/docs/dyn/people_v1.contactGroups.html
+++ b/docs/dyn/people_v1.contactGroups.html
@@ -80,7 +80,7 @@
<p class="firstline">Returns the members Resource.</p>
<p class="toc_element">
- <code><a href="#batchGet">batchGet(maxMembers=None, resourceNames=None, x__xgafv=None)</a></code></p>
+ <code><a href="#batchGet">batchGet(resourceNames=None, maxMembers=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get a list of contact groups owned by the authenticated user by specifying</p>
<p class="toc_element">
<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
@@ -92,7 +92,7 @@
<code><a href="#get">get(resourceName, maxMembers=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get a specific contact group owned by the authenticated user by specifying</p>
<p class="toc_element">
- <code><a href="#list">list(pageSize=None, syncToken=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(syncToken=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all contact groups owned by the authenticated user. Members of the</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -102,14 +102,14 @@
<p class="firstline">Update the name of an existing contact group owned by the authenticated</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="batchGet">batchGet(maxMembers=None, resourceNames=None, x__xgafv=None)</code>
+ <code class="details" id="batchGet">batchGet(resourceNames=None, maxMembers=None, x__xgafv=None)</code>
<pre>Get a list of contact groups owned by the authenticated user by specifying
a list of contact group resource names.
Args:
+ resourceNames: string, Required. The resource names of the contact groups to get. (repeated)
maxMembers: integer, Optional. Specifies the maximum number of members to return for each group. Defaults
to 0 if not set, which will return zero members.
- resourceNames: string, Required. The resource names of the contact groups to get. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -122,30 +122,30 @@
"responses": [ # The list of responses for each requested contact group resource.
{ # The response for a specific contact group.
"contactGroup": { # A contact group. # The contact group.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "groupType": "A String", # Output only. The contact group type.
- "name": "A String", # The contact group name set by the group owner or a system provided name
- # for system groups.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact
# group. The field is not populated for LIST requests and can only be updated
# through the
# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
"A String",
],
- "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
- # or the `Accept-Language` HTTP header locale for system groups names.
- # Group names set by the owner are the same as name.
+ "groupType": "A String", # Output only. The contact group type.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
# string, in the form of `contactGroups/{contact_group_id}`.
+ "name": "A String", # The contact group name set by the group owner or a system provided name
+ # for system groups.
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for
# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
# that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # resource. Used for web cache validation.
+ "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
+ # specified in the request.
+ "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
+ # or the `Accept-Language` HTTP header locale for system groups names.
+ # Group names set by the owner are the same as name.
},
"requestedResourceName": "A String", # The original requested resource name.
"status": { # The `Status` type defines a logical error model that is suitable for # The status of the response.
@@ -155,9 +155,6 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
@@ -165,6 +162,9 @@
},
],
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
},
},
],
@@ -181,30 +181,30 @@
{ # A request to create a new contact group.
"contactGroup": { # A contact group. # Required. The contact group to create.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "groupType": "A String", # Output only. The contact group type.
- "name": "A String", # The contact group name set by the group owner or a system provided name
- # for system groups.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact
# group. The field is not populated for LIST requests and can only be updated
# through the
# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
"A String",
],
- "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
- # or the `Accept-Language` HTTP header locale for system groups names.
- # Group names set by the owner are the same as name.
+ "groupType": "A String", # Output only. The contact group type.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
# string, in the form of `contactGroups/{contact_group_id}`.
+ "name": "A String", # The contact group name set by the group owner or a system provided name
+ # for system groups.
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for
# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
# that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # resource. Used for web cache validation.
+ "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
+ # specified in the request.
+ "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
+ # or the `Accept-Language` HTTP header locale for system groups names.
+ # Group names set by the owner are the same as name.
},
}
@@ -217,30 +217,30 @@
An object of the form:
{ # A contact group.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "groupType": "A String", # Output only. The contact group type.
- "name": "A String", # The contact group name set by the group owner or a system provided name
- # for system groups.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact
# group. The field is not populated for LIST requests and can only be updated
# through the
# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
"A String",
],
- "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
- # or the `Accept-Language` HTTP header locale for system groups names.
- # Group names set by the owner are the same as name.
+ "groupType": "A String", # Output only. The contact group type.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
# string, in the form of `contactGroups/{contact_group_id}`.
+ "name": "A String", # The contact group name set by the group owner or a system provided name
+ # for system groups.
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for
# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
# that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # resource. Used for web cache validation.
+ "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
+ # specified in the request.
+ "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
+ # or the `Accept-Language` HTTP header locale for system groups names.
+ # Group names set by the owner are the same as name.
}</pre>
</div>
@@ -290,46 +290,46 @@
An object of the form:
{ # A contact group.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "groupType": "A String", # Output only. The contact group type.
- "name": "A String", # The contact group name set by the group owner or a system provided name
- # for system groups.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact
# group. The field is not populated for LIST requests and can only be updated
# through the
# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
"A String",
],
- "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
- # or the `Accept-Language` HTTP header locale for system groups names.
- # Group names set by the owner are the same as name.
+ "groupType": "A String", # Output only. The contact group type.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
# string, in the form of `contactGroups/{contact_group_id}`.
+ "name": "A String", # The contact group name set by the group owner or a system provided name
+ # for system groups.
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for
# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
# that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # resource. Used for web cache validation.
+ "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
+ # specified in the request.
+ "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
+ # or the `Accept-Language` HTTP header locale for system groups names.
+ # Group names set by the owner are the same as name.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(pageSize=None, syncToken=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(syncToken=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>List all contact groups owned by the authenticated user. Members of the
contact groups are not populated.
Args:
- pageSize: integer, Optional. The maximum number of resources to return. Valid values are between 1 and
-1000, inclusive. Defaults to 30 if not set or set to 0.
syncToken: string, Optional. A sync token, returned by a previous call to `contactgroups.list`.
Only resources changed since the sync token was created will be returned.
pageToken: string, Optional. The next_page_token value returned from a previous call to
[ListContactGroups](/people/api/rest/v1/contactgroups/list).
Requests the next page of resources.
+ pageSize: integer, Optional. The maximum number of resources to return. Valid values are between 1 and
+1000, inclusive. Defaults to 30 if not set or set to 0.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -339,38 +339,38 @@
An object of the form:
{ # The response to a list contact groups request.
- "nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request.
+ "totalItems": 42, # The total number of items in the list without pagination.
"contactGroups": [ # The list of contact groups. Members of the contact groups are not
# populated.
{ # A contact group.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "groupType": "A String", # Output only. The contact group type.
- "name": "A String", # The contact group name set by the group owner or a system provided name
- # for system groups.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact
# group. The field is not populated for LIST requests and can only be updated
# through the
# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
"A String",
],
- "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
- # or the `Accept-Language` HTTP header locale for system groups names.
- # Group names set by the owner are the same as name.
+ "groupType": "A String", # Output only. The contact group type.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
# string, in the form of `contactGroups/{contact_group_id}`.
+ "name": "A String", # The contact group name set by the group owner or a system provided name
+ # for system groups.
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for
# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
# that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # resource. Used for web cache validation.
+ "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
+ # specified in the request.
+ "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
+ # or the `Accept-Language` HTTP header locale for system groups names.
+ # Group names set by the owner are the same as name.
},
],
- "totalItems": 42, # The total number of items in the list without pagination.
"nextPageToken": "A String", # The token that can be used to retrieve the next page of results.
+ "nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request.
}</pre>
</div>
@@ -402,30 +402,30 @@
{ # A request to update an existing user contact group. All updated fields will
# be replaced.
"contactGroup": { # A contact group. # Required. The contact group to update.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "groupType": "A String", # Output only. The contact group type.
- "name": "A String", # The contact group name set by the group owner or a system provided name
- # for system groups.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact
# group. The field is not populated for LIST requests and can only be updated
# through the
# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
"A String",
],
- "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
- # or the `Accept-Language` HTTP header locale for system groups names.
- # Group names set by the owner are the same as name.
+ "groupType": "A String", # Output only. The contact group type.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
# string, in the form of `contactGroups/{contact_group_id}`.
+ "name": "A String", # The contact group name set by the group owner or a system provided name
+ # for system groups.
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for
# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
# that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # resource. Used for web cache validation.
+ "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
+ # specified in the request.
+ "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
+ # or the `Accept-Language` HTTP header locale for system groups names.
+ # Group names set by the owner are the same as name.
},
}
@@ -438,30 +438,30 @@
An object of the form:
{ # A contact group.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "groupType": "A String", # Output only. The contact group type.
- "name": "A String", # The contact group name set by the group owner or a system provided name
- # for system groups.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact
# group. The field is not populated for LIST requests and can only be updated
# through the
# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
"A String",
],
- "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
- # or the `Accept-Language` HTTP header locale for system groups names.
- # Group names set by the owner are the same as name.
+ "groupType": "A String", # Output only. The contact group type.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
# string, in the form of `contactGroups/{contact_group_id}`.
+ "name": "A String", # The contact group name set by the group owner or a system provided name
+ # for system groups.
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for
# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
# that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # resource. Used for web cache validation.
+ "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
+ # specified in the request.
+ "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
+ # or the `Accept-Language` HTTP header locale for system groups names.
+ # Group names set by the owner are the same as name.
}</pre>
</div>