googleapis
Version:
Google APIs Client Library for Node.js
1,337 lines • 73.2 kB
TypeScript
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace people_v1 {
interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: 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;
/**
* 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;
}
/**
* People API
*
* Provides access to information about profiles and contacts.
*
* @example
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* @namespace people
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for People
*/
class People {
context: APIRequestContext;
contactGroups: Resource$Contactgroups;
people: Resource$People;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A person's physical address. May be a P.O. box or street address. All fields are optional.
*/
interface Schema$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?: Schema$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 one of these predefined values: * `home` * `work` * `other`
*/
type?: string;
}
/**
* A person's age range.
*/
interface Schema$AgeRangeType {
/**
* The age range.
*/
ageRange?: string;
/**
* Metadata about the age range.
*/
metadata?: Schema$FieldMetadata;
}
/**
* The response to a batch get contact groups request.
*/
interface Schema$BatchGetContactGroupsResponse {
/**
* The list of responses for each requested contact group resource.
*/
responses?: Schema$ContactGroupResponse[];
}
/**
* A person's short biography.
*/
interface Schema$Biography {
/**
* The content type of the biography.
*/
contentType?: string;
/**
* Metadata about the biography.
*/
metadata?: Schema$FieldMetadata;
/**
* The short biography.
*/
value?: string;
}
/**
* A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
*/
interface Schema$Birthday {
/**
* The date of the birthday.
*/
date?: Schema$Date;
/**
* Metadata about the birthday.
*/
metadata?: Schema$FieldMetadata;
/**
* A free-form string representing the user's birthday.
*/
text?: string;
}
/**
* A person's bragging rights.
*/
interface Schema$BraggingRights {
/**
* Metadata about the bragging rights.
*/
metadata?: Schema$FieldMetadata;
/**
* The bragging rights; for example, `climbed mount everest`.
*/
value?: string;
}
/**
* A contact group.
*/
interface Schema$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?: Schema$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;
}
/**
* A Google contact group membership.
*/
interface Schema$ContactGroupMembership {
/**
* The read-only contact group ID for the contact group membership.
*/
contactGroupId?: 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>. 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 contact must always have at least one contact group membership.
*/
contactGroupResourceName?: string;
}
/**
* The read-only metadata about a contact group.
*/
interface Schema$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;
}
/**
* The response for a specific contact group.
*/
interface Schema$ContactGroupResponse {
/**
* The contact group.
*/
contactGroup?: Schema$ContactGroup;
/**
* The original requested resource name.
*/
requestedResourceName?: string;
/**
* The status of the response.
*/
status?: Schema$Status;
}
/**
* A person's read-only cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
*/
interface Schema$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?: Schema$FieldMetadata;
/**
* The URL of the cover photo.
*/
url?: string;
}
/**
* A request to create a new contact group.
*/
interface Schema$CreateContactGroupRequest {
/**
* The contact group to create.
*/
contactGroup?: Schema$ContactGroup;
}
/**
* Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date.
*/
interface Schema$Date {
/**
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
*/
day?: number;
/**
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
*/
month?: number;
/**
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
*/
year?: number;
}
/**
* A read-only G Suite Domain membership.
*/
interface Schema$DomainMembership {
/**
* True if the person is in the viewer's G Suite domain.
*/
inViewerDomain?: boolean;
}
/**
* A person's email address.
*/
interface Schema$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?: Schema$FieldMetadata;
/**
* The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
*/
type?: string;
/**
* The email address.
*/
value?: string;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
interface Schema$Empty {
}
/**
* An event related to the person.
*/
interface Schema$Event {
/**
* The date of the event.
*/
date?: Schema$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?: Schema$FieldMetadata;
/**
* The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`
*/
type?: string;
}
/**
* Metadata about a field.
*/
interface Schema$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?: Schema$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;
}
/**
* A person's gender.
*/
interface Schema$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?: Schema$FieldMetadata;
/**
* The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `other` * `unknown`
*/
value?: string;
}
interface Schema$GetPeopleResponse {
/**
* The response for each requested resource name.
*/
responses?: Schema$PersonResponse[];
}
/**
* A person's instant messaging client.
*/
interface Schema$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?: Schema$FieldMetadata;
/**
* The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
*/
protocol?: string;
/**
* The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
*/
type?: string;
/**
* The user name used in the IM client.
*/
username?: string;
}
/**
* One of the person's interests.
*/
interface Schema$Interest {
/**
* Metadata about the interest.
*/
metadata?: Schema$FieldMetadata;
/**
* The interest; for example, `stargazing`.
*/
value?: string;
}
interface Schema$ListConnectionsResponse {
/**
* The list of people that the requestor is connected to.
*/
connections?: Schema$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;
}
/**
* The response to a list contact groups request.
*/
interface Schema$ListContactGroupsResponse {
/**
* The list of contact groups. Members of the contact groups are not populated.
*/
contactGroups?: Schema$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;
}
/**
* A person's locale preference.
*/
interface Schema$Locale {
/**
* Metadata about the locale.
*/
metadata?: Schema$FieldMetadata;
/**
* The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
*/
value?: string;
}
/**
* A person's membership in a group. Only contact group memberships can be modified.
*/
interface Schema$Membership {
/**
* The contact group membership.
*/
contactGroupMembership?: Schema$ContactGroupMembership;
/**
* The read-only domain membership.
*/
domainMembership?: Schema$DomainMembership;
/**
* Metadata about the membership.
*/
metadata?: Schema$FieldMetadata;
}
/**
* A request to modify an existing contact group's members. Contacts can be removed from any group but they can only be added to a user group or "myContacts" or "starred" system groups.
*/
interface Schema$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[];
}
/**
* The response to a modify contact group members request.
*/
interface Schema$ModifyContactGroupMembersResponse {
/**
* The contact people resource names that were not found.
*/
notFoundResourceNames?: string[];
}
/**
* A person's name. If the name is a mononym, the family name is empty.
*/
interface Schema$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?: Schema$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;
}
/**
* A person's nickname.
*/
interface Schema$Nickname {
/**
* Metadata about the nickname.
*/
metadata?: Schema$FieldMetadata;
/**
* The type of the nickname.
*/
type?: string;
/**
* The nickname.
*/
value?: string;
}
/**
* A person's occupation.
*/
interface Schema$Occupation {
/**
* Metadata about the occupation.
*/
metadata?: Schema$FieldMetadata;
/**
* The occupation; for example, `carpenter`.
*/
value?: string;
}
/**
* A person's past or current organization. Overlapping date ranges are permitted.
*/
interface Schema$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?: Schema$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?: Schema$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?: Schema$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 one of these predefined values: * `work` * `school`
*/
type?: string;
}
/**
* Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
*/
interface Schema$Person {
/**
* The person's street addresses.
*/
addresses?: Schema$Address[];
/**
* **DEPRECATED** (Please use `person.ageRanges` instead)** The person's read-only age range.
*/
ageRange?: string;
/**
* The person's read-only age ranges.
*/
ageRanges?: Schema$AgeRangeType[];
/**
* The person's biographies.
*/
biographies?: Schema$Biography[];
/**
* The person's birthdays.
*/
birthdays?: Schema$Birthday[];
/**
* The person's bragging rights.
*/
braggingRights?: Schema$BraggingRights[];
/**
* The person's read-only cover photos.
*/
coverPhotos?: Schema$CoverPhoto[];
/**
* The person's email addresses.
*/
emailAddresses?: Schema$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?: Schema$Event[];
/**
* The person's genders.
*/
genders?: Schema$Gender[];
/**
* The person's instant messaging clients.
*/
imClients?: Schema$ImClient[];
/**
* The person's interests.
*/
interests?: Schema$Interest[];
/**
* The person's locale preferences.
*/
locales?: Schema$Locale[];
/**
* The person's group memberships.
*/
memberships?: Schema$Membership[];
/**
* Read-only metadata about the person.
*/
metadata?: Schema$PersonMetadata;
/**
* The person's names.
*/
names?: Schema$Name[];
/**
* The person's nicknames.
*/
nicknames?: Schema$Nickname[];
/**
* The person's occupations.
*/
occupations?: Schema$Occupation[];
/**
* The person's past or current organizations.
*/
organizations?: Schema$Organization[];
/**
* The person's phone numbers.
*/
phoneNumbers?: Schema$PhoneNumber[];
/**
* The person's read-only photos.
*/
photos?: Schema$Photo[];
/**
* The person's relations.
*/
relations?: Schema$Relation[];
/**
* The person's read-only relationship interests.
*/
relationshipInterests?: Schema$RelationshipInterest[];
/**
* The person's read-only relationship statuses.
*/
relationshipStatuses?: Schema$RelationshipStatus[];
/**
* The person's residences.
*/
residences?: Schema$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 SIP addresses.
*/
sipAddresses?: Schema$SipAddress[];
/**
* The person's skills.
*/
skills?: Schema$Skill[];
/**
* The person's read-only taglines.
*/
taglines?: Schema$Tagline[];
/**
* The person's associated URLs.
*/
urls?: Schema$Url[];
/**
* The person's user defined data.
*/
userDefined?: Schema$UserDefined[];
}
/**
* The read-only metadata about a person.
*/
interface Schema$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?: Schema$Source[];
}
/**
* The response for a single person
*/
interface Schema$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?: Schema$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?: Schema$Status;
}
/**
* A person's phone number.
*/
interface Schema$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?: Schema$FieldMetadata;
/**
* The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
*/
type?: string;
/**
* The phone number.
*/
value?: string;
}
/**
* A person's read-only photo. A picture shown next to the person's name to help others recognize the person.
*/
interface Schema$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?: Schema$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;
}
/**
* The read-only metadata about a profile.
*/
interface Schema$ProfileMetadata {
/**
* The profile object type.
*/
objectType?: string;
/**
* The user types.
*/
userTypes?: string[];
}
/**
* A person's relation to another person.
*/
interface Schema$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?: Schema$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 one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
*/
type?: string;
}
/**
* A person's read-only relationship interest .
*/
interface Schema$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?: Schema$FieldMetadata;
/**
* The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`
*/
value?: string;
}
/**
* A person's read-only relationship status.
*/
interface Schema$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?: Schema$FieldMetadata;
/**
* The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
*/
value?: string;
}
/**
* A person's past or current residence.
*/
interface Schema$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?: Schema$FieldMetadata;
/**
* The address of the residence.
*/
value?: string;
}
/**
* A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
*/
interface Schema$SipAddress {
/**
* The read-only type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string;
/**
* Metadata about the SIP address.
*/
metadata?: Schema$FieldMetadata;
/**
* The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`
*/
type?: string;
/**
* The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
*/
value?: string;
}
/**
* A skill that the person has.
*/
interface Schema$Skill {
/**
* Metadata about the skill.
*/
metadata?: Schema$FieldMetadata;
/**
* The skill; for example, `underwater basket weaving`.
*/
value?: string;
}
/**
* The source of a field.
*/
interface Schema$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?: Schema$ProfileMetadata;
/**
* The source type.
*/
type?: string;
/**
* **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
*/
updateTime?: string;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
interface Schema$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<{
[key: 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;
}
/**
* A read-only brief one-line description of the person.
*/
interface Schema$Tagline {
/**
* Metadata about the tagline.
*/
metadata?: Schema$FieldMetadata;
/**
* The tagline.
*/
value?: string;
}
/**
* A request to update an existing user contact group. All updated fields will be replaced.
*/
interface Schema$UpdateContactGroupRequest {
/**
* The contact group to update.
*/
contactGroup?: Schema$ContactGroup;
}
/**
* A person's associated URLs.
*/
interface Schema$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?: Schema$FieldMetadata;
/**
* The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`
*/
type?: string;
/**
* The URL.
*/
value?: string;
}
/**
* Arbitrary user data that is populated by the end users.
*/
interface Schema$UserDefined {
/**
* The end user specified key of the user defined data.
*/
key?: string;
/**
* Metadata about the user defined data.
*/
metadata?: Schema$FieldMetadata;
/**
* The end user specified value of the user defined data.
*/
value?: string;
}
class Resource$Contactgroups {
context: APIRequestContext;
members: Resource$Contactgroups$Members;
constructor(context: APIRequestContext);
/**
* people.contactGroups.batchGet
* @desc Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
* @alias people.contactGroups.batchGet
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.maxMembers Specifies the maximum number of members to return for each group.
* @param {string=} params.resourceNames The resource names of the contact groups to get.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchGet(params?: Params$Resource$Contactgroups$Batchget, options?: MethodOptions): GaxiosPromise<Schema$BatchGetContactGroupsResponse>;
batchGet(params: Params$Resource$Contactgroups$Batchget, options: MethodOptions | BodyResponseCallback<Schema$BatchGetContactGroupsResponse>, callback: BodyResponseCallback<Schema$BatchGetContactGroupsResponse>): void;
batchGet(params: Params$Resource$Contactgroups$Batchget, callback: BodyResponseCallback<Schema$BatchGetContactGroupsResponse>): void;
batchGet(callback: BodyResponseCallback<Schema$BatchGetContactGroupsResponse>): void;
/**
* people.contactGroups.create
* @desc Create a new contact group owned by the authenticated user.
* @alias people.contactGroups.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().CreateContactGroupRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Contactgroups$Create, options?: MethodOptions): GaxiosPromise<Schema$ContactGroup>;
create(params: Params$Resource$Contactgroups$Create, options: MethodOptions | BodyResponseCallback<Schema$ContactGroup>, callback: BodyResponseCallback<Schema$ContactGroup>): void;
create(params: Params$Resource$Contactgroups$Create, callback: BodyResponseCallback<Schema$ContactGroup>): void;
create(callback: BodyResponseCallback<Schema$ContactGroup>): void;
/**
* people.contactGroups.delete
* @desc Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.
* @alias people.contactGroups.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.deleteContacts Set to true to also delete the contacts in the specified group.
* @param {string} params.resourceName The resource name of the contact group to delete.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Contactgroups$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Contactgroups$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Contactgroups$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* people.contactGroups.get
* @desc Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
* @alias people.contactGroups.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.maxMembers Specifies the maximum number of members to return.
* @param {string} params.resourceName The resource name of the contact group to get.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Contactgroups$Get, options?: MethodOptions): GaxiosPromise<Schema$ContactGroup>;
get(params: Params$Resource$Contactgroups$Get, options: MethodOptions | BodyResponseCallback<Schema$ContactGroup>, callback: BodyResponseCallback<Schema$ContactGroup>): void;
get(params: Params$Resource$Contactgroups$Get, callback: BodyResponseCallback<Schema$ContactGroup>): void;
get(callback: BodyResponseCallback<Schema$ContactGroup>): void;
/**
* people.contactGroups.list
* @desc List all contact groups owned by the authenticated user. Members of the contact groups are not populated.
* @alias people.contactGroups.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of resources to return.
* @param {string=} params.pageToken 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=} params.syncToken A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Contactgroups$List, options?: MethodOptions): GaxiosPromise<Schema$ListContactGroupsResponse>;
list(params: Params$Resource$Contactgroups$List, options: MethodOptions | BodyResponseCallback<Schema$ListContactGroupsResponse>, callback: BodyResponseCallback<Schema$ListContactGroupsResponse>): void;
list(params: Params$Resource$Contactgroups$List, callback: BodyResponseCallback<Schema$ListContactGroupsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListContactGroupsResponse>): void;
/**
* people.contactGroups.update
* @desc Update the name of an existing contact group owned by the authenticated user.
* @alias people.contactGroups.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resourceName The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/`<var>contact_group_id</var>.
* @param {().UpdateContactGroupRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Contactgroups$Update, options?: MethodOptions): GaxiosPromise<Schema$ContactGroup>;
update(params: Params$Resource$Contactgroups$Update, options: MethodOptions | BodyResponseCallback<Schema$ContactGroup>, callback: BodyResponseCallback<Schema$ContactGroup>): void;
update(params: Params$Resource$Contactgroups$Update, callback: BodyResponseCallback<Schema$ContactGroup>): void;
update(callback: BodyResponseCallback<Schema$ContactGroup>): void;
}
interface Params$Resource$Contactgroups$Batchget extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Specifies the maximum number of members to return for each group.
*/
maxMembers?: number;
/**
* The resource names of the contact groups to get.
*/
resourceNames?: string[];
}
interface Params$Resource$Contactgroups$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$CreateContactGroupRequest;
}
interface Params$Resource$Contactgroups$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Set to true to also delete the contacts in the specified group.
*/
deleteContacts?: boolean;
/**
* The resource name of the contact group to delete.
*/
resourceName?: string;
}
interface Params$Resource$Contactgroups$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Specifies the maximum number of members to return.
*/
maxMembers?: number;
/**
* The resource name of the contact group to get.
*/
resourceName?: string;
}
interface Params$Resource$Contactgroups$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of resources to return.
*/
pageSize?: number;
/**
* The next_page_token value returned from a previous call to [ListContactGroups