nodes/generated

Interface AgileCrmNodeParameters

Source
interface AgileCrmNodeParameters {
    additionalFields?:
        | {
            addressOptions?: {
                addressProperties: {
                    address: string;
                    subtype: "home"
                    | "postal"
                    | "office";
                }[];
            };
            company?: string;
            customProperties?: {
                customProperty: {
                    name: string;
                    subtype?: string;
                    value?: string;
                }[];
            };
            emailOptions?: {
                emailProperties: {
                    email: string;
                    subtype: "work"
                    | "personal";
                }[];
            };
            firstName?: string;
            lastName?: string;
            leadScore?: number;
            phoneOptions?: {
                phoneProperties: {
                    number: string;
                    subtype: | "main"
                    | "home"
                    | "work"
                    | "homeFax"
                    | "mobile"
                    | "other"
                    | "workFax";
                }[];
            };
            starValue?: 0
            | 1
            | 3
            | 2
            | 4
            | 5;
            tags?: string;
            title?: string;
            websiteOptions?: {
                websiteProperties: {
                    subtype:
                        | "facebook"
                        | "feed"
                        | "flickr"
                        | "github"
                        | "googlePlus"
                        | "linkedin"
                        | "skype"
                        | "twitter"
                        | "url"
                        | "xing"
                        | "youtube";
                    url: string;
                }[];
            };
        }
        | {
            addressOptions?: {
                addressProperties: {
                    address: string;
                    subtype: "home"
                    | "postal"
                    | "office";
                }[];
            };
            company?: string;
            customProperties?: {
                customProperty: {
                    name: string;
                    subtype?: string;
                    value?: string;
                }[];
            };
            emailOptions?: {
                emailProperties: {
                    email: string;
                    subtype: "work"
                    | "personal";
                }[];
            };
            firstName?: string;
            lastName?: string;
            leadScore?: number;
            phoneOptions?: {
                phoneProperties: {
                    number: string;
                    subtype: | "main"
                    | "home"
                    | "work"
                    | "homeFax"
                    | "mobile"
                    | "other"
                    | "workFax";
                }[];
            };
            starValue?: 0
            | 1
            | 3
            | 2
            | 4
            | 5;
            tags?: string;
            title?: string;
            websiteOptions?: {
                websiteProperties: {
                    subtype:
                        | "facebook"
                        | "feed"
                        | "flickr"
                        | "github"
                        | "googlePlus"
                        | "linkedin"
                        | "skype"
                        | "twitter"
                        | "url"
                        | "xing"
                        | "youtube";
                    url: string;
                }[];
            };
        }
        | {
            addressOptions?: {
                addressProperties: {
                    address: string;
                    subtype: "postal"
                    | "office";
                }[];
            };
            customProperties?: {
                customProperty: {
                    name: string;
                    subtype?: string;
                    value?: string;
                }[];
            };
            email?: string;
            name?: string;
            phone?: string;
            starValue?: 0
            | 1
            | 3
            | 2
            | 4
            | 5;
            tags?: string;
            websiteOptions?: {
                websiteProperties: {
                    subtype:
                        | "facebook"
                        | "feed"
                        | "flickr"
                        | "github"
                        | "googlePlus"
                        | "linkedin"
                        | "skype"
                        | "twitter"
                        | "url"
                        | "xing"
                        | "youtube";
                    url: string;
                }[];
            };
        }
        | {
            addressOptions?: {
                addressProperties: {
                    address: string;
                    subtype: "postal"
                    | "office";
                }[];
            };
            customProperties?: {
                customProperty: {
                    name: string;
                    subtype?: string;
                    value?: string;
                }[];
            };
            email?: string;
            name?: string;
            phone?: string;
            starValue?: 0
            | 1
            | 3
            | 2
            | 4
            | 5;
            tags?: string;
            websiteOptions?: {
                websiteProperties: {
                    subtype:
                        | "facebook"
                        | "feed"
                        | "flickr"
                        | "github"
                        | "googlePlus"
                        | "linkedin"
                        | "skype"
                        | "twitter"
                        | "url"
                        | "xing"
                        | "youtube";
                    url: string;
                }[];
            };
        }
        | {
            contactIds?: string;
            customData?: {
                customProperty: { name: string; value?: string }[];
            };
        }
        | {
            contactIds?: string;
            customData?: {
                customProperty: { name: string; value?: string }[];
            };
            expectedValue?: number;
            name?: string;
            probability?: number;
        };
    additionalFieldsJson?: string;
    closeDate?: string;
    companyId?: string;
    contactId?: string;
    dealId?: string;
    expectedValue?: number;
    filterJson?: string;
    filters?: {
        conditions: {
            condition_type?: | "AFTER"
            | "BEFORE"
            | "BETWEEN"
            | "EQUALS"
            | "LAST"
            | "NOTEQUALS"
            | "ON";
            field?: string;
            value?: string;
            value2?: string;
        }[];
    };
    filterType?: "none"
    | "manual"
    | "json";
    jsonParameters?: boolean;
    limit?: number;
    matchType?: "anyFilter" | "allFilters";
    milestone?: string;
    name?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete";
    options?: {
        sort?: {
            sort: {
                direction?: "ASC"
                | "DESC";
                field?: string;
            };
        };
    };
    probability?: number;
    resource?: "contact"
    | "deal"
    | "company";
    returnAll?: boolean;
    simple?: boolean;
}

Properties§

