Interface SalesmateNodeParameters

Source
interface SalesmateNodeParameters {
    additionalFields?:
        | {
            billingAddressLine1?: string;
            billingAddressLine2?: string;
            billingCity?: string;
            billingState?: string;
            billingZipCode?: string;
            currency?: string;
            description?: string;
            facebookHandle?: string;
            googlePlusHandle?: string;
            linkedInHandle?: string;
            otherPhone?: string;
            phone?: string;
            skypeId?: string;
            tags?: string;
            twitterHandle?: string;
            website?: string;
        }
        | {
            description?: string;
            dueDate?: string;
            duration?: number;
            isCalendarInvite?: boolean;
            isCompleted?: boolean;
            tags?: string;
        }
        | {
            dealValue?: number;
            description?: string;
            estimatedCloseDate?: string;
            primaryCompany?: string;
            priority?: "High"
            | "Low"
            | "Medium";
            source?:
                | "Ads"
                | "Referrals"
                | "Website"
                | "Word of mouth";
            tags?: string;
        };
    currency?: string;
    filters?: | {
        filtersUi: {
            conditions?: {
                conditionsUi: {
                    condition?: | "EQUALS"
                    | "ENDS_WITH"
                    | "NOT_EQUALS"
                    | "Contains"
                    | "DOES_NOT_CONTAINS"
                    | "EMPTY"
                    | "NOT_EMPTY"
                    | "STARTS_WITH";
                    field?: "email"
                    | "name"
                    | "phone";
                    value?: string;
                }[];
            };
            operator?: "AND"
            | "OR";
        };
    }
    | {
        filtersUi: {
            conditions?: {
                conditionsUi: {
                    condition?: | "EQUALS"
                    | "ENDS_WITH"
                    | "NOT_EQUALS"
                    | "Contains"
                    | "DOES_NOT_CONTAINS"
                    | "EMPTY"
                    | "NOT_EMPTY"
                    | "STARTS_WITH";
                    field?: "tags"
                    | "title";
                    value?: string;
                }[];
            };
            operator?: "AND"
            | "OR";
        };
    }
    | {
        filtersUi: {
            conditions?: {
                conditionsUi: {
                    condition?: | "EQUALS"
                    | "ENDS_WITH"
                    | "NOT_EQUALS"
                    | "Contains"
                    | "DOES_NOT_CONTAINS"
                    | "EMPTY"
                    | "NOT_EMPTY"
                    | "STARTS_WITH";
                    field?: "tags"
                    | "title"
                    | "lastCommunicationMode";
                    value?: string;
                }[];
            };
            operator?: "AND"
            | "OR";
        };
    };
    filtersJson?: string;
    id?: string;
    jsonParameters?: boolean;
    limit?: number;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete";
    options?: {
        fields?: string;
        sortBy?: string;
        sortOrder?: "asc"
        | "desc";
    };
    owner?: string;
    pipeline?: "Sales";
    primaryContact?: string;
    rawData?: boolean;
    resource?: "deal"
    | "company"
    | "activity";
    returnAll?: boolean;
    stage?:
        | "Contacted"
        | "In Negotiation"
        | "New (Untouched)"
        | "Proposal Presented"
        | "Qualified";
    status?: "Open"
    | "Close"
    | "Lost";
    title?: string;
    type?: string;
    updateFields?:
        | {
            billingAddressLine1?: string;
            billingAddressLine2?: string;
            billingCity?: string;
            billingState?: string;
            billingZipCode?: string;
            currency?: string;
            description?: string;
            facebookHandle?: string;
            googlePlusHandle?: string;
            linkedInHandle?: string;
            name?: string;
            otherPhone?: string;
            owner?: string;
            phone?: string;
            skypeId?: string;
            tags?: string;
            twitterHandle?: string;
            website?: string;
        }
        | {
            description?: string;
            dueDate?: string;
            duration?: number;
            isCalendarInvite?: boolean;
            isCompleted?: boolean;
            owner?: string;
            tags?: string;
            title?: string;
            type?: string;
        }
        | {
            currency?: string;
            dealValue?: number;
            description?: string;
            estimatedCloseDate?: string;
            owner?: string;
            pipeline?: "Sales";
            primaryCompany?: string;
            primaryContact?: string;
            priority?: "High"
            | "Low"
            | "Medium";
            source?:
                | "Ads"
                | "Referrals"
                | "Website"
                | "Word of mouth";
            stage?: | "Contacted"
            | "In Negotiation"
            | "New (Untouched)"
            | "Proposal Presented"
            | "Qualified";
            status?: "Open"
            | "Close"
            | "Lost";
            tags?: string;
            title?: string;
        };
}

Properties§

Source§

