mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
1506 lines
65 KiB
TypeScript
1506 lines
65 KiB
TypeScript
// Type definitions for non-npm package Google Google People API v1 1.0
|
|
// Project: https://developers.google.com/people/
|
|
// Definitions by: Bolisov Alexey <https://github.com/Bolisov>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.3
|
|
|
|
// IMPORTANT
|
|
// This file was generated by https://github.com/Bolisov/google-api-typings-generator. Please do not edit it manually.
|
|
// In case of any problems please post issue to https://github.com/Bolisov/google-api-typings-generator
|
|
// Generated from: https://people.googleapis.com/$discovery/rest?version=v1
|
|
|
|
/// <reference types="gapi.client" />
|
|
|
|
declare namespace gapi.client {
|
|
/** Load Google People API v1 */
|
|
function load(name: "people", version: "v1"): PromiseLike<void>;
|
|
function load(name: "people", version: "v1", callback: () => any): void;
|
|
|
|
const contactGroups: people.ContactGroupsResource;
|
|
|
|
const people: people.PeopleResource;
|
|
|
|
namespace people {
|
|
interface Address {
|
|
/** The city of the address. */
|
|
city?: string;
|
|
/** The country of the address. */
|
|
country?: string;
|
|
/**
|
|
* The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
|
|
* code of the address.
|
|
*/
|
|
countryCode?: string;
|
|
/** The extended address of the address; for example, the apartment number. */
|
|
extendedAddress?: string;
|
|
/**
|
|
* The read-only type of the address translated and formatted in the viewer's
|
|
* account locale or the `Accept-Language` HTTP header locale.
|
|
*/
|
|
formattedType?: string;
|
|
/**
|
|
* The unstructured value of the address. If this is not set by the user it
|
|
* will be automatically constructed from structured values.
|
|
*/
|
|
formattedValue?: string;
|
|
/** Metadata about the address. */
|
|
metadata?: FieldMetadata;
|
|
/** The P.O. box of the address. */
|
|
poBox?: string;
|
|
/** The postal code of the address. */
|
|
postalCode?: string;
|
|
/** The region of the address; for example, the state or province. */
|
|
region?: string;
|
|
/** The street address. */
|
|
streetAddress?: string;
|
|
/**
|
|
* The type of the address. The type can be custom or predefined.
|
|
* Possible values include, but are not limited to, the following:
|
|
*
|
|
* * `home`
|
|
* * `work`
|
|
* * `other`
|
|
*/
|
|
type?: string;
|
|
}
|
|
interface AgeRangeType {
|
|
/** The age range. */
|
|
ageRange?: string;
|
|
/** Metadata about the age range. */
|
|
metadata?: FieldMetadata;
|
|
}
|
|
interface BatchGetContactGroupsResponse {
|
|
/** The list of responses for each requested contact group resource. */
|
|
responses?: ContactGroupResponse[];
|
|
}
|
|
interface Biography {
|
|
/** The content type of the biography. */
|
|
contentType?: string;
|
|
/** Metadata about the biography. */
|
|
metadata?: FieldMetadata;
|
|
/** The short biography. */
|
|
value?: string;
|
|
}
|
|
interface Birthday {
|
|
/** The date of the birthday. */
|
|
date?: Date;
|
|
/** Metadata about the birthday. */
|
|
metadata?: FieldMetadata;
|
|
/** A free-form string representing the user's birthday. */
|
|
text?: string;
|
|
}
|
|
interface BraggingRights {
|
|
/** Metadata about the bragging rights. */
|
|
metadata?: FieldMetadata;
|
|
/** The bragging rights; for example, `climbed mount everest`. */
|
|
value?: string;
|
|
}
|
|
interface ContactGroup {
|
|
/**
|
|
* The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
|
|
* resource. Used for web cache validation.
|
|
*/
|
|
etag?: string;
|
|
/**
|
|
* The read-only 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.
|
|
*/
|
|
formattedName?: string;
|
|
/** The read-only contact group type. */
|
|
groupType?: string;
|
|
/**
|
|
* The total number of contacts in the group irrespective of max members in
|
|
* specified in the request.
|
|
*/
|
|
memberCount?: number;
|
|
/**
|
|
* 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).
|
|
*/
|
|
memberResourceNames?: string[];
|
|
/** Metadata about the contact group. */
|
|
metadata?: ContactGroupMetadata;
|
|
/**
|
|
* The contact group name set by the group owner or a system provided name
|
|
* for system groups.
|
|
*/
|
|
name?: string;
|
|
/**
|
|
* The resource name for the contact group, assigned by the server. An ASCII
|
|
* string, in the form of `contactGroups/`<var>contact_group_id</var>.
|
|
*/
|
|
resourceName?: string;
|
|
}
|
|
interface ContactGroupMembership {
|
|
/**
|
|
* The contact group ID for the contact group membership. The contact group
|
|
* ID can be custom or predefined. Possible values include, but are not
|
|
* limited to, the following:
|
|
*
|
|
* * `myContacts`
|
|
* * `starred`
|
|
* * A numerical ID for user-created groups.
|
|
*/
|
|
contactGroupId?: string;
|
|
}
|
|
interface ContactGroupMetadata {
|
|
/**
|
|
* 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.
|
|
*/
|
|
deleted?: boolean;
|
|
/** The time the group was last updated. */
|
|
updateTime?: string;
|
|
}
|
|
interface ContactGroupResponse {
|
|
/** The contact group. */
|
|
contactGroup?: ContactGroup;
|
|
/** The original requested resource name. */
|
|
requestedResourceName?: string;
|
|
/** The status of the response. */
|
|
status?: Status;
|
|
}
|
|
interface CoverPhoto {
|
|
/**
|
|
* True if the cover photo is the default cover photo;
|
|
* false if the cover photo is a user-provided cover photo.
|
|
*/
|
|
default?: boolean;
|
|
/** Metadata about the cover photo. */
|
|
metadata?: FieldMetadata;
|
|
/** The URL of the cover photo. */
|
|
url?: string;
|
|
}
|
|
interface CreateContactGroupRequest {
|
|
/** The contact group to create. */
|
|
contactGroup?: ContactGroup;
|
|
}
|
|
interface Date {
|
|
/**
|
|
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0
|
|
* if specifying a year/month where the day is not significant.
|
|
*/
|
|
day?: number;
|
|
/** Month of year. Must be from 1 to 12. */
|
|
month?: number;
|
|
/**
|
|
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without
|
|
* a year.
|
|
*/
|
|
year?: number;
|
|
}
|
|
interface DomainMembership {
|
|
/** True if the person is in the viewer's Google Apps domain. */
|
|
inViewerDomain?: boolean;
|
|
}
|
|
interface EmailAddress {
|
|
/** The display name of the email. */
|
|
displayName?: string;
|
|
/**
|
|
* The read-only type of the email address translated and formatted in the
|
|
* viewer's account locale or the `Accept-Language` HTTP header locale.
|
|
*/
|
|
formattedType?: string;
|
|
/** Metadata about the email address. */
|
|
metadata?: FieldMetadata;
|
|
/**
|
|
* The type of the email address. The type can be custom or predefined.
|
|
* Possible values include, but are not limited to, the following:
|
|
*
|
|
* * `home`
|
|
* * `work`
|
|
* * `other`
|
|
*/
|
|
type?: string;
|
|
/** The email address. */
|
|
value?: string;
|
|
}
|
|
interface Event {
|
|
/** The date of the event. */
|
|
date?: Date;
|
|
/**
|
|
* The read-only type of the event translated and formatted in the
|
|
* viewer's account locale or the `Accept-Language` HTTP header locale.
|
|
*/
|
|
formattedType?: string;
|
|
/** Metadata about the event. */
|
|
metadata?: FieldMetadata;
|
|
/**
|
|
* The type of the event. The type can be custom or predefined.
|
|
* Possible values include, but are not limited to, the following:
|
|
*
|
|
* * `anniversary`
|
|
* * `other`
|
|
*/
|
|
type?: string;
|
|
}
|
|
interface FieldMetadata {
|
|
/**
|
|
* True if the field is the primary field; false if the field is a secondary
|
|
* field.
|
|
*/
|
|
primary?: boolean;
|
|
/** The source of the field. */
|
|
source?: Source;
|
|
/**
|
|
* 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.
|
|
*/
|
|
verified?: boolean;
|
|
}
|
|
interface Gender {
|
|
/**
|
|
* The read-only value of the gender translated and formatted in the viewer's
|
|
* account locale or the `Accept-Language` HTTP header locale.
|
|
*/
|
|
formattedValue?: string;
|
|
/** Metadata about the gender. */
|
|
metadata?: FieldMetadata;
|
|
/**
|
|
* The gender for the person. The gender can be custom or predefined.
|
|
* Possible values include, but are not limited to, the
|
|
* following:
|
|
*
|
|
* * `male`
|
|
* * `female`
|
|
* * `other`
|
|
* * `unknown`
|
|
*/
|
|
value?: string;
|
|
}
|
|
interface GetPeopleResponse {
|
|
/** The response for each requested resource name. */
|
|
responses?: PersonResponse[];
|
|
}
|
|
interface ImClient {
|
|
/**
|
|
* The read-only protocol of the IM client formatted in the viewer's account
|
|
* locale or the `Accept-Language` HTTP header locale.
|
|
*/
|
|
formattedProtocol?: string;
|
|
/**
|
|
* The read-only type of the IM client translated and formatted in the
|
|
* viewer's account locale or the `Accept-Language` HTTP header locale.
|
|
*/
|
|
formattedType?: string;
|
|
/** Metadata about the IM client. */
|
|
metadata?: FieldMetadata;
|
|
/**
|
|
* The protocol of the IM client. The protocol can be custom or predefined.
|
|
* Possible values include, but are not limited to, the following:
|
|
*
|
|
* * `aim`
|
|
* * `msn`
|
|
* * `yahoo`
|
|
* * `skype`
|
|
* * `qq`
|
|
* * `googleTalk`
|
|
* * `icq`
|
|
* * `jabber`
|
|
* * `netMeeting`
|
|
*/
|
|
protocol?: string;
|
|
/**
|
|
* The type of the IM client. The type can be custom or predefined.
|
|
* Possible values include, but are not limited to, the following:
|
|
*
|
|
* * `home`
|
|
* * `work`
|
|
* * `other`
|
|
*/
|
|
type?: string;
|
|
/** The user name used in the IM client. */
|
|
username?: string;
|
|
}
|
|
interface Interest {
|
|
/** Metadata about the interest. */
|
|
metadata?: FieldMetadata;
|
|
/** The interest; for example, `stargazing`. */
|
|
value?: string;
|
|
}
|
|
interface ListConnectionsResponse {
|
|
/** The list of people that the requestor is connected to. */
|
|
connections?: Person[];
|
|
/** The token that can be used to retrieve the next page of results. */
|
|
nextPageToken?: string;
|
|
/** The token that can be used to retrieve changes since the last request. */
|
|
nextSyncToken?: string;
|
|
/** The total number of items in the list without pagination. */
|
|
totalItems?: number;
|
|
/**
|
|
* **DEPRECATED** (Please use totalItems)
|
|
* The total number of people in the list without pagination.
|
|
*/
|
|
totalPeople?: number;
|
|
}
|
|
interface ListContactGroupsResponse {
|
|
/**
|
|
* The list of contact groups. Members of the contact groups are not
|
|
* populated.
|
|
*/
|
|
contactGroups?: ContactGroup[];
|
|
/** The token that can be used to retrieve the next page of results. */
|
|
nextPageToken?: string;
|
|
/** The token that can be used to retrieve changes since the last request. */
|
|
nextSyncToken?: string;
|
|
/** The total number of items in the list without pagination. */
|
|
totalItems?: number;
|
|
}
|
|
interface Locale {
|
|
/** Metadata about the locale. */
|
|
metadata?: FieldMetadata;
|
|
/**
|
|
* The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
|
|
* language tag representing the locale.
|
|
*/
|
|
value?: string;
|
|
}
|
|
interface Membership {
|
|
/** The contact group membership. */
|
|
contactGroupMembership?: ContactGroupMembership;
|
|
/** The domain membership. */
|
|
domainMembership?: DomainMembership;
|
|
/** Metadata about the membership. */
|
|
metadata?: FieldMetadata;
|
|
}
|
|
interface ModifyContactGroupMembersRequest {
|
|
/**
|
|
* The resource names of the contact people to add in the form of in the form
|
|
* `people/`<var>person_id</var>.
|
|
*/
|
|
resourceNamesToAdd?: string[];
|
|
/**
|
|
* The resource names of the contact people to remove in the form of in the
|
|
* form of `people/`<var>person_id</var>.
|
|
*/
|
|
resourceNamesToRemove?: string[];
|
|
}
|
|
interface ModifyContactGroupMembersResponse {
|
|
/** The contact people resource names that were not found. */
|
|
notFoundResourceNames?: string[];
|
|
}
|
|
interface Name {
|
|
/**
|
|
* The read-only display name formatted according to the locale specified by
|
|
* the viewer's account or the `Accept-Language` HTTP header.
|
|
*/
|
|
displayName?: string;
|
|
/**
|
|
* The read-only display name with the last name first formatted according to
|
|
* the locale specified by the viewer's account or the
|
|
* `Accept-Language` HTTP header.
|
|
*/
|
|
displayNameLastFirst?: string;
|
|
/** The family name. */
|
|
familyName?: string;
|
|
/** The given name. */
|
|
givenName?: string;
|
|
/** The honorific prefixes, such as `Mrs.` or `Dr.` */
|
|
honorificPrefix?: string;
|
|
/** The honorific suffixes, such as `Jr.` */
|
|
honorificSuffix?: string;
|
|
/** Metadata about the name. */
|
|
metadata?: FieldMetadata;
|
|
/** The middle name(s). */
|
|
middleName?: string;
|
|
/** The family name spelled as it sounds. */
|
|
phoneticFamilyName?: string;
|
|
/** The full name spelled as it sounds. */
|
|
phoneticFullName?: string;
|
|
/** The given name spelled as it sounds. */
|
|
phoneticGivenName?: string;
|
|
/** The honorific prefixes spelled as they sound. */
|
|
phoneticHonorificPrefix?: string;
|
|
/** The honorific suffixes spelled as they sound. */
|
|
phoneticHonorificSuffix?: string;
|
|
/** The middle name(s) spelled as they sound. */
|
|
phoneticMiddleName?: string;
|
|
}
|
|
interface Nickname {
|
|
/** Metadata about the nickname. */
|
|
metadata?: FieldMetadata;
|
|
/** The type of the nickname. */
|
|
type?: string;
|
|
/** The nickname. */
|
|
value?: string;
|
|
}
|
|
interface Occupation {
|
|
/** Metadata about the occupation. */
|
|
metadata?: FieldMetadata;
|
|
/** The occupation; for example, `carpenter`. */
|
|
value?: string;
|
|
}
|
|
interface Organization {
|
|
/**
|
|
* True if the organization is the person's current organization;
|
|
* false if the organization is a past organization.
|
|
*/
|
|
current?: boolean;
|
|
/** The person's department at the organization. */
|
|
department?: string;
|
|
/** The domain name associated with the organization; for example, `google.com`. */
|
|
domain?: string;
|
|
/** The end date when the person left the organization. */
|
|
endDate?: Date;
|
|
/**
|
|
* The read-only type of the organization translated and formatted in the
|
|
* viewer's account locale or the `Accept-Language` HTTP header locale.
|
|
*/
|
|
formattedType?: string;
|
|
/** The person's job description at the organization. */
|
|
jobDescription?: string;
|
|
/** The location of the organization office the person works at. */
|
|
location?: string;
|
|
/** Metadata about the organization. */
|
|
metadata?: FieldMetadata;
|
|
/** The name of the organization. */
|
|
name?: string;
|
|
/** The phonetic name of the organization. */
|
|
phoneticName?: string;
|
|
/** The start date when the person joined the organization. */
|
|
startDate?: Date;
|
|
/**
|
|
* The symbol associated with the organization; for example, a stock ticker
|
|
* symbol, abbreviation, or acronym.
|
|
*/
|
|
symbol?: string;
|
|
/** The person's job title at the organization. */
|
|
title?: string;
|
|
/**
|
|
* The type of the organization. The type can be custom or predefined.
|
|
* Possible values include, but are not limited to, the following:
|
|
*
|
|
* * `work`
|
|
* * `school`
|
|
*/
|
|
type?: string;
|
|
}
|
|
interface Person {
|
|
/** The person's street addresses. */
|
|
addresses?: Address[];
|
|
/**
|
|
* **DEPRECATED** (Please use `person.ageRanges` instead)**
|
|
*
|
|
* The person's read-only age range.
|
|
*/
|
|
ageRange?: string;
|
|
/** The person's read-only age ranges. */
|
|
ageRanges?: AgeRangeType[];
|
|
/** The person's biographies. */
|
|
biographies?: Biography[];
|
|
/** The person's birthdays. */
|
|
birthdays?: Birthday[];
|
|
/** The person's bragging rights. */
|
|
braggingRights?: BraggingRights[];
|
|
/** The person's read-only cover photos. */
|
|
coverPhotos?: CoverPhoto[];
|
|
/** The person's email addresses. */
|
|
emailAddresses?: EmailAddress[];
|
|
/**
|
|
* The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
|
|
* resource. Used for web cache validation.
|
|
*/
|
|
etag?: string;
|
|
/** The person's events. */
|
|
events?: Event[];
|
|
/** The person's genders. */
|
|
genders?: Gender[];
|
|
/** The person's instant messaging clients. */
|
|
imClients?: ImClient[];
|
|
/** The person's interests. */
|
|
interests?: Interest[];
|
|
/** The person's locale preferences. */
|
|
locales?: Locale[];
|
|
/** The person's read-only group memberships. */
|
|
memberships?: Membership[];
|
|
/** Read-only metadata about the person. */
|
|
metadata?: PersonMetadata;
|
|
/** The person's names. */
|
|
names?: Name[];
|
|
/** The person's nicknames. */
|
|
nicknames?: Nickname[];
|
|
/** The person's occupations. */
|
|
occupations?: Occupation[];
|
|
/** The person's past or current organizations. */
|
|
organizations?: Organization[];
|
|
/** The person's phone numbers. */
|
|
phoneNumbers?: PhoneNumber[];
|
|
/** The person's read-only photos. */
|
|
photos?: Photo[];
|
|
/** The person's relations. */
|
|
relations?: Relation[];
|
|
/** The person's read-only relationship interests. */
|
|
relationshipInterests?: RelationshipInterest[];
|
|
/** The person's read-only relationship statuses. */
|
|
relationshipStatuses?: RelationshipStatus[];
|
|
/** The person's residences. */
|
|
residences?: Residence[];
|
|
/**
|
|
* 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>.
|
|
*/
|
|
resourceName?: string;
|
|
/** The person's skills. */
|
|
skills?: Skill[];
|
|
/** The person's read-only taglines. */
|
|
taglines?: Tagline[];
|
|
/** The person's associated URLs. */
|
|
urls?: Url[];
|
|
/** The person's user defined data. */
|
|
userDefined?: UserDefined[];
|
|
}
|
|
interface PersonMetadata {
|
|
/**
|
|
* 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.
|
|
*/
|
|
deleted?: boolean;
|
|
/** Resource names of people linked to this resource. */
|
|
linkedPeopleResourceNames?: string[];
|
|
/**
|
|
* **DEPRECATED** (Please use
|
|
* `person.metadata.sources.profileMetadata.objectType` instead)
|
|
*
|
|
* The type of the person object.
|
|
*/
|
|
objectType?: string;
|
|
/**
|
|
* 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
|
|
* contact and profile such as a verified email, verified phone number, or
|
|
* profile URL.
|
|
*/
|
|
previousResourceNames?: string[];
|
|
/** The sources of data for the person. */
|
|
sources?: Source[];
|
|
}
|
|
interface PersonResponse {
|
|
/**
|
|
* **DEPRECATED** (Please use status instead)
|
|
*
|
|
* [HTTP 1.1 status code]
|
|
* (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
|
|
*/
|
|
httpStatusCode?: number;
|
|
/** The person. */
|
|
person?: Person;
|
|
/**
|
|
* The original requested resource name. May be different than the resource
|
|
* name on the returned person.
|
|
*
|
|
* The resource name can change when adding or removing fields that link a
|
|
* contact and profile such as a verified email, verified phone number, or a
|
|
* profile URL.
|
|
*/
|
|
requestedResourceName?: string;
|
|
/** The status of the response. */
|
|
status?: Status;
|
|
}
|
|
interface PhoneNumber {
|
|
/**
|
|
* The read-only 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.
|
|
*/
|
|
canonicalForm?: string;
|
|
/**
|
|
* The read-only type of the phone number translated and formatted in the
|
|
* viewer's account locale or the `Accept-Language` HTTP header locale.
|
|
*/
|
|
formattedType?: string;
|
|
/** Metadata about the phone number. */
|
|
metadata?: FieldMetadata;
|
|
/**
|
|
* The type of the phone number. The type can be custom or predefined.
|
|
* Possible values include, but are not limited to, the following:
|
|
*
|
|
* * `home`
|
|
* * `work`
|
|
* * `mobile`
|
|
* * `homeFax`
|
|
* * `workFax`
|
|
* * `otherFax`
|
|
* * `pager`
|
|
* * `workMobile`
|
|
* * `workPager`
|
|
* * `main`
|
|
* * `googleVoice`
|
|
* * `other`
|
|
*/
|
|
type?: string;
|
|
/** The phone number. */
|
|
value?: string;
|
|
}
|
|
interface Photo {
|
|
/**
|
|
* True if the photo is a default photo;
|
|
* false if the photo is a user-provided photo.
|
|
*/
|
|
default?: boolean;
|
|
/** Metadata about the photo. */
|
|
metadata?: FieldMetadata;
|
|
/**
|
|
* 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`
|
|
*/
|
|
url?: string;
|
|
}
|
|
interface ProfileMetadata {
|
|
/** The profile object type. */
|
|
objectType?: string;
|
|
/** The user types. */
|
|
userTypes?: string[];
|
|
}
|
|
interface Relation {
|
|
/**
|
|
* The type of the relation translated and formatted in the viewer's account
|
|
* locale or the locale specified in the Accept-Language HTTP header.
|
|
*/
|
|
formattedType?: string;
|
|
/** Metadata about the relation. */
|
|
metadata?: FieldMetadata;
|
|
/** The name of the other person this relation refers to. */
|
|
person?: string;
|
|
/**
|
|
* The person's relation to the other person. The type can be custom or predefined.
|
|
* Possible values include, but are not limited to, the following values:
|
|
*
|
|
* * `spouse`
|
|
* * `child`
|
|
* * `mother`
|
|
* * `father`
|
|
* * `parent`
|
|
* * `brother`
|
|
* * `sister`
|
|
* * `friend`
|
|
* * `relative`
|
|
* * `domesticPartner`
|
|
* * `manager`
|
|
* * `assistant`
|
|
* * `referredBy`
|
|
* * `partner`
|
|
*/
|
|
type?: string;
|
|
}
|
|
interface RelationshipInterest {
|
|
/**
|
|
* 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.
|
|
*/
|
|
formattedValue?: string;
|
|
/** Metadata about the relationship interest. */
|
|
metadata?: FieldMetadata;
|
|
/**
|
|
* The kind of relationship the person is looking for. The value can be custom
|
|
* or predefined. Possible values include, but are not limited to, the
|
|
* following values:
|
|
*
|
|
* * `friend`
|
|
* * `date`
|
|
* * `relationship`
|
|
* * `networking`
|
|
*/
|
|
value?: string;
|
|
}
|
|
interface RelationshipStatus {
|
|
/**
|
|
* The read-only value of the relationship status translated and formatted in
|
|
* the viewer's account locale or the `Accept-Language` HTTP header locale.
|
|
*/
|
|
formattedValue?: string;
|
|
/** Metadata about the relationship status. */
|
|
metadata?: FieldMetadata;
|
|
/**
|
|
* The relationship status. The value can be custom or predefined.
|
|
* Possible values include, but are not limited to, the following:
|
|
*
|
|
* * `single`
|
|
* * `inARelationship`
|
|
* * `engaged`
|
|
* * `married`
|
|
* * `itsComplicated`
|
|
* * `openRelationship`
|
|
* * `widowed`
|
|
* * `inDomesticPartnership`
|
|
* * `inCivilUnion`
|
|
*/
|
|
value?: string;
|
|
}
|
|
interface Residence {
|
|
/**
|
|
* True if the residence is the person's current residence;
|
|
* false if the residence is a past residence.
|
|
*/
|
|
current?: boolean;
|
|
/** Metadata about the residence. */
|
|
metadata?: FieldMetadata;
|
|
/** The address of the residence. */
|
|
value?: string;
|
|
}
|
|
interface Skill {
|
|
/** Metadata about the skill. */
|
|
metadata?: FieldMetadata;
|
|
/** The skill; for example, `underwater basket weaving`. */
|
|
value?: string;
|
|
}
|
|
interface Source {
|
|
/**
|
|
* **Only populated in `person.metadata.sources`.**
|
|
*
|
|
* The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
|
|
* source. Used for web cache validation.
|
|
*/
|
|
etag?: string;
|
|
/** The unique identifier within the source type generated by the server. */
|
|
id?: string;
|
|
/**
|
|
* **Only populated in `person.metadata.sources`.**
|
|
*
|
|
* Metadata about a source of type PROFILE.
|
|
*/
|
|
profileMetadata?: ProfileMetadata;
|
|
/** The source type. */
|
|
type?: string;
|
|
/**
|
|
* **Only populated in `person.metadata.sources`.**
|
|
*
|
|
* Last update timestamp of this source.
|
|
*/
|
|
updateTime?: string;
|
|
}
|
|
interface Status {
|
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
code?: number;
|
|
/**
|
|
* A list of messages that carry the error details. There is a common set of
|
|
* message types for APIs to use.
|
|
*/
|
|
details?: Array<Record<string, any>>;
|
|
/**
|
|
* A developer-facing error message, which should be in English. Any
|
|
* user-facing error message should be localized and sent in the
|
|
* google.rpc.Status.details field, or localized by the client.
|
|
*/
|
|
message?: string;
|
|
}
|
|
interface Tagline {
|
|
/** Metadata about the tagline. */
|
|
metadata?: FieldMetadata;
|
|
/** The tagline. */
|
|
value?: string;
|
|
}
|
|
interface UpdateContactGroupRequest {
|
|
/** The contact group to update. */
|
|
contactGroup?: ContactGroup;
|
|
}
|
|
interface Url {
|
|
/**
|
|
* The read-only type of the URL translated and formatted in the viewer's
|
|
* account locale or the `Accept-Language` HTTP header locale.
|
|
*/
|
|
formattedType?: string;
|
|
/** Metadata about the URL. */
|
|
metadata?: FieldMetadata;
|
|
/**
|
|
* The type of the URL. The type can be custom or predefined.
|
|
* Possible values include, but are not limited to, the following:
|
|
*
|
|
* * `home`
|
|
* * `work`
|
|
* * `blog`
|
|
* * `profile`
|
|
* * `homePage`
|
|
* * `ftp`
|
|
* * `reservations`
|
|
* * `appInstallPage`: website for a Google+ application.
|
|
* * `other`
|
|
*/
|
|
type?: string;
|
|
/** The URL. */
|
|
value?: string;
|
|
}
|
|
interface UserDefined {
|
|
/** The end user specified key of the user defined data. */
|
|
key?: string;
|
|
/** Metadata about the user defined data. */
|
|
metadata?: FieldMetadata;
|
|
/** The end user specified value of the user defined data. */
|
|
value?: string;
|
|
}
|
|
interface MembersResource {
|
|
/** Modify the members of a contact group owned by the authenticated user. */
|
|
modify(request: {
|
|
/** V1 error format. */
|
|
"$.xgafv"?: string;
|
|
/** OAuth access token. */
|
|
access_token?: string;
|
|
/** Data format for response. */
|
|
alt?: string;
|
|
/** OAuth bearer token. */
|
|
bearer_token?: string;
|
|
/** JSONP */
|
|
callback?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: 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. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Pretty-print response. */
|
|
pp?: boolean;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/** 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. */
|
|
quotaUser?: string;
|
|
/** The resource name of the contact group to modify. */
|
|
resourceName: string;
|
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
uploadType?: string;
|
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
upload_protocol?: string;
|
|
}): Request<ModifyContactGroupMembersResponse>;
|
|
}
|
|
interface ContactGroupsResource {
|
|
/**
|
|
* Get a list of contact groups owned by the authenticated user by specifying
|
|
* a list of contact group resource names.
|
|
*/
|
|
batchGet(request: {
|
|
/** V1 error format. */
|
|
"$.xgafv"?: string;
|
|
/** OAuth access token. */
|
|
access_token?: string;
|
|
/** Data format for response. */
|
|
alt?: string;
|
|
/** OAuth bearer token. */
|
|
bearer_token?: string;
|
|
/** JSONP */
|
|
callback?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: 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. */
|
|
key?: string;
|
|
/** Specifies the maximum number of members to return for each group. */
|
|
maxMembers?: number;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Pretty-print response. */
|
|
pp?: boolean;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/** 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. */
|
|
quotaUser?: string;
|
|
/** The resource names of the contact groups to get. */
|
|
resourceNames?: string;
|
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
uploadType?: string;
|
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
upload_protocol?: string;
|
|
}): Request<BatchGetContactGroupsResponse>;
|
|
/** Create a new contact group owned by the authenticated user. */
|
|
create(request: {
|
|
/** V1 error format. */
|
|
"$.xgafv"?: string;
|
|
/** OAuth access token. */
|
|
access_token?: string;
|
|
/** Data format for response. */
|
|
alt?: string;
|
|
/** OAuth bearer token. */
|
|
bearer_token?: string;
|
|
/** JSONP */
|
|
callback?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: 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. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Pretty-print response. */
|
|
pp?: boolean;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/** 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. */
|
|
quotaUser?: string;
|
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
uploadType?: string;
|
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
upload_protocol?: string;
|
|
}): Request<ContactGroup>;
|
|
/**
|
|
* Delete an existing contact group owned by the authenticated user by
|
|
* specifying a contact group resource name.
|
|
*/
|
|
delete(request: {
|
|
/** V1 error format. */
|
|
"$.xgafv"?: string;
|
|
/** OAuth access token. */
|
|
access_token?: string;
|
|
/** Data format for response. */
|
|
alt?: string;
|
|
/** OAuth bearer token. */
|
|
bearer_token?: string;
|
|
/** JSONP */
|
|
callback?: string;
|
|
/** Set to true to also delete the contacts in the specified group. */
|
|
deleteContacts?: boolean;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: 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. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Pretty-print response. */
|
|
pp?: boolean;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/** 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. */
|
|
quotaUser?: string;
|
|
/** The resource name of the contact group to delete. */
|
|
resourceName: string;
|
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
uploadType?: string;
|
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
upload_protocol?: string;
|
|
}): Request<{}>;
|
|
/**
|
|
* Get a specific contact group owned by the authenticated user by specifying
|
|
* a contact group resource name.
|
|
*/
|
|
get(request: {
|
|
/** V1 error format. */
|
|
"$.xgafv"?: string;
|
|
/** OAuth access token. */
|
|
access_token?: string;
|
|
/** Data format for response. */
|
|
alt?: string;
|
|
/** OAuth bearer token. */
|
|
bearer_token?: string;
|
|
/** JSONP */
|
|
callback?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: 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. */
|
|
key?: string;
|
|
/** Specifies the maximum number of members to return. */
|
|
maxMembers?: number;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Pretty-print response. */
|
|
pp?: boolean;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/** 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. */
|
|
quotaUser?: string;
|
|
/** The resource name of the contact group to get. */
|
|
resourceName: string;
|
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
uploadType?: string;
|
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
upload_protocol?: string;
|
|
}): Request<ContactGroup>;
|
|
/**
|
|
* List all contact groups owned by the authenticated user. Members of the
|
|
* contact groups are not populated.
|
|
*/
|
|
list(request: {
|
|
/** V1 error format. */
|
|
"$.xgafv"?: string;
|
|
/** OAuth access token. */
|
|
access_token?: string;
|
|
/** Data format for response. */
|
|
alt?: string;
|
|
/** OAuth bearer token. */
|
|
bearer_token?: string;
|
|
/** JSONP */
|
|
callback?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: 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. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** The maximum number of resources to return. */
|
|
pageSize?: number;
|
|
/**
|
|
* The next_page_token value returned from a previous call to
|
|
* [ListContactGroups](/people/api/rest/v1/contactgroups/list).
|
|
* Requests the next page of resources.
|
|
*/
|
|
pageToken?: string;
|
|
/** Pretty-print response. */
|
|
pp?: boolean;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/** 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. */
|
|
quotaUser?: string;
|
|
/**
|
|
* A sync token, returned by a previous call to `contactgroups.list`.
|
|
* Only resources changed since the sync token was created will be returned.
|
|
*/
|
|
syncToken?: string;
|
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
uploadType?: string;
|
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
upload_protocol?: string;
|
|
}): Request<ListContactGroupsResponse>;
|
|
/**
|
|
* Update the name of an existing contact group owned by the authenticated
|
|
* user.
|
|
*/
|
|
update(request: {
|
|
/** V1 error format. */
|
|
"$.xgafv"?: string;
|
|
/** OAuth access token. */
|
|
access_token?: string;
|
|
/** Data format for response. */
|
|
alt?: string;
|
|
/** OAuth bearer token. */
|
|
bearer_token?: string;
|
|
/** JSONP */
|
|
callback?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: 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. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Pretty-print response. */
|
|
pp?: boolean;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/** 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. */
|
|
quotaUser?: string;
|
|
/**
|
|
* The resource name for the contact group, assigned by the server. An ASCII
|
|
* string, in the form of `contactGroups/`<var>contact_group_id</var>.
|
|
*/
|
|
resourceName: string;
|
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
uploadType?: string;
|
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
upload_protocol?: string;
|
|
}): Request<ContactGroup>;
|
|
members: MembersResource;
|
|
}
|
|
interface ConnectionsResource {
|
|
/**
|
|
* 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.
|
|
*/
|
|
list(request: {
|
|
/** V1 error format. */
|
|
"$.xgafv"?: string;
|
|
/** OAuth access token. */
|
|
access_token?: string;
|
|
/** Data format for response. */
|
|
alt?: string;
|
|
/** OAuth bearer token. */
|
|
bearer_token?: string;
|
|
/** JSONP */
|
|
callback?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: 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. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/**
|
|
* The number of connections to include in the response. Valid values are
|
|
* between 1 and 2000, inclusive. Defaults to 100.
|
|
*/
|
|
pageSize?: number;
|
|
/** The token of the page to be returned. */
|
|
pageToken?: string;
|
|
/**
|
|
* **Required.** A field mask to restrict which fields on each person are
|
|
* returned. 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
|
|
* * skills
|
|
* * taglines
|
|
* * urls
|
|
*/
|
|
personFields?: string;
|
|
/** Pretty-print response. */
|
|
pp?: boolean;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/** 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. */
|
|
quotaUser?: string;
|
|
/**
|
|
* **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`.
|
|
*/
|
|
"requestMask.includeField"?: string;
|
|
/**
|
|
* Whether the response should include a sync token, which can be used to get
|
|
* all changes since the last request.
|
|
*/
|
|
requestSyncToken?: boolean;
|
|
/** The resource name to return connections for. Only `people/me` is valid. */
|
|
resourceName: string;
|
|
/**
|
|
* The order in which the connections should be sorted. Defaults to
|
|
* `LAST_MODIFIED_ASCENDING`.
|
|
*/
|
|
sortOrder?: string;
|
|
/**
|
|
* A sync token, returned by a previous call to `people.connections.list`.
|
|
* Only resources changed since the sync token was created will be returned.
|
|
*/
|
|
syncToken?: string;
|
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
uploadType?: string;
|
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
upload_protocol?: string;
|
|
}): Request<ListConnectionsResponse>;
|
|
}
|
|
interface PeopleResource {
|
|
/** Create a new contact and return the person resource for that contact. */
|
|
createContact(request: {
|
|
/** V1 error format. */
|
|
"$.xgafv"?: string;
|
|
/** OAuth access token. */
|
|
access_token?: string;
|
|
/** Data format for response. */
|
|
alt?: string;
|
|
/** OAuth bearer token. */
|
|
bearer_token?: string;
|
|
/** JSONP */
|
|
callback?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: 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. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** The resource name of the owning person resource. */
|
|
parent?: string;
|
|
/** Pretty-print response. */
|
|
pp?: boolean;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/** 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. */
|
|
quotaUser?: string;
|
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
uploadType?: string;
|
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
upload_protocol?: string;
|
|
}): Request<Person>;
|
|
/** Delete a contact person. Any non-contact data will not be deleted. */
|
|
deleteContact(request: {
|
|
/** V1 error format. */
|
|
"$.xgafv"?: string;
|
|
/** OAuth access token. */
|
|
access_token?: string;
|
|
/** Data format for response. */
|
|
alt?: string;
|
|
/** OAuth bearer token. */
|
|
bearer_token?: string;
|
|
/** JSONP */
|
|
callback?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: 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. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Pretty-print response. */
|
|
pp?: boolean;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/** 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. */
|
|
quotaUser?: string;
|
|
/** The resource name of the contact to delete. */
|
|
resourceName: string;
|
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
uploadType?: string;
|
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
upload_protocol?: string;
|
|
}): Request<{}>;
|
|
/**
|
|
* 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.
|
|
*/
|
|
get(request: {
|
|
/** V1 error format. */
|
|
"$.xgafv"?: string;
|
|
/** OAuth access token. */
|
|
access_token?: string;
|
|
/** Data format for response. */
|
|
alt?: string;
|
|
/** OAuth bearer token. */
|
|
bearer_token?: string;
|
|
/** JSONP */
|
|
callback?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: 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. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/**
|
|
* **Required.** A field mask to restrict which fields on the person are
|
|
* returned. 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
|
|
* * skills
|
|
* * taglines
|
|
* * urls
|
|
*/
|
|
personFields?: string;
|
|
/** Pretty-print response. */
|
|
pp?: boolean;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/** 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. */
|
|
quotaUser?: string;
|
|
/**
|
|
* **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`.
|
|
*/
|
|
"requestMask.includeField"?: string;
|
|
/**
|
|
* 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).
|
|
*/
|
|
resourceName: string;
|
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
uploadType?: string;
|
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
upload_protocol?: string;
|
|
}): Request<Person>;
|
|
/**
|
|
* 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.
|
|
*/
|
|
getBatchGet(request: {
|
|
/** V1 error format. */
|
|
"$.xgafv"?: string;
|
|
/** OAuth access token. */
|
|
access_token?: string;
|
|
/** Data format for response. */
|
|
alt?: string;
|
|
/** OAuth bearer token. */
|
|
bearer_token?: string;
|
|
/** JSONP */
|
|
callback?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: 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. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/**
|
|
* **Required.** A field mask to restrict which fields on each person are
|
|
* returned. 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
|
|
* * skills
|
|
* * taglines
|
|
* * urls
|
|
*/
|
|
personFields?: string;
|
|
/** Pretty-print response. */
|
|
pp?: boolean;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/** 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. */
|
|
quotaUser?: string;
|
|
/**
|
|
* **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`.
|
|
*/
|
|
"requestMask.includeField"?: string;
|
|
/**
|
|
* 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.
|
|
*/
|
|
resourceNames?: string;
|
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
uploadType?: string;
|
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
upload_protocol?: string;
|
|
}): Request<GetPeopleResponse>;
|
|
/**
|
|
* 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 412 error 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.
|
|
*/
|
|
updateContact(request: {
|
|
/** V1 error format. */
|
|
"$.xgafv"?: string;
|
|
/** OAuth access token. */
|
|
access_token?: string;
|
|
/** Data format for response. */
|
|
alt?: string;
|
|
/** OAuth bearer token. */
|
|
bearer_token?: string;
|
|
/** JSONP */
|
|
callback?: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: 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. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Pretty-print response. */
|
|
pp?: boolean;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/** 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. */
|
|
quotaUser?: string;
|
|
/**
|
|
* 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>.
|
|
*/
|
|
resourceName: string;
|
|
/**
|
|
* **Required.** A field mask to restrict which fields on the person are
|
|
* updated. Valid values are:
|
|
*
|
|
* * addresses
|
|
* * biographies
|
|
* * birthdays
|
|
* * braggingRights
|
|
* * emailAddresses
|
|
* * events
|
|
* * genders
|
|
* * imClients
|
|
* * interests
|
|
* * locales
|
|
* * names
|
|
* * nicknames
|
|
* * occupations
|
|
* * organizations
|
|
* * phoneNumbers
|
|
* * relations
|
|
* * residences
|
|
* * skills
|
|
* * urls
|
|
*/
|
|
updatePersonFields?: string;
|
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
uploadType?: string;
|
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
upload_protocol?: string;
|
|
}): Request<Person>;
|
|
connections: ConnectionsResource;
|
|
}
|
|
}
|
|
}
|