google-apis-people_v1 0.15.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a829a70f027e2db31e93f798965dd0a3e27fd24fd95ca5c70507072e43cf2f4
-  data.tar.gz: 5b9715b37ae4fe75e239b2340986c1b3494d3621e70e3cf8c16ce80252e072cf
+  metadata.gz: 040057a445b4d154d11e5ceee608ce607862769a20ae30069b0be86fe572e826
+  data.tar.gz: c3d5873b94dfe2556969a8c689d22843d07647254716698a196cbf23b4866120
 SHA512:
-  metadata.gz: 76e77c369c7dfac9dd99406109f7a695c2682549fdc85d0084ed07b4b5753148265daa1e1c158a5963579e37e40657820502b94554a3d34407e6c03870fe1527
-  data.tar.gz: 3b00c53345d8a03a17c7999cc1dddfeda671c8842acfa90f5e65a1b1d0e8e79e09e6215f9cd6550d24d4f00db47b4f7b2c04a0ee5cad8814b98b6238b165fe33
+  metadata.gz: 735edd1f948d277319e7dc8e4f421436e518d2c6f9e183247155fae83a24e13e10c86017bac5ee03e569f904f73e38bc6e6b52476079fb26add9ae9f572a50db
+  data.tar.gz: a59249f35a8cbb6d64cc27aa42c3e6a028b4b8336ef2fd93517505466b99574ce476c404534aa706e3454c57bc4592757f7e4e7df4b7118ecd5611e8a083b179

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Release history for google-apis-people_v1
 
+### v0.19.0 (2021-08-05)
+
+* Regenerated from discovery document revision 20210803
+
+### v0.18.0 (2021-07-28)
+
+* Regenerated from discovery document revision 20210726
+
+### v0.17.0 (2021-07-22)
+
+* Regenerated from discovery document revision 20210720
+
+### v0.16.0 (2021-07-16)
+
+* Regenerated from discovery document revision 20210714
+
 ### v0.15.0 (2021-06-29)
 
 * Regenerated using generator version 0.4.0

data/lib/google/apis/people_v1/classes.rb

@@ -1005,8 +1005,7 @@ module Google
       class FieldMetadata
         include Google::Apis::Core::Hashable
       
-        # True if the field is the primary field; false if the field is a secondary
-        # field.
+        # True if the field is the primary field for the person.
         # Corresponds to the JSON property `primary`
         # @return [Boolean]
         attr_accessor :primary
@@ -1017,6 +1016,12 @@ module Google
         # @return [Google::Apis::PeopleV1::Source]
         attr_accessor :source
       
+        # True if the field is the primary field for the source.
+        # Corresponds to the JSON property `sourcePrimary`
+        # @return [Boolean]
+        attr_accessor :source_primary
+        alias_method :source_primary?, :source_primary
+      
         # Output only. True if the field is verified; false if the field is unverified.
         # A verified field is typically a name, email address, phone number, or website
         # that has been confirmed to be owned by the person.
@@ -1033,6 +1038,7 @@ module Google
         def update!(**args)
           @primary = args[:primary] if args.key?(:primary)
           @source = args[:source] if args.key?(:source)
+          @source_primary = args[:source_primary] if args.key?(:source_primary)
           @verified = args[:verified] if args.key?(:verified)
         end
       end
@@ -1934,12 +1940,9 @@ module Google
         # @return [Array<Google::Apis::PeopleV1::CoverPhoto>]
         attr_accessor :cover_photos
       
-        # The person'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
-        # ['people.get'](/people/api/rest/v1/people/get).
+        # The person'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.
         # Corresponds to the JSON property `emailAddresses`
         # @return [Array<Google::Apis::PeopleV1::EmailAddress>]
         attr_accessor :email_addresses
@@ -2025,12 +2028,9 @@ module Google
         # @return [Array<Google::Apis::PeopleV1::Organization>]
         attr_accessor :organizations
       
-        # The person'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 ['
-        # people.get'](/people/api/rest/v1/people/get).
+        # The person'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.
         # Corresponds to the JSON property `phoneNumbers`
         # @return [Array<Google::Apis::PeopleV1::PhoneNumber>]
         attr_accessor :phone_numbers
@@ -2145,10 +2145,8 @@ module Google
       class PersonMetadata
         include Google::Apis::Core::Hashable
       
-        # 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.
+        # Output only. True if the person resource has been deleted. Populated only for `
+        # people.connections.list` and `otherContacts.list` sync requests.
         # Corresponds to the JSON property `deleted`
         # @return [Boolean]
         attr_accessor :deleted
@@ -2166,10 +2164,9 @@ module Google
         attr_accessor :object_type
       
         # 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.
+        # `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.
         # Corresponds to the JSON property `previousResourceNames`
         # @return [Array<String>]
         attr_accessor :previous_resource_names

data/lib/google/apis/people_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module PeopleV1
       # Version of the google-apis-people_v1 gem
