google-api-client 0.32.1 → 0.40.0

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

@@ -48,7 +48,7 @@ module Google
         # @return [String]
         attr_accessor :extended_address
       
-        # The read-only type of the address translated and formatted in the viewer's
+        # Output only. The type of the address translated and formatted in the viewer's
         # account locale or the `Accept-Language` HTTP header locale.
         # Corresponds to the JSON property `formattedType`
         # @return [String]
@@ -230,6 +230,7 @@ module Google
         end
       end
       
+      # **DEPRECATED**: No data will be returned
       # A person's bragging rights.
       class BraggingRights
         include Google::Apis::Core::Hashable
@@ -265,25 +266,27 @@ module Google
         # @return [String]
         attr_accessor :etag
       
-        # The read-only name translated and formatted in the viewer's account locale
+        # Output only. The name translated and formatted in the viewer's account locale
         # or the `Accept-Language` HTTP header locale for system groups names.
         # Group names set by the owner are the same as name.
         # Corresponds to the JSON property `formattedName`
         # @return [String]
         attr_accessor :formatted_name
       
-        # The read-only contact group type.
+        # Output only. The contact group type.
         # Corresponds to the JSON property `groupType`
         # @return [String]
         attr_accessor :group_type
       
-        # The total number of contacts in the group irrespective of max members in
+        # Output only. The total number of contacts in the group irrespective of max
+        # members in
         # specified in the request.
         # Corresponds to the JSON property `memberCount`
         # @return [Fixnum]
         attr_accessor :member_count
       
-        # The list of contact person resource names that are members of the contact
+        # Output only. The list of contact person resource names that are members of the
+        # contact
         # group. The field is not populated for LIST requests and can only be updated
         # through the
         # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
@@ -291,7 +294,7 @@ module Google
         # @return [Array<String>]
         attr_accessor :member_resource_names
       
-        # The read-only metadata about a contact group.
+        # The metadata about a contact group.
         # Corresponds to the JSON property `metadata`
         # @return [Google::Apis::PeopleV1::ContactGroupMetadata]
         attr_accessor :metadata
@@ -303,7 +306,7 @@ module Google
         attr_accessor :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``.
         # Corresponds to the JSON property `resourceName`
         # @return [String]
         attr_accessor :resource_name
@@ -329,13 +332,13 @@ module Google
       class ContactGroupMembership
         include Google::Apis::Core::Hashable
       
-        # The read-only contact group ID for the contact group membership.
+        # Output only. The contact group ID for the contact group membership.
         # Corresponds to the JSON property `contactGroupId`
         # @return [String]
         attr_accessor :contact_group_id
       
         # 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``.
         # Only contact_group_resource_name can be used for modifying memberships.
         # Any contact group membership can be removed, but only user group or
         # "myContacts" or "starred" system groups memberships can be added. A
@@ -355,11 +358,12 @@ module Google
         end
       end
       
-      # The read-only metadata about a contact group.
+      # The metadata about a contact group.
       class ContactGroupMetadata
         include Google::Apis::Core::Hashable
       
-        # True if the contact group resource has been deleted. Populated only for
+        # Output only. True if the contact group resource has been deleted. Populated
+        # only for
         # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
         # that include a sync token.
         # Corresponds to the JSON property `deleted`
@@ -367,7 +371,7 @@ module Google
         attr_accessor :deleted
         alias_method :deleted?, :deleted
       
-        # The time the group was last updated.
+        # Output only. The time the group was last updated.
         # Corresponds to the JSON property `updateTime`
         # @return [String]
         attr_accessor :update_time
@@ -419,7 +423,7 @@ module Google
         end
       end
       
-      # A person's read-only cover photo. A large image shown on the person's
+      # A person's cover photo. A large image shown on the person's
       # profile page that represents who they are or what they care about.
       class CoverPhoto
         include Google::Apis::Core::Hashable
@@ -537,7 +541,7 @@ module Google
         end
       end
       
-      # A read-only G Suite Domain membership.
+      # A G Suite Domain membership.
       class DomainMembership
         include Google::Apis::Core::Hashable
       
@@ -566,7 +570,7 @@ module Google
         # @return [String]
         attr_accessor :display_name
       
-        # The read-only type of the email address translated and formatted in the
+        # Output only. The type of the email address translated and formatted in the
         # viewer's account locale or the `Accept-Language` HTTP header locale.
         # Corresponds to the JSON property `formattedType`
         # @return [String]