§readonly additionalFields?:
    | {
        addressOptions?: {
            addressProperties: {
                address: string;
                subtype: "home"
                | "postal"
                | "office";
            }[];
        };
        company?: string;
        customProperties?: {
            customProperty: {
                name: string;
                subtype?: string;
                value?: string;
            }[];
        };
        emailOptions?: {
            emailProperties: {
                email: string;
                subtype: "work"
                | "personal";
            }[];
        };
        firstName?: string;
        lastName?: string;
        leadScore?: number;
        phoneOptions?: {
            phoneProperties: {
                number: string;
                subtype: | "main"
                | "home"
                | "work"
                | "homeFax"
                | "mobile"
                | "other"
                | "workFax";
            }[];
        };
        starValue?: 0
        | 1
        | 3
        | 2
        | 4
        | 5;
        tags?: string;
        title?: string;
        websiteOptions?: {
            websiteProperties: {
                subtype:
                    | "facebook"
                    | "feed"
                    | "flickr"
                    | "github"
                    | "googlePlus"
                    | "linkedin"
                    | "skype"
                    | "twitter"
                    | "url"
                    | "xing"
                    | "youtube";
                url: string;
            }[];
        };
    }
    | {
        addressOptions?: {
            addressProperties: {
                address: string;
                subtype: "home"
                | "postal"
                | "office";
            }[];
        };
        company?: string;
        customProperties?: {
            customProperty: {
                name: string;
                subtype?: string;
                value?: string;
            }[];
        };
        emailOptions?: {
            emailProperties: {
                email: string;
                subtype: "work"
                | "personal";
            }[];
        };
        firstName?: string;
        lastName?: string;
        leadScore?: number;
        phoneOptions?: {
            phoneProperties: {
                number: string;
                subtype: | "main"
                | "home"
                | "work"
                | "homeFax"
                | "mobile"
                | "other"
                | "workFax";
            }[];
        };
        starValue?: 0
        | 1
        | 3
        | 2
        | 4
        | 5;
        tags?: string;
        title?: string;
        websiteOptions?: {
            websiteProperties: {
                subtype:
                    | "facebook"
                    | "feed"
                    | "flickr"
                    | "github"
                    | "googlePlus"
                    | "linkedin"
                    | "skype"
                    | "twitter"
                    | "url"
                    | "xing"
                    | "youtube";
                url: string;
            }[];
        };
    }
    | {
        addressOptions?: {
            addressProperties: {
                address: string;
                subtype: "postal"
                | "office";
            }[];
        };
        customProperties?: {
            customProperty: {
                name: string;
                subtype?: string;
                value?: string;
            }[];
        };
        email?: string;
        name?: string;
        phone?: string;
        starValue?: 0
        | 1
        | 3
        | 2
        | 4
        | 5;
        tags?: string;
        websiteOptions?: {
            websiteProperties: {
                subtype:
                    | "facebook"
                    | "feed"
                    | "flickr"
                    | "github"
                    | "googlePlus"
                    | "linkedin"
                    | "skype"
                    | "twitter"
                    | "url"
                    | "xing"
                    | "youtube";
                url: string;
            }[];
        };
    }
    | {
        addressOptions?: {
            addressProperties: {
                address: string;
                subtype: "postal"
                | "office";
            }[];
        };
        customProperties?: {
            customProperty: {
                name: string;
                subtype?: string;
                value?: string;
            }[];
        };
        email?: string;
        name?: string;
        phone?: string;
        starValue?: 0
        | 1
        | 3
        | 2
        | 4
        | 5;
        tags?: string;
        websiteOptions?: {
            websiteProperties: {
                subtype:
                    | "facebook"
                    | "feed"
                    | "flickr"
                    | "github"
                    | "googlePlus"
                    | "linkedin"
                    | "skype"
                    | "twitter"
                    | "url"
                    | "xing"
                    | "youtube";
                url: string;
            }[];
        };
    }
    | {
        contactIds?: string;
        customData?: {
            customProperty: { name: string; value?: string }[];
        };
    }
    | {
        contactIds?: string;
        customData?: {
            customProperty: { name: string; value?: string }[];
        };
        expectedValue?: number;
        name?: string;
        probability?: number;
    }

Default: {}

§readonly additionalFieldsJson?: string

Object of values to set as described here Type options: {"alwaysOpenEditWindow":true}

§readonly closeDate?: string

Closing date of deal

§readonly companyId?: string

Unique identifier for a particular company

§readonly contactId?: string

Unique identifier for a particular contact

§readonly dealId?: string

Unique identifier for a particular deal

§readonly expectedValue?: number

Expected Value of deal Default: 1 Type options: {"minValue":0,"maxValue":1000000000000}

§readonly filterJson?: string
§readonly filters?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly filterType?: "none" | "manual" | "json"

Default: "none"

§readonly jsonParameters?: boolean
§readonly limit?: number

Max number of results to return Default: 20 Type options: {"minValue":1}

§readonly matchType?: "anyFilter" | "allFilters"

Default: "anyFilter"

§readonly milestone?: string

Milestone of deal

§readonly name?: string

Name of deal

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

Default: "get"

§readonly options?: { ... }

Default: {}

§readonly probability?: number

Expected probability Default: 50 Type options: {"minValue":0,"maxValue":100}

§readonly resource?: "contact" | "deal" | "company"

Default: "contact"

§readonly returnAll?: boolean

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

§readonly simple?: boolean

Whether to return a simplified version of the response instead of the raw data