1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module PeopleV1
# People API
#
# Provides access to information about profiles and contacts.
#
# @example
# require 'google/apis/people_v1'
#
# People = Google::Apis::PeopleV1 # Alias the module
# service = People::PeopleServiceService.new
#
# @see https://developers.google.com/people/
class PeopleServiceService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://people.googleapis.com/', '')
@batch_path = 'batch'
end
# Get a list of contact groups owned by the authenticated user by specifying
# a list of contact group resource names.
# @param [Fixnum] max_members
# Specifies the maximum number of members to return for each group.
# @param [Array<String>, String] resource_names
# The resource names of the contact groups to get.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::BatchGetContactGroupsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::BatchGetContactGroupsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_contact_group_get(max_members: nil, resource_names: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/contactGroups:batchGet', options)
command.response_representation = Google::Apis::PeopleV1::BatchGetContactGroupsResponse::Representation
command.response_class = Google::Apis::PeopleV1::BatchGetContactGroupsResponse
command.query['maxMembers'] = max_members unless max_members.nil?
command.query['resourceNames'] = resource_names unless resource_names.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Create a new contact group owned by the authenticated user.
# @param [Google::Apis::PeopleV1::CreateContactGroupRequest] create_contact_group_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::ContactGroup] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::ContactGroup]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_contact_group(create_contact_group_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/contactGroups', options)
command.request_representation = Google::Apis::PeopleV1::CreateContactGroupRequest::Representation
command.request_object = create_contact_group_request_object
command.response_representation = Google::Apis::PeopleV1::ContactGroup::Representation
command.response_class = Google::Apis::PeopleV1::ContactGroup
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete an existing contact group owned by the authenticated user by
# specifying a contact group resource name.
# @param [String] resource_name
# The resource name of the contact group to delete.
# @param [Boolean] delete_contacts
# Set to true to also delete the contacts in the specified group.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_contact_group(resource_name, delete_contacts: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+resourceName}', options)
command.response_representation = Google::Apis::PeopleV1::Empty::Representation
command.response_class = Google::Apis::PeopleV1::Empty
command.params['resourceName'] = resource_name unless resource_name.nil?
command.query['deleteContacts'] = delete_contacts unless delete_contacts.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get a specific contact group owned by the authenticated user by specifying
# a contact group resource name.
# @param [String] resource_name
# The resource name of the contact group to get.
# @param [Fixnum] max_members
# Specifies the maximum number of members to return.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::ContactGroup] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::ContactGroup]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_contact_group(resource_name, max_members: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+resourceName}', options)
command.response_representation = Google::Apis::PeopleV1::ContactGroup::Representation
command.response_class = Google::Apis::PeopleV1::ContactGroup
command.params['resourceName'] = resource_name unless resource_name.nil?
command.query['maxMembers'] = max_members unless max_members.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# List all contact groups owned by the authenticated user. Members of the
# contact groups are not populated.
# @param [Fixnum] page_size
# The maximum number of resources to return.
# @param [String] page_token
# The next_page_token value returned from a previous call to
# [ListContactGroups](/people/api/rest/v1/contactgroups/list).
# Requests the next page of resources.
# @param [String] sync_token
# A sync token, returned by a previous call to `contactgroups.list`.
# Only resources changed since the sync token was created will be returned.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::ListContactGroupsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::ListContactGroupsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_contact_groups(page_size: nil, page_token: nil, sync_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/contactGroups', options)
command.response_representation = Google::Apis::PeopleV1::ListContactGroupsResponse::Representation
command.response_class = Google::Apis::PeopleV1::ListContactGroupsResponse
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['syncToken'] = sync_token unless sync_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Update the name of an existing contact group owned by the authenticated
# user.
# @param [String] resource_name
# The resource name for the contact group, assigned by the server. An ASCII
# string, in the form of `contactGroups/`<var>contact_group_id</var>.
# @param [Google::Apis::PeopleV1::UpdateContactGroupRequest] update_contact_group_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::ContactGroup] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::ContactGroup]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_contact_group(resource_name, update_contact_group_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+resourceName}', options)
command.request_representation = Google::Apis::PeopleV1::UpdateContactGroupRequest::Representation
command.request_object = update_contact_group_request_object
command.response_representation = Google::Apis::PeopleV1::ContactGroup::Representation
command.response_class = Google::Apis::PeopleV1::ContactGroup
command.params['resourceName'] = resource_name unless resource_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Modify the members of a contact group owned by the authenticated user.
# <br>
# The only system contact groups that can have members added are
# `contactGroups/myContacts` and `contactGroups/starred`. Other system
# contact groups are deprecated and can only have contacts removed.
# @param [String] resource_name
# The resource name of the contact group to modify.
# @param [Google::Apis::PeopleV1::ModifyContactGroupMembersRequest] modify_contact_group_members_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::ModifyContactGroupMembersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::ModifyContactGroupMembersResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def modify_contact_group_members(resource_name, modify_contact_group_members_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resourceName}/members:modify', options)
command.request_representation = Google::Apis::PeopleV1::ModifyContactGroupMembersRequest::Representation
command.request_object = modify_contact_group_members_request_object
command.response_representation = Google::Apis::PeopleV1::ModifyContactGroupMembersResponse::Representation
command.response_class = Google::Apis::PeopleV1::ModifyContactGroupMembersResponse
command.params['resourceName'] = resource_name unless resource_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Create a new contact and return the person resource for that contact.
# @param [Google::Apis::PeopleV1::Person] person_object
# @param [String] parent
# The resource name of the owning person resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::Person] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::Person]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_person_contact(person_object = nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/people:createContact', options)
command.request_representation = Google::Apis::PeopleV1::Person::Representation
command.request_object = person_object
command.response_representation = Google::Apis::PeopleV1::Person::Representation
command.response_class = Google::Apis::PeopleV1::Person
command.query['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete a contact person. Any non-contact data will not be deleted.
# @param [String] resource_name
# The resource name of the contact to delete.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_person_contact(resource_name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+resourceName}:deleteContact', options)
command.response_representation = Google::Apis::PeopleV1::Empty::Representation
command.response_class = Google::Apis::PeopleV1::Empty
command.params['resourceName'] = resource_name unless resource_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete a contact's photo.
# @param [String] resource_name
# The resource name of the contact whose photo will be deleted.
# @param [String] person_fields
# **Optional.** Not specifying any fields will skip the post mutate read.
# A field mask to restrict which fields on the person are
# returned. Multiple fields can be specified by separating them with commas.
# Valid values are:
# * addresses
# * ageRanges
# * biographies
# * birthdays
# * braggingRights
# * coverPhotos
# * emailAddresses
# * events
# * genders
# * imClients
# * interests
# * locales
# * memberships
# * metadata
# * names
# * nicknames
# * occupations
# * organizations
# * phoneNumbers
# * photos
# * relations
# * relationshipInterests
# * relationshipStatuses
# * residences
# * sipAddresses
# * skills
# * taglines
# * urls
# * userDefined
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::DeleteContactPhotoResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::DeleteContactPhotoResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_person_contact_photo(resource_name, person_fields: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+resourceName}:deleteContactPhoto', options)
command.response_representation = Google::Apis::PeopleV1::DeleteContactPhotoResponse::Representation
command.response_class = Google::Apis::PeopleV1::DeleteContactPhotoResponse
command.params['resourceName'] = resource_name unless resource_name.nil?
command.query['personFields'] = person_fields unless person_fields.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Provides information about a person by specifying a resource name. Use
# `people/me` to indicate the authenticated user.
# <br>
# The request throws a 400 error if 'personFields' is not specified.
# @param [String] resource_name
# The resource name of the person to provide information about.
# - To get information about the authenticated user, specify `people/me`.
# - To get information about a google account, specify
# `people/`<var>account_id</var>.
# - To get information about a contact, specify the resource name that
# identifies the contact as returned by
# [`people.connections.list`](/people/api/rest/v1/people.connections/list).
# @param [String] person_fields
# **Required.** A field mask to restrict which fields on the person are
# returned. Multiple fields can be specified by separating them with commas.
# Valid values are:
# * addresses
# * ageRanges
# * biographies
# * birthdays
# * braggingRights
# * coverPhotos
# * emailAddresses
# * events
# * genders
# * imClients
# * interests
# * locales
# * memberships
# * metadata
# * names
# * nicknames
# * occupations
# * organizations
# * phoneNumbers
# * photos
# * relations
# * relationshipInterests
# * relationshipStatuses
# * residences
# * sipAddresses
# * skills
# * taglines
# * urls
# * userDefined
# @param [String] request_mask_include_field
# **Required.** Comma-separated list of person fields to be included in the
# response. Each path should start with `person.`: for example,
# `person.names` or `person.photos`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::Person] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::Person]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_person(resource_name, person_fields: nil, request_mask_include_field: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+resourceName}', options)
command.response_representation = Google::Apis::PeopleV1::Person::Representation
command.response_class = Google::Apis::PeopleV1::Person
command.params['resourceName'] = resource_name unless resource_name.nil?
command.query['personFields'] = person_fields unless person_fields.nil?
command.query['requestMask.includeField'] = request_mask_include_field unless request_mask_include_field.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Provides information about a list of specific people by specifying a list
# of requested resource names. Use `people/me` to indicate the authenticated
# user.
# <br>
# The request throws a 400 error if 'personFields' is not specified.
# @param [String] person_fields
# **Required.** A field mask to restrict which fields on each person are
# returned. Multiple fields can be specified by separating them with commas.
# Valid values are:
# * addresses
# * ageRanges
# * biographies
# * birthdays
# * braggingRights
# * coverPhotos
# * emailAddresses
# * events
# * genders
# * imClients
# * interests
# * locales
# * memberships
# * metadata
# * names
# * nicknames
# * occupations
# * organizations
# * phoneNumbers
# * photos
# * relations
# * relationshipInterests
# * relationshipStatuses
# * residences
# * sipAddresses
# * skills
# * taglines
# * urls
# * userDefined
# @param [String] request_mask_include_field
# **Required.** Comma-separated list of person fields to be included in the
# response. Each path should start with `person.`: for example,
# `person.names` or `person.photos`.
# @param [Array<String>, String] resource_names
# The resource names of the people to provide information about.
# - To get information about the authenticated user, specify `people/me`.
# - To get information about a google account, specify
# `people/`<var>account_id</var>.
# - To get information about a contact, specify the resource name that
# identifies the contact as returned by
# [`people.connections.list`](/people/api/rest/v1/people.connections/list).
# You can include up to 50 resource names in one request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::GetPeopleResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::GetPeopleResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_people(person_fields: nil, request_mask_include_field: nil, resource_names: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/people:batchGet', options)
command.response_representation = Google::Apis::PeopleV1::GetPeopleResponse::Representation
command.response_class = Google::Apis::PeopleV1::GetPeopleResponse
command.query['personFields'] = person_fields unless person_fields.nil?
command.query['requestMask.includeField'] = request_mask_include_field unless request_mask_include_field.nil?
command.query['resourceNames'] = resource_names unless resource_names.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Update contact data for an existing contact person. Any non-contact data
# will not be modified.
# The request throws a 400 error if `updatePersonFields` is not specified.
# <br>
# The request throws a 400 error if `person.metadata.sources` is not
# specified for the contact to be updated.
# <br>
# The request throws a 400 error with an error with reason
# `"failedPrecondition"` if `person.metadata.sources.etag` is different than
# the contact's etag, which indicates the contact has changed since its data
# was read. Clients should get the latest person and re-apply their updates
# to the latest person.
# @param [String] resource_name
# The resource name for the person, assigned by the server. An ASCII string
# with a max length of 27 characters, in the form of
# `people/`<var>person_id</var>.
# @param [Google::Apis::PeopleV1::Person] person_object
# @param [String] update_person_fields
# **Required.** A field mask to restrict which fields on the person are
# updated. Multiple fields can be specified by separating them with commas.
# All updated fields will be replaced. Valid values are:
# * addresses
# * biographies
# * birthdays
# * emailAddresses
# * events
# * genders
# * imClients
# * interests
# * locales
# * memberships
# * names
# * nicknames
# * occupations
# * organizations
# * phoneNumbers
# * relations
# * residences
# * sipAddresses
# * urls
# * userDefined
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::Person] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::Person]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_person_contact(resource_name, person_object = nil, update_person_fields: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+resourceName}:updateContact', options)
command.request_representation = Google::Apis::PeopleV1::Person::Representation
command.request_object = person_object
command.response_representation = Google::Apis::PeopleV1::Person::Representation
command.response_class = Google::Apis::PeopleV1::Person
command.params['resourceName'] = resource_name unless resource_name.nil?
command.query['updatePersonFields'] = update_person_fields unless update_person_fields.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Update a contact's photo.
# @param [String] resource_name
# Person resource name
# @param [Google::Apis::PeopleV1::UpdateContactPhotoRequest] update_contact_photo_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::UpdateContactPhotoResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::UpdateContactPhotoResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_person_contact_photo(resource_name, update_contact_photo_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+resourceName}:updateContactPhoto', options)
command.request_representation = Google::Apis::PeopleV1::UpdateContactPhotoRequest::Representation
command.request_object = update_contact_photo_request_object
command.response_representation = Google::Apis::PeopleV1::UpdateContactPhotoResponse::Representation
command.response_class = Google::Apis::PeopleV1::UpdateContactPhotoResponse
command.params['resourceName'] = resource_name unless resource_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Provides a list of the authenticated user's contacts merged with any
# connected profiles.
# <br>
# The request throws a 400 error if 'personFields' is not specified.
# @param [String] resource_name
# The resource name to return connections for. Only `people/me` is valid.
# @param [Fixnum] page_size
# The number of connections to include in the response. Valid values are
# between 1 and 2000, inclusive. Defaults to 100.
# @param [String] page_token
# The token of the page to be returned.
# @param [String] person_fields
# **Required.** A field mask to restrict which fields on each person are
# returned. Multiple fields can be specified by separating them with commas.
# Valid values are:
# * addresses
# * ageRanges
# * biographies
# * birthdays
# * braggingRights
# * coverPhotos
# * emailAddresses
# * events
# * genders
# * imClients
# * interests
# * locales
# * memberships
# * metadata
# * names
# * nicknames
# * occupations
# * organizations
# * phoneNumbers
# * photos
# * relations
# * relationshipInterests
# * relationshipStatuses
# * residences
# * sipAddresses
# * skills
# * taglines
# * urls
# * userDefined
# @param [String] request_mask_include_field
# **Required.** Comma-separated list of person fields to be included in the
# response. Each path should start with `person.`: for example,
# `person.names` or `person.photos`.
# @param [Boolean] request_sync_token
# Whether the response should include a sync token, which can be used to get
# all changes since the last request. For subsequent sync requests use the
# `sync_token` param instead. Initial sync requests that specify
# `request_sync_token` have an additional rate limit.
# @param [String] sort_order
# The order in which the connections should be sorted. Defaults to
# `LAST_MODIFIED_ASCENDING`.
# @param [String] sync_token
# A sync token returned by a previous call to `people.connections.list`.
# Only resources changed since the sync token was created will be returned.
# Sync requests that specify `sync_token` have an additional rate limit.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::ListConnectionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::ListConnectionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_person_connections(resource_name, page_size: nil, page_token: nil, person_fields: nil, request_mask_include_field: nil, request_sync_token: nil, sort_order: nil, sync_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+resourceName}/connections', options)
command.response_representation = Google::Apis::PeopleV1::ListConnectionsResponse::Representation
command.response_class = Google::Apis::PeopleV1::ListConnectionsResponse
command.params['resourceName'] = resource_name unless resource_name.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['personFields'] = person_fields unless person_fields.nil?
command.query['requestMask.includeField'] = request_mask_include_field unless request_mask_include_field.nil?
command.query['requestSyncToken'] = request_sync_token unless request_sync_token.nil?
command.query['sortOrder'] = sort_order unless sort_order.nil?
command.query['syncToken'] = sync_token unless sync_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|