google-apis-people_v1 0.8.0 → 0.13.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e11b89a8e80ab4658833f8f1855258148de969889a371c59dd83b106de16c3c6
4
- data.tar.gz: c9ec437b9581bff7fa9598cdae293949d983111407aa2cff051ad8cb5c616713
3
+ metadata.gz: 364e27c9c4f7b5a658554ccdc4d19346370f14bfcb0dcbdaf2d57d093a2a1d26
4
+ data.tar.gz: 158d7d594f94fdb1db990aa51869b7873b69fc5809bc12b64ae7bafdfd432d60
5
5
  SHA512:
6
- metadata.gz: ecd81e4b3b43fea69662e880805a8d279a38d69cb8982f32d8ffe99f5f2c2b7dfb43707aad9a1471c729e6bd1367ddfd3cdf789106af851b3895f579a9e34cb4
7
- data.tar.gz: 7235ccc06d0c40a475a614c41cc002fd10755dce99671dbb55f238db2a0036502a8736d3f19e568c19c83bf5126c86b1b6048b86f71fa440d2c7098fda5ecbbe
6
+ metadata.gz: 0aaef8be1d2fac55715dc34bcf00809b0541ebf577a027a41a926956551e109ce0d1ae57877040dbd76b668cb993bf2bce467ef443f4895f6b54034ff8e550f7
7
+ data.tar.gz: ca30bbcae67a6d76ff287a2dd3b7588059d8143040f8b3fdf89fe05fe243cf2b9bfd0d6542883866588ef046de3ed5708b879e7420f8b990810adebdacdcbcdd
data/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Release history for google-apis-people_v1
2
2
 
3
+ ### v0.13.0 (2021-06-19)
4
+
5
+ * Regenerated from discovery document revision 20210617
6
+
7
+ ### v0.12.0 (2021-06-09)
8
+
9
+ * Regenerated from discovery document revision 20210607
10
+ * Regenerated using generator version 0.3.0
11
+
12
+ ### v0.11.0 (2021-05-28)
13
+
14
+ * Regenerated from discovery document revision 20210526
15
+
16
+ ### v0.10.0 (2021-05-19)
17
+
18
+ * Regenerated from discovery document revision 20210515
19
+
20
+ ### v0.9.0 (2021-04-21)
21
+
22
+ * Regenerated from discovery document revision 20210419
23
+
3
24
  ### v0.8.0 (2021-03-31)
4
25
 
5
26
  * Regenerated from discovery document revision 20210330
@@ -831,11 +831,11 @@ module Google
831
831
  end
832
832
  end
833
833
 
834
- # A G Suite Domain membership.
834
+ # A Google Workspace Domain membership.
835
835
  class DomainMembership
836
836
  include Google::Apis::Core::Hashable
837
837
 
838
- # True if the person is in the viewer's G Suite domain.
838
+ # True if the person is in the viewer's Google Workspace domain.
839
839
  # Corresponds to the JSON property `inViewerDomain`
840
840
  # @return [Boolean]
841
841
  attr_accessor :in_viewer_domain
@@ -1364,6 +1364,11 @@ module Google
1364
1364
  # @return [Array<Google::Apis::PeopleV1::Person>]
1365
1365
  attr_accessor :other_contacts
1366
1366
 
1367
+ # The total number of other contacts in the list without pagination.
1368
+ # Corresponds to the JSON property `totalSize`
1369
+ # @return [Fixnum]
1370
+ attr_accessor :total_size
1371
+
1367
1372
  def initialize(**args)
1368
1373
  update!(**args)
1369
1374
  end
@@ -1373,6 +1378,7 @@ module Google
1373
1378
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1374
1379
  @next_sync_token = args[:next_sync_token] if args.key?(:next_sync_token)
1375
1380
  @other_contacts = args[:other_contacts] if args.key?(:other_contacts)
1381
+ @total_size = args[:total_size] if args.key?(:total_size)
1376
1382
  end
1377
1383
  end
1378
1384
 
@@ -1475,7 +1481,7 @@ module Google
1475
1481
  # @return [Google::Apis::PeopleV1::ContactGroupMembership]
