chore: regens API reference docs (#889)
diff --git a/docs/dyn/people_v1.contactGroups.html b/docs/dyn/people_v1.contactGroups.html
index 947f0b9..a194da7 100644
--- a/docs/dyn/people_v1.contactGroups.html
+++ b/docs/dyn/people_v1.contactGroups.html
@@ -83,7 +83,7 @@
<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, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a new contact group owned by the authenticated user.</p>
<p class="toc_element">
<code><a href="#delete">delete(resourceName, deleteContacts=None, x__xgafv=None)</a></code></p>
@@ -98,7 +98,7 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#update">update(resourceName, body, x__xgafv=None)</a></code></p>
+ <code><a href="#update">update(resourceName, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update the name of an existing contact group owned by the authenticated</p>
<h3>Method Details</h3>
<div class="method">
@@ -107,8 +107,9 @@
a list of contact group resource names.
Args:
- resourceNames: string, The resource names of the contact groups to get. (repeated)
- maxMembers: integer, Specifies the maximum number of members to return for each group.
+ 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -138,71 +139,71 @@
},
],
},
- "requestedResourceName": "A String", # The original requested resource name.
"contactGroup": { # A contact group. # The contact group.
- "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
+ "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.
- "groupType": "A String", # The read-only contact group type.
"name": "A String", # The contact group name set by the group owner or a system provided name
# for system groups.
- "memberResourceNames": [ # 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",
],
- "memberCount": 42, # The total number of contacts in the group irrespective of max members in
+ "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/`<var>contact_group_id</var>.
- "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
- "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
+ # 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", # The time the group was last updated.
+ "updateTime": "A String", # Output only. The time the group was last updated.
},
},
+ "requestedResourceName": "A String", # The original requested resource name.
},
],
}</pre>
</div>
<div class="method">
- <code class="details" id="create">create(body, x__xgafv=None)</code>
+ <code class="details" id="create">create(body=None, x__xgafv=None)</code>
<pre>Create a new contact group owned by the authenticated user.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A request to create a new contact group.
- "contactGroup": { # A contact group. # The contact group to create.
- "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
+ "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.
- "groupType": "A String", # The read-only contact group type.
"name": "A String", # The contact group name set by the group owner or a system provided name
# for system groups.
- "memberResourceNames": [ # 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",
],
- "memberCount": 42, # The total number of contacts in the group irrespective of max members in
+ "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/`<var>contact_group_id</var>.
- "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
- "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
+ # 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", # The time the group was last updated.
+ "updateTime": "A String", # Output only. The time the group was last updated.
},
},
}
@@ -216,29 +217,29 @@
An object of the form:
{ # A contact group.
- "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
+ "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.
- "groupType": "A String", # The read-only contact group type.
"name": "A String", # The contact group name set by the group owner or a system provided name
# for system groups.
- "memberResourceNames": [ # 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",
],
- "memberCount": 42, # The total number of contacts in the group irrespective of max members in
+ "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/`<var>contact_group_id</var>.
- "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
- "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
+ # 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", # The time the group was last updated.
+ "updateTime": "A String", # Output only. The time the group was last updated.
},
}</pre>
</div>
@@ -249,8 +250,8 @@
specifying a contact group resource name.
Args:
- resourceName: string, The resource name of the contact group to delete. (required)
- deleteContacts: boolean, Set to true to also delete the contacts in the specified group.
+ resourceName: string, Required. The resource name of the contact group to delete. (required)
+ deleteContacts: boolean, Optional. Set to true to also delete the contacts in the specified group.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -277,8 +278,9 @@
a contact group resource name.
Args:
- resourceName: string, The resource name of the contact group to get. (required)
- maxMembers: integer, Specifies the maximum number of members to return.
+ resourceName: string, Required. The resource name of the contact group to get. (required)
+ maxMembers: integer, Optional. Specifies the maximum number of members to return. Defaults to 0 if not
+set, which will return zero members.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -288,29 +290,29 @@
An object of the form:
{ # A contact group.
- "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
+ "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.
- "groupType": "A String", # The read-only contact group type.
"name": "A String", # The contact group name set by the group owner or a system provided name
# for system groups.
- "memberResourceNames": [ # 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",
],
- "memberCount": 42, # The total number of contacts in the group irrespective of max members in
+ "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/`<var>contact_group_id</var>.
- "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
- "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
+ # 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", # The time the group was last updated.
+ "updateTime": "A String", # Output only. The time the group was last updated.
},
}</pre>
</div>
@@ -321,10 +323,11 @@
contact groups are not populated.
Args:
- pageSize: integer, The maximum number of resources to return.
- syncToken: string, A sync token, returned by a previous call to `contactgroups.list`.
+ 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, The next_page_token value returned from a previous call to
+ 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.
x__xgafv: string, V1 error format.
@@ -340,29 +343,29 @@
"contactGroups": [ # The list of contact groups. Members of the contact groups are not
# populated.
{ # A contact group.
- "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
+ "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.
- "groupType": "A String", # The read-only contact group type.
"name": "A String", # The contact group name set by the group owner or a system provided name
# for system groups.
- "memberResourceNames": [ # 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",
],
- "memberCount": 42, # The total number of contacts in the group irrespective of max members in
+ "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/`<var>contact_group_id</var>.
- "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
- "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
+ # 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", # The time the group was last updated.
+ "updateTime": "A String", # Output only. The time the group was last updated.
},
},
],
@@ -386,42 +389,42 @@
</div>
<div class="method">
- <code class="details" id="update">update(resourceName, body, x__xgafv=None)</code>
+ <code class="details" id="update">update(resourceName, body=None, x__xgafv=None)</code>
<pre>Update the name of an existing contact group owned by the authenticated
user.
Args:
resourceName: string, The resource name for the contact group, assigned by the server. An ASCII
-string, in the form of `contactGroups/`<var>contact_group_id</var>. (required)
- body: object, The request body. (required)
+string, in the form of `contactGroups/{contact_group_id}`. (required)
+ body: object, The request body.
The object takes the form of:
{ # A request to update an existing user contact group. All updated fields will
# be replaced.
- "contactGroup": { # A contact group. # The contact group to update.
- "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
+ "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.
- "groupType": "A String", # The read-only contact group type.
"name": "A String", # The contact group name set by the group owner or a system provided name
# for system groups.
- "memberResourceNames": [ # 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",
],
- "memberCount": 42, # The total number of contacts in the group irrespective of max members in
+ "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/`<var>contact_group_id</var>.
- "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
- "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
+ # 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", # The time the group was last updated.
+ "updateTime": "A String", # Output only. The time the group was last updated.
},
},
}
@@ -435,29 +438,29 @@
An object of the form:
{ # A contact group.
- "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
+ "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.
- "groupType": "A String", # The read-only contact group type.
"name": "A String", # The contact group name set by the group owner or a system provided name
# for system groups.
- "memberResourceNames": [ # 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",
],
- "memberCount": 42, # The total number of contacts in the group irrespective of max members in
+ "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/`<var>contact_group_id</var>.
- "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
- "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
+ # 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", # The time the group was last updated.
+ "updateTime": "A String", # Output only. The time the group was last updated.
},
}</pre>
</div>