src/apis/people/v1.ts
Properties |
| pageSize |
pageSize:
|
Type : number
|
| Optional |
|
Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30. |
| query |
query:
|
Type : string
|
| Optional |
|
Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n". |
| readMask |
readMask:
|
Type : string
|
| Optional |
|
Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * metadata * names * phoneNumbers |
import {
OAuth2Client,
JWT,
Compute,
UserRefreshClient,
BaseExternalAccountClient,
GaxiosPromise,
GoogleConfigurable,
createAPIRequest,
MethodOptions,
StreamMethodOptions,
GlobalOptions,
GoogleAuth,
BodyResponseCallback,
APIRequestContext,
} from 'googleapis-common';
import {Readable} from 'stream';
export namespace people_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?:
| string
| OAuth2Client
| JWT
| Compute
| UserRefreshClient
| BaseExternalAccountClient
| GoogleAuth;
/**
* 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
* ```js
* const {google} = require('googleapis');
* const people = google.people('v1');
* ```
*/
export class People {
context: APIRequestContext;
contactGroups: Resource$Contactgroups;
otherContacts: Resource$Othercontacts;
people: Resource$People;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this.context = {
_options: options || {},
google,
};
this.contactGroups = new Resource$Contactgroups(this.context);
this.otherContacts = new Resource$Othercontacts(this.context);
this.people = new Resource$People(this.context);
}
}
/**
* A person's physical address. May be a P.O. box or street address. All fields are optional.
*/
export interface Schema$Address {
/**
* The city of the address.
*/
city?: string | null;
/**
* The country of the address.
*/
country?: string | null;
/**
* The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
*/
countryCode?: string | null;
/**
* The extended address of the address; for example, the apartment number.
*/
extendedAddress?: string | null;
/**
* Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string | null;
/**
* The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
*/
formattedValue?: string | null;
/**
* Metadata about the address.
*/
metadata?: Schema$FieldMetadata;
/**
* The P.O. box of the address.
*/
poBox?: string | null;
/**
* The postal code of the address.
*/
postalCode?: string | null;
/**
* The region of the address; for example, the state or province.
*/
region?: string | null;
/**
* The street address.
*/
streetAddress?: string | null;
/**
* The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`
*/
type?: string | null;
}
/**
* A person's age range.
*/
export interface Schema$AgeRangeType {
/**
* The age range.
*/
ageRange?: string | null;
/**
* Metadata about the age range.
*/
metadata?: Schema$FieldMetadata;
}
/**
* A request to create a batch of contacts.
*/
export interface Schema$BatchCreateContactsRequest {
/**
* Required. The contact to create. Allows up to 200 contacts in a single request.
*/
contacts?: Schema$ContactToCreate[];
/**
* Required. A field mask to restrict which fields on each person are returned in the response. Multiple fields can be specified by separating them with commas. If read mask is left empty, the post-mutate-get is skipped and no data will be returned in the response. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
readMask?: string | null;
/**
* Optional. A mask of what source types to return in the post mutate read. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
*/
sources?: string[] | null;
}
/**
* If not successful, returns BatchCreateContactsErrorDetails which contains a list of errors for each invalid contact. The response to a request to create a batch of contacts.
*/
export interface Schema$BatchCreateContactsResponse {
/**
* The contacts that were created, unless the request `read_mask` is empty.
*/
createdPeople?: Schema$PersonResponse[];
}
/**
* A request to delete a batch of existing contacts.
*/
export interface Schema$BatchDeleteContactsRequest {
/**
* Required. The resource names of the contact to delete. It's repeatable. Allows up to 500 resource names in a single request.
*/
resourceNames?: string[] | null;
}
/**
* The response to a batch get contact groups request.
*/
export interface Schema$BatchGetContactGroupsResponse {
/**
* The list of responses for each requested contact group resource.
*/
responses?: Schema$ContactGroupResponse[];
}
/**
* A request to update a batch of contacts.
*/
export interface Schema$BatchUpdateContactsRequest {
/**
* Required. A map of resource names to the person data to be updated. Allows up to 200 contacts in a single request.
*/
contacts?: {[key: string]: Schema$Person} | null;
/**
* Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. If read mask is left empty, the post-mutate-get is skipped and no data will be returned in the response. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
readMask?: string | null;
/**
* Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
*/
sources?: string[] | null;
/**
* Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All specified fields will be replaced, or cleared if left empty for each person. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined
*/
updateMask?: string | null;
}
/**
* If not successful, returns BatchUpdateContactsErrorDetails, a list of errors corresponding to each contact. The response to a request to update a batch of contacts.
*/
export interface Schema$BatchUpdateContactsResponse {
/**
* A map of resource names to the contacts that were updated, unless the request `read_mask` is empty.
*/
updateResult?: {[key: string]: Schema$PersonResponse} | null;
}
/**
* A person's short biography.
*/
export interface Schema$Biography {
/**
* The content type of the biography.
*/
contentType?: string | null;
/**
* Metadata about the biography.
*/
metadata?: Schema$FieldMetadata;
/**
* The short biography.
*/
value?: string | null;
}
/**
* 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.
*/
export 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 | null;
}
/**
* **DEPRECATED**: No data will be returned A person's bragging rights.
*/
export interface Schema$BraggingRights {
/**
* Metadata about the bragging rights.
*/
metadata?: Schema$FieldMetadata;
/**
* The bragging rights; for example, `climbed mount everest`.
*/
value?: string | null;
}
/**
* A person's calendar URL.
*/
export interface Schema$CalendarUrl {
/**
* Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string | null;
/**
* Metadata about the calendar URL.
*/
metadata?: Schema$FieldMetadata;
/**
* The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`
*/
type?: string | null;
/**
* The calendar URL.
*/
url?: string | null;
}
/**
* Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
*/
export interface Schema$ClientData {
/**
* The client specified key of the client data.
*/
key?: string | null;
/**
* Metadata about the client data.
*/
metadata?: Schema$FieldMetadata;
/**
* The client specified value of the client data.
*/
value?: string | null;
}
/**
* A contact group.
*/
export interface Schema$ContactGroup {
/**
* The group's client data.
*/
clientData?: Schema$GroupClientData[];
/**
* The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
*/
etag?: string | null;
/**
* Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
*/
formattedName?: string | null;
/**
* Output only. The contact group type.
*/
groupType?: string | null;
/**
* Output only. The total number of contacts in the group irrespective of max members in specified in the request.
*/
memberCount?: number | null;
/**
* Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
*/
memberResourceNames?: string[] | null;
/**
* Output only. 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. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
*/
name?: string | null;
/**
* The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id\}`.
*/
resourceName?: string | null;
}
/**
* A Google contact group membership.
*/
export interface Schema$ContactGroupMembership {
/**
* Output only. The contact group ID for the contact group membership.
*/
contactGroupId?: string | null;
/**
* The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id\}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.
*/
contactGroupResourceName?: string | null;
}
/**
* The metadata about a contact group.
*/
export interface Schema$ContactGroupMetadata {
/**
* Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
*/
deleted?: boolean | null;
/**
* Output only. The time the group was last updated.
*/
updateTime?: string | null;
}
/**
* The response for a specific contact group.
*/
export interface Schema$ContactGroupResponse {
/**
* The contact group.
*/
contactGroup?: Schema$ContactGroup;
/**
* The original requested resource name.
*/
requestedResourceName?: string | null;
/**
* The status of the response.
*/
status?: Schema$Status;
}
/**
* A wrapper that contains the person data to populate a newly created source.
*/
export interface Schema$ContactToCreate {
/**
* Required. The person data to populate a newly created source.
*/
contactPerson?: Schema$Person;
}
/**
* A request to copy an "Other contact" to my contacts group.
*/
export interface Schema$CopyOtherContactToMyContactsGroupRequest {
/**
* Required. A field mask to restrict which fields are copied into the new contact. Valid values are: * emailAddresses * names * phoneNumbers
*/
copyMask?: string | null;
/**
* Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to the copy mask with metadata and membership fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
readMask?: string | null;
/**
* Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
*/
sources?: string[] | null;
}
/**
* A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
*/
export 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 | null;
/**
* Metadata about the cover photo.
*/
metadata?: Schema$FieldMetadata;
/**
* The URL of the cover photo.
*/
url?: string | null;
}
/**
* A request to create a new contact group.
*/
export interface Schema$CreateContactGroupRequest {
/**
* Required. The contact group to create.
*/
contactGroup?: Schema$ContactGroup;
/**
* Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * metadata * name
*/
readGroupFields?: string | null;
}
/**
* Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
export interface Schema$Date {
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
day?: number | null;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
month?: number | null;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
year?: number | null;
}
/**
* The response for deleting a contact's photo.
*/
export interface Schema$DeleteContactPhotoResponse {
/**
* The updated person, if person_fields is set in the DeleteContactPhotoRequest; otherwise this will be unset.
*/
person?: Schema$Person;
}
/**
* A Google Workspace Domain membership.
*/
export interface Schema$DomainMembership {
/**
* True if the person is in the viewer's Google Workspace domain.
*/
inViewerDomain?: boolean | null;
}
/**
* A person's email address.
*/
export interface Schema$EmailAddress {
/**
* The display name of the email.
*/
displayName?: string | null;
/**
* Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string | null;
/**
* 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 | null;
/**
* The email address.
*/
value?: string | null;
}
/**
* 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 `{\}`.
*/
export interface Schema$Empty {}
/**
* An event related to the person.
*/
export interface Schema$Event {
/**
* The date of the event.
*/
date?: Schema$Date;
/**
* Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string | null;
/**
* 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 | null;
}
/**
* An identifier from an external entity related to the person.
*/
export interface Schema$ExternalId {
/**
* Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string | null;
/**
* Metadata about the external ID.
*/
metadata?: Schema$FieldMetadata;
/**
* The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
*/
type?: string | null;
/**
* The value of the external ID.
*/
value?: string | null;
}
/**
* Metadata about a field.
*/
export interface Schema$FieldMetadata {
/**
* Output only. True if the field is the primary field for all sources in the person. Each person will have at most one field with `primary` set to true.
*/
primary?: boolean | null;
/**
* The source of the field.
*/
source?: Schema$Source;
/**
* True if the field is the primary field for the source. Each source must have at most one field with `source_primary` set to true.
*/
sourcePrimary?: boolean | null;
/**
* Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
*/
verified?: boolean | null;
}
/**
* The name that should be used to sort the person in a list.
*/
export interface Schema$FileAs {
/**
* Metadata about the file-as.
*/
metadata?: Schema$FieldMetadata;
/**
* The file-as value
*/
value?: string | null;
}
/**
* A person's gender.
*/
export interface Schema$Gender {
/**
* Free form text field for pronouns that should be used to address the person. Common values are: * `he`/`him` * `she`/`her` * `they`/`them`
*/
addressMeAs?: string | null;
/**
* Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.
*/
formattedValue?: string | null;
/**
* 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` * `unspecified`
*/
value?: string | null;
}
/**
* The response to a get request for a list of people by resource name.
*/
export interface Schema$GetPeopleResponse {
/**
* The response for each requested resource name.
*/
responses?: Schema$PersonResponse[];
}
/**
* Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
*/
export interface Schema$GroupClientData {
/**
* The client specified key of the client data.
*/
key?: string | null;
/**
* The client specified value of the client data.
*/
value?: string | null;
}
/**
* A person's instant messaging client.
*/
export interface Schema$ImClient {
/**
* Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedProtocol?: string | null;
/**
* Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string | null;
/**
* 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 | null;
/**
* The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`
*/
type?: string | null;
/**
* The user name used in the IM client.
*/
username?: string | null;
}
/**
* One of the person's interests.
*/
export interface Schema$Interest {
/**
* Metadata about the interest.
*/
metadata?: Schema$FieldMetadata;
/**
* The interest; for example, `stargazing`.
*/
value?: string | null;
}
/**
* The response to a request for the authenticated user's connections.
*/
export interface Schema$ListConnectionsResponse {
/**
* The list of people that the requestor is connected to.
*/
connections?: Schema$Person[];
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token. When the response is paginated, only the last page will contain `nextSyncToken`.
*/
nextSyncToken?: string | null;
/**
* The total number of items in the list without pagination.
*/
totalItems?: number | null;
/**
* **DEPRECATED** (Please use totalItems) The total number of people in the list without pagination.
*/
totalPeople?: number | null;
}
/**
* The response to a list contact groups request.
*/
export 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 | null;
/**
* The token that can be used to retrieve changes since the last request.
*/
nextSyncToken?: string | null;
/**
* The total number of items in the list without pagination.
*/
totalItems?: number | null;
}
/**
* The response to a request for the authenticated user's domain directory.
*/
export interface Schema$ListDirectoryPeopleResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token.
*/
nextSyncToken?: string | null;
/**
* The list of people in the domain directory.
*/
people?: Schema$Person[];
}
/**
* The response to a request for the authenticated user's "Other contacts".
*/
export interface Schema$ListOtherContactsResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token.
*/
nextSyncToken?: string | null;
/**
* The list of "Other contacts" returned as Person resources. "Other contacts" support a limited subset of fields. See ListOtherContactsRequest.request_mask for more detailed information.
*/
otherContacts?: Schema$Person[];
/**
* The total number of other contacts in the list without pagination.
*/
totalSize?: number | null;
}
/**
* A person's locale preference.
*/
export 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 | null;
}
/**
* A person's location.
*/
export interface Schema$Location {
/**
* The building identifier.
*/
buildingId?: string | null;
/**
* Whether the location is the current location.
*/
current?: boolean | null;
/**
* The individual desk location.
*/
deskCode?: string | null;
/**
* The floor name or number.
*/
floor?: string | null;
/**
* The floor section in `floor_name`.
*/
floorSection?: string | null;
/**
* Metadata about the location.
*/
metadata?: Schema$FieldMetadata;
/**
* The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`
*/
type?: string | null;
/**
* The free-form value of the location.
*/
value?: string | null;
}
/**
* A person's membership in a group. Only contact group memberships can be modified.
*/
export interface Schema$Membership {
/**
* The contact group membership.
*/
contactGroupMembership?: Schema$ContactGroupMembership;
/**
* Output only. The domain membership.
*/
domainMembership?: Schema$DomainMembership;
/**
* Metadata about the membership.
*/
metadata?: Schema$FieldMetadata;
}
/**
* A person's miscellaneous keyword.
*/
export interface Schema$MiscKeyword {
/**
* Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string | null;
/**
* Metadata about the miscellaneous keyword.
*/
metadata?: Schema$FieldMetadata;
/**
* The miscellaneous keyword type.
*/
type?: string | null;
/**
* The value of the miscellaneous keyword.
*/
value?: string | null;
}
/**
* 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.
*/
export interface Schema$ModifyContactGroupMembersRequest {
/**
* Optional. The resource names of the contact people to add in the form of `people/{person_id\}`. The total number of resource names in `resource_names_to_add` and `resource_names_to_remove` must be less than or equal to 1000.
*/
resourceNamesToAdd?: string[] | null;
/**
* Optional. The resource names of the contact people to remove in the form of `people/{person_id\}`. The total number of resource names in `resource_names_to_add` and `resource_names_to_remove` must be less than or equal to 1000.
*/
resourceNamesToRemove?: string[] | null;
}
/**
* The response to a modify contact group members request.
*/
export interface Schema$ModifyContactGroupMembersResponse {
/**
* The contact people resource names that cannot be removed from their last contact group.
*/
canNotRemoveLastContactGroupResourceNames?: string[] | null;
/**
* The contact people resource names that were not found.
*/
notFoundResourceNames?: string[] | null;
}
/**
* A person's name. If the name is a mononym, the family name is empty.
*/
export interface Schema$Name {
/**
* Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
*/
displayName?: string | null;
/**
* Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
*/
displayNameLastFirst?: string | null;
/**
* The family name.
*/
familyName?: string | null;
/**
* The given name.
*/
givenName?: string | null;
/**
* The honorific prefixes, such as `Mrs.` or `Dr.`
*/
honorificPrefix?: string | null;
/**
* The honorific suffixes, such as `Jr.`
*/
honorificSuffix?: string | null;
/**
* Metadata about the name.
*/
metadata?: Schema$FieldMetadata;
/**
* The middle name(s).
*/
middleName?: string | null;
/**
* The family name spelled as it sounds.
*/
phoneticFamilyName?: string | null;
/**
* The full name spelled as it sounds.
*/
phoneticFullName?: string | null;
/**
* The given name spelled as it sounds.
*/
phoneticGivenName?: string | null;
/**
* The honorific prefixes spelled as they sound.
*/
phoneticHonorificPrefix?: string | null;
/**
* The honorific suffixes spelled as they sound.
*/
phoneticHonorificSuffix?: string | null;
/**
* The middle name(s) spelled as they sound.
*/
phoneticMiddleName?: string | null;
/**
* The free form name value.
*/
unstructuredName?: string | null;
}
/**
* A person's nickname.
*/
export interface Schema$Nickname {
/**
* Metadata about the nickname.
*/
metadata?: Schema$FieldMetadata;
/**
* The type of the nickname.
*/
type?: string | null;
/**
* The nickname.
*/
value?: string | null;
}
/**
* A person's occupation.
*/
export interface Schema$Occupation {
/**
* Metadata about the occupation.
*/
metadata?: Schema$FieldMetadata;
/**
* The occupation; for example, `carpenter`.
*/
value?: string | null;
}
/**
* A person's past or current organization. Overlapping date ranges are permitted.
*/
export interface Schema$Organization {
/**
* The person's cost center at the organization.
*/
costCenter?: string | null;
/**
* True if the organization is the person's current organization; false if the organization is a past organization.
*/
current?: boolean | null;
/**
* The person's department at the organization.
*/
department?: string | null;
/**
* The domain name associated with the organization; for example, `google.com`.
*/
domain?: string | null;
/**
* The end date when the person left the organization.
*/
endDate?: Schema$Date;
/**
* Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string | null;
/**
* The person's full-time equivalent millipercent within the organization (100000 = 100%).
*/
fullTimeEquivalentMillipercent?: number | null;
/**
* The person's job description at the organization.
*/
jobDescription?: string | null;
/**
* The location of the organization office the person works at.
*/
location?: string | null;
/**
* Metadata about the organization.
*/
metadata?: Schema$FieldMetadata;
/**
* The name of the organization.
*/
name?: string | null;
/**
* The phonetic name of the organization.
*/
phoneticName?: string | null;
/**
* 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 | null;
/**
* The person's job title at the organization.
*/
title?: string | null;
/**
* The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`
*/
type?: string | null;
}
/**
* 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.
*/
export interface Schema$Person {
/**
* The person's street addresses.
*/
addresses?: Schema$Address[];
/**
* Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
*/
ageRange?: string | null;
/**
* Output only. The person's age ranges.
*/
ageRanges?: Schema$AgeRangeType[];
/**
* The person's biographies. This field is a singleton for contact sources.
*/
biographies?: Schema$Biography[];
/**
* The person's birthdays. This field is a singleton for contact sources.
*/
birthdays?: Schema$Birthday[];
/**
* **DEPRECATED**: No data will be returned The person's bragging rights.
*/
braggingRights?: Schema$BraggingRights[];
/**
* The person's calendar URLs.
*/
calendarUrls?: Schema$CalendarUrl[];
/**
* The person's client data.
*/
clientData?: Schema$ClientData[];
/**
* Output only. The person's cover photos.
*/
coverPhotos?: Schema$CoverPhoto[];
/**
* The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
*/
emailAddresses?: Schema$EmailAddress[];
/**
* The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
*/
etag?: string | null;
/**
* The person's events.
*/
events?: Schema$Event[];
/**
* The person's external IDs.
*/
externalIds?: Schema$ExternalId[];
/**
* The person's file-ases.
*/
fileAses?: Schema$FileAs[];
/**
* The person's genders. This field is a singleton for contact sources.
*/
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 locations.
*/
locations?: Schema$Location[];
/**
* The person's group memberships.
*/
memberships?: Schema$Membership[];
/**
* Output only. Metadata about the person.
*/
metadata?: Schema$PersonMetadata;
/**
* The person's miscellaneous keywords.
*/
miscKeywords?: Schema$MiscKeyword[];
/**
* The person's names. This field is a singleton for contact sources.
*/
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. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
*/
phoneNumbers?: Schema$PhoneNumber[];
/**
* Output only. The person's photos.
*/
photos?: Schema$Photo[];
/**
* The person's relations.
*/
relations?: Schema$Relation[];
/**
* Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
*/
relationshipInterests?: Schema$RelationshipInterest[];
/**
* Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
*/
relationshipStatuses?: Schema$RelationshipStatus[];
/**
* **DEPRECATED**: (Please use `person.locations` instead) 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/{person_id\}`.
*/
resourceName?: string | null;
/**
* The person's SIP addresses.
*/
sipAddresses?: Schema$SipAddress[];
/**
* The person's skills.
*/
skills?: Schema$Skill[];
/**
* Output only. **DEPRECATED**: No data will be returned The person's taglines.
*/
taglines?: Schema$Tagline[];
/**
* The person's associated URLs.
*/
urls?: Schema$Url[];
/**
* The person's user defined data.
*/
userDefined?: Schema$UserDefined[];
}
/**
* The metadata about a person.
*/
export interface Schema$PersonMetadata {
/**
* Output only. True if the person resource has been deleted. Populated only for `people.connections.list` and `otherContacts.list` sync requests.
*/
deleted?: boolean | null;
/**
* Output only. Resource names of people linked to this resource.
*/
linkedPeopleResourceNames?: string[] | null;
/**
* Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.
*/
objectType?: string | null;
/**
* Output only. Any former resource names this person has had. Populated only for `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[] | null;
/**
* The sources of data for the person.
*/
sources?: Schema$Source[];
}
/**
* The response for a single person
*/
export interface Schema$PersonResponse {
/**
* **DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
*/
httpStatusCode?: number | null;
/**
* 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 | null;
/**
* The status of the response.
*/
status?: Schema$Status;
}
/**
* A person's phone number.
*/
export interface Schema$PhoneNumber {
/**
* Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
*/
canonicalForm?: string | null;
/**
* Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string | null;
/**
* 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 | null;
/**
* The phone number.
*/
value?: string | null;
}
/**
* A person's photo. A picture shown next to the person's name to help others recognize the person.
*/
export interface Schema$Photo {
/**
* True if the photo is a default photo; false if the photo is a user-provided photo.
*/
default?: boolean | null;
/**
* Metadata about the photo.
*/
metadata?: Schema$FieldMetadata;
/**
* The URL of the photo. You can change the desired size by appending a query parameter `sz={size\}` at the end of the url, where {size\} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
*/
url?: string | null;
}
/**
* The metadata about a profile.
*/
export interface Schema$ProfileMetadata {
/**
* Output only. The profile object type.
*/
objectType?: string | null;
/**
* Output only. The user types.
*/
userTypes?: string[] | null;
}
/**
* A person's relation to another person.
*/
export interface Schema$Relation {
/**
* Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
*/
formattedType?: string | null;
/**
* Metadata about the relation.
*/
metadata?: Schema$FieldMetadata;
/**
* The name of the other person this relation refers to.
*/
person?: string | null;
/**
* 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 | null;
}
/**
* **DEPRECATED**: No data will be returned A person's relationship interest .
*/
export interface Schema$RelationshipInterest {
/**
* Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
*/
formattedValue?: string | null;
/**
* 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 | null;
}
/**
* **DEPRECATED**: No data will be returned A person's relationship status.
*/
export interface Schema$RelationshipStatus {
/**
* Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedValue?: string | null;
/**
* 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 | null;
}
/**
* **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.
*/
export interface Schema$Residence {
/**
* True if the residence is the person's current residence; false if the residence is a past residence.
*/
current?: boolean | null;
/**
* Metadata about the residence.
*/
metadata?: Schema$FieldMetadata;
/**
* The address of the residence.
*/
value?: string | null;
}
/**
* The response to a request for people in the authenticated user's domain directory that match the specified query.
*/
export interface Schema$SearchDirectoryPeopleResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* The list of people in the domain directory that match the query.
*/
people?: Schema$Person[];
/**
* The total number of items in the list without pagination.
*/
totalSize?: number | null;
}
/**
* The response to a search request for the authenticated user, given a query.
*/
export interface Schema$SearchResponse {
/**
* The results of the request.
*/
results?: Schema$SearchResult[];
}
/**
* A result of a search query.
*/
export interface Schema$SearchResult {
/**
* The matched Person.
*/
person?: Schema$Person;
}
/**
* A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
*/
export interface Schema$SipAddress {
/**
* Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string | null;
/**
* 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 | null;
/**
* The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.
*/
value?: string | null;
}
/**
* A skill that the person has.
*/
export interface Schema$Skill {
/**
* Metadata about the skill.
*/
metadata?: Schema$FieldMetadata;
/**
* The skill; for example, `underwater basket weaving`.
*/
value?: string | null;
}
/**
* The source of a field.
*/
export 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 | null;
/**
* The unique identifier within the source type generated by the server.
*/
id?: string | null;
/**
* Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.
*/
profileMetadata?: Schema$ProfileMetadata;
/**
* The source type.
*/
type?: string | null;
/**
* Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.
*/
updateTime?: string | null;
}
/**
* 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).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* 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}> | null;
/**
* 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 | null;
}
/**
* **DEPRECATED**: No data will be returned A brief one-line description of the person.
*/
export interface Schema$Tagline {
/**
* Metadata about the tagline.
*/
metadata?: Schema$FieldMetadata;
/**
* The tagline.
*/
value?: string | null;
}
/**
* A request to update an existing user contact group. All updated fields will be replaced.
*/
export interface Schema$UpdateContactGroupRequest {
/**
* Required. The contact group to update.
*/
contactGroup?: Schema$ContactGroup;
/**
* Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
*/
readGroupFields?: string | null;
/**
* Optional. A field mask to restrict which fields on the group are updated. Multiple fields can be specified by separating them with commas. Defaults to `name` if not set or set to empty. Updated fields are replaced. Valid values are: * clientData * name
*/
updateGroupFields?: string | null;
}
/**
* A request to update an existing contact's photo. All requests must have a valid photo format: JPEG or PNG.
*/
export interface Schema$UpdateContactPhotoRequest {
/**
* Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
personFields?: string | null;
/**
* Required. Raw photo bytes
*/
photoBytes?: string | null;
/**
* Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
*/
sources?: string[] | null;
}
/**
* The response for updating a contact's photo.
*/
export interface Schema$UpdateContactPhotoResponse {
/**
* The updated person, if person_fields is set in the UpdateContactPhotoRequest; otherwise this will be unset.
*/
person?: Schema$Person;
}
/**
* A person's associated URLs.
*/
export interface Schema$Url {
/**
* Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
*/
formattedType?: string | null;
/**
* 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 Currents application. * `other`
*/
type?: string | null;
/**
* The URL.
*/
value?: string | null;
}
/**
* Arbitrary user data that is populated by the end users.
*/
export interface Schema$UserDefined {
/**
* The end user specified key of the user defined data.
*/
key?: string | null;
/**
* Metadata about the user defined data.
*/
metadata?: Schema$FieldMetadata;
/**
* The end user specified value of the user defined data.
*/
value?: string | null;
}
export class Resource$Contactgroups {
context: APIRequestContext;
members: Resource$Contactgroups$Members;
constructor(context: APIRequestContext) {
this.context = context;
this.members = new Resource$Contactgroups$Members(this.context);
}
/**
* Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/contacts',
* 'https://www.googleapis.com/auth/contacts.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.contactGroups.batchGet({
* // Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
* groupFields: 'placeholder-value',
* // Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members.
* maxMembers: 'placeholder-value',
* // Required. The resource names of the contact groups to get. There is a maximum of 200 resource names.
* resourceNames: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "responses": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
batchGet(
params: Params$Resource$Contactgroups$Batchget,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
batchGet(
params?: Params$Resource$Contactgroups$Batchget,
options?: MethodOptions
): GaxiosPromise<Schema$BatchGetContactGroupsResponse>;
batchGet(
params: Params$Resource$Contactgroups$Batchget,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
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;
batchGet(
paramsOrCallback?:
| Params$Resource$Contactgroups$Batchget
| BodyResponseCallback<Schema$BatchGetContactGroupsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$BatchGetContactGroupsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$BatchGetContactGroupsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$BatchGetContactGroupsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Contactgroups$Batchget;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Contactgroups$Batchget;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/contactGroups:batchGet').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$BatchGetContactGroupsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$BatchGetContactGroupsResponse>(
parameters
);
}
}
/**
* Create a new contact group owned by the authenticated user. Created contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.contactGroups.create({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "contactGroup": {},
* // "readGroupFields": "my_readGroupFields"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "clientData": [],
* // "etag": "my_etag",
* // "formattedName": "my_formattedName",
* // "groupType": "my_groupType",
* // "memberCount": 0,
* // "memberResourceNames": [],
* // "metadata": {},
* // "name": "my_name",
* // "resourceName": "my_resourceName"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(
params: Params$Resource$Contactgroups$Create,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
create(
params?: Params$Resource$Contactgroups$Create,
options?: MethodOptions
): GaxiosPromise<Schema$ContactGroup>;
create(
params: Params$Resource$Contactgroups$Create,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
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;
create(
paramsOrCallback?:
| Params$Resource$Contactgroups$Create
| BodyResponseCallback<Schema$ContactGroup>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ContactGroup>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ContactGroup>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$ContactGroup> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Contactgroups$Create;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Contactgroups$Create;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/contactGroups').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ContactGroup>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ContactGroup>(parameters);
}
}
/**
* Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.contactGroups.delete({
* // Optional. Set to true to also delete the contacts in the specified group.
* deleteContacts: 'placeholder-value',
* // Required. The resource name of the contact group to delete.
* resourceName: 'contactGroups/my-contactGroup',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(
params: Params$Resource$Contactgroups$Delete,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
delete(
params?: Params$Resource$Contactgroups$Delete,
options?: MethodOptions
): GaxiosPromise<Schema$Empty>;
delete(
params: Params$Resource$Contactgroups$Delete,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
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;
delete(
paramsOrCallback?:
| Params$Resource$Contactgroups$Delete
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Empty> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Contactgroups$Delete;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Contactgroups$Delete;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+resourceName}').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'DELETE',
},
options
),
params,
requiredParams: ['resourceName'],
pathParams: ['resourceName'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Empty>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Empty>(parameters);
}
}
/**
* Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/contacts',
* 'https://www.googleapis.com/auth/contacts.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.contactGroups.get({
* // Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
* groupFields: 'placeholder-value',
* // Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.
* maxMembers: 'placeholder-value',
* // Required. The resource name of the contact group to get.
* resourceName: 'contactGroups/my-contactGroup',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "clientData": [],
* // "etag": "my_etag",
* // "formattedName": "my_formattedName",
* // "groupType": "my_groupType",
* // "memberCount": 0,
* // "memberResourceNames": [],
* // "metadata": {},
* // "name": "my_name",
* // "resourceName": "my_resourceName"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$Contactgroups$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$Contactgroups$Get,
options?: MethodOptions
): GaxiosPromise<Schema$ContactGroup>;
get(
params: Params$Resource$Contactgroups$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
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;
get(
paramsOrCallback?:
| Params$Resource$Contactgroups$Get
| BodyResponseCallback<Schema$ContactGroup>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ContactGroup>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ContactGroup>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$ContactGroup> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Contactgroups$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Contactgroups$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+resourceName}').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['resourceName'],
pathParams: ['resourceName'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ContactGroup>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ContactGroup>(parameters);
}
}
/**
* List all contact groups owned by the authenticated user. Members of the contact groups are not populated.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/contacts',
* 'https://www.googleapis.com/auth/contacts.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.contactGroups.list({
* // Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
* groupFields: 'placeholder-value',
* // Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.
* pageSize: 'placeholder-value',
* // Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.
* pageToken: 'placeholder-value',
* // Optional. A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.
* syncToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "contactGroups": [],
* // "nextPageToken": "my_nextPageToken",
* // "nextSyncToken": "my_nextSyncToken",
* // "totalItems": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Contactgroups$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Contactgroups$List,
options?: MethodOptions
): GaxiosPromise<Schema$ListContactGroupsResponse>;
list(
params: Params$Resource$Contactgroups$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
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;
list(
paramsOrCallback?:
| Params$Resource$Contactgroups$List
| BodyResponseCallback<Schema$ListContactGroupsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ListContactGroupsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ListContactGroupsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ListContactGroupsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Contactgroups$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Contactgroups$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/contactGroups').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ListContactGroupsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ListContactGroupsResponse>(parameters);
}
}
/**
* Update the name of an existing contact group owned by the authenticated user. Updated contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.contactGroups.update({
* // The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id\}`.
* resourceName: 'contactGroups/my-contactGroup',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "contactGroup": {},
* // "readGroupFields": "my_readGroupFields",
* // "updateGroupFields": "my_updateGroupFields"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "clientData": [],
* // "etag": "my_etag",
* // "formattedName": "my_formattedName",
* // "groupType": "my_groupType",
* // "memberCount": 0,
* // "memberResourceNames": [],
* // "metadata": {},
* // "name": "my_name",
* // "resourceName": "my_resourceName"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
update(
params: Params$Resource$Contactgroups$Update,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
update(
params?: Params$Resource$Contactgroups$Update,
options?: MethodOptions
): GaxiosPromise<Schema$ContactGroup>;
update(
params: Params$Resource$Contactgroups$Update,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
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;
update(
paramsOrCallback?:
| Params$Resource$Contactgroups$Update
| BodyResponseCallback<Schema$ContactGroup>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ContactGroup>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ContactGroup>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$ContactGroup> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Contactgroups$Update;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Contactgroups$Update;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+resourceName}').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'PUT',
},
options
),
params,
requiredParams: ['resourceName'],
pathParams: ['resourceName'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ContactGroup>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ContactGroup>(parameters);
}
}
}
export interface Params$Resource$Contactgroups$Batchget
extends StandardParameters {
/**
* Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
*/
groupFields?: string;
/**
* Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members.
*/
maxMembers?: number;
/**
* Required. The resource names of the contact groups to get. There is a maximum of 200 resource names.
*/
resourceNames?: string[];
}
export interface Params$Resource$Contactgroups$Create
extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$CreateContactGroupRequest;
}
export interface Params$Resource$Contactgroups$Delete
extends StandardParameters {
/**
* Optional. Set to true to also delete the contacts in the specified group.
*/
deleteContacts?: boolean;
/**
* Required. The resource name of the contact group to delete.
*/
resourceName?: string;
}
export interface Params$Resource$Contactgroups$Get
extends StandardParameters {
/**
* Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
*/
groupFields?: string;
/**
* Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.
*/
maxMembers?: number;
/**
* Required. The resource name of the contact group to get.
*/
resourceName?: string;
}
export interface Params$Resource$Contactgroups$List
extends StandardParameters {
/**
* Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
*/
groupFields?: string;
/**
* Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.
*/
pageSize?: number;
/**
* Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.
*/
pageToken?: string;
/**
* Optional. 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;
}
export interface Params$Resource$Contactgroups$Update
extends StandardParameters {
/**
* The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id\}`.
*/
resourceName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateContactGroupRequest;
}
export class Resource$Contactgroups$Members {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Modify the members of a contact group owned by the authenticated user. The only system contact groups that can have members added are `contactGroups/myContacts` and `contactGroups/starred`. Other system contact groups are deprecated and can only have contacts removed.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.contactGroups.members.modify({
* // Required. The resource name of the contact group to modify.
* resourceName: 'contactGroups/my-contactGroup',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "resourceNamesToAdd": [],
* // "resourceNamesToRemove": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "canNotRemoveLastContactGroupResourceNames": [],
* // "notFoundResourceNames": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
modify(
params: Params$Resource$Contactgroups$Members$Modify,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
modify(
params?: Params$Resource$Contactgroups$Members$Modify,
options?: MethodOptions
): GaxiosPromise<Schema$ModifyContactGroupMembersResponse>;
modify(
params: Params$Resource$Contactgroups$Members$Modify,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
modify(
params: Params$Resource$Contactgroups$Members$Modify,
options:
| MethodOptions
| BodyResponseCallback<Schema$ModifyContactGroupMembersResponse>,
callback: BodyResponseCallback<Schema$ModifyContactGroupMembersResponse>
): void;
modify(
params: Params$Resource$Contactgroups$Members$Modify,
callback: BodyResponseCallback<Schema$ModifyContactGroupMembersResponse>
): void;
modify(
callback: BodyResponseCallback<Schema$ModifyContactGroupMembersResponse>
): void;
modify(
paramsOrCallback?:
| Params$Resource$Contactgroups$Members$Modify
| BodyResponseCallback<Schema$ModifyContactGroupMembersResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ModifyContactGroupMembersResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ModifyContactGroupMembersResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ModifyContactGroupMembersResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Contactgroups$Members$Modify;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Contactgroups$Members$Modify;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+resourceName}/members:modify').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['resourceName'],
pathParams: ['resourceName'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ModifyContactGroupMembersResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ModifyContactGroupMembersResponse>(
parameters
);
}
}
}
export interface Params$Resource$Contactgroups$Members$Modify
extends StandardParameters {
/**
* Required. The resource name of the contact group to modify.
*/
resourceName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ModifyContactGroupMembersRequest;
}
export class Resource$Othercontacts {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Copies an "Other contact" to a new contact in the user's "myContacts" group
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/contacts',
* 'https://www.googleapis.com/auth/contacts.other.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.otherContacts.copyOtherContactToMyContactsGroup({
* // Required. The resource name of the "Other contact" to copy.
* resourceName: 'otherContacts/my-otherContact',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "copyMask": "my_copyMask",
* // "readMask": "my_readMask",
* // "sources": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "addresses": [],
* // "ageRange": "my_ageRange",
* // "ageRanges": [],
* // "biographies": [],
* // "birthdays": [],
* // "braggingRights": [],
* // "calendarUrls": [],
* // "clientData": [],
* // "coverPhotos": [],
* // "emailAddresses": [],
* // "etag": "my_etag",
* // "events": [],
* // "externalIds": [],
* // "fileAses": [],
* // "genders": [],
* // "imClients": [],
* // "interests": [],
* // "locales": [],
* // "locations": [],
* // "memberships": [],
* // "metadata": {},
* // "miscKeywords": [],
* // "names": [],
* // "nicknames": [],
* // "occupations": [],
* // "organizations": [],
* // "phoneNumbers": [],
* // "photos": [],
* // "relations": [],
* // "relationshipInterests": [],
* // "relationshipStatuses": [],
* // "residences": [],
* // "resourceName": "my_resourceName",
* // "sipAddresses": [],
* // "skills": [],
* // "taglines": [],
* // "urls": [],
* // "userDefined": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
copyOtherContactToMyContactsGroup(
params: Params$Resource$Othercontacts$Copyothercontacttomycontactsgroup,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
copyOtherContactToMyContactsGroup(
params?: Params$Resource$Othercontacts$Copyothercontacttomycontactsgroup,
options?: MethodOptions
): GaxiosPromise<Schema$Person>;
copyOtherContactToMyContactsGroup(
params: Params$Resource$Othercontacts$Copyothercontacttomycontactsgroup,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
copyOtherContactToMyContactsGroup(
params: Params$Resource$Othercontacts$Copyothercontacttomycontactsgroup,
options: MethodOptions | BodyResponseCallback<Schema$Person>,
callback: BodyResponseCallback<Schema$Person>
): void;
copyOtherContactToMyContactsGroup(
params: Params$Resource$Othercontacts$Copyothercontacttomycontactsgroup,
callback: BodyResponseCallback<Schema$Person>
): void;
copyOtherContactToMyContactsGroup(
callback: BodyResponseCallback<Schema$Person>
): void;
copyOtherContactToMyContactsGroup(
paramsOrCallback?:
| Params$Resource$Othercontacts$Copyothercontacttomycontactsgroup
| BodyResponseCallback<Schema$Person>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Person>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Person>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Person> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Othercontacts$Copyothercontacttomycontactsgroup;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Othercontacts$Copyothercontacttomycontactsgroup;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (
rootUrl + '/v1/{+resourceName}:copyOtherContactToMyContactsGroup'
).replace(/([^:]\/)\/+/g, '$1'),
method: 'POST',
},
options
),
params,
requiredParams: ['resourceName'],
pathParams: ['resourceName'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Person>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Person>(parameters);
}
}
/**
* List all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions. Sync tokens expire 7 days after the full sync. A request with an expired sync token will result in a 410 error. In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the user's other contacts that have changed](/people/v1/other-contacts#list_the_users_other_contacts_that_have_changed).
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts.other.readonly'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.otherContacts.list({
* // Optional. The number of "Other contacts" to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
* pageSize: 'placeholder-value',
* // Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `otherContacts.list` must match the first call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. What values are valid depend on what ReadSourceType is used. If READ_SOURCE_TYPE_CONTACT is used, valid values are: * emailAddresses * metadata * names * phoneNumbers * photos If READ_SOURCE_TYPE_PROFILE is used, valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
* readMask: 'placeholder-value',
* // Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `otherContacts.list`.
* requestSyncToken: 'placeholder-value',
* // Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set.
* sources: 'placeholder-value',
* // Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `otherContacts.list` must match the first call that provided the sync token. More details about sync behavior at `otherContacts.list`.
* syncToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "nextSyncToken": "my_nextSyncToken",
* // "otherContacts": [],
* // "totalSize": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$Othercontacts$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$Othercontacts$List,
options?: MethodOptions
): GaxiosPromise<Schema$ListOtherContactsResponse>;
list(
params: Params$Resource$Othercontacts$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$Othercontacts$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$ListOtherContactsResponse>,
callback: BodyResponseCallback<Schema$ListOtherContactsResponse>
): void;
list(
params: Params$Resource$Othercontacts$List,
callback: BodyResponseCallback<Schema$ListOtherContactsResponse>
): void;
list(
callback: BodyResponseCallback<Schema$ListOtherContactsResponse>
): void;
list(
paramsOrCallback?:
| Params$Resource$Othercontacts$List
| BodyResponseCallback<Schema$ListOtherContactsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ListOtherContactsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ListOtherContactsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ListOtherContactsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Othercontacts$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Othercontacts$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/otherContacts').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ListOtherContactsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ListOtherContactsResponse>(parameters);
}
}
/**
* Provides a list of contacts in the authenticated user's other contacts that matches the search query. The query matches on a contact's `names`, `emailAddresses`, and `phoneNumbers` fields that are from the OTHER_CONTACT source. **IMPORTANT**: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/other-contacts#search_the_users_other_contacts
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts.other.readonly'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.otherContacts.search({
* // Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.
* pageSize: 'placeholder-value',
* // Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n".
* query: 'placeholder-value',
* // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * metadata * names * phoneNumbers
* readMask: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "results": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
search(
params: Params$Resource$Othercontacts$Search,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
search(
params?: Params$Resource$Othercontacts$Search,
options?: MethodOptions
): GaxiosPromise<Schema$SearchResponse>;
search(
params: Params$Resource$Othercontacts$Search,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
search(
params: Params$Resource$Othercontacts$Search,
options: MethodOptions | BodyResponseCallback<Schema$SearchResponse>,
callback: BodyResponseCallback<Schema$SearchResponse>
): void;
search(
params: Params$Resource$Othercontacts$Search,
callback: BodyResponseCallback<Schema$SearchResponse>
): void;
search(callback: BodyResponseCallback<Schema$SearchResponse>): void;
search(
paramsOrCallback?:
| Params$Resource$Othercontacts$Search
| BodyResponseCallback<Schema$SearchResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$SearchResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$SearchResponse>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$SearchResponse> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Othercontacts$Search;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Othercontacts$Search;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/otherContacts:search').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$SearchResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$SearchResponse>(parameters);
}
}
}
export interface Params$Resource$Othercontacts$Copyothercontacttomycontactsgroup
extends StandardParameters {
/**
* Required. The resource name of the "Other contact" to copy.
*/
resourceName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CopyOtherContactToMyContactsGroupRequest;
}
export interface Params$Resource$Othercontacts$List
extends StandardParameters {
/**
* Optional. The number of "Other contacts" to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
*/
pageSize?: number;
/**
* Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `otherContacts.list` must match the first call that provided the page token.
*/
pageToken?: string;
/**
* Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. What values are valid depend on what ReadSourceType is used. If READ_SOURCE_TYPE_CONTACT is used, valid values are: * emailAddresses * metadata * names * phoneNumbers * photos If READ_SOURCE_TYPE_PROFILE is used, valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
readMask?: string;
/**
* Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `otherContacts.list`.
*/
requestSyncToken?: boolean;
/**
* Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set.
*/
sources?: string[];
/**
* Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `otherContacts.list` must match the first call that provided the sync token. More details about sync behavior at `otherContacts.list`.
*/
syncToken?: string;
}
export interface Params$Resource$Othercontacts$Search
extends StandardParameters {
/**
* Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.
*/
pageSize?: number;
/**
* Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n".
*/
query?: string;
/**
* Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * metadata * names * phoneNumbers
*/
readMask?: string;
}
export class Resource$People {
context: APIRequestContext;
connections: Resource$People$Connections;
constructor(context: APIRequestContext) {
this.context = context;
this.connections = new Resource$People$Connections(this.context);
}
/**
* Create a batch of new contacts and return the PersonResponses for the newly created contacts. Limited to 10 parallel requests per user.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.batchCreateContacts({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "contacts": [],
* // "readMask": "my_readMask",
* // "sources": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createdPeople": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
batchCreateContacts(
params: Params$Resource$People$Batchcreatecontacts,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
batchCreateContacts(
params?: Params$Resource$People$Batchcreatecontacts,
options?: MethodOptions
): GaxiosPromise<Schema$BatchCreateContactsResponse>;
batchCreateContacts(
params: Params$Resource$People$Batchcreatecontacts,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
batchCreateContacts(
params: Params$Resource$People$Batchcreatecontacts,
options:
| MethodOptions
| BodyResponseCallback<Schema$BatchCreateContactsResponse>,
callback: BodyResponseCallback<Schema$BatchCreateContactsResponse>
): void;
batchCreateContacts(
params: Params$Resource$People$Batchcreatecontacts,
callback: BodyResponseCallback<Schema$BatchCreateContactsResponse>
): void;
batchCreateContacts(
callback: BodyResponseCallback<Schema$BatchCreateContactsResponse>
): void;
batchCreateContacts(
paramsOrCallback?:
| Params$Resource$People$Batchcreatecontacts
| BodyResponseCallback<Schema$BatchCreateContactsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$BatchCreateContactsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$BatchCreateContactsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$BatchCreateContactsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$People$Batchcreatecontacts;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Batchcreatecontacts;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/people:batchCreateContacts').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$BatchCreateContactsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$BatchCreateContactsResponse>(parameters);
}
}
/**
* Delete a batch of contacts. Any non-contact data will not be deleted. Limited to 10 parallel requests per user.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.batchDeleteContacts({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "resourceNames": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
batchDeleteContacts(
params: Params$Resource$People$Batchdeletecontacts,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
batchDeleteContacts(
params?: Params$Resource$People$Batchdeletecontacts,
options?: MethodOptions
): GaxiosPromise<Schema$Empty>;
batchDeleteContacts(
params: Params$Resource$People$Batchdeletecontacts,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
batchDeleteContacts(
params: Params$Resource$People$Batchdeletecontacts,
options: MethodOptions | BodyResponseCallback<Schema$Empty>,
callback: BodyResponseCallback<Schema$Empty>
): void;
batchDeleteContacts(
params: Params$Resource$People$Batchdeletecontacts,
callback: BodyResponseCallback<Schema$Empty>
): void;
batchDeleteContacts(callback: BodyResponseCallback<Schema$Empty>): void;
batchDeleteContacts(
paramsOrCallback?:
| Params$Resource$People$Batchdeletecontacts
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Empty> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$People$Batchdeletecontacts;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Batchdeletecontacts;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/people:batchDeleteContacts').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Empty>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Empty>(parameters);
}
}
/**
* Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts. Limited to 10 parallel requests per user.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.batchUpdateContacts({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "contacts": {},
* // "readMask": "my_readMask",
* // "sources": [],
* // "updateMask": "my_updateMask"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "updateResult": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
batchUpdateContacts(
params: Params$Resource$People$Batchupdatecontacts,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
batchUpdateContacts(
params?: Params$Resource$People$Batchupdatecontacts,
options?: MethodOptions
): GaxiosPromise<Schema$BatchUpdateContactsResponse>;
batchUpdateContacts(
params: Params$Resource$People$Batchupdatecontacts,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
batchUpdateContacts(
params: Params$Resource$People$Batchupdatecontacts,
options:
| MethodOptions
| BodyResponseCallback<Schema$BatchUpdateContactsResponse>,
callback: BodyResponseCallback<Schema$BatchUpdateContactsResponse>
): void;
batchUpdateContacts(
params: Params$Resource$People$Batchupdatecontacts,
callback: BodyResponseCallback<Schema$BatchUpdateContactsResponse>
): void;
batchUpdateContacts(
callback: BodyResponseCallback<Schema$BatchUpdateContactsResponse>
): void;
batchUpdateContacts(
paramsOrCallback?:
| Params$Resource$People$Batchupdatecontacts
| BodyResponseCallback<Schema$BatchUpdateContactsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$BatchUpdateContactsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$BatchUpdateContactsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$BatchUpdateContactsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$People$Batchupdatecontacts;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Batchupdatecontacts;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/people:batchUpdateContacts').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$BatchUpdateContactsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$BatchUpdateContactsResponse>(parameters);
}
}
/**
* Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.createContact({
* // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
* personFields: 'placeholder-value',
* // Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
* sources: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "addresses": [],
* // "ageRange": "my_ageRange",
* // "ageRanges": [],
* // "biographies": [],
* // "birthdays": [],
* // "braggingRights": [],
* // "calendarUrls": [],
* // "clientData": [],
* // "coverPhotos": [],
* // "emailAddresses": [],
* // "etag": "my_etag",
* // "events": [],
* // "externalIds": [],
* // "fileAses": [],
* // "genders": [],
* // "imClients": [],
* // "interests": [],
* // "locales": [],
* // "locations": [],
* // "memberships": [],
* // "metadata": {},
* // "miscKeywords": [],
* // "names": [],
* // "nicknames": [],
* // "occupations": [],
* // "organizations": [],
* // "phoneNumbers": [],
* // "photos": [],
* // "relations": [],
* // "relationshipInterests": [],
* // "relationshipStatuses": [],
* // "residences": [],
* // "resourceName": "my_resourceName",
* // "sipAddresses": [],
* // "skills": [],
* // "taglines": [],
* // "urls": [],
* // "userDefined": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "addresses": [],
* // "ageRange": "my_ageRange",
* // "ageRanges": [],
* // "biographies": [],
* // "birthdays": [],
* // "braggingRights": [],
* // "calendarUrls": [],
* // "clientData": [],
* // "coverPhotos": [],
* // "emailAddresses": [],
* // "etag": "my_etag",
* // "events": [],
* // "externalIds": [],
* // "fileAses": [],
* // "genders": [],
* // "imClients": [],
* // "interests": [],
* // "locales": [],
* // "locations": [],
* // "memberships": [],
* // "metadata": {},
* // "miscKeywords": [],
* // "names": [],
* // "nicknames": [],
* // "occupations": [],
* // "organizations": [],
* // "phoneNumbers": [],
* // "photos": [],
* // "relations": [],
* // "relationshipInterests": [],
* // "relationshipStatuses": [],
* // "residences": [],
* // "resourceName": "my_resourceName",
* // "sipAddresses": [],
* // "skills": [],
* // "taglines": [],
* // "urls": [],
* // "userDefined": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
createContact(
params: Params$Resource$People$Createcontact,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
createContact(
params?: Params$Resource$People$Createcontact,
options?: MethodOptions
): GaxiosPromise<Schema$Person>;
createContact(
params: Params$Resource$People$Createcontact,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
createContact(
params: Params$Resource$People$Createcontact,
options: MethodOptions | BodyResponseCallback<Schema$Person>,
callback: BodyResponseCallback<Schema$Person>
): void;
createContact(
params: Params$Resource$People$Createcontact,
callback: BodyResponseCallback<Schema$Person>
): void;
createContact(callback: BodyResponseCallback<Schema$Person>): void;
createContact(
paramsOrCallback?:
| Params$Resource$People$Createcontact
| BodyResponseCallback<Schema$Person>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Person>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Person>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Person> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$People$Createcontact;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Createcontact;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/people:createContact').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Person>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Person>(parameters);
}
}
/**
* Delete a contact person. Any non-contact data will not be deleted.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.deleteContact({
* // Required. The resource name of the contact to delete.
* resourceName: 'people/[^/]+',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
deleteContact(
params: Params$Resource$People$Deletecontact,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
deleteContact(
params?: Params$Resource$People$Deletecontact,
options?: MethodOptions
): GaxiosPromise<Schema$Empty>;
deleteContact(
params: Params$Resource$People$Deletecontact,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
deleteContact(
params: Params$Resource$People$Deletecontact,
options: MethodOptions | BodyResponseCallback<Schema$Empty>,
callback: BodyResponseCallback<Schema$Empty>
): void;
deleteContact(
params: Params$Resource$People$Deletecontact,
callback: BodyResponseCallback<Schema$Empty>
): void;
deleteContact(callback: BodyResponseCallback<Schema$Empty>): void;
deleteContact(
paramsOrCallback?:
| Params$Resource$People$Deletecontact
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Empty> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$People$Deletecontact;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Deletecontact;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+resourceName}:deleteContact').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'DELETE',
},
options
),
params,
requiredParams: ['resourceName'],
pathParams: ['resourceName'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Empty>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Empty>(parameters);
}
}
/**
* Delete a contact's photo.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.deleteContactPhoto({
* // Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
* personFields: 'placeholder-value',
* // Required. The resource name of the contact whose photo will be deleted.
* resourceName: 'people/[^/]+',
* // Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
* sources: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "person": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
deleteContactPhoto(
params: Params$Resource$People$Deletecontactphoto,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
deleteContactPhoto(
params?: Params$Resource$People$Deletecontactphoto,
options?: MethodOptions
): GaxiosPromise<Schema$DeleteContactPhotoResponse>;
deleteContactPhoto(
params: Params$Resource$People$Deletecontactphoto,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
deleteContactPhoto(
params: Params$Resource$People$Deletecontactphoto,
options:
| MethodOptions
| BodyResponseCallback<Schema$DeleteContactPhotoResponse>,
callback: BodyResponseCallback<Schema$DeleteContactPhotoResponse>
): void;
deleteContactPhoto(
params: Params$Resource$People$Deletecontactphoto,
callback: BodyResponseCallback<Schema$DeleteContactPhotoResponse>
): void;
deleteContactPhoto(
callback: BodyResponseCallback<Schema$DeleteContactPhotoResponse>
): void;
deleteContactPhoto(
paramsOrCallback?:
| Params$Resource$People$Deletecontactphoto
| BodyResponseCallback<Schema$DeleteContactPhotoResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$DeleteContactPhotoResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$DeleteContactPhotoResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$DeleteContactPhotoResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$People$Deletecontactphoto;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Deletecontactphoto;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+resourceName}:deleteContactPhoto').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'DELETE',
},
options
),
params,
requiredParams: ['resourceName'],
pathParams: ['resourceName'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$DeleteContactPhotoResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$DeleteContactPhotoResponse>(parameters);
}
}
/**
* Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/contacts',
* 'https://www.googleapis.com/auth/contacts.readonly',
* 'https://www.googleapis.com/auth/directory.readonly',
* 'https://www.googleapis.com/auth/user.addresses.read',
* 'https://www.googleapis.com/auth/user.birthday.read',
* 'https://www.googleapis.com/auth/user.emails.read',
* 'https://www.googleapis.com/auth/user.gender.read',
* 'https://www.googleapis.com/auth/user.organization.read',
* 'https://www.googleapis.com/auth/user.phonenumbers.read',
* 'https://www.googleapis.com/auth/userinfo.email',
* 'https://www.googleapis.com/auth/userinfo.profile',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.get({
* // Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
* personFields: 'placeholder-value',
* // 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': 'placeholder-value',
* // Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id\}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`.
* resourceName: 'people/[^/]+',
* // Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.
* sources: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "addresses": [],
* // "ageRange": "my_ageRange",
* // "ageRanges": [],
* // "biographies": [],
* // "birthdays": [],
* // "braggingRights": [],
* // "calendarUrls": [],
* // "clientData": [],
* // "coverPhotos": [],
* // "emailAddresses": [],
* // "etag": "my_etag",
* // "events": [],
* // "externalIds": [],
* // "fileAses": [],
* // "genders": [],
* // "imClients": [],
* // "interests": [],
* // "locales": [],
* // "locations": [],
* // "memberships": [],
* // "metadata": {},
* // "miscKeywords": [],
* // "names": [],
* // "nicknames": [],
* // "occupations": [],
* // "organizations": [],
* // "phoneNumbers": [],
* // "photos": [],
* // "relations": [],
* // "relationshipInterests": [],
* // "relationshipStatuses": [],
* // "residences": [],
* // "resourceName": "my_resourceName",
* // "sipAddresses": [],
* // "skills": [],
* // "taglines": [],
* // "urls": [],
* // "userDefined": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(
params: Params$Resource$People$Get,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
get(
params?: Params$Resource$People$Get,
options?: MethodOptions
): GaxiosPromise<Schema$Person>;
get(
params: Params$Resource$People$Get,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
get(
params: Params$Resource$People$Get,
options: MethodOptions | BodyResponseCallback<Schema$Person>,
callback: BodyResponseCallback<Schema$Person>
): void;
get(
params: Params$Resource$People$Get,
callback: BodyResponseCallback<Schema$Person>
): void;
get(callback: BodyResponseCallback<Schema$Person>): void;
get(
paramsOrCallback?:
| Params$Resource$People$Get
| BodyResponseCallback<Schema$Person>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Person>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Person>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Person> | GaxiosPromise<Readable> {
let params = (paramsOrCallback || {}) as Params$Resource$People$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+resourceName}').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['resourceName'],
pathParams: ['resourceName'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Person>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Person>(parameters);
}
}
/**
* 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 returns a 400 error if 'personFields' is not specified.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/contacts',
* 'https://www.googleapis.com/auth/contacts.readonly',
* 'https://www.googleapis.com/auth/directory.readonly',
* 'https://www.googleapis.com/auth/user.addresses.read',
* 'https://www.googleapis.com/auth/user.birthday.read',
* 'https://www.googleapis.com/auth/user.emails.read',
* 'https://www.googleapis.com/auth/user.gender.read',
* 'https://www.googleapis.com/auth/user.organization.read',
* 'https://www.googleapis.com/auth/user.phonenumbers.read',
* 'https://www.googleapis.com/auth/userinfo.email',
* 'https://www.googleapis.com/auth/userinfo.profile',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.getBatchGet({
* // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
* personFields: 'placeholder-value',
* // 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': 'placeholder-value',
* // Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=<name1\>&resourceNames=<name2\>&... - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id\}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`. There is a maximum of 200 resource names.
* resourceNames: 'placeholder-value',
* // Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
* sources: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "responses": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getBatchGet(
params: Params$Resource$People$Getbatchget,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
getBatchGet(
params?: Params$Resource$People$Getbatchget,
options?: MethodOptions
): GaxiosPromise<Schema$GetPeopleResponse>;
getBatchGet(
params: Params$Resource$People$Getbatchget,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
getBatchGet(
params: Params$Resource$People$Getbatchget,
options: MethodOptions | BodyResponseCallback<Schema$GetPeopleResponse>,
callback: BodyResponseCallback<Schema$GetPeopleResponse>
): void;
getBatchGet(
params: Params$Resource$People$Getbatchget,
callback: BodyResponseCallback<Schema$GetPeopleResponse>
): void;
getBatchGet(callback: BodyResponseCallback<Schema$GetPeopleResponse>): void;
getBatchGet(
paramsOrCallback?:
| Params$Resource$People$Getbatchget
| BodyResponseCallback<Schema$GetPeopleResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$GetPeopleResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$GetPeopleResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$GetPeopleResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$People$Getbatchget;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Getbatchget;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/people:batchGet').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$GetPeopleResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$GetPeopleResponse>(parameters);
}
}
/**
* Provides a list of domain profiles and domain contacts in the authenticated user's domain directory. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the directory people that have changed](/people/v1/directory#list_the_directory_people_that_have_changed).
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/directory.readonly'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.listDirectoryPeople({
* // Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.
* mergeSources: 'placeholder-value',
* // Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
* pageSize: 'placeholder-value',
* // Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
* readMask: 'placeholder-value',
* // Optional. Whether the response should return `next_sync_token`. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.listDirectoryPeople`.
* requestSyncToken: 'placeholder-value',
* // Required. Directory sources to return.
* sources: 'placeholder-value',
* // Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the sync token. More details about sync behavior at `people.listDirectoryPeople`.
* syncToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "nextSyncToken": "my_nextSyncToken",
* // "people": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
listDirectoryPeople(
params: Params$Resource$People$Listdirectorypeople,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
listDirectoryPeople(
params?: Params$Resource$People$Listdirectorypeople,
options?: MethodOptions
): GaxiosPromise<Schema$ListDirectoryPeopleResponse>;
listDirectoryPeople(
params: Params$Resource$People$Listdirectorypeople,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
listDirectoryPeople(
params: Params$Resource$People$Listdirectorypeople,
options:
| MethodOptions
| BodyResponseCallback<Schema$ListDirectoryPeopleResponse>,
callback: BodyResponseCallback<Schema$ListDirectoryPeopleResponse>
): void;
listDirectoryPeople(
params: Params$Resource$People$Listdirectorypeople,
callback: BodyResponseCallback<Schema$ListDirectoryPeopleResponse>
): void;
listDirectoryPeople(
callback: BodyResponseCallback<Schema$ListDirectoryPeopleResponse>
): void;
listDirectoryPeople(
paramsOrCallback?:
| Params$Resource$People$Listdirectorypeople
| BodyResponseCallback<Schema$ListDirectoryPeopleResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ListDirectoryPeopleResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ListDirectoryPeopleResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ListDirectoryPeopleResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$People$Listdirectorypeople;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Listdirectorypeople;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/people:listDirectoryPeople').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ListDirectoryPeopleResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ListDirectoryPeopleResponse>(parameters);
}
}
/**
* Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's `names`, `nickNames`, `emailAddresses`, `phoneNumbers`, and `organizations` fields that are from the CONTACT" source. **IMPORTANT**: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/contacts#search_the_users_contacts
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/contacts',
* 'https://www.googleapis.com/auth/contacts.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.searchContacts({
* // Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.
* pageSize: 'placeholder-value',
* // Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n".
* query: 'placeholder-value',
* // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
* readMask: 'placeholder-value',
* // Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set.
* sources: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "results": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
searchContacts(
params: Params$Resource$People$Searchcontacts,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
searchContacts(
params?: Params$Resource$People$Searchcontacts,
options?: MethodOptions
): GaxiosPromise<Schema$SearchResponse>;
searchContacts(
params: Params$Resource$People$Searchcontacts,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
searchContacts(
params: Params$Resource$People$Searchcontacts,
options: MethodOptions | BodyResponseCallback<Schema$SearchResponse>,
callback: BodyResponseCallback<Schema$SearchResponse>
): void;
searchContacts(
params: Params$Resource$People$Searchcontacts,
callback: BodyResponseCallback<Schema$SearchResponse>
): void;
searchContacts(callback: BodyResponseCallback<Schema$SearchResponse>): void;
searchContacts(
paramsOrCallback?:
| Params$Resource$People$Searchcontacts
| BodyResponseCallback<Schema$SearchResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$SearchResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$SearchResponse>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$SearchResponse> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$People$Searchcontacts;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Searchcontacts;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/people:searchContacts').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$SearchResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$SearchResponse>(parameters);
}
}
/**
* Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/directory.readonly'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.searchDirectoryPeople({
* // Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.
* mergeSources: 'placeholder-value',
* // Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.
* pageSize: 'placeholder-value',
* // Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the first call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.
* query: 'placeholder-value',
* // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
* readMask: 'placeholder-value',
* // Required. Directory sources to return.
* sources: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "people": [],
* // "totalSize": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
searchDirectoryPeople(
params: Params$Resource$People$Searchdirectorypeople,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
searchDirectoryPeople(
params?: Params$Resource$People$Searchdirectorypeople,
options?: MethodOptions
): GaxiosPromise<Schema$SearchDirectoryPeopleResponse>;
searchDirectoryPeople(
params: Params$Resource$People$Searchdirectorypeople,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
searchDirectoryPeople(
params: Params$Resource$People$Searchdirectorypeople,
options:
| MethodOptions
| BodyResponseCallback<Schema$SearchDirectoryPeopleResponse>,
callback: BodyResponseCallback<Schema$SearchDirectoryPeopleResponse>
): void;
searchDirectoryPeople(
params: Params$Resource$People$Searchdirectorypeople,
callback: BodyResponseCallback<Schema$SearchDirectoryPeopleResponse>
): void;
searchDirectoryPeople(
callback: BodyResponseCallback<Schema$SearchDirectoryPeopleResponse>
): void;
searchDirectoryPeople(
paramsOrCallback?:
| Params$Resource$People$Searchdirectorypeople
| BodyResponseCallback<Schema$SearchDirectoryPeopleResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$SearchDirectoryPeopleResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$SearchDirectoryPeopleResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$SearchDirectoryPeopleResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$People$Searchdirectorypeople;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Searchdirectorypeople;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/people:searchDirectoryPeople').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: [],
pathParams: [],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$SearchDirectoryPeopleResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$SearchDirectoryPeopleResponse>(
parameters
);
}
}
/**
* Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 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 merge their updates into the latest person. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.updateContact({
* // Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
* personFields: 'placeholder-value',
* // 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/{person_id\}`.
* resourceName: 'people/[^/]+',
* // Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
* sources: 'placeholder-value',
* // Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined
* updatePersonFields: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "addresses": [],
* // "ageRange": "my_ageRange",
* // "ageRanges": [],
* // "biographies": [],
* // "birthdays": [],
* // "braggingRights": [],
* // "calendarUrls": [],
* // "clientData": [],
* // "coverPhotos": [],
* // "emailAddresses": [],
* // "etag": "my_etag",
* // "events": [],
* // "externalIds": [],
* // "fileAses": [],
* // "genders": [],
* // "imClients": [],
* // "interests": [],
* // "locales": [],
* // "locations": [],
* // "memberships": [],
* // "metadata": {},
* // "miscKeywords": [],
* // "names": [],
* // "nicknames": [],
* // "occupations": [],
* // "organizations": [],
* // "phoneNumbers": [],
* // "photos": [],
* // "relations": [],
* // "relationshipInterests": [],
* // "relationshipStatuses": [],
* // "residences": [],
* // "resourceName": "my_resourceName",
* // "sipAddresses": [],
* // "skills": [],
* // "taglines": [],
* // "urls": [],
* // "userDefined": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "addresses": [],
* // "ageRange": "my_ageRange",
* // "ageRanges": [],
* // "biographies": [],
* // "birthdays": [],
* // "braggingRights": [],
* // "calendarUrls": [],
* // "clientData": [],
* // "coverPhotos": [],
* // "emailAddresses": [],
* // "etag": "my_etag",
* // "events": [],
* // "externalIds": [],
* // "fileAses": [],
* // "genders": [],
* // "imClients": [],
* // "interests": [],
* // "locales": [],
* // "locations": [],
* // "memberships": [],
* // "metadata": {},
* // "miscKeywords": [],
* // "names": [],
* // "nicknames": [],
* // "occupations": [],
* // "organizations": [],
* // "phoneNumbers": [],
* // "photos": [],
* // "relations": [],
* // "relationshipInterests": [],
* // "relationshipStatuses": [],
* // "residences": [],
* // "resourceName": "my_resourceName",
* // "sipAddresses": [],
* // "skills": [],
* // "taglines": [],
* // "urls": [],
* // "userDefined": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
updateContact(
params: Params$Resource$People$Updatecontact,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
updateContact(
params?: Params$Resource$People$Updatecontact,
options?: MethodOptions
): GaxiosPromise<Schema$Person>;
updateContact(
params: Params$Resource$People$Updatecontact,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
updateContact(
params: Params$Resource$People$Updatecontact,
options: MethodOptions | BodyResponseCallback<Schema$Person>,
callback: BodyResponseCallback<Schema$Person>
): void;
updateContact(
params: Params$Resource$People$Updatecontact,
callback: BodyResponseCallback<Schema$Person>
): void;
updateContact(callback: BodyResponseCallback<Schema$Person>): void;
updateContact(
paramsOrCallback?:
| Params$Resource$People$Updatecontact
| BodyResponseCallback<Schema$Person>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Person>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Person>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Person> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$People$Updatecontact;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Updatecontact;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+resourceName}:updateContact').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'PATCH',
},
options
),
params,
requiredParams: ['resourceName'],
pathParams: ['resourceName'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Person>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Person>(parameters);
}
}
/**
* Update a contact's photo.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/contacts'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.updateContactPhoto({
* // Required. Person resource name
* resourceName: 'people/[^/]+',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "personFields": "my_personFields",
* // "photoBytes": "my_photoBytes",
* // "sources": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "person": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
updateContactPhoto(
params: Params$Resource$People$Updatecontactphoto,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
updateContactPhoto(
params?: Params$Resource$People$Updatecontactphoto,
options?: MethodOptions
): GaxiosPromise<Schema$UpdateContactPhotoResponse>;
updateContactPhoto(
params: Params$Resource$People$Updatecontactphoto,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
updateContactPhoto(
params: Params$Resource$People$Updatecontactphoto,
options:
| MethodOptions
| BodyResponseCallback<Schema$UpdateContactPhotoResponse>,
callback: BodyResponseCallback<Schema$UpdateContactPhotoResponse>
): void;
updateContactPhoto(
params: Params$Resource$People$Updatecontactphoto,
callback: BodyResponseCallback<Schema$UpdateContactPhotoResponse>
): void;
updateContactPhoto(
callback: BodyResponseCallback<Schema$UpdateContactPhotoResponse>
): void;
updateContactPhoto(
paramsOrCallback?:
| Params$Resource$People$Updatecontactphoto
| BodyResponseCallback<Schema$UpdateContactPhotoResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$UpdateContactPhotoResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$UpdateContactPhotoResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$UpdateContactPhotoResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$People$Updatecontactphoto;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Updatecontactphoto;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+resourceName}:updateContactPhoto').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'PATCH',
},
options
),
params,
requiredParams: ['resourceName'],
pathParams: ['resourceName'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$UpdateContactPhotoResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$UpdateContactPhotoResponse>(parameters);
}
}
}
export interface Params$Resource$People$Batchcreatecontacts
extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$BatchCreateContactsRequest;
}
export interface Params$Resource$People$Batchdeletecontacts
extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$BatchDeleteContactsRequest;
}
export interface Params$Resource$People$Batchupdatecontacts
extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$BatchUpdateContactsRequest;
}
export interface Params$Resource$People$Createcontact
extends StandardParameters {
/**
* Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
personFields?: string;
/**
* Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
*/
sources?: string[];
/**
* Request body metadata
*/
requestBody?: Schema$Person;
}
export interface Params$Resource$People$Deletecontact
extends StandardParameters {
/**
* Required. The resource name of the contact to delete.
*/
resourceName?: string;
}
export interface Params$Resource$People$Deletecontactphoto
extends StandardParameters {
/**
* Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
personFields?: string;
/**
* Required. The resource name of the contact whose photo will be deleted.
*/
resourceName?: string;
/**
* Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
*/
sources?: string[];
}
export interface Params$Resource$People$Get extends StandardParameters {
/**
* Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
personFields?: 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;
/**
* Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id\}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`.
*/
resourceName?: string;
/**
* Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.
*/
sources?: string[];
}
export interface Params$Resource$People$Getbatchget
extends StandardParameters {
/**
* Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
personFields?: 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;
/**
* Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=<name1\>&resourceNames=<name2\>&... - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id\}`. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`. There is a maximum of 200 resource names.
*/
resourceNames?: string[];
/**
* Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
*/
sources?: string[];
}
export interface Params$Resource$People$Listdirectorypeople
extends StandardParameters {
/**
* Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.
*/
mergeSources?: string[];
/**
* Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
*/
pageSize?: number;
/**
* Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the page token.
*/
pageToken?: string;
/**
* Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
readMask?: string;
/**
* Optional. Whether the response should return `next_sync_token`. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.listDirectoryPeople`.
*/
requestSyncToken?: boolean;
/**
* Required. Directory sources to return.
*/
sources?: string[];
/**
* Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.listDirectoryPeople` must match the first call that provided the sync token. More details about sync behavior at `people.listDirectoryPeople`.
*/
syncToken?: string;
}
export interface Params$Resource$People$Searchcontacts
extends StandardParameters {
/**
* Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.
*/
pageSize?: number;
/**
* Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n".
*/
query?: string;
/**
* Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
readMask?: string;
/**
* Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set.
*/
sources?: string[];
}
export interface Params$Resource$People$Searchdirectorypeople
extends StandardParameters {
/**
* Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.
*/
mergeSources?: string[];
/**
* Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.
*/
pageSize?: number;
/**
* Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the first call that provided the page token.
*/
pageToken?: string;
/**
* Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.
*/
query?: string;
/**
* Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
readMask?: string;
/**
* Required. Directory sources to return.
*/
sources?: string[];
}
export interface Params$Resource$People$Updatecontact
extends StandardParameters {
/**
* Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
personFields?: 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/{person_id\}`.
*/
resourceName?: string;
/**
* Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
*/
sources?: string[];
/**
* Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined
*/
updatePersonFields?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Person;
}
export interface Params$Resource$People$Updatecontactphoto
extends StandardParameters {
/**
* Required. Person resource name
*/
resourceName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateContactPhotoRequest;
}
export class Resource$People$Connections {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Provides a list of the authenticated user's contacts. Sync tokens expire 7 days after the full sync. A request with an expired sync token will result in a 410 error. In the case of such an error clients should make a full sync request without a `sync_token`. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the `sync_token` is specified, resources deleted since the last sync will be returned as a person with `PersonMetadata.deleted` set to true. When the `page_token` or `sync_token` is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at [List the user's contacts that have changed](/people/v1/contacts#list_the_users_contacts_that_have_changed).
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/people.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const people = google.people('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/contacts',
* 'https://www.googleapis.com/auth/contacts.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await people.people.connections.list({
* // Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
* pageSize: 'placeholder-value',
* // Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.connections.list` must match the first call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
* personFields: 'placeholder-value',
* // 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': 'placeholder-value',
* // Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.connections.list`.
* requestSyncToken: 'placeholder-value',
* // Required. The resource name to return connections for. Only `people/me` is valid.
* resourceName: 'people/[^/]+',
* // Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.
* sortOrder: 'placeholder-value',
* // Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
* sources: 'placeholder-value',
* // Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.connections.list` must match the first call that provided the sync token. More details about sync behavior at `people.connections.list`.
* syncToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "connections": [],
* // "nextPageToken": "my_nextPageToken",
* // "nextSyncToken": "my_nextSyncToken",
* // "totalItems": 0,
* // "totalPeople": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(
params: Params$Resource$People$Connections$List,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
list(
params?: Params$Resource$People$Connections$List,
options?: MethodOptions
): GaxiosPromise<Schema$ListConnectionsResponse>;
list(
params: Params$Resource$People$Connections$List,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
list(
params: Params$Resource$People$Connections$List,
options:
| MethodOptions
| BodyResponseCallback<Schema$ListConnectionsResponse>,
callback: BodyResponseCallback<Schema$ListConnectionsResponse>
): void;
list(
params: Params$Resource$People$Connections$List,
callback: BodyResponseCallback<Schema$ListConnectionsResponse>
): void;
list(callback: BodyResponseCallback<Schema$ListConnectionsResponse>): void;
list(
paramsOrCallback?:
| Params$Resource$People$Connections$List
| BodyResponseCallback<Schema$ListConnectionsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ListConnectionsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ListConnectionsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ListConnectionsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$People$Connections$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$People$Connections$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://people.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1/{+resourceName}/connections').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['resourceName'],
pathParams: ['resourceName'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ListConnectionsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ListConnectionsResponse>(parameters);
}
}
}
export interface Params$Resource$People$Connections$List
extends StandardParameters {
/**
* Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
*/
pageSize?: number;
/**
* Optional. A page token, received from a previous response `next_page_token`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `people.connections.list` must match the first call that provided the page token.
*/
pageToken?: string;
/**
* Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
*/
personFields?: 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;
/**
* Optional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.connections.list`.
*/
requestSyncToken?: boolean;
/**
* Required. The resource name to return connections for. Only `people/me` is valid.
*/
resourceName?: string;
/**
* Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.
*/
sortOrder?: string;
/**
* Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
*/
sources?: string[];
/**
* Optional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.connections.list` must match the first call that provided the sync token. More details about sync behavior at `people.connections.list`.
*/
syncToken?: string;
}
}