google-apis-people_v1 0.15.0 → 0.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/people_v1/classes.rb +11 -20
- data/lib/google/apis/people_v1/gem_version.rb +2 -2
- data/lib/google/apis/people_v1/service.rb +70 -57
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f50e79e3977f0cb75a1b3f92e069e708ccb3a3a31a910553d9283f1608e4b791
|
4
|
+
data.tar.gz: 83309ac6558d26ca550d7a5f8687029fe4e1de817cf7a75f5306d15e0494777d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c4cfae6d803c97429d47961c4a5f367fc1baa2f9a0b54ecf53621e0862f81e4e5b349a8d475a59b00abe0c3bca4c9285d994325942db5befce91d4be65bbf94d
|
7
|
+
data.tar.gz: c8047a583e3341a4168ebcec07901bdb011a0cf103cf389ab1dc69ae8da739c221c84303cf3604c7b3be2bed95a0693e2bcf6ecc18f98ebd35cb55104f214369
|
data/CHANGELOG.md
CHANGED
@@ -1934,12 +1934,9 @@ module Google
|
|
1934
1934
|
# @return [Array<Google::Apis::PeopleV1::CoverPhoto>]
|
1935
1935
|
attr_accessor :cover_photos
|
1936
1936
|
|
1937
|
-
# The person's email addresses. For
|
1938
|
-
#
|
1939
|
-
#
|
1940
|
-
# people/listDirectoryPeople) the number of email addresses is limited to 100.
|
1941
|
-
# If a Person has more email addresses the entire set can be obtained by calling
|
1942
|
-
# ['people.get'](/people/api/rest/v1/people/get).
|
1937
|
+
# The person's email addresses. For `people.connections.list` and `otherContacts.
|
1938
|
+
# list` the number of email addresses is limited to 100. If a Person has more
|
1939
|
+
# email addresses the entire set can be obtained by calling GetPeople.
|
1943
1940
|
# Corresponds to the JSON property `emailAddresses`
|
1944
1941
|
# @return [Array<Google::Apis::PeopleV1::EmailAddress>]
|
1945
1942
|
attr_accessor :email_addresses
|
@@ -2025,12 +2022,9 @@ module Google
|
|
2025
2022
|
# @return [Array<Google::Apis::PeopleV1::Organization>]
|
2026
2023
|
attr_accessor :organizations
|
2027
2024
|
|
2028
|
-
# The person's phone numbers. For
|
2029
|
-
#
|
2030
|
-
#
|
2031
|
-
# people/listDirectoryPeople) the number of phone numbers is limited to 100. If
|
2032
|
-
# a Person has more phone numbers the entire set can be obtained by calling ['
|
2033
|
-
# people.get'](/people/api/rest/v1/people/get).
|
2025
|
+
# The person's phone numbers. For `people.connections.list` and `otherContacts.
|
2026
|
+
# list` the number of phone numbers is limited to 100. If a Person has more
|
2027
|
+
# phone numbers the entire set can be obtained by calling GetPeople.
|
2034
2028
|
# Corresponds to the JSON property `phoneNumbers`
|
2035
2029
|
# @return [Array<Google::Apis::PeopleV1::PhoneNumber>]
|
2036
2030
|
attr_accessor :phone_numbers
|
@@ -2145,10 +2139,8 @@ module Google
|
|
2145
2139
|
class PersonMetadata
|
2146
2140
|
include Google::Apis::Core::Hashable
|
2147
2141
|
|
2148
|
-
# Output only. True if the person resource has been deleted. Populated only for
|
2149
|
-
#
|
2150
|
-
# otherContacts.list`](/people/api/rest/v1/otherContacts/list) requests that
|
2151
|
-
# include a sync token.
|
2142
|
+
# Output only. True if the person resource has been deleted. Populated only for `
|
2143
|
+
# people.connections.list` and `otherContacts.list` sync requests.
|
2152
2144
|
# Corresponds to the JSON property `deleted`
|
2153
2145
|
# @return [Boolean]
|
2154
2146
|
attr_accessor :deleted
|
@@ -2166,10 +2158,9 @@ module Google
|
|
2166
2158
|
attr_accessor :object_type
|
2167
2159
|
|
2168
2160
|
# Output only. Any former resource names this person has had. Populated only for
|
2169
|
-
#
|
2170
|
-
#
|
2171
|
-
#
|
2172
|
-
# verified phone number, or profile URL.
|
2161
|
+
# `people.connections.list` requests that include a sync token. The resource
|
2162
|
+
# name may change when adding or removing fields that link a contact and profile
|
2163
|
+
# such as a verified email, verified phone number, or profile URL.
|
2173
2164
|
# Corresponds to the JSON property `previousResourceNames`
|
2174
2165
|
# @return [Array<String>]
|
2175
2166
|
attr_accessor :previous_resource_names
|
@@ -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.
|
19
|
+
GEM_VERSION = "0.16.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.4.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20210714"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -352,34 +352,44 @@ module Google
|
|
352
352
|
end
|
353
353
|
|
354
354
|
# List all "Other contacts", that is contacts that are not in a contact group. "
|
355
|
-
# Other contacts" are typically auto created contacts from interactions.
|
355
|
+
# Other contacts" are typically auto created contacts from interactions. Sync
|
356
|
+
# tokens expire 7 days after the full sync. A request with an expired sync token
|
357
|
+
# will result in a 410 error. In the case of such an error clients should make a
|
358
|
+
# full sync request without a `sync_token`. The first page of a full sync
|
359
|
+
# request has an additional quota. If the quota is exceeded, a 429 error will be
|
360
|
+
# returned. This quota is fixed and can not be increased. When the `sync_token`
|
361
|
+
# is specified, resources deleted since the last sync will be returned as a
|
362
|
+
# person with `PersonMetadata.deleted` set to true. When the `page_token` or `
|
363
|
+
# sync_token` is specified, all other request parameters must match the first
|
364
|
+
# call. See example usage at [List the user's other contacts that have changed](/
|
365
|
+
# people/v1/other-contacts#list_the_users_other_contacts_that_have_changed).
|
356
366
|
# @param [Fixnum] page_size
|
357
367
|
# Optional. The number of "Other contacts" to include in the response. Valid
|
358
368
|
# values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to
|
359
369
|
# 0.
|
360
370
|
# @param [String] page_token
|
361
|
-
# Optional. A page token, received from a previous `
|
371
|
+
# Optional. A page token, received from a previous response `next_page_token`.
|
362
372
|
# Provide this to retrieve the subsequent page. When paginating, all other
|
363
|
-
# parameters provided to `
|
364
|
-
# the page token.
|
373
|
+
# parameters provided to `otherContacts.list` must match the first call that
|
374
|
+
# provided the page token.
|
365
375
|
# @param [String] read_mask
|
366
376
|
# Required. A field mask to restrict which fields on each person are returned.
|
367
377
|
# Multiple fields can be specified by separating them with commas. Valid values
|
368
378
|
# are: * emailAddresses * metadata * names * phoneNumbers * photos
|
369
379
|
# @param [Boolean] request_sync_token
|
370
|
-
# Optional. Whether the response should
|
371
|
-
# used to get
|
372
|
-
#
|
373
|
-
#
|
380
|
+
# Optional. Whether the response should return `next_sync_token` on the last
|
381
|
+
# page of results. It can be used to get incremental changes since the last
|
382
|
+
# request by setting it on the request `sync_token`. More details about sync
|
383
|
+
# behavior at `otherContacts.list`.
|
384
|
+
# @param [Array<String>, String] sources
|
385
|
+
# Optional. A mask of what source types to return. Defaults to
|
386
|
+
# READ_SOURCE_TYPE_CONTACT if not set.
|
374
387
|
# @param [String] sync_token
|
375
|
-
# Optional. A sync token, received from a previous `
|
388
|
+
# Optional. A sync token, received from a previous response `next_sync_token`
|
376
389
|
# Provide this to retrieve only the resources changed since the last request.
|
377
|
-
#
|
378
|
-
# the
|
379
|
-
#
|
380
|
-
# people#Person.PersonMetadata.FIELDS.deleted) set to true. When the `syncToken`
|
381
|
-
# is specified, all other parameters provided to `ListOtherContacts` must match
|
382
|
-
# the call that provided the sync token.
|
390
|
+
# When syncing, all other parameters provided to `otherContacts.list` must match
|
391
|
+
# the first call that provided the sync token. More details about sync behavior
|
392
|
+
# at `otherContacts.list`.
|
383
393
|
# @param [String] fields
|
384
394
|
# Selector specifying which fields to include in a partial response.
|
385
395
|
# @param [String] quota_user
|
@@ -397,7 +407,7 @@ module Google
|
|
397
407
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
398
408
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
399
409
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
400
|
-
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)
|
410
|
+
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)
|
401
411
|
command = make_simple_command(:get, 'v1/otherContacts', options)
|
402
412
|
command.response_representation = Google::Apis::PeopleV1::ListOtherContactsResponse::Representation
|
403
413
|
command.response_class = Google::Apis::PeopleV1::ListOtherContactsResponse
|
@@ -405,6 +415,7 @@ module Google
|
|
405
415
|
command.query['pageToken'] = page_token unless page_token.nil?
|
406
416
|
command.query['readMask'] = read_mask unless read_mask.nil?
|
407
417
|
command.query['requestSyncToken'] = request_sync_token unless request_sync_token.nil?
|
418
|
+
command.query['sources'] = sources unless sources.nil?
|
408
419
|
command.query['syncToken'] = sync_token unless sync_token.nil?
|
409
420
|
command.query['fields'] = fields unless fields.nil?
|
410
421
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
@@ -681,8 +692,7 @@ module Google
|
|
681
692
|
# get information about the authenticated user, specify `people/me`. - To get
|
682
693
|
# information about a google account, specify `people/`account_id``. - To get
|
683
694
|
# information about a contact, specify the resource name that identifies the
|
684
|
-
# contact as returned by
|
685
|
-
# connections/list).
|
695
|
+
# contact as returned by `people.connections.list`.
|
686
696
|
# @param [String] person_fields
|
687
697
|
# Required. A field mask to restrict which fields on the person are returned.
|
688
698
|
# Multiple fields can be specified by separating them with commas. Valid values
|
@@ -749,9 +759,8 @@ module Google
|
|
749
759
|
# resourceNames=<name2>&... - To get information about the authenticated user,
|
750
760
|
# specify `people/me`. - To get information about a google account, specify `
|
751
761
|
# people/`account_id``. - To get information about a contact, specify the
|
752
|
-
# resource name that identifies the contact as returned by
|
753
|
-
# list
|
754
|
-
# resource names.
|
762
|
+
# resource name that identifies the contact as returned by `people.connections.
|
763
|
+
# list`. There is a maximum of 200 resource names.
|
755
764
|
# @param [Array<String>, String] sources
|
756
765
|
# Optional. A mask of what source types to return. Defaults to
|
757
766
|
# READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
|
@@ -786,7 +795,12 @@ module Google
|
|
786
795
|
end
|
787
796
|
|
788
797
|
# Provides a list of domain profiles and domain contacts in the authenticated
|
789
|
-
# user's domain directory.
|
798
|
+
# user's domain directory. When the `sync_token` is specified, resources deleted
|
799
|
+
# since the last sync will be returned as a person with `PersonMetadata.deleted`
|
800
|
+
# set to true. When the `page_token` or `sync_token` is specified, all other
|
801
|
+
# request parameters must match the first call. See example usage at [List the
|
802
|
+
# directory people that have changed](/people/v1/directory#
|
803
|
+
# list_the_directory_people_that_have_changed).
|
790
804
|
# @param [Array<String>, String] merge_sources
|
791
805
|
# Optional. Additional data to merge into the directory sources if they are
|
792
806
|
# connected through verified join keys such as email addresses or phone numbers.
|
@@ -794,10 +808,10 @@ module Google
|
|
794
808
|
# Optional. The number of people to include in the response. Valid values are
|
795
809
|
# between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
|
796
810
|
# @param [String] page_token
|
797
|
-
# Optional. A page token, received from a previous `
|
811
|
+
# Optional. A page token, received from a previous response `next_page_token`.
|
798
812
|
# Provide this to retrieve the subsequent page. When paginating, all other
|
799
|
-
# parameters provided to `
|
800
|
-
# the page token.
|
813
|
+
# parameters provided to `people.listDirectoryPeople` must match the first call
|
814
|
+
# that provided the page token.
|
801
815
|
# @param [String] read_mask
|
802
816
|
# Required. A field mask to restrict which fields on each person are returned.
|
803
817
|
# Multiple fields can be specified by separating them with commas. Valid values
|
@@ -807,16 +821,17 @@ module Google
|
|
807
821
|
# miscKeywords * names * nicknames * occupations * organizations * phoneNumbers *
|
808
822
|
# photos * relations * sipAddresses * skills * urls * userDefined
|
809
823
|
# @param [Boolean] request_sync_token
|
810
|
-
# Optional. Whether the response should
|
811
|
-
#
|
812
|
-
#
|
824
|
+
# Optional. Whether the response should return `next_sync_token`. It can be used
|
825
|
+
# to get incremental changes since the last request by setting it on the request
|
826
|
+
# `sync_token`. More details about sync behavior at `people.listDirectoryPeople`.
|
813
827
|
# @param [Array<String>, String] sources
|
814
828
|
# Required. Directory sources to return.
|
815
829
|
# @param [String] sync_token
|
816
|
-
# Optional. A sync token, received from a previous `
|
830
|
+
# Optional. A sync token, received from a previous response `next_sync_token`
|
817
831
|
# Provide this to retrieve only the resources changed since the last request.
|
818
|
-
# When syncing, all other parameters provided to `
|
819
|
-
# match the call that provided the sync token.
|
832
|
+
# When syncing, all other parameters provided to `people.listDirectoryPeople`
|
833
|
+
# must match the first call that provided the sync token. More details about
|
834
|
+
# sync behavior at `people.listDirectoryPeople`.
|
820
835
|
# @param [String] fields
|
821
836
|
# Selector specifying which fields to include in a partial response.
|
822
837
|
# @param [String] quota_user
|
@@ -914,9 +929,9 @@ module Google
|
|
914
929
|
# Optional. The number of people to include in the response. Valid values are
|
915
930
|
# between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.
|
916
931
|
# @param [String] page_token
|
917
|
-
# Optional. A page token, received from a previous `
|
932
|
+
# Optional. A page token, received from a previous response `next_page_token`.
|
918
933
|
# Provide this to retrieve the subsequent page. When paginating, all other
|
919
|
-
# parameters provided to `SearchDirectoryPeople` must match the call that
|
934
|
+
# parameters provided to `SearchDirectoryPeople` must match the first call that
|
920
935
|
# provided the page token.
|
921
936
|
# @param [String] query
|
922
937
|
# Required. Prefix query that matches fields in the person. Does NOT use the
|
@@ -1065,12 +1080,17 @@ module Google
|
|
1065
1080
|
execute_or_queue_command(command, &block)
|
1066
1081
|
end
|
1067
1082
|
|
1068
|
-
# Provides a list of the authenticated user's contacts.
|
1069
|
-
#
|
1070
|
-
#
|
1071
|
-
#
|
1072
|
-
#
|
1073
|
-
#
|
1083
|
+
# Provides a list of the authenticated user's contacts. Sync tokens expire 7
|
1084
|
+
# days after the full sync. A request with an expired sync token will result in
|
1085
|
+
# a 410 error. In the case of such an error clients should make a full sync
|
1086
|
+
# request without a `sync_token`. The first page of a full sync request has an
|
1087
|
+
# additional quota. If the quota is exceeded, a 429 error will be returned. This
|
1088
|
+
# quota is fixed and can not be increased. When the `sync_token` is specified,
|
1089
|
+
# resources deleted since the last sync will be returned as a person with `
|
1090
|
+
# PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is
|
1091
|
+
# specified, all other request parameters must match the first call. See example
|
1092
|
+
# usage at [List the user's contacts that have changed](/people/v1/contacts#
|
1093
|
+
# list_the_users_contacts_that_have_changed).
|
1074
1094
|
# @param [String] resource_name
|
1075
1095
|
# Required. The resource name to return connections for. Only `people/me` is
|
1076
1096
|
# valid.
|
@@ -1078,10 +1098,10 @@ module Google
|
|
1078
1098
|
# Optional. The number of connections to include in the response. Valid values
|
1079
1099
|
# are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
|
1080
1100
|
# @param [String] page_token
|
1081
|
-
# Optional. A page token, received from a previous `
|
1101
|
+
# Optional. A page token, received from a previous response `next_page_token`.
|
1082
1102
|
# Provide this to retrieve the subsequent page. When paginating, all other
|
1083
|
-
# parameters provided to `
|
1084
|
-
# page token.
|
1103
|
+
# parameters provided to `people.connections.list` must match the first call
|
1104
|
+
# that provided the page token.
|
1085
1105
|
# @param [String] person_fields
|
1086
1106
|
# Required. A field mask to restrict which fields on each person are returned.
|
1087
1107
|
# Multiple fields can be specified by separating them with commas. Valid values
|
@@ -1095,13 +1115,10 @@ module Google
|
|
1095
1115
|
# Each path should start with `person.`: for example, `person.names` or `person.
|
1096
1116
|
# photos`.
|
1097
1117
|
# @param [Boolean] request_sync_token
|
1098
|
-
# Optional. Whether the response should
|
1099
|
-
# page
|
1100
|
-
#
|
1101
|
-
#
|
1102
|
-
# have an additional rate limit per user. Each client should generally only be
|
1103
|
-
# doing a full sync once every few days per user and so should not hit this
|
1104
|
-
# limit.
|
1118
|
+
# Optional. Whether the response should return `next_sync_token` on the last
|
1119
|
+
# page of results. It can be used to get incremental changes since the last
|
1120
|
+
# request by setting it on the request `sync_token`. More details about sync
|
1121
|
+
# behavior at `people.connections.list`.
|
1105
1122
|
# @param [String] sort_order
|
1106
1123
|
# Optional. The order in which the connections should be sorted. Defaults to `
|
1107
1124
|
# LAST_MODIFIED_ASCENDING`.
|
@@ -1109,15 +1126,11 @@ module Google
|
|
1109
1126
|
# Optional. A mask of what source types to return. Defaults to
|
1110
1127
|
# READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
|
1111
1128
|
# @param [String] sync_token
|
1112
|
-
# Optional. A sync token, received from a previous `
|
1129
|
+
# Optional. A sync token, received from a previous response `next_sync_token`
|
1113
1130
|
# Provide this to retrieve only the resources changed since the last request.
|
1114
|
-
# When
|
1115
|
-
#
|
1116
|
-
# people
|
1117
|
-
# is specified, all other parameters provided to `ListConnections` except `
|
1118
|
-
# page_size` and `page_token` must match the initial call that provided the sync
|
1119
|
-
# token. Sync tokens expire after seven days, after which a full sync request
|
1120
|
-
# without a `sync_token` should be made.
|
1131
|
+
# When syncing, all other parameters provided to `people.connections.list` must
|
1132
|
+
# match the first call that provided the sync token. More details about sync
|
1133
|
+
# behavior at `people.connections.list`.
|
1121
1134
|
# @param [String] fields
|
1122
1135
|
# Selector specifying which fields to include in a partial response.
|
1123
1136
|
# @param [String] quota_user
|
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.
|
4
|
+
version: 0.16.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-07-
|
11
|
+
date: 2021-07-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-people_v1/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-people_v1/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-people_v1/v0.16.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-people_v1
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|