nodes/generated

Interface GoogleContactsNodeParameters

Source
interface GoogleContactsNodeParameters {
    additionalFields?: {
        addressesUi?: {
            addressesValues: {
                city?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                streetAddress?: string;
                type?: "home" | "work" | "other";
            };
        };
        biographies?: string;
        birthday?: string;
        companyUi?: {
            companyValues: {
                current?: boolean;
                domain?: string;
                name?: string;
                title?: string;
            }[];
        };
        customFieldsUi?: {
            customFieldsValues: {
                key?: string;
                value?: string;
            }[];
        };
        emailsUi?: {
            emailsValues: {
                type?: "home"
                | "work"
                | "other";
                value?: string;
            }[];
        };
        eventsUi?: {
            eventsValues: {
                date?: string;
                type?: "other"
                | "anniversary";
            }[];
        };
        fileAs?: string;
        group?: unknown[];
        honorificPrefix?: string;
        honorificSuffix?: string;
        middleName?: string;
        phoneUi?: {
            phoneValues: {
                type?: | "main"
                | "home"
                | "work"
                | "homeFax"
                | "mobile"
                | "other"
                | "workFax"
                | "pager"
                | "googleVoice"
                | "otherFax"
                | "workMobile"
                | "workPager";
                value?: string;
            }[];
        };
        relationsUi?: {
            relationsValues: {
                person?: string;
                type?: | "assistant"
                | "parent"
                | "brother"
                | "child"
                | "domesticPartner"
                | "father"
                | "friend"
                | "manager"
                | "mother"
                | "referredBy"
                | "relative"
                | "sister"
                | "spouse";
            }[];
        };
    };
    contactId?: string;
    familyName?: string;
    fields?: (
        | "metadata"
        | "*"
        | "addresses"
        | "biographies"
        | "birthdays"
        | "coverPhotos"
        | "emailAddresses"
        | "events"
        | "genders"
        | "imClients"
        | "interests"
        | "locales"
        | "memberships"
        | "names"
        | "nicknames"
        | "occupations"
        | "organizations"
        | "phoneNumbers"
        | "photos"
        | "relations"
        | "residences"
        | "sipAddresses"
        | "skills"
        | "urls"
        | "userDefined"
    )[];
    givenName?: string;
    limit?: number;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete";
    options?: {
        sortOrder?: | "LAST_MODIFIED_ASCENDING"
        | "LAST_MODIFIED_DESCENDING"
        | "FIRST_NAME_ASCENDING"
        | "LAST_NAME_ASCENDING";
    };
    query?: string;
    rawData?: boolean;
    resource?: "contact";
    returnAll?: boolean;
    updateFields?: {
        addressesUi?: {
            addressesValues: {
                city?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                streetAddress?: string;
                type?: "home"
                | "work"
                | "other";
            };
        };
        biographies?: string;
        birthday?: string;
        companyUi?: {
            companyValues: {
                current?: boolean;
                domain?: string;
                name?: string;
                title?: string;
            }[];
        };
        customFieldsUi?: {
            customFieldsValues: {
                key?: string;
                value?: string;
            }[];
        };
        emailsUi?: {
            emailsValues: {
                type?: "home"
                | "work"
                | "other";
                value?: string;
            }[];
        };
        etag?: string;
        eventsUi?: {
            eventsValues: {
                date?: string;
                type?: "other"
                | "anniversary";
            }[];
        };
        familyName?: string;
        fileAs?: string;
        givenName?: string;
        group?: unknown[];
        honorificPrefix?: string;
        honorificSuffix?: string;
        middleName?: string;
        phoneUi?: {
            phoneValues: {
                type?: | "main"
                | "home"
                | "work"
                | "homeFax"
                | "mobile"
                | "other"
                | "workFax"
                | "pager"
                | "googleVoice"
                | "otherFax"
                | "workMobile"
                | "workPager";
                value?: string;
            }[];
        };
        relationsUi?: {
            relationsValues: {
                person?: string;
                type?: | "assistant"
                | "parent"
                | "brother"
                | "child"
                | "domesticPartner"
                | "father"
                | "friend"
                | "manager"
                | "mother"
                | "referredBy"
                | "relative"
                | "sister"
                | "spouse";
            }[];
        };
    };
    useQuery?: boolean;
}

Properties§

§readonly additionalFields?: { ... }

Default: {}

§readonly contactId?: string
§readonly familyName?: string
§readonly fields?: (
    | "metadata"
    | "*"
    | "addresses"
    | "biographies"
    | "birthdays"
    | "coverPhotos"
    | "emailAddresses"
    | "events"
    | "genders"
    | "imClients"
    | "interests"
    | "locales"
    | "memberships"
    | "names"
    | "nicknames"
    | "occupations"
    | "organizations"
    | "phoneNumbers"
    | "photos"
    | "relations"
    | "residences"
    | "sipAddresses"
    | "skills"
    | "urls"
    | "userDefined"
)[]

A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Default: []

§readonly givenName?: string
§readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}

§readonly operation?: "create" | "get" | "getAll" | "update" | "delete"

Default: "create"

§readonly options?: { ... }

Default: {}

§readonly query?: string

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".

§readonly rawData?: boolean

Whether to return the data exactly in the way it got received from the API

§readonly resource?: "contact"

Default: "contact"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly updateFields?: { ... }

Default: {}

§readonly useQuery?: boolean

Whether or not to use a query to filter the results