1476
1482
  attr_accessor :contact_group_membership
1477
1483
 
1478
- # A G Suite Domain membership.
1484
+ # A Google Workspace Domain membership.
1479
1485
  # Corresponds to the JSON property `domainMembership`
1480
1486
  # @return [Google::Apis::PeopleV1::DomainMembership]
1481
1487
  attr_accessor :domain_membership
@@ -1925,7 +1931,12 @@ module Google
1925
1931
  # @return [Array<Google::Apis::PeopleV1::CoverPhoto>]
1926
1932
  attr_accessor :cover_photos
1927
1933
 
1928
- # The person's email addresses.
1934
+ # The person's email addresses. For [`connections.list`](/people/api/rest/v1/
1935
+ # people.connections/list), [`otherContacts.list`](/people/api/rest/v1/
1936
+ # otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/
1937
+ # people/listDirectoryPeople) the number of email addresses is limited to 100.
1938
+ # If a Person has more email addresses the entire set can be obtained by calling
1939
+ # ['people.get'](/people/api/rest/v1/people/get).
1929
1940
  # Corresponds to the JSON property `emailAddresses`
1930
1941
  # @return [Array<Google::Apis::PeopleV1::EmailAddress>]
1931
1942
  attr_accessor :email_addresses
@@ -2011,7 +2022,12 @@ module Google
2011
2022
  # @return [Array<Google::Apis::PeopleV1::Organization>]
2012
2023
  attr_accessor :organizations
2013
2024
 
2014
- # The person's phone numbers.
2025
+ # The person's phone numbers. For [`connections.list`](/people/api/rest/v1/
2026
+ # people.connections/list), [`otherContacts.list`](/people/api/rest/v1/
2027
+ # otherContacts/list), and [`people.listDirectoryPeople`](/people/api/rest/v1/
2028
+ # people/listDirectoryPeople) the number of phone numbers is limited to 100. If
2029
+ # a Person has more phone numbers the entire set can be obtained by calling ['
2030
+ # people.get'](/people/api/rest/v1/people/get).
2015
2031
  # Corresponds to the JSON property `phoneNumbers`
2016
2032
  # @return [Array<Google::Apis::PeopleV1::PhoneNumber>]
2017
2033
  attr_accessor :phone_numbers
@@ -2127,7 +2143,8 @@ module Google
2127
2143
  include Google::Apis::Core::Hashable
2128
2144
 
2129
2145
  # Output only. True if the person resource has been deleted. Populated only for [
2130
- # `connections.list`](/people/api/rest/v1/people.connections/list) requests that
2146
+ # `connections.list`](/people/api/rest/v1/people.connections/list) and [`
2147
+ # otherContacts.list`](/people/api/rest/v1/otherContacts/list) requests that
2131
2148
  # include a sync token.
2132
2149
  # Corresponds to the JSON property `deleted`
2133
2150
  # @return [Boolean]
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module PeopleV1
18
18
  # Version of the google-apis-people_v1 gem
19
- GEM_VERSION = "0.8.0"
19
+ GEM_VERSION = "0.13.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.2.0"
22
+ GENERATOR_VERSION = "0.3.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210330"
25
+ REVISION = "20210617"
26
26
  end
27
27
  end
28
28
  end
@@ -838,6 +838,7 @@ module Google
838
838
  property :next_sync_token, as: 'nextSyncToken'
839
839
  collection :other_contacts, as: 'otherContacts', class: Google::Apis::PeopleV1::Person, decorator: Google::Apis::PeopleV1::Person::Representation
840
840
 
841
+ property :total_size, as: 'totalSize'
841
842
  end
842
843
  end
843
844
 
@@ -60,7 +60,8 @@ module Google
60
60
  # Optional. Specifies the maximum number of members to return for each group.
61
61
  # Defaults to 0 if not set, which will return zero members.
62
62
  # @param [Array<String>, String] resource_names
63
- # Required. The resource names of the contact groups to get.
63
+ # Required. The resource names of the contact groups to get. There is a maximum
64
+ # of 200 resource names.
64
65
  # @param [String] fields
