google-apis-people_v1 0.2.0 → 0.7.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 +21 -0
- data/lib/google/apis/people_v1.rb +2 -2
- data/lib/google/apis/people_v1/classes.rb +218 -2
- data/lib/google/apis/people_v1/gem_version.rb +3 -3
- data/lib/google/apis/people_v1/representations.rb +116 -0
- data/lib/google/apis/people_v1/service.rb +181 -0
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cf6ed7ba026bb2eacc1cbcde342b838fedef5086e6d5452841b6fc90fc1b1a9e
|
4
|
+
data.tar.gz: 8efb7e840e9a3d09d66f241d6015845dc9a9c482853eab4bfa65a5664d6804e3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8fd47646f355feadbab825f2405cfb4dc43896497396a4f9dacc9dfbbc31b19ef9538204687ec17bd98579c66917200e6044d5dd62285569bc482bacd33e310e
|
7
|
+
data.tar.gz: 2798ecdec964deced1e90f4077e05d607ccc107ab984e7d946579f5e073fae6849263e31152086c1f0cac0b47347e02c8e9fc0284ed1b84d30c4bf5354af1820
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,26 @@
|
|
1
1
|
# Release history for google-apis-people_v1
|
2
2
|
|
3
|
+
### v0.7.0 (2021-03-24)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20210322
|
6
|
+
|
7
|
+
### v0.6.0 (2021-03-16)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20210315
|
10
|
+
* Regenerated using generator version 0.2.0
|
11
|
+
|
12
|
+
### v0.5.0 (2021-03-04)
|
13
|
+
|
14
|
+
* Regenerated from discovery document revision 20210302
|
15
|
+
|
16
|
+
### v0.4.0 (2021-02-24)
|
17
|
+
|
18
|
+
* Regenerated from discovery document revision 20210223
|
19
|
+
|
20
|
+
### v0.3.0 (2021-02-19)
|
21
|
+
|
22
|
+
* Regenerated from discovery document revision 20210218
|
23
|
+
|
3
24
|
### v0.2.0 (2021-01-21)
|
4
25
|
|
5
26
|
* Regenerated from discovery document revision 20210120
|
@@ -47,7 +47,7 @@ module Google
|
|
47
47
|
# See and download your exact date of birth
|
48
48
|
AUTH_USER_BIRTHDAY_READ = 'https://www.googleapis.com/auth/user.birthday.read'
|
49
49
|
|
50
|
-
#
|
50
|
+
# See and download all of your Google Account email addresses
|
51
51
|
AUTH_USER_EMAILS_READ = 'https://www.googleapis.com/auth/user.emails.read'
|
52
52
|
|
53
53
|
# See your gender
|
@@ -59,7 +59,7 @@ module Google
|
|
59
59
|
# See and download your personal phone numbers
|
60
60
|
AUTH_USER_PHONENUMBERS_READ = 'https://www.googleapis.com/auth/user.phonenumbers.read'
|
61
61
|
|
62
|
-
#
|
62
|
+
# See your primary Google Account email address
|
63
63
|
AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email'
|
64
64
|
|
65
65
|
# See your personal info, including any personal info you've made publicly available
|
@@ -137,6 +137,85 @@ module Google
|
|
137
137
|
end
|
138
138
|
end
|
139
139
|
|
140
|
+
# A request to create a batch of contacts.
|
141
|
+
class BatchCreateContactsRequest
|
142
|
+
include Google::Apis::Core::Hashable
|
143
|
+
|
144
|
+
# Required. The contact to create. Allows up to 200 contacts in a single request.
|
145
|
+
# Corresponds to the JSON property `contacts`
|
146
|
+
# @return [Array<Google::Apis::PeopleV1::ContactToCreate>]
|
147
|
+
attr_accessor :contacts
|
148
|
+
|
149
|
+
# Required. A field mask to restrict which fields on each person are returned in
|
150
|
+
# the response. Multiple fields can be specified by separating them with commas.
|
151
|
+
# If read mask is left empty, the post-mutate-get is skipped and no data will be
|
152
|
+
# returned in the response. Valid values are: * addresses * ageRanges *
|
153
|
+
# biographies * birthdays * calendarUrls * clientData * coverPhotos *
|
154
|
+
# emailAddresses * events * externalIds * genders * imClients * interests *
|
155
|
+
# locales * locations * memberships * metadata * miscKeywords * names *
|
156
|
+
# nicknames * occupations * organizations * phoneNumbers * photos * relations *
|
157
|
+
# sipAddresses * skills * urls * userDefined
|
158
|
+
# Corresponds to the JSON property `readMask`
|
159
|
+
# @return [String]
|
160
|
+
attr_accessor :read_mask
|
161
|
+
|
162
|
+
# Optional. A mask of what source types to return in the post mutate read.
|
163
|
+
# Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
|
164
|
+
# Corresponds to the JSON property `sources`
|
165
|
+
# @return [Array<String>]
|
166
|
+
attr_accessor :sources
|
167
|
+
|
168
|
+
def initialize(**args)
|
169
|
+
update!(**args)
|
170
|
+
end
|
171
|
+
|
172
|
+
# Update properties of this object
|
173
|
+
def update!(**args)
|
174
|
+
@contacts = args[:contacts] if args.key?(:contacts)
|
175
|
+
@read_mask = args[:read_mask] if args.key?(:read_mask)
|
176
|
+
@sources = args[:sources] if args.key?(:sources)
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
180
|
+
# The response to a request to create a batch of contacts.
|
181
|
+
class BatchCreateContactsResponse
|
182
|
+
include Google::Apis::Core::Hashable
|
183
|
+
|
184
|
+
# The contacts that were created, unless the request `read_mask` is empty.
|
185
|
+
# Corresponds to the JSON property `createdPeople`
|
186
|
+
# @return [Array<Google::Apis::PeopleV1::PersonResponse>]
|
187
|
+
attr_accessor :created_people
|
188
|
+
|
189
|
+
def initialize(**args)
|
190
|
+
update!(**args)
|
191
|
+
end
|
192
|
+
|
193
|
+
# Update properties of this object
|
194
|
+
def update!(**args)
|
195
|
+
@created_people = args[:created_people] if args.key?(:created_people)
|
196
|
+
end
|
197
|
+
end
|
198
|
+
|
199
|
+
# A request to delete a batch of existing contacts.
|
200
|
+
class BatchDeleteContactsRequest
|
201
|
+
include Google::Apis::Core::Hashable
|
202
|
+
|
203
|
+
# Required. The resource names of the contact to delete. It's repeatable. Allows
|
204
|
+
# up to 500 resource names in a single request.
|
205
|
+
# Corresponds to the JSON property `resourceNames`
|
206
|
+
# @return [Array<String>]
|
207
|
+
attr_accessor :resource_names
|
208
|
+
|
209
|
+
def initialize(**args)
|
210
|
+
update!(**args)
|
211
|
+
end
|
212
|
+
|
213
|
+
# Update properties of this object
|
214
|
+
def update!(**args)
|
215
|
+
@resource_names = args[:resource_names] if args.key?(:resource_names)
|
216
|
+
end
|
217
|
+
end
|
218
|
+
|
140
219
|
# The response to a batch get contact groups request.
|
141
220
|
class BatchGetContactGroupsResponse
|
142
221
|
include Google::Apis::Core::Hashable
|
@@ -156,6 +235,80 @@ module Google
|
|
156
235
|
end
|
157
236
|
end
|
158
237
|
|
238
|
+
# A request to update a batch of contacts.
|
239
|
+
class BatchUpdateContactsRequest
|
240
|
+
include Google::Apis::Core::Hashable
|
241
|
+
|
242
|
+
# Required. A map of resource names to the person data to be updated. Allows up
|
243
|
+
# to 200 contacts in a single request.
|
244
|
+
# Corresponds to the JSON property `contacts`
|
245
|
+
# @return [Hash<String,Google::Apis::PeopleV1::Person>]
|
246
|
+
attr_accessor :contacts
|
247
|
+
|
248
|
+
# Required. A field mask to restrict which fields on each person are returned.
|
249
|
+
# Multiple fields can be specified by separating them with commas. If read mask
|
250
|
+
# is left empty, the post-mutate-get is skipped and no data will be returned in
|
251
|
+
# the response. Valid values are: * addresses * ageRanges * biographies *
|
252
|
+
# birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events *
|
253
|
+
# externalIds * genders * imClients * interests * locales * locations *
|
254
|
+
# memberships * metadata * miscKeywords * names * nicknames * occupations *
|
255
|
+
# organizations * phoneNumbers * photos * relations * sipAddresses * skills *
|
256
|
+
# urls * userDefined
|
257
|
+
# Corresponds to the JSON property `readMask`
|
258
|
+
# @return [String]
|
259
|
+
attr_accessor :read_mask
|
260
|
+
|
261
|
+
# Optional. A mask of what source types to return. Defaults to
|
262
|
+
# READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
|
263
|
+
# Corresponds to the JSON property `sources`
|
264
|
+
# @return [Array<String>]
|
265
|
+
attr_accessor :sources
|
266
|
+
|
267
|
+
# Required. A field mask to restrict which fields on the person are updated.
|
268
|
+
# Multiple fields can be specified by separating them with commas. All specified
|
269
|
+
# fields will be replaced, or cleared if left empty for each person. Valid
|
270
|
+
# values are: * addresses * biographies * birthdays * calendarUrls * clientData *
|
271
|
+
# emailAddresses * events * externalIds * genders * imClients * interests *
|
272
|
+
# locales * locations * memberships * miscKeywords * names * nicknames *
|
273
|
+
# occupations * organizations * phoneNumbers * relations * sipAddresses * urls *
|
274
|
+
# userDefined
|
275
|
+
# Corresponds to the JSON property `updateMask`
|
276
|
+
# @return [String]
|
277
|
+
attr_accessor :update_mask
|
278
|
+
|
279
|
+
def initialize(**args)
|
280
|
+
update!(**args)
|
281
|
+
end
|
282
|
+
|
283
|
+
# Update properties of this object
|
284
|
+
def update!(**args)
|
285
|
+
@contacts = args[:contacts] if args.key?(:contacts)
|
286
|
+
@read_mask = args[:read_mask] if args.key?(:read_mask)
|
287
|
+
@sources = args[:sources] if args.key?(:sources)
|
288
|
+
@update_mask = args[:update_mask] if args.key?(:update_mask)
|
289
|
+
end
|
290
|
+
end
|
291
|
+
|
292
|
+
# The response to a request to create a batch of contacts.
|
293
|
+
class BatchUpdateContactsResponse
|
294
|
+
include Google::Apis::Core::Hashable
|
295
|
+
|
296
|
+
# A map of resource names to the contacts that were updated, unless the request `
|
297
|
+
# read_mask` is empty.
|
298
|
+
# Corresponds to the JSON property `updateResult`
|
299
|
+
# @return [Hash<String,Google::Apis::PeopleV1::PersonResponse>]
|
300
|
+
attr_accessor :update_result
|
301
|
+
|
302
|
+
def initialize(**args)
|
303
|
+
update!(**args)
|
304
|
+
end
|
305
|
+
|
306
|
+
# Update properties of this object
|
307
|
+
def update!(**args)
|
308
|
+
@update_result = args[:update_result] if args.key?(:update_result)
|
309
|
+
end
|
310
|
+
end
|
311
|
+
|
159
312
|
# A person's short biography.
|
160
313
|
class Biography
|
161
314
|
include Google::Apis::Core::Hashable
|
@@ -492,6 +645,28 @@ module Google
|
|
492
645
|
end
|
493
646
|
end
|
494
647
|
|
648
|
+
# A wrapper that contains the person data to populate a newly created source.
|
649
|
+
class ContactToCreate
|
650
|
+
include Google::Apis::Core::Hashable
|
651
|
+
|
652
|
+
# Information about a person merged from various data sources such as the
|
653
|
+
# authenticated user's contacts and profile data. Most fields can have multiple
|
654
|
+
# items. The items in a field have no guaranteed order, but each non-empty field
|
655
|
+
# is guaranteed to have exactly one field with `metadata.primary` set to true.
|
656
|
+
# Corresponds to the JSON property `contactPerson`
|
657
|
+
# @return [Google::Apis::PeopleV1::Person]
|
658
|
+
attr_accessor :contact_person
|
659
|
+
|
660
|
+
def initialize(**args)
|
661
|
+
update!(**args)
|
662
|
+
end
|
663
|
+
|
664
|
+
# Update properties of this object
|
665
|
+
def update!(**args)
|
666
|
+
@contact_person = args[:contact_person] if args.key?(:contact_person)
|
667
|
+
end
|
668
|
+
end
|
669
|
+
|
495
670
|
# A request to copy an "Other contact" to my contacts group.
|
496
671
|
class CopyOtherContactToMyContactsGroupRequest
|
497
672
|
include Google::Apis::Core::Hashable
|
@@ -634,7 +809,7 @@ module Google
|
|
634
809
|
end
|
635
810
|
end
|
636
811
|
|
637
|
-
# The response for
|
812
|
+
# The response for deleting a contact's photo.
|
638
813
|
class DeleteContactPhotoResponse
|
639
814
|
include Google::Apis::Core::Hashable
|
640
815
|
|
@@ -945,7 +1120,7 @@ module Google
|
|
945
1120
|
end
|
946
1121
|
|
947
1122
|
# Arbitrary client data that is populated by clients. Duplicate keys and values
|
948
|
-
# are allowed.
|
1123
|
+
# are allowed.
|
949
1124
|
class GroupClientData
|
950
1125
|
include Google::Apis::Core::Hashable
|
951
1126
|
|
@@ -2335,6 +2510,47 @@ module Google
|
|
2335
2510
|
end
|
2336
2511
|
end
|
2337
2512
|
|
2513
|
+
# The response to a search request for the authenticated user, given a query.
|
2514
|
+
class SearchResponse
|
2515
|
+
include Google::Apis::Core::Hashable
|
2516
|
+
|
2517
|
+
# The results of the request.
|
2518
|
+
# Corresponds to the JSON property `results`
|
2519
|
+
# @return [Array<Google::Apis::PeopleV1::SearchResult>]
|
2520
|
+
attr_accessor :results
|
2521
|
+
|
2522
|
+
def initialize(**args)
|
2523
|
+
update!(**args)
|
2524
|
+
end
|
2525
|
+
|
2526
|
+
# Update properties of this object
|
2527
|
+
def update!(**args)
|
2528
|
+
@results = args[:results] if args.key?(:results)
|
2529
|
+
end
|
2530
|
+
end
|
2531
|
+
|
2532
|
+
# A result of a search query.
|
2533
|
+
class SearchResult
|
2534
|
+
include Google::Apis::Core::Hashable
|
2535
|
+
|
2536
|
+
# Information about a person merged from various data sources such as the
|
2537
|
+
# authenticated user's contacts and profile data. Most fields can have multiple
|
2538
|
+
# items. The items in a field have no guaranteed order, but each non-empty field
|
2539
|
+
# is guaranteed to have exactly one field with `metadata.primary` set to true.
|
2540
|
+
# Corresponds to the JSON property `person`
|
2541
|
+
# @return [Google::Apis::PeopleV1::Person]
|
2542
|
+
attr_accessor :person
|
2543
|
+
|
2544
|
+
def initialize(**args)
|
2545
|
+
update!(**args)
|
2546
|
+
end
|
2547
|
+
|
2548
|
+
# Update properties of this object
|
2549
|
+
def update!(**args)
|
2550
|
+
@person = args[:person] if args.key?(:person)
|
2551
|
+
end
|
2552
|
+
end
|
2553
|
+
|
2338
2554
|
# A person's SIP address. Session Initial Protocol addresses are used for VoIP
|
2339
2555
|
# communications to make voice or video calls over the internet.
|
2340
2556
|
class SipAddress
|
@@ -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.7.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.2.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20210322"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -34,12 +34,42 @@ module Google
|
|
34
34
|
include Google::Apis::Core::JsonObjectSupport
|
35
35
|
end
|
36
36
|
|
37
|
+
class BatchCreateContactsRequest
|
38
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
39
|
+
|
40
|
+
include Google::Apis::Core::JsonObjectSupport
|
41
|
+
end
|
42
|
+
|
43
|
+
class BatchCreateContactsResponse
|
44
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
45
|
+
|
46
|
+
include Google::Apis::Core::JsonObjectSupport
|
47
|
+
end
|
48
|
+
|
49
|
+
class BatchDeleteContactsRequest
|
50
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
51
|
+
|
52
|
+
include Google::Apis::Core::JsonObjectSupport
|
53
|
+
end
|
54
|
+
|
37
55
|
class BatchGetContactGroupsResponse
|
38
56
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
39
57
|
|
40
58
|
include Google::Apis::Core::JsonObjectSupport
|
41
59
|
end
|
42
60
|
|
61
|
+
class BatchUpdateContactsRequest
|
62
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
63
|
+
|
64
|
+
include Google::Apis::Core::JsonObjectSupport
|
65
|
+
end
|
66
|
+
|
67
|
+
class BatchUpdateContactsResponse
|
68
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
69
|
+
|
70
|
+
include Google::Apis::Core::JsonObjectSupport
|
71
|
+
end
|
72
|
+
|
43
73
|
class Biography
|
44
74
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
45
75
|
|
@@ -94,6 +124,12 @@ module Google
|
|
94
124
|
include Google::Apis::Core::JsonObjectSupport
|
95
125
|
end
|
96
126
|
|
127
|
+
class ContactToCreate
|
128
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
129
|
+
|
130
|
+
include Google::Apis::Core::JsonObjectSupport
|
131
|
+
end
|
132
|
+
|
97
133
|
class CopyOtherContactToMyContactsGroupRequest
|
98
134
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
99
135
|
|
@@ -346,6 +382,18 @@ module Google
|
|
346
382
|
include Google::Apis::Core::JsonObjectSupport
|
347
383
|
end
|
348
384
|
|
385
|
+
class SearchResponse
|
386
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
387
|
+
|
388
|
+
include Google::Apis::Core::JsonObjectSupport
|
389
|
+
end
|
390
|
+
|
391
|
+
class SearchResult
|
392
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
393
|
+
|
394
|
+
include Google::Apis::Core::JsonObjectSupport
|
395
|
+
end
|
396
|
+
|
349
397
|
class SipAddress
|
350
398
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
351
399
|
|
@@ -434,6 +482,31 @@ module Google
|
|
434
482
|
end
|
435
483
|
end
|
436
484
|
|
485
|
+
class BatchCreateContactsRequest
|
486
|
+
# @private
|
487
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
488
|
+
collection :contacts, as: 'contacts', class: Google::Apis::PeopleV1::ContactToCreate, decorator: Google::Apis::PeopleV1::ContactToCreate::Representation
|
489
|
+
|
490
|
+
property :read_mask, as: 'readMask'
|
491
|
+
collection :sources, as: 'sources'
|
492
|
+
end
|
493
|
+
end
|
494
|
+
|
495
|
+
class BatchCreateContactsResponse
|
496
|
+
# @private
|
497
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
498
|
+
collection :created_people, as: 'createdPeople', class: Google::Apis::PeopleV1::PersonResponse, decorator: Google::Apis::PeopleV1::PersonResponse::Representation
|
499
|
+
|
500
|
+
end
|
501
|
+
end
|
502
|
+
|
503
|
+
class BatchDeleteContactsRequest
|
504
|
+
# @private
|
505
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
506
|
+
collection :resource_names, as: 'resourceNames'
|
507
|
+
end
|
508
|
+
end
|
509
|
+
|
437
510
|
class BatchGetContactGroupsResponse
|
438
511
|
# @private
|
439
512
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -442,6 +515,25 @@ module Google
|
|
442
515
|
end
|
443
516
|
end
|
444
517
|
|
518
|
+
class BatchUpdateContactsRequest
|
519
|
+
# @private
|
520
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
521
|
+
hash :contacts, as: 'contacts', class: Google::Apis::PeopleV1::Person, decorator: Google::Apis::PeopleV1::Person::Representation
|
522
|
+
|
523
|
+
property :read_mask, as: 'readMask'
|
524
|
+
collection :sources, as: 'sources'
|
525
|
+
property :update_mask, as: 'updateMask'
|
526
|
+
end
|
527
|
+
end
|
528
|
+
|
529
|
+
class BatchUpdateContactsResponse
|
530
|
+
# @private
|
531
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
532
|
+
hash :update_result, as: 'updateResult', class: Google::Apis::PeopleV1::PersonResponse, decorator: Google::Apis::PeopleV1::PersonResponse::Representation
|
533
|
+
|
534
|
+
end
|
535
|
+
end
|
536
|
+
|
445
537
|
class Biography
|
446
538
|
# @private
|
447
539
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -537,6 +629,14 @@ module Google
|
|
537
629
|
end
|
538
630
|
end
|
539
631
|
|
632
|
+
class ContactToCreate
|
633
|
+
# @private
|
634
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
635
|
+
property :contact_person, as: 'contactPerson', class: Google::Apis::PeopleV1::Person, decorator: Google::Apis::PeopleV1::Person::Representation
|
636
|
+
|
637
|
+
end
|
638
|
+
end
|
639
|
+
|
540
640
|
class CopyOtherContactToMyContactsGroupRequest
|
541
641
|
# @private
|
542
642
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1052,6 +1152,22 @@ module Google
|
|
1052
1152
|
end
|
1053
1153
|
end
|
1054
1154
|
|
1155
|
+
class SearchResponse
|
1156
|
+
# @private
|
1157
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1158
|
+
collection :results, as: 'results', class: Google::Apis::PeopleV1::SearchResult, decorator: Google::Apis::PeopleV1::SearchResult::Representation
|
1159
|
+
|
1160
|
+
end
|
1161
|
+
end
|
1162
|
+
|
1163
|
+
class SearchResult
|
1164
|
+
# @private
|
1165
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1166
|
+
property :person, as: 'person', class: Google::Apis::PeopleV1::Person, decorator: Google::Apis::PeopleV1::Person::Representation
|
1167
|
+
|
1168
|
+
end
|
1169
|
+
end
|
1170
|
+
|
1055
1171
|
class SipAddress
|
1056
1172
|
# @private
|
1057
1173
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -402,6 +402,141 @@ module Google
|
|
402
402
|
execute_or_queue_command(command, &block)
|
403
403
|
end
|
404
404
|
|
405
|
+
# Provides a list of contacts in the authenticated user's other contacts that
|
406
|
+
# matches the search query.
|
407
|
+
# @param [Fixnum] page_size
|
408
|
+
# Optional. The number of results to return. Defaults to 10 if field is not set,
|
409
|
+
# or set to 0.
|
410
|
+
# @param [String] query
|
411
|
+
# Required. The plain-text query for the request. The query is used to match
|
412
|
+
# prefix phrases of the fields on a person. For example, a person with name "foo
|
413
|
+
# name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "
|
414
|
+
# oo n".
|
415
|
+
# @param [String] read_mask
|
416
|
+
# Required. A field mask to restrict which fields on each person are returned.
|
417
|
+
# Multiple fields can be specified by separating them with commas. Valid values
|
418
|
+
# are: * emailAddresses * names * phoneNumbers
|
419
|
+
# @param [String] fields
|
420
|
+
# Selector specifying which fields to include in a partial response.
|
421
|
+
# @param [String] quota_user
|
422
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
423
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
424
|
+
# @param [Google::Apis::RequestOptions] options
|
425
|
+
# Request-specific options
|
426
|
+
#
|
427
|
+
# @yield [result, err] Result & error if block supplied
|
428
|
+
# @yieldparam result [Google::Apis::PeopleV1::SearchResponse] parsed result object
|
429
|
+
# @yieldparam err [StandardError] error object if request failed
|
430
|
+
#
|
431
|
+
# @return [Google::Apis::PeopleV1::SearchResponse]
|
432
|
+
#
|
433
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
434
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
435
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
436
|
+
def search_other_contacts(page_size: nil, query: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
437
|
+
command = make_simple_command(:get, 'v1/otherContacts:search', options)
|
438
|
+
command.response_representation = Google::Apis::PeopleV1::SearchResponse::Representation
|
439
|
+
command.response_class = Google::Apis::PeopleV1::SearchResponse
|
440
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
441
|
+
command.query['query'] = query unless query.nil?
|
442
|
+
command.query['readMask'] = read_mask unless read_mask.nil?
|
443
|
+
command.query['fields'] = fields unless fields.nil?
|
444
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
445
|
+
execute_or_queue_command(command, &block)
|
446
|
+
end
|
447
|
+
|
448
|
+
# Create a batch of new contacts and return the PersonResponses for the newly
|
449
|
+
# created contacts.
|
450
|
+
# @param [Google::Apis::PeopleV1::BatchCreateContactsRequest] batch_create_contacts_request_object
|
451
|
+
# @param [String] fields
|
452
|
+
# Selector specifying which fields to include in a partial response.
|
453
|
+
# @param [String] quota_user
|
454
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
455
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
456
|
+
# @param [Google::Apis::RequestOptions] options
|
457
|
+
# Request-specific options
|
458
|
+
#
|
459
|
+
# @yield [result, err] Result & error if block supplied
|
460
|
+
# @yieldparam result [Google::Apis::PeopleV1::BatchCreateContactsResponse] parsed result object
|
461
|
+
# @yieldparam err [StandardError] error object if request failed
|
462
|
+
#
|
463
|
+
# @return [Google::Apis::PeopleV1::BatchCreateContactsResponse]
|
464
|
+
#
|
465
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
466
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
467
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
468
|
+
def batch_person_create_contacts(batch_create_contacts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
469
|
+
command = make_simple_command(:post, 'v1/people:batchCreateContacts', options)
|
470
|
+
command.request_representation = Google::Apis::PeopleV1::BatchCreateContactsRequest::Representation
|
471
|
+
command.request_object = batch_create_contacts_request_object
|
472
|
+
command.response_representation = Google::Apis::PeopleV1::BatchCreateContactsResponse::Representation
|
473
|
+
command.response_class = Google::Apis::PeopleV1::BatchCreateContactsResponse
|
474
|
+
command.query['fields'] = fields unless fields.nil?
|
475
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
476
|
+
execute_or_queue_command(command, &block)
|
477
|
+
end
|
478
|
+
|
479
|
+
# Delete a batch of contacts. Any non-contact data will not be deleted.
|
480
|
+
# @param [Google::Apis::PeopleV1::BatchDeleteContactsRequest] batch_delete_contacts_request_object
|
481
|
+
# @param [String] fields
|
482
|
+
# Selector specifying which fields to include in a partial response.
|
483
|
+
# @param [String] quota_user
|
484
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
485
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
486
|
+
# @param [Google::Apis::RequestOptions] options
|
487
|
+
# Request-specific options
|
488
|
+
#
|
489
|
+
# @yield [result, err] Result & error if block supplied
|
490
|
+
# @yieldparam result [Google::Apis::PeopleV1::Empty] parsed result object
|
491
|
+
# @yieldparam err [StandardError] error object if request failed
|
492
|
+
#
|
493
|
+
# @return [Google::Apis::PeopleV1::Empty]
|
494
|
+
#
|
495
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
496
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
497
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
498
|
+
def batch_person_delete_contacts(batch_delete_contacts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
499
|
+
command = make_simple_command(:post, 'v1/people:batchDeleteContacts', options)
|
500
|
+
command.request_representation = Google::Apis::PeopleV1::BatchDeleteContactsRequest::Representation
|
501
|
+
command.request_object = batch_delete_contacts_request_object
|
502
|
+
command.response_representation = Google::Apis::PeopleV1::Empty::Representation
|
503
|
+
command.response_class = Google::Apis::PeopleV1::Empty
|
504
|
+
command.query['fields'] = fields unless fields.nil?
|
505
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
506
|
+
execute_or_queue_command(command, &block)
|
507
|
+
end
|
508
|
+
|
509
|
+
# Update a batch of contacts and return a map of resource names to
|
510
|
+
# PersonResponses for the updated contacts.
|
511
|
+
# @param [Google::Apis::PeopleV1::BatchUpdateContactsRequest] batch_update_contacts_request_object
|
512
|
+
# @param [String] fields
|
513
|
+
# Selector specifying which fields to include in a partial response.
|
514
|
+
# @param [String] quota_user
|
515
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
516
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
517
|
+
# @param [Google::Apis::RequestOptions] options
|
518
|
+
# Request-specific options
|
519
|
+
#
|
520
|
+
# @yield [result, err] Result & error if block supplied
|
521
|
+
# @yieldparam result [Google::Apis::PeopleV1::BatchUpdateContactsResponse] parsed result object
|
522
|
+
# @yieldparam err [StandardError] error object if request failed
|
523
|
+
#
|
524
|
+
# @return [Google::Apis::PeopleV1::BatchUpdateContactsResponse]
|
525
|
+
#
|
526
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
527
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
528
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
529
|
+
def batch_person_update_contacts(batch_update_contacts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
530
|
+
command = make_simple_command(:post, 'v1/people:batchUpdateContacts', options)
|
531
|
+
command.request_representation = Google::Apis::PeopleV1::BatchUpdateContactsRequest::Representation
|
532
|
+
command.request_object = batch_update_contacts_request_object
|
533
|
+
command.response_representation = Google::Apis::PeopleV1::BatchUpdateContactsResponse::Representation
|
534
|
+
command.response_class = Google::Apis::PeopleV1::BatchUpdateContactsResponse
|
535
|
+
command.query['fields'] = fields unless fields.nil?
|
536
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
537
|
+
execute_or_queue_command(command, &block)
|
538
|
+
end
|
539
|
+
|
405
540
|
# Create a new contact and return the person resource for that contact. The
|
406
541
|
# request returns a 400 error if more than one field is specified on a field
|
407
542
|
# that is a singleton for contact sources: * biographies * birthdays * genders *
|
@@ -700,6 +835,52 @@ module Google
|
|
700
835
|
execute_or_queue_command(command, &block)
|
701
836
|
end
|
702
837
|
|
838
|
+
# Provides a list of contacts in the authenticated user's grouped contacts that
|
839
|
+
# matches the search query.
|
840
|
+
# @param [Fixnum] page_size
|
841
|
+
# Optional. The number of results to return.
|
842
|
+
# @param [String] query
|
843
|
+
# Required. The plain-text query for the request. The query is used to match
|
844
|
+
# prefix phrases of the fields on a person. For example, a person with name "foo
|
845
|
+
# name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "
|
846
|
+
# oo n".
|
847
|
+
# @param [String] read_mask
|
848
|
+
# Required. A field mask to restrict which fields on each person are returned.
|
849
|
+
# Multiple fields can be specified by separating them with commas. Valid values
|
850
|
+
# are: * addresses * ageRanges * biographies * birthdays * calendarUrls *
|
851
|
+
# clientData * coverPhotos * emailAddresses * events * externalIds * genders *
|
852
|
+
# imClients * interests * locales * locations * memberships * metadata *
|
853
|
+
# miscKeywords * names * nicknames * occupations * organizations * phoneNumbers *
|
854
|
+
# photos * relations * sipAddresses * skills * urls * userDefined
|
855
|
+
# @param [String] fields
|
856
|
+
# Selector specifying which fields to include in a partial response.
|
857
|
+
# @param [String] quota_user
|
858
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
859
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
860
|
+
# @param [Google::Apis::RequestOptions] options
|
861
|
+
# Request-specific options
|
862
|
+
#
|
863
|
+
# @yield [result, err] Result & error if block supplied
|
864
|
+
# @yieldparam result [Google::Apis::PeopleV1::SearchResponse] parsed result object
|
865
|
+
# @yieldparam err [StandardError] error object if request failed
|
866
|
+
#
|
867
|
+
# @return [Google::Apis::PeopleV1::SearchResponse]
|
868
|
+
#
|
869
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
870
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
871
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
872
|
+
def search_person_contacts(page_size: nil, query: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
873
|
+
command = make_simple_command(:get, 'v1/people:searchContacts', options)
|
874
|
+
command.response_representation = Google::Apis::PeopleV1::SearchResponse::Representation
|
875
|
+
command.response_class = Google::Apis::PeopleV1::SearchResponse
|
876
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
877
|
+
command.query['query'] = query unless query.nil?
|
878
|
+
command.query['readMask'] = read_mask unless read_mask.nil?
|
879
|
+
command.query['fields'] = fields unless fields.nil?
|
880
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
881
|
+
execute_or_queue_command(command, &block)
|
882
|
+
end
|
883
|
+
|
703
884
|
# Provides a list of domain profiles and domain contacts in the authenticated
|
704
885
|
# user's domain directory that match the search query.
|
705
886
|
# @param [Array<String>, String] merge_sources
|
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.7.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-
|
11
|
+
date: 2021-03-29 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.
|
55
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-people_v1/v0.7.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: []
|
@@ -62,14 +62,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
62
62
|
requirements:
|
63
63
|
- - ">="
|
64
64
|
- !ruby/object:Gem::Version
|
65
|
-
version: '2.
|
65
|
+
version: '2.5'
|
66
66
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
67
67
|
requirements:
|
68
68
|
- - ">="
|
69
69
|
- !ruby/object:Gem::Version
|
70
70
|
version: '0'
|
71
71
|
requirements: []
|
72
|
-
rubygems_version: 3.2.
|
72
|
+
rubygems_version: 3.2.13
|
73
73
|
signing_key:
|
74
74
|
specification_version: 4
|
75
75
|
summary: Simple REST client for People API V1
|