google-apis-people_v1 0.5.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 23d806976914d9fbe7f3bcf5e1a1d3f2d95ce3543648596ccd4c9beebfb4bf51
4
- data.tar.gz: dc008089447c946ca22a33dee26322c92aa191da73b9db040fb5e665866ea0c0
3
+ metadata.gz: 9d5439b1b76586dfa1192977b2420513ef4272527dfa2434e63c6e660e84d13b
4
+ data.tar.gz: 41e2ea8d5bc1c6fd6f608250380ca11771e3790ba6dd5219cd7b6fb3be1d0996
5
5
  SHA512:
6
- metadata.gz: cac258ac63892b2888cae71b87d7a9258926a6abb906d7d678dec0a3338e7ec062d48383beed068ece47c22fbc3a21435b4b80fd1289f31baf31b166a8544600
7
- data.tar.gz: cd12c71bcd0e49fe820426cad274fcb41b98c314aca346b1cf6f3b3d8a2fe7ce0d76bebf7ea2d56e6716d958ca8111adc35dd5f81bd5b9ef13fb6f5fe9fb38e8
6
+ metadata.gz: 0070f44061c58c4b65a23489a69e3f51f75dfed556c65e8c45027717f5a31ee4f21aadadc10d020f62d9947c5a44505459dea65fdaeb57bf41df4a6985036bc1
7
+ data.tar.gz: ced4b423a81d5701f444370b0813e0332369c60ba8bd3bfff29ceebd80918459318f6920b94a54ff8b064d3fb1c7add0e60943d1b3aab1b9b8a6cf81d52d4b35
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-people_v1
2
2
 
3
+ ### v0.6.0 (2021-03-16)
4
+
5
+ * Regenerated from discovery document revision 20210315
6
+ * Regenerated using generator version 0.2.0
7
+
3
8
  ### v0.5.0 (2021-03-04)
4
9
 
5
10
  * Regenerated from discovery document revision 20210302
@@ -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
@@ -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.5.0"
19
+ GEM_VERSION = "0.6.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.1.2"
22
+ GENERATOR_VERSION = "0.2.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210302"
25
+ REVISION = "20210315"
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
 
@@ -446,6 +482,31 @@ module Google
446
482
  end
447
483
  end
448
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
+
449
510
  class BatchGetContactGroupsResponse
450
511
  # @private
451
512
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -454,6 +515,25 @@ module Google
454
515
  end
455
516
  end
456
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
+
457
537
  class Biography
458
538
  # @private
459
539
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -549,6 +629,14 @@ module Google
549
629
  end
550
630
  end
551
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
+
552
640
  class CopyOtherContactToMyContactsGroupRequest
553
641
  # @private
554
642
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -445,6 +445,98 @@ module Google
445
445
  execute_or_queue_command(command, &block)
446
446
  end
447
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
+
448
540
  # Create a new contact and return the person resource for that contact. The
449
541
  # request returns a 400 error if more than one field is specified on a field
450
542
  # that is a singleton for contact sources: * biographies * birthdays * genders *
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.5.0
4
+ version: 0.6.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-03-08 00:00:00.000000000 Z
11
+ date: 2021-03-22 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.5.0
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-people_v1/v0.6.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: []