feat(people): update the api

#### people:v1 The following keys were added: - resources.otherContacts.methods.list.parameters.sources (Total Keys: 3)
googleapis · Jul 20, 2021 · a646e56 · a646e56
1 parent e7a88ca
commit a646e56
Show file tree

Hide file tree

Showing 4 changed files with 140 additions and 116 deletions.
diff --git a/docs/dyn/people_v1.otherContacts.html b/docs/dyn/people_v1.otherContacts.html
@@ -81,8 +81,8 @@ <h2>Instance Methods</h2>
   <code><a href="#copyOtherContactToMyContactsGroup">copyOtherContactToMyContactsGroup(resourceName, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Copies an "Other contact" to a new contact in the user's "myContacts" group</p>
 <p class="toc_element">
-  <code><a href="#list">list(pageSize=None, pageToken=None, readMask=None, requestSyncToken=None, syncToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">List all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions.</p>
+  <code><a href="#list">list(pageSize=None, pageToken=None, readMask=None, requestSyncToken=None, sources=None, syncToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">List all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions. Sync tokens expire 7 days after the full sync. A request with an expired sync token will result in a 410 error. In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. See example usage at [List the user's other contacts that have changed](/people/v1/other-contacts#list_the_users_other_contacts_that_have_changed).</p>
 <p class="toc_element">
   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
@@ -310,7 +310,7 @@ <h3>Method Details</h3>
       &quot;url&quot;: &quot;A String&quot;, # The URL of the cover photo.
     },
   ],
-  &quot;emailAddresses&quot;: [ # The person&#x27;s email addresses. For [`connections.list`](/people/api/rest/v1/people.connections/list), [`otherContacts.list`](/people/api/rest/v1/otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling [&#x27;people.get&#x27;](/people/api/rest/v1/people/get).
+  &quot;emailAddresses&quot;: [ # The person&#x27;s email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
     { # A person&#x27;s email address.
       &quot;displayName&quot;: &quot;A String&quot;, # The display name of the email.
       &quot;formattedType&quot;: &quot;A String&quot;, # Output only. The type of the email address translated and formatted in the viewer&#x27;s account locale or the `Accept-Language` HTTP header locale.
@@ -551,12 +551,12 @@ <h3>Method Details</h3>
     },
   ],
   &quot;metadata&quot;: { # The metadata about a person. # Output only. Metadata about the person.
-    &quot;deleted&quot;: True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) and [`otherContacts.list`](/people/api/rest/v1/otherContacts/list) requests that include a sync token.
+    &quot;deleted&quot;: True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
     &quot;linkedPeopleResourceNames&quot;: [ # Output only. Resource names of people linked to this resource.
       &quot;A String&quot;,
     ],
     &quot;objectType&quot;: &quot;A String&quot;, # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
-    &quot;previousResourceNames&quot;: [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
+    &quot;previousResourceNames&quot;: [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
       &quot;A String&quot;,
     ],
     &quot;sources&quot;: [ # The sources of data for the person.
@@ -715,7 +715,7 @@ <h3>Method Details</h3>
       &quot;type&quot;: &quot;A String&quot;, # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
     },
   ],
-  &quot;phoneNumbers&quot;: [ # The person&#x27;s phone numbers. For [`connections.list`](/people/api/rest/v1/people.connections/list), [`otherContacts.list`](/people/api/rest/v1/otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling [&#x27;people.get&#x27;](/people/api/rest/v1/people/get).
+  &quot;phoneNumbers&quot;: [ # The person&#x27;s phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
     { # A person&#x27;s phone number.
       &quot;canonicalForm&quot;: &quot;A String&quot;, # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
       &quot;formattedType&quot;: &quot;A String&quot;, # Output only. The type of the phone number translated and formatted in the viewer&#x27;s account locale or the `Accept-Language` HTTP header locale.
@@ -965,15 +965,21 @@ <h3>Method Details</h3>
 </div>
 
 <div class="method">
-    <code class="details" id="list">list(pageSize=None, pageToken=None, readMask=None, requestSyncToken=None, syncToken=None, x__xgafv=None)</code>
-  <pre>List all &quot;Other contacts&quot;, that is contacts that are not in a contact group. &quot;Other contacts&quot; are typically auto created contacts from interactions.
+    <code class="details" id="list">list(pageSize=None, pageToken=None, readMask=None, requestSyncToken=None, sources=None, syncToken=None, x__xgafv=None)</code>
+  <pre>List all &quot;Other contacts&quot;, that is contacts that are not in a contact group. &quot;Other contacts&quot; are typically auto created contacts from interactions. Sync tokens expire 7 days after the full sync. A request with an expired sync token will result in a 410 error. In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. See example usage at [List the user&#x27;s other contacts that have changed](/people/v1/other-contacts#list_the_users_other_contacts_that_have_changed).
 
 Args:
   pageSize: integer, Optional. The number of &quot;Other contacts&quot; to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
-  pageToken: string, Optional. A page token, received from a previous `ListOtherContacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOtherContacts` must match the call that provided the page token.
+  pageToken: string, Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `otherContacts.list` must match the first call that provided the page token.
   readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * metadata * names * phoneNumbers * photos
-  requestSyncToken: boolean, Optional. Whether the response should include `next_sync_token`, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit.
-  syncToken: string, Optional. A sync token, received from a previous `ListOtherContacts` call. Provide this to retrieve only the resources changed since the last request. Sync requests that specify `sync_token` have an additional rate limit. When the `syncToken` is specified, resources deleted since the last sync will be returned as a person with [`PersonMetadata.deleted`](/people/api/rest/v1/people#Person.PersonMetadata.FIELDS.deleted) set to true. When the `syncToken` is specified, all other parameters provided to `ListOtherContacts` must match the call that provided the sync token.
+  requestSyncToken: boolean, Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `otherContacts.list`.
+  sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. (repeated)
+    Allowed values
+      READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.
+      READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.
+      READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.
+      READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.
+  syncToken: string, Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `otherContacts.list` must match the first call that provided the sync token. More details about sync behavior at `otherContacts.list`.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1176,7 +1182,7 @@ <h3>Method Details</h3>
           &quot;url&quot;: &quot;A String&quot;, # The URL of the cover photo.
         },
       ],
-      &quot;emailAddresses&quot;: [ # The person&#x27;s email addresses. For [`connections.list`](/people/api/rest/v1/people.connections/list), [`otherContacts.list`](/people/api/rest/v1/otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling [&#x27;people.get&#x27;](/people/api/rest/v1/people/get).
+      &quot;emailAddresses&quot;: [ # The person&#x27;s email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
         { # A person&#x27;s email address.
           &quot;displayName&quot;: &quot;A String&quot;, # The display name of the email.
           &quot;formattedType&quot;: &quot;A String&quot;, # Output only. The type of the email address translated and formatted in the viewer&#x27;s account locale or the `Accept-Language` HTTP header locale.
@@ -1417,12 +1423,12 @@ <h3>Method Details</h3>
         },
       ],
       &quot;metadata&quot;: { # The metadata about a person. # Output only. Metadata about the person.
-        &quot;deleted&quot;: True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) and [`otherContacts.list`](/people/api/rest/v1/otherContacts/list) requests that include a sync token.
+        &quot;deleted&quot;: True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
         &quot;linkedPeopleResourceNames&quot;: [ # Output only. Resource names of people linked to this resource.
           &quot;A String&quot;,
         ],
         &quot;objectType&quot;: &quot;A String&quot;, # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
-        &quot;previousResourceNames&quot;: [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
+        &quot;previousResourceNames&quot;: [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
           &quot;A String&quot;,
         ],
         &quot;sources&quot;: [ # The sources of data for the person.
@@ -1581,7 +1587,7 @@ <h3>Method Details</h3>
           &quot;type&quot;: &quot;A String&quot;, # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
         },
       ],
-      &quot;phoneNumbers&quot;: [ # The person&#x27;s phone numbers. For [`connections.list`](/people/api/rest/v1/people.connections/list), [`otherContacts.list`](/people/api/rest/v1/otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling [&#x27;people.get&#x27;](/people/api/rest/v1/people/get).
+      &quot;phoneNumbers&quot;: [ # The person&#x27;s phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
         { # A person&#x27;s phone number.
           &quot;canonicalForm&quot;: &quot;A String&quot;, # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
           &quot;formattedType&quot;: &quot;A String&quot;, # Output only. The type of the phone number translated and formatted in the viewer&#x27;s account locale or the `Accept-Language` HTTP header locale.
@@ -2056,7 +2062,7 @@ <h3>Method Details</h3>
             &quot;url&quot;: &quot;A String&quot;, # The URL of the cover photo.
           },
         ],
-        &quot;emailAddresses&quot;: [ # The person&#x27;s email addresses. For [`connections.list`](/people/api/rest/v1/people.connections/list), [`otherContacts.list`](/people/api/rest/v1/otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling [&#x27;people.get&#x27;](/people/api/rest/v1/people/get).
+        &quot;emailAddresses&quot;: [ # The person&#x27;s email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
           { # A person&#x27;s email address.
             &quot;displayName&quot;: &quot;A String&quot;, # The display name of the email.
             &quot;formattedType&quot;: &quot;A String&quot;, # Output only. The type of the email address translated and formatted in the viewer&#x27;s account locale or the `Accept-Language` HTTP header locale.
@@ -2297,12 +2303,12 @@ <h3>Method Details</h3>
           },
         ],
         &quot;metadata&quot;: { # The metadata about a person. # Output only. Metadata about the person.
-          &quot;deleted&quot;: True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) and [`otherContacts.list`](/people/api/rest/v1/otherContacts/list) requests that include a sync token.
+          &quot;deleted&quot;: True or False, # Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
           &quot;linkedPeopleResourceNames&quot;: [ # Output only. Resource names of people linked to this resource.
             &quot;A String&quot;,
           ],
           &quot;objectType&quot;: &quot;A String&quot;, # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
-          &quot;previousResourceNames&quot;: [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
+          &quot;previousResourceNames&quot;: [ # Output only. Any former resource names this person has had. Populated only for `people.connections.list` requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
             &quot;A String&quot;,
           ],
           &quot;sources&quot;: [ # The sources of data for the person.
@@ -2461,7 +2467,7 @@ <h3>Method Details</h3>
             &quot;type&quot;: &quot;A String&quot;, # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
           },
         ],
-        &quot;phoneNumbers&quot;: [ # The person&#x27;s phone numbers. For [`connections.list`](/people/api/rest/v1/people.connections/list), [`otherContacts.list`](/people/api/rest/v1/otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/people/listDirectoryPeople) the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling [&#x27;people.get&#x27;](/people/api/rest/v1/people/get).
+        &quot;phoneNumbers&quot;: [ # The person&#x27;s phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
           { # A person&#x27;s phone number.
             &quot;canonicalForm&quot;: &quot;A String&quot;, # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
             &quot;formattedType&quot;: &quot;A String&quot;, # Output only. The type of the phone number translated and formatted in the viewer&#x27;s account locale or the `Accept-Language` HTTP header locale.