@@ -640,7 +644,7 @@ module Google
         # @return [Google::Apis::PeopleV1::Date]
         attr_accessor :date
       
-        # The read-only type of the event translated and formatted in the
+        # Output only. The type of the event translated and formatted in the
         # viewer's account locale or the `Accept-Language` HTTP header locale.
         # Corresponds to the JSON property `formattedType`
         # @return [String]
@@ -688,7 +692,8 @@ module Google
         # @return [Google::Apis::PeopleV1::Source]
         attr_accessor :source
       
-        # True if the field is verified; false if the field is unverified. A
+        # Output only. True if the field is verified; false if the field is unverified.
+        # A
         # verified field is typically a name, email address, phone number, or
         # website that has been confirmed to be owned by the person.
         # Corresponds to the JSON property `verified`
@@ -712,8 +717,19 @@ module Google
       class Gender
         include Google::Apis::Core::Hashable
       
-        # The read-only value of the gender translated and formatted in the viewer's
-        # account locale or the `Accept-Language` HTTP header locale.
+        # The type of pronouns that should be used to address the person. The value
+        # can be custom or one of these predefined values:
+        # * `male`
+        # * `female`
+        # * `other`
+        # Corresponds to the JSON property `addressMeAs`
+        # @return [String]
+        attr_accessor :address_me_as
+      
+        # Output only. The value of the gender translated and formatted in the viewer's
+        # account
+        # locale or the `Accept-Language` HTTP header locale. Unspecified or custom
+        # value are not localized.
         # Corresponds to the JSON property `formattedValue`
         # @return [String]
         attr_accessor :formatted_value
@@ -727,8 +743,7 @@ module Google
         # predefined values:
         # * `male`
         # * `female`
-        # * `other`
-        # * `unknown`
+        # * `unspecified`
         # Corresponds to the JSON property `value`
         # @return [String]
         attr_accessor :value
@@ -739,13 +754,14 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @address_me_as = args[:address_me_as] if args.key?(:address_me_as)
           @formatted_value = args[:formatted_value] if args.key?(:formatted_value)
           @metadata = args[:metadata] if args.key?(:metadata)
           @value = args[:value] if args.key?(:value)
         end
       end
       
-      # 
+      # The response to a get request for a list of people by resource name.
       class GetPeopleResponse
         include Google::Apis::Core::Hashable
       
@@ -768,13 +784,13 @@ module Google
       class ImClient
         include Google::Apis::Core::Hashable
       
-        # The read-only protocol of the IM client formatted in the viewer's account
+        # Output only. The protocol of the IM client formatted in the viewer's account
         # locale or the `Accept-Language` HTTP header locale.
         # Corresponds to the JSON property `formattedProtocol`
         # @return [String]
         attr_accessor :formatted_protocol
       
-        # The read-only type of the IM client translated and formatted in the
+        # Output only. The type of the IM client translated and formatted in the
         # viewer's account locale or the `Accept-Language` HTTP header locale.
         # Corresponds to the JSON property `formattedType`
         # @return [String]
@@ -854,7 +870,7 @@ module Google
         end
       end
       
-      # 
+      # The response to a request for the authenticated user's connections.
       class ListConnectionsResponse
         include Google::Apis::Core::Hashable
       
@@ -863,12 +879,15 @@ module Google
         # @return [Array<Google::Apis::PeopleV1::Person>]
         attr_accessor :connections
       
-        # The token that can be used to retrieve the next page of results.
+        # A token, which can be sent as `page_token` to retrieve the next page.
+        # If this field is omitted, there are no subsequent pages.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token
       
-        # The token that can be used to retrieve changes since the last request.
+        # A token, which can be sent as `sync_token` to retrieve changes since the
+        # last request. Request must set `request_sync_token` to return the sync
+        # token.
         # Corresponds to the JSON property `nextSyncToken`
         # @return [String]
         attr_accessor :next_sync_token
@@ -972,7 +991,7 @@ module Google
         # @return [Google::Apis::PeopleV1::ContactGroupMembership]
         attr_accessor :contact_group_membership
       
-        # A read-only G Suite Domain membership.
+        # A G Suite Domain membership.
         # Corresponds to the JSON property `domainMembership`
         # @return [Google::Apis::PeopleV1::DomainMembership]
         attr_accessor :domain_membership
