google-apis-people_v1 0.12.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bef7c08a2ceaa8531870c163208c4f0e93b289a234deef4780f0a3bd4b110269
-  data.tar.gz: b4e52655985eb8e1e71acf2cf31c16e697c7b011c4df60077359663e010e235d
+  metadata.gz: f50e79e3977f0cb75a1b3f92e069e708ccb3a3a31a910553d9283f1608e4b791
+  data.tar.gz: 83309ac6558d26ca550d7a5f8687029fe4e1de817cf7a75f5306d15e0494777d
 SHA512:
-  metadata.gz: ba410470d9a42a171f108c4ab5da854d628086f3b4b031f95118e4a9d960957e8ec8fefe80bd5e58232335ebce9f4fc8641f4ffb6c9d5d30a99a6d2c94bdfd5b
-  data.tar.gz: 39f598ce84d039f17a5ad2f205b0c7f08d49f04b3ee25d346c6926779bca9d2e88444f7d1ad7e75d83590fd5babd550b15b68b2f227738cd9232fd486026fc0d
+  metadata.gz: c4cfae6d803c97429d47961c4a5f367fc1baa2f9a0b54ecf53621e0862f81e4e5b349a8d475a59b00abe0c3bca4c9285d994325942db5befce91d4be65bbf94d
+  data.tar.gz: c8047a583e3341a4168ebcec07901bdb011a0cf103cf389ab1dc69ae8da739c221c84303cf3604c7b3be2bed95a0693e2bcf6ecc18f98ebd35cb55104f214369

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Release history for google-apis-people_v1
 
+### 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
+
+### v0.14.0 (2021-06-25)
+
+* Regenerated from discovery document revision 20210623
+
+### v0.13.0 (2021-06-19)
+
+* Regenerated from discovery document revision 20210617
+
 ### v0.12.0 (2021-06-09)
 
 * Regenerated from discovery document revision 20210607

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

@@ -522,7 +522,10 @@ module Google
         attr_accessor :metadata
       
         # The contact group name set by the group owner or a system provided name for
-        # system groups.
+        # system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/
+        # create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update)
+        # the name must be unique to the users contact groups. Attempting to create a
+        # group with a duplicate name will return a HTTP 409 error.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -1931,7 +1934,9 @@ module Google
         # @return [Array<Google::Apis::PeopleV1::CoverPhoto>]
         attr_accessor :cover_photos
       
-        # The person's email addresses.
+        # 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
@@ -2017,7 +2022,9 @@ module Google
         # @return [Array<Google::Apis::PeopleV1::Organization>]
         attr_accessor :organizations
       
-        # The person's phone numbers.
+        # 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
@@ -2132,9 +2139,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) 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
@@ -2152,10 +2158,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.12.0"
+      GEM_VERSION = "0.16.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.3.0"
+      GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210607"
+      REVISION = "20210714"
     end
   end
 end

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

@@ -91,7 +91,9 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Create a new contact group owned by the authenticated user.
+        # Create a new contact group owned by the authenticated user. Created contact
+        # group names must be unique to the users contact groups. Attempting to create a
+        # group with a duplicate name will return a HTTP 409 error.
         # @param [Google::Apis::PeopleV1::CreateContactGroupRequest] create_contact_group_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -244,6 +246,9 @@ module Google
         end
         
         # Update the name of an existing contact group owned by the authenticated user.
+        # Updated contact group names must be unique to the users contact groups.
+        # Attempting to create a group with a duplicate name will return a HTTP 409
+        # error.
         # @param [String] resource_name
         #   The resource name for the contact group, assigned by the server. An ASCII
         #   string, in the form of `contactGroups/`contact_group_id``.
@@ -347,31 +352,44 @@ 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. 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 * names * phoneNumbers
+        #   are: * emailAddresses * metadata * names * phoneNumbers * photos
         # @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
-        #   syncing, 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
@@ -389,7 +407,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
@@ -397,6 +415,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?
@@ -411,7 +430,7 @@ module Google
         # people/v1/other-contacts#search_the_users_other_contacts
         # @param [Fixnum] page_size
         #   Optional. The number of results to return. Defaults to 10 if field is not set,
-        #   or set to 0. Values greater than 10 will be capped to 10.
+        #   or set to 0. Values greater than 30 will be capped to 30.
         # @param [String] query
         #   Required. The plain-text query for the request. The query is used to match
         #   prefix phrases of the fields on a person. For example, a person with name "foo
@@ -420,7 +439,7 @@ module Google
         # @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 * names * phoneNumbers
+        #   are: * emailAddresses * metadata * names * phoneNumbers
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -673,8 +692,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
@@ -741,9 +759,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.
@@ -778,7 +795,12 @@ 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. 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.
@@ -786,10 +808,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
@@ -799,16 +821,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
@@ -850,7 +873,7 @@ module Google
         # google.com/people/v1/contacts#search_the_users_contacts
         # @param [Fixnum] page_size
         #   Optional. The number of results to return. Defaults to 10 if field is not set,
-        #   or set to 0. Values greater than 10 will be capped to 10.
+        #   or set to 0. Values greater than 30 will be capped to 30.
         # @param [String] query
         #   Required. The plain-text query for the request. The query is used to match
         #   prefix phrases of the fields on a person. For example, a person with name "foo
@@ -906,9 +929,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
@@ -1057,12 +1080,17 @@ 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. 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.
@@ -1070,10 +1098,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
@@ -1087,13 +1115,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`.
@@ -1101,12 +1126,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 syncing, 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,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-people_v1
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 2.a
 description: This is the simple REST client for People API V1. Simple REST clients
   are Ruby client libraries that provide access to Google services via their HTTP
   REST API endpoints. These libraries are generated and updated automatically based
@@ -52,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.12.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-people_v1/v0.16.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-people_v1
 post_install_message: 
 rdoc_options: []