65
66
  # Selector specifying which fields to include in a partial response.
66
67
  # @param [String] quota_user
@@ -359,7 +360,7 @@ module Google
359
360
  # @param [String] read_mask
360
361
  # Required. A field mask to restrict which fields on each person are returned.
361
362
  # Multiple fields can be specified by separating them with commas. Valid values
362
- # are: * emailAddresses * names * phoneNumbers
363
+ # are: * emailAddresses * metadata * names * phoneNumbers
363
364
  # @param [Boolean] request_sync_token
364
365
  # Optional. Whether the response should include `next_sync_token`, which can be
365
366
  # used to get all changes since the last request. For subsequent sync requests
@@ -369,8 +370,11 @@ module Google
369
370
  # Optional. A sync token, received from a previous `ListOtherContacts` call.
370
371
  # Provide this to retrieve only the resources changed since the last request.
371
372
  # Sync requests that specify `sync_token` have an additional rate limit. When
372
- # syncing, all other parameters provided to `ListOtherContacts` must match the
373
- # call that provided the sync token.
373
+ # the `syncToken` is specified, resources deleted since the last sync will be
374
+ # returned as a person with [`PersonMetadata.deleted`](/people/api/rest/v1/
375
+ # people#Person.PersonMetadata.FIELDS.deleted) set to true. When the `syncToken`
376
+ # is specified, all other parameters provided to `ListOtherContacts` must match
377
+ # the call that provided the sync token.
374
378
  # @param [String] fields
375
379
  # Selector specifying which fields to include in a partial response.
376
380
  # @param [String] quota_user
@@ -405,10 +409,12 @@ module Google
405
409
  # Provides a list of contacts in the authenticated user's other contacts that
406
410
  # matches the search query. The query matches on a contact's `names`, `
407
411
  # emailAddresses`, and `phoneNumbers` fields that are from the OTHER_CONTACT
408
- # source.
412
+ # source. **IMPORTANT**: Before searching, clients should send a warmup request
413
+ # with an empty query to update the cache. See https://developers.google.com/
414
+ # people/v1/other-contacts#search_the_users_other_contacts
409
415
  # @param [Fixnum] page_size
410
416
  # Optional. The number of results to return. Defaults to 10 if field is not set,
411
- # or set to 0.
417
+ # or set to 0. Values greater than 10 will be capped to 10.
412
418
  # @param [String] query
413
419
  # Required. The plain-text query for the request. The query is used to match
414
420
  # prefix phrases of the fields on a person. For example, a person with name "foo
@@ -417,7 +423,7 @@ module Google
417
423
  # @param [String] read_mask
418
424
  # Required. A field mask to restrict which fields on each person are returned.
419
425
  # Multiple fields can be specified by separating them with commas. Valid values
420
- # are: * emailAddresses * names * phoneNumbers
426
+ # are: * emailAddresses * metadata * names * phoneNumbers
421
427
  # @param [String] fields
422
428
  # Selector specifying which fields to include in a partial response.
423
429
  # @param [String] quota_user
@@ -739,8 +745,8 @@ module Google
739
745
  # specify `people/me`. - To get information about a google account, specify `
740
746
  # people/`account_id``. - To get information about a contact, specify the
741
747
  # resource name that identifies the contact as returned by [`people.connections.
742
- # list`](/people/api/rest/v1/people.connections/list). You can include up to 50
743
- # resource names in one request.
748
+ # list`](/people/api/rest/v1/people.connections/list). There is a maximum of 200
749
+ # resource names.
744
750
  # @param [Array<String>, String] sources
745
751
  # Optional. A mask of what source types to return. Defaults to
746
752
  # READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
@@ -842,9 +848,12 @@ module Google
842
848
  # Provides a list of contacts in the authenticated user's grouped contacts that
843
849
  # matches the search query. The query matches on a contact's `names`, `nickNames`
844
850
  # , `emailAddresses`, `phoneNumbers`, and `organizations` fields that are from