readonly additionalFields?:
    | {
        billingAddressLine1?: string;
        billingAddressLine2?: string;
        billingCity?: string;
        billingState?: string;
        billingZipCode?: string;
        currency?: string;
        description?: string;
        facebookHandle?: string;
        googlePlusHandle?: string;
        linkedInHandle?: string;
        otherPhone?: string;
        phone?: string;
        skypeId?: string;
        tags?: string;
        twitterHandle?: string;
        website?: string;
    }
    | {
        description?: string;
        dueDate?: string;
        duration?: number;
        isCalendarInvite?: boolean;
        isCompleted?: boolean;
        tags?: string;
    }
    | {
        dealValue?: number;
        description?: string;
        estimatedCloseDate?: string;
        primaryCompany?: string;
        priority?: "High"
        | "Low"
        | "Medium";
        source?:
            | "Ads"
            | "Referrals"
            | "Website"
            | "Word of mouth";
        tags?: string;
    }

Default: {}

Source§

readonly currency?: string

Source§

readonly filters?:
    | {
        filtersUi: {
            conditions?: {
                conditionsUi: {
                    condition?: | "EQUALS"
                    | "ENDS_WITH"
                    | "NOT_EQUALS"
                    | "Contains"
                    | "DOES_NOT_CONTAINS"
                    | "EMPTY"
                    | "NOT_EMPTY"
                    | "STARTS_WITH";
                    field?: "email"
                    | "name"
                    | "phone";
                    value?: string;
                }[];
            };
            operator?: "AND"
            | "OR";
        };
    }
    | {
        filtersUi: {
            conditions?: {
                conditionsUi: {
                    condition?: | "EQUALS"
                    | "ENDS_WITH"
                    | "NOT_EQUALS"
                    | "Contains"
                    | "DOES_NOT_CONTAINS"
                    | "EMPTY"
                    | "NOT_EMPTY"
                    | "STARTS_WITH";
                    field?: "tags"
                    | "title";
                    value?: string;
                }[];
            };
            operator?: "AND"
            | "OR";
        };
    }
    | {
        filtersUi: {
            conditions?: {
                conditionsUi: {
                    condition?: | "EQUALS"
                    | "ENDS_WITH"
                    | "NOT_EQUALS"
                    | "Contains"
                    | "DOES_NOT_CONTAINS"
                    | "EMPTY"
                    | "NOT_EMPTY"
                    | "STARTS_WITH";
                    field?: "tags"
                    | "title"
                    | "lastCommunicationMode";
                    value?: string;
                }[];
            };
            operator?: "AND"
            | "OR";
        };
    }

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

Source§

readonly filtersJson?: string

Type options: {"alwaysOpenEditWindow":true}

Source§

readonly id?: string

Source§

readonly jsonParameters?: boolean

Source§

readonly limit?: number

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

Source§

readonly name?: string

Source§

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

Default: "create"

Source§

readonly options?: {
    fields?: string;
    sortBy?: string;
    sortOrder?: "asc" | "desc";
}

Default: {}

Source§

readonly owner?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getUsers"}

Source§

readonly pipeline?: "Sales"

Source§

readonly primaryContact?: string

Primary contact for the deal. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getContacts"}

Source§

readonly rawData?: boolean

Whether the data should include the fields details

Source§

readonly resource?: "deal" | "company" | "activity"

Default: "activity"

Source§

readonly returnAll?: boolean

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

Source§

readonly stage?:
    | "Contacted"
    | "In Negotiation"
    | "New (Untouched)"
    | "Proposal Presented"
    | "Qualified"

Source§

readonly status?: "Open" | "Close" | "Lost"

Default: "Open"

Source§

readonly title?: string

Source§

readonly type?: string

This field displays activity type such as call, meeting etc

Source§

readonly updateFields?:
    | {
        billingAddressLine1?: string;
        billingAddressLine2?: string;
        billingCity?: string;
        billingState?: string;
        billingZipCode?: string;
        currency?: string;
        description?: string;
        facebookHandle?: string;
        googlePlusHandle?: string;
        linkedInHandle?: string;
        name?: string;
        otherPhone?: string;
        owner?: string;
        phone?: string;
        skypeId?: string;
        tags?: string;
        twitterHandle?: string;
        website?: string;
    }
    | {
        description?: string;
        dueDate?: string;
        duration?: number;
        isCalendarInvite?: boolean;
        isCompleted?: boolean;
        owner?: string;
        tags?: string;
        title?: string;
        type?: string;
    }
    | {
        currency?: string;
        dealValue?: number;
        description?: string;
        estimatedCloseDate?: string;
        owner?: string;
        pipeline?: "Sales";
        primaryCompany?: string;
        primaryContact?: string;
        priority?: "High"
        | "Low"
        | "Medium";
        source?:
            | "Ads"
            | "Referrals"
            | "Website"
            | "Word of mouth";
        stage?: | "Contacted"
        | "In Negotiation"
        | "New (Untouched)"
        | "Proposal Presented"
        | "Qualified";
        status?: "Open"
        | "Close"
        | "Lost";
        tags?: string;
        title?: string;
    }

Default: {}