google-apis-people_v1 0.3.0 → 0.4.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:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5d3b597dfc5cbf077de10a81e4aa1a571237384c599e51374649e0c818b295f4
|
4
|
+
data.tar.gz: 1303c50635a65d6e94e0e66960b12b779c485a30b59562965be01e284a7d14e8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 45d226ee81cbaf197eb5c3ba4460db8dc2f76624c9c6056f696951ea1a5e7a99e5131202c32dc04924dfa43d130029ec58f68c71116561b616e963adea7c57f0
|
7
|
+
data.tar.gz: 18c8fb792a3d0a25b523d8e3567ff6c3d63c90a4b1454e55480a447a644b3104a9024322db7501cc7fa8b2eaca48a0c06b706d545fc466afec4da62eb2009b2c
|
data/CHANGELOG.md
CHANGED
@@ -634,7 +634,7 @@ module Google
|
|
634
634
|
end
|
635
635
|
end
|
636
636
|
|
637
|
-
# The response for
|
637
|
+
# The response for deleting a contact's photo.
|
638
638
|
class DeleteContactPhotoResponse
|
639
639
|
include Google::Apis::Core::Hashable
|
640
640
|
|
@@ -2335,6 +2335,47 @@ module Google
|
|
2335
2335
|
end
|
2336
2336
|
end
|
2337
2337
|
|
2338
|
+
# The response to a search request for the authenticated user, given a query.
|
2339
|
+
class SearchResponse
|
2340
|
+
include Google::Apis::Core::Hashable
|
2341
|
+
|
2342
|
+
# The results of the request.
|
2343
|
+
# Corresponds to the JSON property `results`
|
2344
|
+
# @return [Array<Google::Apis::PeopleV1::SearchResult>]
|
2345
|
+
attr_accessor :results
|
2346
|
+
|
2347
|
+
def initialize(**args)
|
2348
|
+
update!(**args)
|
2349
|
+
end
|
2350
|
+
|
2351
|
+
# Update properties of this object
|
2352
|
+
def update!(**args)
|
2353
|
+
@results = args[:results] if args.key?(:results)
|
2354
|
+
end
|
2355
|
+
end
|
2356
|
+
|
2357
|
+
# A result of a search query.
|
2358
|
+
class SearchResult
|
2359
|
+
include Google::Apis::Core::Hashable
|
2360
|
+
|
2361
|
+
# Information about a person merged from various data sources such as the
|
2362
|
+
# authenticated user's contacts and profile data. Most fields can have multiple
|
2363
|
+
# items. The items in a field have no guaranteed order, but each non-empty field
|
2364
|
+
# is guaranteed to have exactly one field with `metadata.primary` set to true.
|
2365
|
+
# Corresponds to the JSON property `person`
|
2366
|
+
# @return [Google::Apis::PeopleV1::Person]
|
2367
|
+
attr_accessor :person
|
2368
|
+
|
2369
|
+
def initialize(**args)
|
2370
|
+
update!(**args)
|
2371
|
+
end
|
2372
|
+
|
2373
|
+
# Update properties of this object
|
2374
|
+
def update!(**args)
|
2375
|
+
@person = args[:person] if args.key?(:person)
|
2376
|
+
end
|
2377
|
+
end
|
2378
|
+
|
2338
2379
|
# A person's SIP address. Session Initial Protocol addresses are used for VoIP
|
2339
2380
|
# communications to make voice or video calls over the internet.
|
2340
2381
|
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.4.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.1.2"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20210223"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -346,6 +346,18 @@ module Google
|
|
346
346
|
include Google::Apis::Core::JsonObjectSupport
|
347
347
|
end
|
348
348
|
|
349
|
+
class SearchResponse
|
350
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
351
|
+
|
352
|
+
include Google::Apis::Core::JsonObjectSupport
|
353
|
+
end
|
354
|
+
|
355
|
+
class SearchResult
|
356
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
357
|
+
|
358
|
+
include Google::Apis::Core::JsonObjectSupport
|
359
|
+
end
|
360
|
+
|
349
361
|
class SipAddress
|
350
362
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
351
363
|
|
@@ -1052,6 +1064,22 @@ module Google
|
|
1052
1064
|
end
|
1053
1065
|
end
|
1054
1066
|
|
1067
|
+
class SearchResponse
|
1068
|
+
# @private
|
1069
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1070
|
+
collection :results, as: 'results', class: Google::Apis::PeopleV1::SearchResult, decorator: Google::Apis::PeopleV1::SearchResult::Representation
|
1071
|
+
|
1072
|
+
end
|
1073
|
+
end
|
1074
|
+
|
1075
|
+
class SearchResult
|
1076
|
+
# @private
|
1077
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1078
|
+
property :person, as: 'person', class: Google::Apis::PeopleV1::Person, decorator: Google::Apis::PeopleV1::Person::Representation
|
1079
|
+
|
1080
|
+
end
|
1081
|
+
end
|
1082
|
+
|
1055
1083
|
class SipAddress
|
1056
1084
|
# @private
|
1057
1085
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -402,6 +402,49 @@ 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
|
+
|
405
448
|
# Create a new contact and return the person resource for that contact. The
|
406
449
|
# request returns a 400 error if more than one field is specified on a field
|
407
450
|
# that is a singleton for contact sources: * biographies * birthdays * genders *
|
@@ -700,6 +743,52 @@ module Google
|
|
700
743
|
execute_or_queue_command(command, &block)
|
701
744
|
end
|
702
745
|
|
746
|
+
# Provides a list of contacts in the authenticated user's grouped contacts that
|
747
|
+
# matches the search query.
|
748
|
+
# @param [Fixnum] page_size
|
749
|
+
# Optional. The number of results to return.
|
750
|
+
# @param [String] query
|
751
|
+
# Required. The plain-text query for the request. The query is used to match
|
752
|
+
# prefix phrases of the fields on a person. For example, a person with name "foo
|
753
|
+
# name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "
|
754
|
+
# oo n".
|
755
|
+
# @param [String] read_mask
|
756
|
+
# Required. A field mask to restrict which fields on each person are returned.
|
757
|
+
# Multiple fields can be specified by separating them with commas. Valid values
|
758
|
+
# are: * addresses * ageRanges * biographies * birthdays * calendarUrls *
|
759
|
+
# clientData * coverPhotos * emailAddresses * events * externalIds * genders *
|
760
|
+
# imClients * interests * locales * locations * memberships * metadata *
|
761
|
+
# miscKeywords * names * nicknames * occupations * organizations * phoneNumbers *
|
762
|
+
# photos * relations * sipAddresses * skills * urls * userDefined
|
763
|
+
# @param [String] fields
|
764
|
+
# Selector specifying which fields to include in a partial response.
|
765
|
+
# @param [String] quota_user
|
766
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
767
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
768
|
+
# @param [Google::Apis::RequestOptions] options
|
769
|
+
# Request-specific options
|
770
|
+
#
|
771
|
+
# @yield [result, err] Result & error if block supplied
|
772
|
+
# @yieldparam result [Google::Apis::PeopleV1::SearchResponse] parsed result object
|
773
|
+
# @yieldparam err [StandardError] error object if request failed
|
774
|
+
#
|
775
|
+
# @return [Google::Apis::PeopleV1::SearchResponse]
|
776
|
+
#
|
777
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
778
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
779
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
780
|
+
def search_person_contacts(page_size: nil, query: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
781
|
+
command = make_simple_command(:get, 'v1/people:searchContacts', options)
|
782
|
+
command.response_representation = Google::Apis::PeopleV1::SearchResponse::Representation
|
783
|
+
command.response_class = Google::Apis::PeopleV1::SearchResponse
|
784
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
785
|
+
command.query['query'] = query unless query.nil?
|
786
|
+
command.query['readMask'] = read_mask unless read_mask.nil?
|
787
|
+
command.query['fields'] = fields unless fields.nil?
|
788
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
789
|
+
execute_or_queue_command(command, &block)
|
790
|
+
end
|
791
|
+
|
703
792
|
# Provides a list of domain profiles and domain contacts in the authenticated
|
704
793
|
# user's domain directory that match the search query.
|
705
794
|
# @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.4.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-01 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.4.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.
|
72
|
+
rubygems_version: 3.2.11
|
73
73
|
signing_key:
|
74
74
|
specification_version: 4
|
75
75
|
summary: Simple REST client for People API V1
|