@@ -1000,14 +1019,14 @@ module Google
       class ModifyContactGroupMembersRequest
         include Google::Apis::Core::Hashable
       
-        # The resource names of the contact people to add in the form of in the form
-        # `people/`<var>person_id</var>.
+        # Optional. The resource names of the contact people to add in the form of
+        # `people/`person_id``.
         # Corresponds to the JSON property `resourceNamesToAdd`
         # @return [Array<String>]
         attr_accessor :resource_names_to_add
       
-        # The resource names of the contact people to remove in the form of in the
-        # form of `people/`<var>person_id</var>.
+        # Optional. The resource names of the contact people to remove in the form of
+        # `people/`person_id``.
         # Corresponds to the JSON property `resourceNamesToRemove`
         # @return [Array<String>]
         attr_accessor :resource_names_to_remove
@@ -1053,13 +1072,13 @@ module Google
       class Name
         include Google::Apis::Core::Hashable
       
-        # The read-only display name formatted according to the locale specified by
+        # Output only. The display name formatted according to the locale specified by
         # the viewer's account or the `Accept-Language` HTTP header.
         # Corresponds to the JSON property `displayName`
         # @return [String]
         attr_accessor :display_name
       
-        # The read-only display name with the last name first formatted according to
+        # Output only. The display name with the last name first formatted according to
         # the locale specified by the viewer's account or the
         # `Accept-Language` HTTP header.
         # Corresponds to the JSON property `displayNameLastFirst`
@@ -1240,7 +1259,7 @@ module Google
         # @return [Google::Apis::PeopleV1::Date]
         attr_accessor :end_date
       
-        # The read-only type of the organization translated and formatted in the
+        # Output only. The type of the organization translated and formatted in the
         # viewer's account locale or the `Accept-Language` HTTP header locale.
         # Corresponds to the JSON property `formattedType`
         # @return [String]
@@ -1338,13 +1357,13 @@ module Google
         # @return [Array<Google::Apis::PeopleV1::Address>]
         attr_accessor :addresses
       
-        # **DEPRECATED** (Please use `person.ageRanges` instead)**
-        # The person's read-only age range.
+        # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
+        # The person's age range.
         # Corresponds to the JSON property `ageRange`
         # @return [String]
         attr_accessor :age_range
       
-        # The person's read-only age ranges.
+        # Output only. The person's age ranges.
         # Corresponds to the JSON property `ageRanges`
         # @return [Array<Google::Apis::PeopleV1::AgeRangeType>]
         attr_accessor :age_ranges
@@ -1359,12 +1378,13 @@ module Google
         # @return [Array<Google::Apis::PeopleV1::Birthday>]
         attr_accessor :birthdays
       
+        # **DEPRECATED**: No data will be returned
         # The person's bragging rights.
         # Corresponds to the JSON property `braggingRights`
         # @return [Array<Google::Apis::PeopleV1::BraggingRights>]
         attr_accessor :bragging_rights
       
-        # The person's read-only cover photos.
+        # Output only. The person's cover photos.
         # Corresponds to the JSON property `coverPhotos`
         # @return [Array<Google::Apis::PeopleV1::CoverPhoto>]
         attr_accessor :cover_photos
@@ -1410,7 +1430,7 @@ module Google
         # @return [Array<Google::Apis::PeopleV1::Membership>]
         attr_accessor :memberships
       
-        # The read-only metadata about a person.
+        # The metadata about a person.
         # Corresponds to the JSON property `metadata`
         # @return [Google::Apis::PeopleV1::PersonMetadata]
         attr_accessor :metadata
@@ -1440,7 +1460,7 @@ module Google
         # @return [Array<Google::Apis::PeopleV1::PhoneNumber>]
         attr_accessor :phone_numbers
       
-        # The person's read-only photos.
+        # Output only. The person's photos.
         # Corresponds to the JSON property `photos`
         # @return [Array<Google::Apis::PeopleV1::Photo>]
         attr_accessor :photos
@@ -1450,12 +1470,14 @@ module Google
         # @return [Array<Google::Apis::PeopleV1::Relation>]
         attr_accessor :relations
       
-        # The person's read-only relationship interests.
+        # Output only. **DEPRECATED**: No data will be returned
+        # The person's relationship interests.
         # Corresponds to the JSON property `relationshipInterests`
         # @return [Array<Google::Apis::PeopleV1::RelationshipInterest>]
         attr_accessor :relationship_interests
       
