google-api-client 0.32.1 → 0.40.0

data/generated/google/apis/people_v1/service.rb

@@ -50,9 +50,11 @@ module Google
         # 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.
+        #   Optional. Specifies the maximum number of members to return for each group.
+        #   Defaults
+        #   to 0 if not set, which will return zero members.
         # @param [Array<String>, String] resource_names
-        #   The resource names of the contact groups to get.
+        #   Required. 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
@@ -114,9 +116,9 @@ module Google
         # 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.
+        #   Required. 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.
+        #   Optional. 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
@@ -148,9 +150,11 @@ module Google
         # 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.
+        #   Required. The resource name of the contact group to get.
         # @param [Fixnum] max_members
-        #   Specifies the maximum number of members to return.
+        #   Optional. Specifies the maximum number of members to return. Defaults to 0 if
+        #   not
+        #   set, which will return zero members.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -182,13 +186,15 @@ module Google
         # 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.
+        #   Optional. The maximum number of resources to return. Valid values are between
+        #   1 and
+        #   1000, inclusive. Defaults to 30 if not set or set to 0.
         # @param [String] page_token
-        #   The next_page_token value returned from a previous call to
+        #   Optional. 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`.
+        #   Optional. 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.
@@ -223,7 +229,7 @@ module Google
         # 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>.
+        #   string, in the form of `contactGroups/`contact_group_id``.
         # @param [Google::Apis::PeopleV1::UpdateContactGroupRequest] update_contact_group_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -255,12 +261,11 @@ module Google
         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.
+        #   Required. 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.
@@ -293,8 +298,6 @@ module Google
         
         # 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
@@ -312,13 +315,12 @@ module Google
         # @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)
+        def create_person_contact(person_object = 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)
@@ -326,7 +328,7 @@ module Google
         
         # Delete a contact person. Any non-contact data will not be deleted.
         # @param [String] resource_name
-        #   The resource name of the contact to delete.
+        #   Required. 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
@@ -356,17 +358,16 @@ module Google
         
         # Delete a contact's photo.
         # @param [String] resource_name
-        #   The resource name of the contact whose photo will be deleted.
+        #   Required. 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:
+        #   Optional. A field mask to restrict which fields on the person are returned.
+        #   Multiple
+        #   fields can be specified by separating them with commas. Defaults to empty
+        #   if not set, which will skip the post mutate get. Valid values are:
         #   * addresses
         #   * ageRanges
         #   * biographies
         #   * birthdays
-        #   * braggingRights
         #   * coverPhotos
         #   * emailAddresses
         #   * events
@@ -383,12 +384,9 @@ module Google
         #   * phoneNumbers
         #   * photos
         #   * relations
-        #   * relationshipInterests
-        #   * relationshipStatuses
         #   * residences
         #   * sipAddresses
         #   * skills
-        #   * taglines
         #   * urls
         #   * userDefined
         # @param [String] fields
@@ -421,25 +419,23 @@ module Google
         
         # 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.
+        #   Required. 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>.
+        #   `people/`account_id``.
         #   - 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:
+        #   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
@@ -456,18 +452,16 @@ module Google
         #   * 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`.
+        #   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
@@ -500,17 +494,15 @@ module Google
         # 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:
+        #   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
@@ -527,23 +519,21 @@ module Google
         #   * 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`.
+        #   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.
+        #   Required. 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>.
+        #   `people/`account_id``.
         #   - 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).
@@ -580,10 +570,8 @@ module Google
         # 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
@@ -592,11 +580,12 @@ module Google
         # @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>.
+        #   `people/`person_id``.
         # @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.
+        #   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
@@ -650,7 +639,7 @@ module Google
         
         # Update a contact's photo.
         # @param [String] resource_name
-        #   Person resource name
+        #   Required. 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.
@@ -683,24 +672,27 @@ module Google
         
         # 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.
+        #   Required. 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.
+        #   Optional. The number of connections to include in the response. Valid values
+        #   are
+        #   between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
         # @param [String] page_token
-        #   The token of the page to be returned.
+        #   Optional. A page token, received from a previous `ListConnections` call.
+        #   Provide this to retrieve the subsequent page.
+        #   When paginating, all other parameters provided to `ListConnections`
+        #   must match the call that provided the page token.
         # @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:
+        #   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
@@ -717,30 +709,31 @@ module Google
         #   * 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`.
+        #   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
+        #   Optional. Whether the response should include `next_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
+        #   Optional. 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.
+        #   Optional. A sync token, received from a previous `ListConnections` call.
+        #   Provide this to retrieve only the resources changed since the last request.
         #   Sync requests that specify `sync_token` have an additional rate limit.
+        #   When syncing, all other parameters provided to `ListConnections`
+        #   must match the call that provided the sync token.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user

data/generated/google/apis/people_v1.rb

@@ -25,7 +25,7 @@ module Google
     # @see https://developers.google.com/people/
     module PeopleV1
       VERSION = 'V1'
-      REVISION = '20190910'
+      REVISION = '20200513'
 
       # See, edit, download, and permanently delete your contacts
       AUTH_CONTACTS = 'https://www.googleapis.com/auth/contacts'
@@ -33,6 +33,9 @@ module Google
       # See and download your contacts
       AUTH_CONTACTS_READONLY = 'https://www.googleapis.com/auth/contacts.readonly'
 
+      # See and download your organization's GSuite directory
+      AUTH_DIRECTORY_READONLY = 'https://www.googleapis.com/auth/directory.readonly'
+
       # View your street addresses
       AUTH_USER_ADDRESSES_READ = 'https://www.googleapis.com/auth/user.addresses.read'
 
@@ -42,6 +45,12 @@ module Google
       # View your email addresses
       AUTH_USER_EMAILS_READ = 'https://www.googleapis.com/auth/user.emails.read'
 
+      # See your gender
+      AUTH_USER_GENDER_READ = 'https://www.googleapis.com/auth/user.gender.read'
+
+      # See your education, work history and org info
+      AUTH_USER_ORGANIZATION_READ = 'https://www.googleapis.com/auth/user.organization.read'
+
       # View your phone numbers
       AUTH_USER_PHONENUMBERS_READ = 'https://www.googleapis.com/auth/user.phonenumbers.read'