845
- # the CONTACT" source.
851
+ # the CONTACT" source. **IMPORTANT**: Before searching, clients should send a
852
+ # warmup request with an empty query to update the cache. See https://developers.
853
+ # google.com/people/v1/contacts#search_the_users_contacts
846
854
  # @param [Fixnum] page_size
847
- # Optional. The number of results to return.
855
+ # Optional. The number of results to return. Defaults to 10 if field is not set,
856
+ # or set to 0. Values greater than 10 will be capped to 10.
848
857
  # @param [String] query
849
858
  # Required. The plain-text query for the request. The query is used to match
850
859
  # prefix phrases of the fields on a person. For example, a person with name "foo
@@ -858,6 +867,9 @@ module Google
858
867
  # imClients * interests * locales * locations * memberships * metadata *
859
868
  # miscKeywords * names * nicknames * occupations * organizations * phoneNumbers *
860
869
  # photos * relations * sipAddresses * skills * urls * userDefined
870
+ # @param [Array<String>, String] sources
871
+ # Optional. A mask of what source types to return. Defaults to
872
+ # READ_SOURCE_TYPE_CONTACT if not set.
861
873
  # @param [String] fields
862
874
  # Selector specifying which fields to include in a partial response.
863
875
  # @param [String] quota_user
@@ -875,13 +887,14 @@ module Google
875
887
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
876
888
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
877
889
  # @raise [Google::Apis::AuthorizationError] Authorization is required
878
- def search_person_contacts(page_size: nil, query: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
890
+ def search_person_contacts(page_size: nil, query: nil, read_mask: nil, sources: nil, fields: nil, quota_user: nil, options: nil, &block)
879
891
  command = make_simple_command(:get, 'v1/people:searchContacts', options)
880
892
  command.response_representation = Google::Apis::PeopleV1::SearchResponse::Representation
881
893
  command.response_class = Google::Apis::PeopleV1::SearchResponse
882
894
  command.query['pageSize'] = page_size unless page_size.nil?
883
895
  command.query['query'] = query unless query.nil?
884
896
  command.query['readMask'] = read_mask unless read_mask.nil?
897
+ command.query['sources'] = sources unless sources.nil?
885
898
  command.query['fields'] = fields unless fields.nil?
886
899
  command.query['quotaUser'] = quota_user unless quota_user.nil?
887
900
  execute_or_queue_command(command, &block)
@@ -1093,7 +1106,10 @@ module Google
1093
1106
  # @param [String] sync_token
1094
1107
  # Optional. A sync token, received from a previous `ListConnections` call.
1095
1108
  # Provide this to retrieve only the resources changed since the last request.
1096
- # When syncing, all other parameters provided to `ListConnections` except `
1109
+ # When the `syncToken` is specified, resources deleted since the last sync will
1110
+ # be returned as a person with [`PersonMetadata.deleted`](/people/api/rest/v1/
1111
+ # people#Person.PersonMetadata.FIELDS.deleted) set to true. When the `syncToken`
1112
+ # is specified, all other parameters provided to `ListConnections` except `
1097
1113
  # page_size` and `page_token` must match the initial call that provided the sync
1098
1114
  # token. Sync tokens expire after seven days, after which a full sync request
1099
1115
  # without a `sync_token` should be made.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-people_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.8.0
4
+ version: 0.13.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-04-05 00:00:00.000000000 Z
11
+ date: 2021-06-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -52,7 +52,7 @@ licenses:
52
52
  metadata:
53
53
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
54
54
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-people_v1/CHANGELOG.md
55
- documentation_uri: https://googleapis.dev/ruby/google-apis-people_v1/v0.8.0
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-people_v1/v0.13.0
56
56
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-people_v1
57
57
  post_install_message:
58
58
  rdoc_options: []
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
69
69
  - !ruby/object:Gem::Version
70
70
  version: '0'
71
71
  requirements: []
72
- rubygems_version: 3.2.13
72
+ rubygems_version: 3.2.17
73
73
  signing_key:
74
74
  specification_version: 4
75
75
  summary: Simple REST client for People API V1