-        # The person's read-only relationship statuses.
+        # Output only. **DEPRECATED**: No data will be returned
+        # The person's relationship statuses.
         # Corresponds to the JSON property `relationshipStatuses`
         # @return [Array<Google::Apis::PeopleV1::RelationshipStatus>]
         attr_accessor :relationship_statuses
@@ -1467,7 +1489,7 @@ module Google
       
         # 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``.
         # Corresponds to the JSON property `resourceName`
         # @return [String]
         attr_accessor :resource_name
@@ -1482,7 +1504,8 @@ module Google
         # @return [Array<Google::Apis::PeopleV1::Skill>]
         attr_accessor :skills
       
-        # The person's read-only taglines.
+        # Output only. **DEPRECATED**: No data will be returned
+        # The person's taglines.
         # Corresponds to the JSON property `taglines`
         # @return [Array<Google::Apis::PeopleV1::Tagline>]
         attr_accessor :taglines
@@ -1538,11 +1561,11 @@ module Google
         end
       end
       
-      # The read-only metadata about a person.
+      # The metadata about a person.
       class PersonMetadata
         include Google::Apis::Core::Hashable
       
-        # True if the person resource has been deleted. Populated only for
+        # Output only. True if the person resource has been deleted. Populated only for
         # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
         # that include a sync token.
         # Corresponds to the JSON property `deleted`
@@ -1550,19 +1573,19 @@ module Google
         attr_accessor :deleted
         alias_method :deleted?, :deleted
       
-        # Resource names of people linked to this resource.
+        # Output only. Resource names of people linked to this resource.
         # Corresponds to the JSON property `linkedPeopleResourceNames`
         # @return [Array<String>]
         attr_accessor :linked_people_resource_names
       
-        # **DEPRECATED** (Please use
+        # Output only. **DEPRECATED** (Please use
         # `person.metadata.sources.profileMetadata.objectType` instead)
         # The type of the person object.
         # Corresponds to the JSON property `objectType`
         # @return [String]
         attr_accessor :object_type
       
-        # Any former resource names this person has had. Populated only for
+        # Output only. Any former resource names this person has had. Populated only for
         # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
         # that include a sync token.
         # The resource name may change when adding or removing fields that link a
@@ -1647,14 +1670,14 @@ module Google
       class PhoneNumber
         include Google::Apis::Core::Hashable
       
-        # The read-only canonicalized [ITU-T
+        # Output only. The canonicalized [ITU-T
         # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
         # form of the phone number.
         # Corresponds to the JSON property `canonicalForm`
         # @return [String]
         attr_accessor :canonical_form
       
-        # The read-only type of the phone number translated and formatted in the
+        # Output only. The type of the phone number translated and formatted in the
         # viewer's account locale or the `Accept-Language` HTTP header locale.
         # Corresponds to the JSON property `formattedType`
         # @return [String]
@@ -1702,7 +1725,7 @@ module Google
         end
       end
       
-      # A person's read-only photo. A picture shown next to the person's name to
+      # A person's photo. A picture shown next to the person's name to
       # help others recognize the person.
       class Photo
         include Google::Apis::Core::Hashable
@@ -1720,9 +1743,10 @@ module Google
         attr_accessor :metadata
       
         # The URL of the photo. You can change the desired size by appending a query
-        # parameter `sz=`<var>size</var> at the end of the url. Example:
-        # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/
-        # 00gzXvDBYqw/s100/photo.jpg?sz=50`
+        # parameter `sz=`size`` at the end of the url, where `size` is the size in
+        # pixels. Example:
+        # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/
+        # 00gzXvDBYqw/s100/photo.jpg?sz=50
         # Corresponds to the JSON property `url`
         # @return [String]
         attr_accessor :url
@@ -1739,16 +1763,16 @@ module Google
         end
       end
       
-      # The read-only metadata about a profile.
+      # The metadata about a profile.
       class ProfileMetadata
         include Google::Apis::Core::Hashable
       
-        # The profile object type.
+        # Output only. The profile object type.
         # Corresponds to the JSON property `objectType`
         # @return [String]
         attr_accessor :object_type
       
-        # The user types.
+        # Output only. The user types.
         # Corresponds to the JSON property `userTypes`
         # @return [Array<String>]
         attr_accessor :user_types
