Contact Groups
create
contactGroups.create
Create a contact group
Risk: write
await corsair.googlecontacts.api.contactGroups.create({});
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
etag | string | No | — |
metadata | object | No | — |
groupType | string | No | — |
name | string | No | — |
formattedName | string | No | — |
memberResourceNames | string[] | No | — |
memberCount | number | No | — |
metadata full type
metadata full type
{
updateTime?: string,
deleted?: boolean
}
delete
contactGroups.delete
Delete a contact group, optionally with its contacts [DESTRUCTIVE · IRREVERSIBLE]
Risk: destructive · Irreversible
await corsair.googlecontacts.api.contactGroups.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
deleteContacts | boolean | No | Also delete the contacts in the group, not just the group |
void
get
contactGroups.get
Get a single contact group
Risk: read
await corsair.googlecontacts.api.contactGroups.get({});
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | e.g. “contactGroups/myContacts” |
maxMembers | number | No | — |
groupFields | string[] | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
etag | string | No | — |
metadata | object | No | — |
groupType | string | No | — |
name | string | No | — |
formattedName | string | No | — |
memberResourceNames | string[] | No | — |
memberCount | number | No | — |
metadata full type
metadata full type
{
updateTime?: string,
deleted?: boolean
}
list
contactGroups.list
List contact groups
Risk: read
await corsair.googlecontacts.api.contactGroups.list({});
| Name | Type | Required | Description |
|---|---|---|---|
pageSize | number | No | — |
pageToken | string | No | — |
syncToken | string | No | — |
groupFields | string[] | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
contactGroups | object[] | No | — |
nextPageToken | string | No | — |
nextSyncToken | string | No | — |
totalItems | number | No | — |
contactGroups full type
contactGroups full type
{
resourceName: string,
etag?: string,
metadata?: {
updateTime?: string,
deleted?: boolean
},
groupType?: string,
name?: string,
formattedName?: string,
memberResourceNames?: string[],
memberCount?: number
}[]
modifyMembers
contactGroups.modifyMembers
Add or remove contacts from a group
Risk: write
await corsair.googlecontacts.api.contactGroups.modifyMembers({});
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
resourceNamesToAdd | string[] | No | — |
resourceNamesToRemove | string[] | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
notFoundResourceNames | string[] | No | — |
canNotRemoveLastContactGroupResourceNames | string[] | No | — |
update
contactGroups.update
Rename a contact group
Risk: write
await corsair.googlecontacts.api.contactGroups.update({});
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
etag | string | Yes | — |
name | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
etag | string | No | — |
metadata | object | No | — |
groupType | string | No | — |
name | string | No | — |
formattedName | string | No | — |
memberResourceNames | string[] | No | — |
memberCount | number | No | — |
metadata full type
metadata full type
{
updateTime?: string,
deleted?: boolean
}
Contacts
create
contacts.create
Create a new contact
Risk: write
await corsair.googlecontacts.api.contacts.create({});
| Name | Type | Required | Description |
|---|---|---|---|
person | object | Yes | — |
personFields | string[] | No | Person fields to return, e.g. [“names”,“emailAddresses”,“phoneNumbers”]. Defaults to names, emailAddresses and phoneNumbers. |
person full type
person full type
{
names?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
displayName?: string,
familyName?: string,
givenName?: string,
middleName?: string,
honorificPrefix?: string,
honorificSuffix?: string
}[],
emailAddresses?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
type?: string,
displayName?: string
}[],
phoneNumbers?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
canonicalForm?: string,
type?: string
}[],
organizations?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
name?: string,
title?: string,
department?: string
}[],
addresses?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
formattedValue?: string,
streetAddress?: string,
city?: string,
region?: string,
postalCode?: string,
country?: string,
countryCode?: string,
type?: string
}[],
biographies?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
contentType?: string
}[]
}
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
etag | string | No | — |
metadata | object | No | — |
names | object[] | No | — |
emailAddresses | object[] | No | — |
phoneNumbers | object[] | No | — |
organizations | object[] | No | — |
addresses | object[] | No | — |
photos | object[] | No | — |
biographies | object[] | No | — |
memberships | object[] | No | — |
metadata full type
metadata full type
{
sources?: {
type?: string,
id?: string,
etag?: string
}[],
deleted?: boolean,
objectType?: string
}
names full type
names full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
displayName?: string,
familyName?: string,
givenName?: string,
middleName?: string,
honorificPrefix?: string,
honorificSuffix?: string
}[]
emailAddresses full type
emailAddresses full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
type?: string,
displayName?: string
}[]
phoneNumbers full type
phoneNumbers full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
canonicalForm?: string,
type?: string
}[]
organizations full type
organizations full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
name?: string,
title?: string,
department?: string
}[]
addresses full type
addresses full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
formattedValue?: string,
streetAddress?: string,
city?: string,
region?: string,
postalCode?: string,
country?: string,
countryCode?: string,
type?: string
}[]
photos full type
photos full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
url?: string,
default?: boolean
}[]
biographies full type
biographies full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
contentType?: string
}[]
memberships full type
memberships full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
contactGroupMembership?: {
contactGroupId?: string,
contactGroupResourceName?: string
}
}[]
delete
contacts.delete
Permanently delete a contact [DESTRUCTIVE · IRREVERSIBLE]
Risk: destructive · Irreversible
await corsair.googlecontacts.api.contacts.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
void
deletePhoto
contacts.deletePhoto
Remove a contact’s photo [DESTRUCTIVE]
Risk: destructive
await corsair.googlecontacts.api.contacts.deletePhoto({});
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
personFields | string[] | No | Person fields to return, e.g. [“names”,“emailAddresses”,“phoneNumbers”]. Defaults to names, emailAddresses and phoneNumbers. |
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
etag | string | No | — |
metadata | object | No | — |
names | object[] | No | — |
emailAddresses | object[] | No | — |
phoneNumbers | object[] | No | — |
organizations | object[] | No | — |
addresses | object[] | No | — |
photos | object[] | No | — |
biographies | object[] | No | — |
memberships | object[] | No | — |
metadata full type
metadata full type
{
sources?: {
type?: string,
id?: string,
etag?: string
}[],
deleted?: boolean,
objectType?: string
}
names full type
names full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
displayName?: string,
familyName?: string,
givenName?: string,
middleName?: string,
honorificPrefix?: string,
honorificSuffix?: string
}[]
emailAddresses full type
emailAddresses full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
type?: string,
displayName?: string
}[]
phoneNumbers full type
phoneNumbers full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
canonicalForm?: string,
type?: string
}[]
organizations full type
organizations full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
name?: string,
title?: string,
department?: string
}[]
addresses full type
addresses full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
formattedValue?: string,
streetAddress?: string,
city?: string,
region?: string,
postalCode?: string,
country?: string,
countryCode?: string,
type?: string
}[]
photos full type
photos full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
url?: string,
default?: boolean
}[]
biographies full type
biographies full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
contentType?: string
}[]
memberships full type
memberships full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
contactGroupMembership?: {
contactGroupId?: string,
contactGroupResourceName?: string
}
}[]
get
contacts.get
Get a single contact
Risk: read
await corsair.googlecontacts.api.contacts.get({});
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | e.g. “people/c123456789” or “people/me” for the signed-in user |
personFields | string[] | No | Person fields to return, e.g. [“names”,“emailAddresses”,“phoneNumbers”]. Defaults to names, emailAddresses and phoneNumbers. |
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
etag | string | No | — |
metadata | object | No | — |
names | object[] | No | — |
emailAddresses | object[] | No | — |
phoneNumbers | object[] | No | — |
organizations | object[] | No | — |
addresses | object[] | No | — |
photos | object[] | No | — |
biographies | object[] | No | — |
memberships | object[] | No | — |
metadata full type
metadata full type
{
sources?: {
type?: string,
id?: string,
etag?: string
}[],
deleted?: boolean,
objectType?: string
}
names full type
names full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
displayName?: string,
familyName?: string,
givenName?: string,
middleName?: string,
honorificPrefix?: string,
honorificSuffix?: string
}[]
emailAddresses full type
emailAddresses full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
type?: string,
displayName?: string
}[]
phoneNumbers full type
phoneNumbers full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
canonicalForm?: string,
type?: string
}[]
organizations full type
organizations full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
name?: string,
title?: string,
department?: string
}[]
addresses full type
addresses full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
formattedValue?: string,
streetAddress?: string,
city?: string,
region?: string,
postalCode?: string,
country?: string,
countryCode?: string,
type?: string
}[]
photos full type
photos full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
url?: string,
default?: boolean
}[]
biographies full type
biographies full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
contentType?: string
}[]
memberships full type
memberships full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
contactGroupMembership?: {
contactGroupId?: string,
contactGroupResourceName?: string
}
}[]
list
contacts.list
List the user’s contacts
Risk: read
await corsair.googlecontacts.api.contacts.list({});
| Name | Type | Required | Description |
|---|---|---|---|
personFields | string[] | No | Person fields to return, e.g. [“names”,“emailAddresses”,“phoneNumbers”]. Defaults to names, emailAddresses and phoneNumbers. |
pageSize | number | No | — |
pageToken | string | No | — |
sortOrder | LAST_MODIFIED_ASCENDING | LAST_MODIFIED_DESCENDING | FIRST_NAME_ASCENDING | LAST_NAME_ASCENDING | No | — |
requestSyncToken | boolean | No | Return a nextSyncToken for incremental reads. Expires after 7 days. |
syncToken | string | No | Return only changes since this token. An expired token answers 410 EXPIRED_SYNC_TOKEN; re-list in full. |
| Name | Type | Required | Description |
|---|---|---|---|
connections | object[] | No | — |
nextPageToken | string | No | — |
nextSyncToken | string | No | — |
totalPeople | number | No | — |
totalItems | number | No | — |
connections full type
connections full type
{
resourceName: string,
etag?: string,
metadata?: {
sources?: {
type?: string,
id?: string,
etag?: string
}[],
deleted?: boolean,
objectType?: string
},
names?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
displayName?: string,
familyName?: string,
givenName?: string,
middleName?: string,
honorificPrefix?: string,
honorificSuffix?: string
}[],
emailAddresses?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
type?: string,
displayName?: string
}[],
phoneNumbers?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
canonicalForm?: string,
type?: string
}[],
organizations?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
name?: string,
title?: string,
department?: string
}[],
addresses?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
formattedValue?: string,
streetAddress?: string,
city?: string,
region?: string,
postalCode?: string,
country?: string,
countryCode?: string,
type?: string
}[],
photos?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
url?: string,
default?: boolean
}[],
biographies?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
contentType?: string
}[],
memberships?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
contactGroupMembership?: {
contactGroupId?: string,
contactGroupResourceName?: string
}
}[]
}[]
search
contacts.search
Search contacts by name, email or phone. Google warms this index per account, so the first call after authorizing can return nothing; retry.
Risk: read
await corsair.googlecontacts.api.contacts.search({});
| Name | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Prefix-matched against names, nicknames, emails and phones |
readMask | string[] | No | Person fields to return, e.g. [“names”,“emailAddresses”,“phoneNumbers”]. Defaults to names, emailAddresses and phoneNumbers. |
pageSize | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
results | object[] | No | — |
results full type
results full type
{
person?: {
resourceName: string,
etag?: string,
metadata?: {
sources?: {
type?: string,
id?: string,
etag?: string
}[],
deleted?: boolean,
objectType?: string
},
names?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
displayName?: string,
familyName?: string,
givenName?: string,
middleName?: string,
honorificPrefix?: string,
honorificSuffix?: string
}[],
emailAddresses?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
type?: string,
displayName?: string
}[],
phoneNumbers?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
canonicalForm?: string,
type?: string
}[],
organizations?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
name?: string,
title?: string,
department?: string
}[],
addresses?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
formattedValue?: string,
streetAddress?: string,
city?: string,
region?: string,
postalCode?: string,
country?: string,
countryCode?: string,
type?: string
}[],
photos?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
url?: string,
default?: boolean
}[],
biographies?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
contentType?: string
}[],
memberships?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
contactGroupMembership?: {
contactGroupId?: string,
contactGroupResourceName?: string
}
}[]
}
}[]
update
contacts.update
Update an existing contact
Risk: write
await corsair.googlecontacts.api.contacts.update({});
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
etag | string | Yes | etag from a prior read; the API rejects updates without it |
person | object | Yes | — |
updatePersonFields | string[] | Yes | Fields to overwrite, e.g. [“emailAddresses”]. Omitted fields are left untouched. |
personFields | string[] | No | Person fields to return, e.g. [“names”,“emailAddresses”,“phoneNumbers”]. Defaults to names, emailAddresses and phoneNumbers. |
person full type
person full type
{
names?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
displayName?: string,
familyName?: string,
givenName?: string,
middleName?: string,
honorificPrefix?: string,
honorificSuffix?: string
}[],
emailAddresses?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
type?: string,
displayName?: string
}[],
phoneNumbers?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
canonicalForm?: string,
type?: string
}[],
organizations?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
name?: string,
title?: string,
department?: string
}[],
addresses?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
formattedValue?: string,
streetAddress?: string,
city?: string,
region?: string,
postalCode?: string,
country?: string,
countryCode?: string,
type?: string
}[],
biographies?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
contentType?: string
}[]
}
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
etag | string | No | — |
metadata | object | No | — |
names | object[] | No | — |
emailAddresses | object[] | No | — |
phoneNumbers | object[] | No | — |
organizations | object[] | No | — |
addresses | object[] | No | — |
photos | object[] | No | — |
biographies | object[] | No | — |
memberships | object[] | No | — |
metadata full type
metadata full type
{
sources?: {
type?: string,
id?: string,
etag?: string
}[],
deleted?: boolean,
objectType?: string
}
names full type
names full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
displayName?: string,
familyName?: string,
givenName?: string,
middleName?: string,
honorificPrefix?: string,
honorificSuffix?: string
}[]
emailAddresses full type
emailAddresses full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
type?: string,
displayName?: string
}[]
phoneNumbers full type
phoneNumbers full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
canonicalForm?: string,
type?: string
}[]
organizations full type
organizations full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
name?: string,
title?: string,
department?: string
}[]
addresses full type
addresses full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
formattedValue?: string,
streetAddress?: string,
city?: string,
region?: string,
postalCode?: string,
country?: string,
countryCode?: string,
type?: string
}[]
photos full type
photos full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
url?: string,
default?: boolean
}[]
biographies full type
biographies full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
contentType?: string
}[]
memberships full type
memberships full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
contactGroupMembership?: {
contactGroupId?: string,
contactGroupResourceName?: string
}
}[]
updatePhoto
contacts.updatePhoto
Set or replace a contact’s photo
Risk: write
await corsair.googlecontacts.api.contacts.updatePhoto({});
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
photoBytes | string | Yes | Base64-encoded image |
personFields | string[] | No | Person fields to return, e.g. [“names”,“emailAddresses”,“phoneNumbers”]. Defaults to names, emailAddresses and phoneNumbers. |
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
etag | string | No | — |
metadata | object | No | — |
names | object[] | No | — |
emailAddresses | object[] | No | — |
phoneNumbers | object[] | No | — |
organizations | object[] | No | — |
addresses | object[] | No | — |
photos | object[] | No | — |
biographies | object[] | No | — |
memberships | object[] | No | — |
metadata full type
metadata full type
{
sources?: {
type?: string,
id?: string,
etag?: string
}[],
deleted?: boolean,
objectType?: string
}
names full type
names full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
displayName?: string,
familyName?: string,
givenName?: string,
middleName?: string,
honorificPrefix?: string,
honorificSuffix?: string
}[]
emailAddresses full type
emailAddresses full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
type?: string,
displayName?: string
}[]
phoneNumbers full type
phoneNumbers full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
canonicalForm?: string,
type?: string
}[]
organizations full type
organizations full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
name?: string,
title?: string,
department?: string
}[]
addresses full type
addresses full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
formattedValue?: string,
streetAddress?: string,
city?: string,
region?: string,
postalCode?: string,
country?: string,
countryCode?: string,
type?: string
}[]
photos full type
photos full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
url?: string,
default?: boolean
}[]
biographies full type
biographies full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
contentType?: string
}[]
memberships full type
memberships full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
contactGroupMembership?: {
contactGroupId?: string,
contactGroupResourceName?: string
}
}[]
Other Contacts
copyToContacts
otherContacts.copyToContacts
Copy an auto-saved contact into the saved contacts
Risk: write
await corsair.googlecontacts.api.otherContacts.copyToContacts({});
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | e.g. “otherContacts/c123456789” |
copyMask | (emailAddresses | names | phoneNumbers)[] | No | Fields to carry over. Google permits only these three. |
personFields | string[] | No | Person fields to return, e.g. [“names”,“emailAddresses”,“phoneNumbers”]. Defaults to names, emailAddresses and phoneNumbers. |
| Name | Type | Required | Description |
|---|---|---|---|
resourceName | string | Yes | — |
etag | string | No | — |
metadata | object | No | — |
names | object[] | No | — |
emailAddresses | object[] | No | — |
phoneNumbers | object[] | No | — |
organizations | object[] | No | — |
addresses | object[] | No | — |
photos | object[] | No | — |
biographies | object[] | No | — |
memberships | object[] | No | — |
metadata full type
metadata full type
{
sources?: {
type?: string,
id?: string,
etag?: string
}[],
deleted?: boolean,
objectType?: string
}
names full type
names full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
displayName?: string,
familyName?: string,
givenName?: string,
middleName?: string,
honorificPrefix?: string,
honorificSuffix?: string
}[]
emailAddresses full type
emailAddresses full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
type?: string,
displayName?: string
}[]
phoneNumbers full type
phoneNumbers full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
canonicalForm?: string,
type?: string
}[]
organizations full type
organizations full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
name?: string,
title?: string,
department?: string
}[]
addresses full type
addresses full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
formattedValue?: string,
streetAddress?: string,
city?: string,
region?: string,
postalCode?: string,
country?: string,
countryCode?: string,
type?: string
}[]
photos full type
photos full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
url?: string,
default?: boolean
}[]
biographies full type
biographies full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
contentType?: string
}[]
memberships full type
memberships full type
{
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
contactGroupMembership?: {
contactGroupId?: string,
contactGroupResourceName?: string
}
}[]
list
otherContacts.list
List auto-saved contacts the user never filed
Risk: read
await corsair.googlecontacts.api.otherContacts.list({});
| Name | Type | Required | Description |
|---|---|---|---|
readMask | (emailAddresses | metadata | names | phoneNumbers | photos)[] | No | — |
pageSize | number | No | — |
pageToken | string | No | — |
requestSyncToken | boolean | No | Return a nextSyncToken for incremental reads. Expires after 7 days. |
syncToken | string | No | Return only changes since this token. Deleted contacts come back with metadata.deleted set. |
| Name | Type | Required | Description |
|---|---|---|---|
otherContacts | object[] | No | — |
nextPageToken | string | No | — |
nextSyncToken | string | No | — |
totalSize | number | No | — |
otherContacts full type
otherContacts full type
{
resourceName: string,
etag?: string,
metadata?: {
sources?: {
type?: string,
id?: string,
etag?: string
}[],
deleted?: boolean,
objectType?: string
},
names?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
displayName?: string,
familyName?: string,
givenName?: string,
middleName?: string,
honorificPrefix?: string,
honorificSuffix?: string
}[],
emailAddresses?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
type?: string,
displayName?: string
}[],
phoneNumbers?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
canonicalForm?: string,
type?: string
}[],
organizations?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
name?: string,
title?: string,
department?: string
}[],
addresses?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
formattedValue?: string,
streetAddress?: string,
city?: string,
region?: string,
postalCode?: string,
country?: string,
countryCode?: string,
type?: string
}[],
photos?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
url?: string,
default?: boolean
}[],
biographies?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
contentType?: string
}[],
memberships?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
contactGroupMembership?: {
contactGroupId?: string,
contactGroupResourceName?: string
}
}[]
}[]
search
otherContacts.search
Search auto-saved contacts
Risk: read
await corsair.googlecontacts.api.otherContacts.search({});
| Name | Type | Required | Description |
|---|---|---|---|
query | string | Yes | — |
readMask | (emailAddresses | metadata | names | phoneNumbers)[] | No | — |
pageSize | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
results | object[] | No | — |
results full type
results full type
{
person?: {
resourceName: string,
etag?: string,
metadata?: {
sources?: {
type?: string,
id?: string,
etag?: string
}[],
deleted?: boolean,
objectType?: string
},
names?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
displayName?: string,
familyName?: string,
givenName?: string,
middleName?: string,
honorificPrefix?: string,
honorificSuffix?: string
}[],
emailAddresses?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
type?: string,
displayName?: string
}[],
phoneNumbers?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
canonicalForm?: string,
type?: string
}[],
organizations?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
name?: string,
title?: string,
department?: string
}[],
addresses?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
formattedValue?: string,
streetAddress?: string,
city?: string,
region?: string,
postalCode?: string,
country?: string,
countryCode?: string,
type?: string
}[],
photos?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
url?: string,
default?: boolean
}[],
biographies?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
value?: string,
contentType?: string
}[],
memberships?: {
metadata?: {
primary?: boolean,
verified?: boolean,
source?: {
type?: string,
id?: string
}
},
contactGroupMembership?: {
contactGroupId?: string,
contactGroupResourceName?: string
}
}[]
}
}[]