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/people_v1.contactGroups.html b/docs/dyn/people_v1.contactGroups.html
index a194da7..4815e81 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(resourceNames=None, maxMembers=None, x__xgafv=None)</a></code></p>
+ <code><a href="#batchGet">batchGet(maxMembers=None, resourceNames=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>
@@ -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(resourceNames=None, maxMembers=None, x__xgafv=None)</code>
+ <code class="details" id="batchGet">batchGet(maxMembers=None, resourceNames=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
@@ -119,53 +119,53 @@
An object of the form:
{ # The response to a batch get contact groups request.
- "responses": [ # The list of responses for each requested contact group resource.
+ "responses": [ # The list of responses for each requested contact group resource.
{ # The response for a specific contact group.
- "status": { # The `Status` type defines a logical error model that is suitable for # The status of the response.
+ "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.
+ "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}`.
+ "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.
+ },
+ },
+ "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.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# 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
+ "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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "contactGroup": { # A contact group. # The contact group.
- "groupType": "A String", # Output only. The contact group type.
- "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.
- "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",
- ],
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "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}`.
- "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.
- },
- },
- "requestedResourceName": "A String", # The original requested resource name.
},
],
}</pre>
@@ -180,30 +180,30 @@
The object takes the form of:
{ # A request to create a new contact group.
- "contactGroup": { # A contact group. # Required. The contact group to create.
- "groupType": "A String", # Output only. The contact group type.
- "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.
- "name": "A String", # The contact group name set by the group owner or a system provided name
+ "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
+ "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",
+ "A String",
],
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
+ "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.
+ "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}`.
- "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
+ "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.
+ "updateTime": "A String", # Output only. The time the group was last updated.
},
},
}
@@ -217,29 +217,29 @@
An object of the form:
{ # A contact group.
- "groupType": "A String", # Output only. The contact group type.
- "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.
- "name": "A String", # The contact group name set by the group owner or a system provided name
+ "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
+ "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",
+ "A String",
],
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
+ "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.
+ "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}`.
- "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
+ "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.
+ "updateTime": "A String", # Output only. The time the group was last updated.
},
}</pre>
</div>
@@ -290,29 +290,29 @@
An object of the form:
{ # A contact group.
- "groupType": "A String", # Output only. The contact group type.
- "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.
- "name": "A String", # The contact group name set by the group owner or a system provided name
+ "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
+ "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",
+ "A String",
],
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
+ "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.
+ "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}`.
- "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
+ "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.
+ "updateTime": "A String", # Output only. The time the group was last updated.
},
}</pre>
</div>
@@ -339,38 +339,38 @@
An object of the form:
{ # The response to a list contact groups request.
- "nextPageToken": "A String", # The token that can be used to retrieve the next page of results.
- "contactGroups": [ # The list of contact groups. Members of the contact groups are not
+ "nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request.
+ "contactGroups": [ # The list of contact groups. Members of the contact groups are not
# populated.
{ # A contact group.
- "groupType": "A String", # Output only. The contact group type.
- "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.
- "name": "A String", # The contact group name set by the group owner or a system provided name
+ "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
+ "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",
+ "A String",
],
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
+ "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.
+ "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}`.
- "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
+ "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.
+ "updateTime": "A String", # Output only. The time the group was last updated.
},
},
],
- "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.
+ "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.
}</pre>
</div>
@@ -383,7 +383,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -401,30 +401,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.
- "groupType": "A String", # Output only. The contact group type.
- "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.
- "name": "A String", # The contact group name set by the group owner or a system provided name
+ "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
+ "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",
+ "A String",
],
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
+ "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.
+ "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}`.
- "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
+ "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.
+ "updateTime": "A String", # Output only. The time the group was last updated.
},
},
}
@@ -438,29 +438,29 @@
An object of the form:
{ # A contact group.
- "groupType": "A String", # Output only. The contact group type.
- "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.
- "name": "A String", # The contact group name set by the group owner or a system provided name
+ "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
+ "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",
+ "A String",
],
- "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
- # specified in the request.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # resource. Used for web cache validation.
- "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
+ "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.
+ "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}`.
- "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
+ "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.
+ "updateTime": "A String", # Output only. The time the group was last updated.
},
}</pre>
</div>