@@ -1768,8 +1792,8 @@ module Google
       class Relation
         include Google::Apis::Core::Hashable
       
-        # The type of the relation translated and formatted in the viewer's account
-        # locale or the locale specified in the Accept-Language HTTP header.
+        # Output only. The type of the relation translated and formatted in the viewer's
+        # account locale or the locale specified in the Accept-Language HTTP header.
         # Corresponds to the JSON property `formattedType`
         # @return [String]
         attr_accessor :formatted_type
@@ -1817,13 +1841,14 @@ module Google
         end
       end
       
-      # A person's read-only relationship interest .
+      # **DEPRECATED**: No data will be returned
+      # A person's relationship interest .
       class RelationshipInterest
         include Google::Apis::Core::Hashable
       
-        # The value of the relationship interest translated and formatted in the
-        # viewer's account locale or the locale specified in the Accept-Language
-        # HTTP header.
+        # Output only. The value of the relationship interest translated and formatted
+        # in the viewer's account locale or the locale specified in the
+        # Accept-Language HTTP header.
         # Corresponds to the JSON property `formattedValue`
         # @return [String]
         attr_accessor :formatted_value
@@ -1855,11 +1880,12 @@ module Google
         end
       end
       
-      # A person's read-only relationship status.
+      # **DEPRECATED**: No data will be returned
+      # A person's relationship status.
       class RelationshipStatus
         include Google::Apis::Core::Hashable
       
-        # The read-only value of the relationship status translated and formatted in
+        # Output only. The value of the relationship status translated and formatted in
         # the viewer's account locale or the `Accept-Language` HTTP header locale.
         # Corresponds to the JSON property `formattedValue`
         # @return [String]
@@ -1935,7 +1961,7 @@ module Google
       class SipAddress
         include Google::Apis::Core::Hashable
       
-        # The read-only type of the SIP address translated and formatted in the
+        # Output only. The type of the SIP address translated and formatted in the
         # viewer's account locale or the `Accept-Language` HTTP header locale.
         # Corresponds to the JSON property `formattedType`
         # @return [String]
@@ -2017,7 +2043,7 @@ module Google
         # @return [String]
         attr_accessor :id
       
-        # The read-only metadata about a profile.
+        # The metadata about a profile.
         # Corresponds to the JSON property `profileMetadata`
         # @return [Google::Apis::PeopleV1::ProfileMetadata]
         attr_accessor :profile_metadata
@@ -2027,7 +2053,7 @@ module Google
         # @return [String]
         attr_accessor :type
       
-        # **Only populated in `person.metadata.sources`.**
+        # Output only. **Only populated in `person.metadata.sources`.**
         # Last update timestamp of this source.
         # Corresponds to the JSON property `updateTime`
         # @return [String]
@@ -2086,7 +2112,8 @@ module Google
         end
       end
       
-      # A read-only brief one-line description of the person.
+      # **DEPRECATED**: No data will be returned
+      # A brief one-line description of the person.
       class Tagline
         include Google::Apis::Core::Hashable
       
@@ -2136,15 +2163,14 @@ module Google
       class UpdateContactPhotoRequest
         include Google::Apis::Core::Hashable
       
-        # **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
@@ -2161,19 +2187,16 @@ module Google
         # * phoneNumbers
         # * photos
         # * relations
-        # * relationshipInterests
-        # * relationshipStatuses
         # * residences
         # * sipAddresses
         # * skills
-        # * taglines
         # * urls
         # * userDefined
         # Corresponds to the JSON property `personFields`
         # @return [String]
         attr_accessor :person_fields
       
-        # Raw photo bytes
+        # Required. Raw photo bytes
         # Corresponds to the JSON property `photoBytes`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
@@ -2217,7 +2240,7 @@ module Google
       class Url
         include Google::Apis::Core::Hashable
       
-        # The read-only type of the URL translated and formatted in the viewer's
+        # Output only. The type of the URL translated and formatted in the viewer's
         # account locale or the `Accept-Language` HTTP header locale.
         # Corresponds to the JSON property `formattedType`
         # @return [String]

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

@@ -533,6 +533,7 @@ module Google
       class Gender
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :address_me_as, as: 'addressMeAs'
           property :formatted_value, as: 'formattedValue'
           property :metadata, as: 'metadata', class: Google::Apis::PeopleV1::FieldMetadata, decorator: Google::Apis::PeopleV1::FieldMetadata::Representation