happygapi.people.people — happygapi 0.4.2

People API: people. Provides access to information about profiles and contacts. See: https://developers.google.com/people/api/reference/rest/v1/people

connections-list$ clj

(connections-list$ auth parameters)

https://developers.google.com/people/api/reference/rest/v1/people/connections/list

Required parameters: resourceName

Optional parameters: personFields, sortOrder, requestSyncToken, pageToken, pageSize, requestMask.includeField, syncToken

Provides a list of the authenticated user's contacts merged with any connected profiles.

The request throws a 400 error if 'personFields' is not specified.

createContact$ clj

(createContact$ auth parameters body)

https://developers.google.com/people/api/reference/rest/v1/people/createContact

Required parameters: none

Optional parameters: none

Body:

{:addresses [{:formattedType string, :poBox string, :city string, :type string, :streetAddress string, :region string, :formattedValue string, :postalCode string, :extendedAddress string, :country string, :metadata FieldMetadata, :countryCode string}], :urls [{:metadata FieldMetadata, :type string, :value string, :formattedType string}], :relationshipStatuses [{:formattedValue string, :metadata FieldMetadata, :value string}], :coverPhotos [{:url string, :metadata FieldMetadata, :default boolean}], :birthdays [{:date Date, :metadata FieldMetadata, :text string}], :relations [{:metadata FieldMetadata, :type string, :person string, :formattedType string}], :ageRange string, :events [{:metadata FieldMetadata, :type string, :date Date, :formattedType string}], :phoneNumbers [{:value string, :formattedType string, :canonicalForm string, :metadata FieldMetadata, :type string}], :etag string, :biographies [{:value string, :contentType string, :metadata FieldMetadata}], :emailAddresses [{:displayName string, :metadata FieldMetadata, :type string, :value string, :formattedType string}], :organizations [{:department string, :formattedType string, :symbol string, :name string, :startDate Date, :type string, :phoneticName string, :title string, :endDate Date, :jobDescription string, :current boolean, :domain string, :location string, :metadata FieldMetadata}], :sipAddresses [{:formattedType string, :metadata FieldMetadata, :type string, :value string}], :braggingRights [{:metadata FieldMetadata, :value string}], :resourceName string, :relationshipInterests [{:formattedValue string, :metadata FieldMetadata, :value string}], :photos [{:url string, :metadata FieldMetadata, :default boolean}], :skills [{:metadata FieldMetadata, :value string}], :locales [{:metadata FieldMetadata, :value string}], :ageRanges [{:ageRange string, :metadata FieldMetadata}], :memberships [{:metadata FieldMetadata, :contactGroupMembership ContactGroupMembership, :domainMembership DomainMembership}], :interests [{:value string, :metadata FieldMetadata}], :nicknames [{:metadata FieldMetadata, :type string, :value string}], :residences [{:metadata FieldMetadata, :current boolean, :value string}], :imClients [{:formattedProtocol string, :formattedType string, :protocol string, :metadata FieldMetadata, :type string, :username string}], :genders [{:value string, :formattedValue string, :metadata FieldMetadata}], :taglines [{:value string, :metadata FieldMetadata}], :occupations [{:value string, :metadata FieldMetadata}], :metadata {:linkedPeopleResourceNames [string], :sources [Source], :previousResourceNames [string], :deleted boolean, :objectType string}, :names [{:middleName string, :phoneticHonorificPrefix string, :phoneticHonorificSuffix string, :displayNameLastFirst string, :displayName string, :phoneticGivenName string, :honorificPrefix string, :phoneticFullName string, :phoneticFamilyName string, :familyName string, :phoneticMiddleName string, :givenName string, :honorificSuffix string, :metadata FieldMetadata}], :userDefined [{:key string, :metadata FieldMetadata, :value string}]}

Create a new contact and return the person resource for that contact.

deleteContact$ clj

(deleteContact$ auth parameters)

https://developers.google.com/people/api/reference/rest/v1/people/deleteContact

Required parameters: resourceName

Optional parameters: none

Delete a contact person. Any non-contact data will not be deleted.

deleteContactPhoto$ clj

(deleteContactPhoto$ auth parameters)

https://developers.google.com/people/api/reference/rest/v1/people/deleteContactPhoto

Required parameters: resourceName

Optional parameters: personFields

Delete a contact's photo.