-      GEM_VERSION = "0.15.0"
+      GEM_VERSION = "0.19.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210623"
+      REVISION = "20210803"
     end
   end
 end

data/lib/google/apis/people_v1/representations.rb

@@ -736,6 +736,7 @@ module Google
           property :primary, as: 'primary'
           property :source, as: 'source', class: Google::Apis::PeopleV1::Source, decorator: Google::Apis::PeopleV1::Source::Representation
       
+          property :source_primary, as: 'sourcePrimary'
           property :verified, as: 'verified'
         end
       end

data/lib/google/apis/people_v1/service.rb

@@ -352,34 +352,53 @@ module Google
         end
         
         # List all "Other contacts", that is contacts that are not in a contact group. "
-        # Other contacts" are typically auto created contacts from interactions.
+        # 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. Writes may have a propagation delay of several minutes for sync requests.
+        # Incremental syncs are not intended for read-after-write use cases. 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).
         # @param [Fixnum] page_size
         #   Optional. The number of "Other contacts" to include in the response. Valid
         #   values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to
         #   0.
         # @param [String] page_token
-        #   Optional. A page token, received from a previous `ListOtherContacts` call.
+        #   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 `ListOtherContacts` must match the call that provided
-        #   the page token.
+        #   parameters provided to `otherContacts.list` must match the first call that
+        #   provided the page token.
         # @param [String] read_mask
         #   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
+        #   Multiple fields can be specified by separating them with commas. What values
+        #   are valid depend on what ReadSourceType is used. If READ_SOURCE_TYPE_CONTACT
+        #   is used, valid values are: * emailAddresses * metadata * names * phoneNumbers *
+        #   photos If READ_SOURCE_TYPE_PROFILE is used, valid values are: * addresses *
+        #   ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos *
+        #   emailAddresses * events * externalIds * genders * imClients * interests *
+        #   locales * locations * memberships * metadata * miscKeywords * names *
+        #   nicknames * occupations * organizations * phoneNumbers * photos * relations *
+        #   sipAddresses * skills * urls * userDefined
         # @param [Boolean] request_sync_token
-        #   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.
+        #   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`.
+        # @param [Array<String>, String] sources
+        #   Optional. A mask of what source types to return. Defaults to
+        #   READ_SOURCE_TYPE_CONTACT if not set.
         # @param [String] sync_token
-        #   Optional. A sync token, received from a previous `ListOtherContacts` call.
+        #   Optional. A sync token, received from a previous response `next_sync_token`
         #   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.
+        #   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`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -397,7 +416,7 @@ module Google
         # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
         # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
         # @raise [Google::Apis::AuthorizationError] Authorization is required
