nodes/generated

Interface AffinityNodeParameters

Source


interface AffinityNodeParameters {
    additionalFields?:
        | { creator_id?: string }
        | { persons?: unknown[] }
        | { organizations?: unknown[] };
    domain?: string;
    emails?: string;
    entityId?: string;
    firstName?: string;
    lastName?: string;
    limit?: number;
    listEntryId?: string;
    listId?: string;
    name?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete";
    options?: | { withInteractionDates?: boolean }
    | { term?: string; withInteractionDates?: boolean };
    organizationId?: string;
    personId?: string;
    resource?:
        | "person"
        | "list"
        | "listEntry"
        | "organization";
    returnAll?: boolean;
    updateFields?: | {
        domain?: string;
        name?: string;
        persons?: unknown[];
    }
    | {
        firstName?: string;
        lastName?: string;
        organizations?: unknown[];
    };
}

Properties§

§readonly additionalFields?:
    | { creator_id?: string }
    | { persons?: unknown[] }
    | { organizations?: unknown[] }

Default: {}

§readonly domain?: string

The domain name of the organization

§readonly emails?: string

The email addresses of the person Default: [] Type options: {"multipleValues":true,"multipleValueButtonText":"Add To Email"}

§readonly entityId?: string

The unique ID of the entity (person, organization, or opportunity) to add to this list

§readonly firstName?: string

The first name of the person

§readonly lastName?: string

The last name of the person

§readonly limit?: number

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

§readonly listEntryId?: string

The unique ID of the list entry object to be retrieved

§readonly listId?: string

The unique ID of the list object to be retrieved

§readonly name?: string

The name of the organization

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

Default: "get"

§readonly options?:
    | { withInteractionDates?: boolean }
    | { term?: string; withInteractionDates?: boolean }

Default: {}

§readonly organizationId?: string

Unique identifier for the organization

§readonly personId?: string

Unique identifier for the person

§readonly resource?: "person" | "list" | "listEntry" | "organization"

Default: "organization"

§readonly returnAll?: boolean

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

§readonly updateFields?:
    | {
        domain?: string;
        name?: string;
        persons?: unknown[];
    }
    | {
        firstName?: string;
        lastName?: string;
        organizations?: unknown[];
    }

Default: {}