get$ clj

(get$ auth parameters)

https://developers.google.com/people/api/reference/rest/v1/people/get

Required parameters: resourceName

Optional parameters: personFields, requestMask.includeField

Provides information about a person by specifying a resource name. Use people/me to indicate the authenticated user.

The request throws a 400 error if 'personFields' is not specified.

getBatchGet$ clj

(getBatchGet$ auth parameters)

https://developers.google.com/people/api/reference/rest/v1/people/getBatchGet

Required parameters: none

Optional parameters: resourceNames, personFields, requestMask.includeField

Provides information about a list of specific people by specifying a list of requested resource names. Use people/me to indicate the authenticated user.

The request throws a 400 error if 'personFields' is not specified.

updateContact$ clj

(updateContact$ auth parameters body)

https://developers.google.com/people/api/reference/rest/v1/people/updateContact

Required parameters: resourceName

Optional parameters: updatePersonFields

Body:

{:addresses [{:formattedType string, :poBox string, :city string, :type string, :streetAddress string, :region string, :formattedValue string, :postalCode string, :extendedAddress string, :country string, :metadata FieldMetadata, :countryCode string}], :urls [{:metadata FieldMetadata, :type string, :value string, :formattedType string}], :relationshipStatuses [{:formattedValue string, :metadata FieldMetadata, :value string}], :coverPhotos [{:url string, :metadata FieldMetadata, :default boolean}], :birthdays [{:date Date, :metadata FieldMetadata, :text string}], :relations [{:metadata FieldMetadata, :type string, :person string, :formattedType string}], :ageRange string, :events [{:metadata FieldMetadata, :type string, :date Date, :formattedType string}], :phoneNumbers [{:value string, :formattedType string, :canonicalForm string, :metadata FieldMetadata, :type string}], :etag string, :biographies [{:value string, :contentType string, :metadata FieldMetadata}], :emailAddresses [{:displayName string, :metadata FieldMetadata, :type string, :value string, :formattedType string}], :organizations [{:department string, :formattedType string, :symbol string, :name string, :startDate Date, :type string, :phoneticName string, :title string, :endDate Date, :jobDescription string, :current boolean, :domain string, :location string, :metadata FieldMetadata}], :sipAddresses [{:formattedType string, :metadata FieldMetadata, :type string, :value string}], :braggingRights [{:metadata FieldMetadata, :value string}], :resourceName string, :relationshipInterests [{:formattedValue string, :metadata FieldMetadata, :value string}], :photos [{:url string, :metadata FieldMetadata, :default boolean}], :skills [{:metadata FieldMetadata, :value string}], :locales [{:metadata FieldMetadata, :value string}], :ageRanges [{:ageRange string, :metadata FieldMetadata}], :memberships [{:metadata FieldMetadata, :contactGroupMembership ContactGroupMembership, :domainMembership DomainMembership}], :interests [{:value string, :metadata FieldMetadata}], :nicknames [{:metadata FieldMetadata, :type string, :value string}], :residences [{:metadata FieldMetadata, :current boolean, :value string}], :imClients [{:formattedProtocol string, :formattedType string, :protocol string, :metadata FieldMetadata, :type string, :username string}], :genders [{:value string, :formattedValue string, :metadata FieldMetadata}], :taglines [{:value string, :metadata FieldMetadata}], :occupations [{:value string, :metadata FieldMetadata}], :metadata {:linkedPeopleResourceNames [string], :sources [Source], :previousResourceNames [string], :deleted boolean, :objectType string}, :names [{:middleName string, :phoneticHonorificPrefix string, :phoneticHonorificSuffix string, :displayNameLastFirst string, :displayName string, :phoneticGivenName string, :honorificPrefix string, :phoneticFullName string, :phoneticFamilyName string, :familyName string, :phoneticMiddleName string, :givenName string, :honorificSuffix string, :metadata FieldMetadata}], :userDefined [{:key string, :metadata FieldMetadata, :value string}]}

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.

The request throws a 400 error if person.metadata.sources is not specified for the contact to be updated.

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.

updateContactPhoto$ clj

(updateContactPhoto$ auth parameters body)

https://developers.google.com/people/api/reference/rest/v1/people/updateContactPhoto

Required parameters: resourceName

Optional parameters: none

Body:

{:personFields string, :photoBytes string}

Update a contact's photo.