-        def list_other_contacts(page_size: nil, page_token: nil, read_mask: nil, request_sync_token: nil, sync_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+        def list_other_contacts(page_size: nil, page_token: nil, read_mask: nil, request_sync_token: nil, sources: nil, sync_token: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:get, 'v1/otherContacts', options)
           command.response_representation = Google::Apis::PeopleV1::ListOtherContactsResponse::Representation
           command.response_class = Google::Apis::PeopleV1::ListOtherContactsResponse
@@ -405,6 +424,7 @@ module Google
           command.query['pageToken'] = page_token unless page_token.nil?
           command.query['readMask'] = read_mask unless read_mask.nil?
           command.query['requestSyncToken'] = request_sync_token unless request_sync_token.nil?
+          command.query['sources'] = sources unless sources.nil?
           command.query['syncToken'] = sync_token unless sync_token.nil?
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
@@ -681,8 +701,7 @@ module Google
         #   get information about the authenticated user, specify `people/me`. - To get
         #   information about a google account, specify `people/`account_id``. - To get
         #   information about a contact, specify the resource name that identifies the
-        #   contact as returned by [`people.connections.list`](/people/api/rest/v1/people.
-        #   connections/list).
+        #   contact as returned by `people.connections.list`.
         # @param [String] person_fields
         #   Required. A field mask to restrict which fields on the person are returned.
         #   Multiple fields can be specified by separating them with commas. Valid values
@@ -749,9 +768,8 @@ module Google
         #   resourceNames=<name2>&... - To get information about the authenticated user,
         #   specify `people/me`. - To get information about a google account, specify `
         #   people/`account_id``. - To get information about a contact, specify the
-        #   resource name that identifies the contact as returned by [`people.connections.
-        #   list`](/people/api/rest/v1/people.connections/list). There is a maximum of 200
-        #   resource names.
+        #   resource name that identifies the contact as returned by `people.connections.
+        #   list`. There is a maximum of 200 resource names.
         # @param [Array<String>, String] sources
         #   Optional. A mask of what source types to return. Defaults to
         #   READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
@@ -786,7 +804,14 @@ module Google
         end
         
         # Provides a list of domain profiles and domain contacts in the authenticated
-        # user's domain directory.
+        # user's domain directory. 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. Writes may have a propagation
+        # delay of several minutes for sync requests. Incremental syncs are not intended
+        # for read-after-write use cases. See example usage at [List the directory
+        # people that have changed](/people/v1/directory#
+        # list_the_directory_people_that_have_changed).
         # @param [Array<String>, String] merge_sources
         #   Optional. Additional data to merge into the directory sources if they are
         #   connected through verified join keys such as email addresses or phone numbers.
@@ -794,10 +819,10 @@ module Google
         #   Optional. The number of people to include in the response. Valid values are
         #   between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
         # @param [String] page_token
-        #   Optional. A page token, received from a previous `ListDirectoryPeople` call.
+        #   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 `ListDirectoryPeople` must match the call that provided
-        #   the page token.
+        #   parameters provided to `people.listDirectoryPeople` must match the first call
+        #   that provided the page token.
         # @param [String] read_mask
         #   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
@@ -807,16 +832,17 @@ module Google
         #   miscKeywords * names * nicknames * occupations * organizations * phoneNumbers *
         #   photos * relations * sipAddresses * skills * urls * userDefined
         # @param [Boolean] request_sync_token
-        #   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.
+        #   Optional. Whether the response should return `next_sync_token`. 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 `people.listDirectoryPeople`.
         # @param [Array<String>, String] sources
         #   Required. Directory sources to return.
         # @param [String] sync_token
-        #   Optional. A sync token, received from a previous `ListDirectoryPeople` call.
+        #   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 `ListDirectoryPeople` must
-        #   match the call that provided the sync token.
+        #   When syncing, all other parameters provided to `people.listDirectoryPeople`
+        #   must match the first call that provided the sync token. More details about
+        #   sync behavior at `people.listDirectoryPeople`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -914,9 +940,9 @@ module Google
         #   Optional. The number of people to include in the response. Valid values are
         #   between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.
         # @param [String] page_token
-        #   Optional. A page token, received from a previous `SearchDirectoryPeople` call.
+        #   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 `SearchDirectoryPeople` must match the call that
+        #   parameters provided to `SearchDirectoryPeople` must match the first call that
         #   provided the page token.
         # @param [String] query
         #   Required. Prefix query that matches fields in the person. Does NOT use the
@@ -1065,12 +1091,19 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Provides a list of the authenticated user's contacts. The request returns a
-        # 400 error if `personFields` is not specified. The request returns a 410 error
-        # if `sync_token` is specified and is expired. Sync tokens expire after 7 days
-        # to prevent data drift between clients and the server. To handle a sync token
-        # expired error, a request should be sent without `sync_token` to get all
-        # contacts.
+        # Provides a list of the authenticated user's contacts. 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. Writes may
+        # have a propagation delay of several minutes for sync requests. Incremental
+        # syncs are not intended for read-after-write use cases. See example usage at [
+        # List the user's contacts that have changed](/people/v1/contacts#
+        # list_the_users_contacts_that_have_changed).
         # @param [String] resource_name
         #   Required. The resource name to return connections for. Only `people/me` is
         #   valid.
@@ -1078,10 +1111,10 @@ module Google
         #   Optional. The number of connections to include in the response. Valid values
         #   are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
         # @param [String] page_token
-        #   Optional. A page token, received from a previous `ListConnections` call.
+        #   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 `ListConnections` must match the call that provided the
-        #   page token.
+        #   parameters provided to `people.connections.list` must match the first call
+        #   that provided the page token.
         # @param [String] person_fields
         #   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
@@ -1095,13 +1128,10 @@ module Google
         #   Each path should start with `person.`: for example, `person.names` or `person.
         #   photos`.
         # @param [Boolean] request_sync_token
-        #   Optional. Whether the response should include `next_sync_token` on the last
-        #   page, which can be used to get all changes since the last request. For
-        #   subsequent sync requests use the `sync_token` param instead. Initial full sync
-        #   requests that specify `request_sync_token` and do not specify `sync_token`
-        #   have an additional rate limit per user. Each client should generally only be
-        #   doing a full sync once every few days per user and so should not hit this
-        #   limit.
+        #   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 `people.connections.list`.
         # @param [String] sort_order
         #   Optional. The order in which the connections should be sorted. Defaults to `
         #   LAST_MODIFIED_ASCENDING`.
@@ -1109,15 +1139,11 @@ module Google
         #   Optional. A mask of what source types to return. Defaults to
         #   READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
         # @param [String] sync_token
-        #   Optional. A sync token, received from a previous `ListConnections` call.
+        #   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 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 `ListConnections` except `
-        #   page_size` and `page_token` must match the initial call that provided the sync
-        #   token. Sync tokens expire after seven days, after which a full sync request
-        #   without a `sync_token` should be made.
+        #   When syncing, all other parameters provided to `people.connections.list` must
+        #   match the first call that provided the sync token. More details about sync
+        #   behavior at `people.connections.list`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-people_v1
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-people_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-people_v1/v0.15.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-people_v1/v0.19.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-people_v1
 post_install_message: 
 rdoc_options: []