nodes/generated

Interface MauticNodeParameters

Source
interface MauticNodeParameters {
    action?: "add" | "remove";
    additionalFields?:
        | {
            addressUi?: {
                addressValues: {
                    address1?: string;
                    address2?: string;
                    city?: string;
                    country?: string;
                    state?: string;
                    zipCode?: string;
                };
            };
            annualRevenue?: number;
            companyEmail?: string;
            customFieldsUi?: {
                customFieldValues: {
                    fieldId?: string;
                    fieldValue?: string;
                }[];
            };
            description?: string;
            fax?: string;
            industry?: string;
            isPublished?: boolean;
            numberOfEmpoyees?: number;
            overwriteWithBlank?: boolean;
            phone?: string;
            website?: string;
        }
        | {
            orderBy?: string;
            orderByDir?: "asc"
            | "desc";
            search?: string;
        }
        | {
            addressUi?: {
                addressValues: {
                    address1?: string;
                    address2?: string;
                    city?: string;
                    country?: string;
                    state?: string;
                    zipCode?: string;
                };
            };
            b2bOrb2c?: "B2B"
            | "B2C";
            crmId?: string;
            customFieldsUi?: {
                customFieldValues: {
                    fieldId?: string;
                    fieldValue?: string;
                }[];
            };
            fax?: string;
            hasPurchased?: boolean;
            ipAddress?: string;
            lastActive?: string;
            mobile?: string;
            ownerId?: string;
            phone?: string;
            prospectOrCustomer?: "Prospect"
            | "Customer";
            sandbox?: boolean;
            socialMediaUi?: {
                socialMediaValues: {
                    facebook?: string;
                    foursquare?: string;
                    instagram?: string;
                    linkedIn?: string;
                    skype?: string;
                    twitter?: string;
                };
            };
            stage?: string;
            tags?: unknown[];
            website?: string;
        }
        | { comments?: string; reason?: "1"
        | "2"
        | "3" };
    authentication?: "oAuth2" | "credentials";
    bodyJson?: string;
    campaignEmailId?: string;
    campaignId?: string;
    channel?: "email" | "sms";
    company?: string;
    companyId?: string;
    contactId?: string;
    email?: string;
    firstName?: string;
    jsonParameters?: boolean;
    lastName?: string;
    limit?: number;
    name?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "add"
        | "remove"
        | "delete"
        | "send"
        | "editContactPoint"
        | "editDoNotContactList"
        | "sendEmail";
    options?: {
        minimal?: boolean;
        orderBy?: string;
        orderByDir?: "asc"
        | "desc";
        publishedOnly?: boolean;
        rawData?: boolean;
        search?: string;
    };
    points?: number;
    position?: string;
    resource?: | "contact"
    | "company"
    | "campaignContact"
    | "companyContact"
    | "contactSegment"
    | "segmentEmail";
    returnAll?: boolean;
    segmentEmailId?: string;
    segmentId?: string;
    simple?: boolean;
    title?: string;
    updateFields?: | {
        addressUi?: {
            addressValues: {
                address1?: string;
                address2?: string;
                city?: string;
                country?: string;
                state?: string;
                zipCode?: string;
            };
        };
        annualRevenue?: number;
        companyEmail?: string;
        customFieldsUi?: {
            customFieldValues: {
                fieldId?: string;
                fieldValue?: string;
            }[];
        };
        description?: string;
        fax?: string;
        industry?: string;
        isPublished?: boolean;
        name?: string;
        numberOfEmpoyees?: number;
        overwriteWithBlank?: boolean;
        phone?: string;
        website?: string;
    }
    | {
        addressUi?: {
            addressValues: {
                address1?: string;
                address2?: string;
                city?: string;
                country?: string;
                state?: string;
                zipCode?: string;
            };
        };
        b2bOrb2c?: "B2B"
        | "B2C";
        bodyJson?: string;
        company?: string;
        crmId?: string;
        customFieldsUi?: {
            customFieldValues: {
                fieldId?: string;
                fieldValue?: string;
            }[];
        };
        email?: string;
        fax?: string;
        firstName?: string;
        hasPurchased?: boolean;
        ipAddress?: string;
        lastActive?: string;
        lastName?: string;
        mobile?: string;
        ownerId?: string;
        phone?: string;
        position?: string;
        prospectOrCustomer?: "Prospect"
        | "Customer";
        sandbox?: boolean;
        socialMediaUi?: {
            socialMediaValues: {
                facebook?: string;
                foursquare?: string;
                instagram?: string;
                linkedIn?: string;
                skype?: string;
                twitter?: string;
            };
        };
        stage?: string;
        tags?: unknown[];
        title?: string;
        website?: string;
    };
}

Properties§

Source§

readonly action?: "add" | "remove"

Default: "add"

Source§

readonly additionalFields?:
    | {
        addressUi?: {
            addressValues: {
                address1?: string;
                address2?: string;
                city?: string;
                country?: string;
                state?: string;
                zipCode?: string;
            };
        };
        annualRevenue?: number;
        companyEmail?: string;
        customFieldsUi?: {
            customFieldValues: {
                fieldId?: string;
                fieldValue?: string;
            }[];
        };
        description?: string;
        fax?: string;
        industry?: string;
        isPublished?: boolean;
        numberOfEmpoyees?: number;
        overwriteWithBlank?: boolean;
        phone?: string;
        website?: string;
    }
    | {
        orderBy?: string;
        orderByDir?: "asc"
        | "desc";
        search?: string;
    }
    | {
        addressUi?: {
            addressValues: {
                address1?: string;
                address2?: string;
                city?: string;
                country?: string;
                state?: string;
                zipCode?: string;
            };
        };
        b2bOrb2c?: "B2B"
        | "B2C";
        crmId?: string;
        customFieldsUi?: {
            customFieldValues: {
                fieldId?: string;
                fieldValue?: string;
            }[];
        };
        fax?: string;
        hasPurchased?: boolean;
        ipAddress?: string;
        lastActive?: string;
        mobile?: string;
        ownerId?: string;
        phone?: string;
        prospectOrCustomer?: "Prospect"
        | "Customer";
        sandbox?: boolean;
        socialMediaUi?: {
            socialMediaValues: {
                facebook?: string;
                foursquare?: string;
                instagram?: string;
                linkedIn?: string;
                skype?: string;
                twitter?: string;
            };
        };
        stage?: string;
        tags?: unknown[];
        website?: string;
    }
    | { comments?: string; reason?: "1"
    | "2"
    | "3" }

Default: {}

Source§

readonly authentication?: "oAuth2" | "credentials"

Default: "credentials"

Source§

readonly bodyJson?: string

Contact parameters

Source§

readonly campaignEmailId?: string

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

Source§

readonly campaignId?: string

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

Source§

readonly channel?: "email" | "sms"

Default: "email"

Source§

readonly company?: string

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

Source§

readonly companyId?: string

The ID of the company to update

Source§

readonly contactId?: string

Source§

readonly email?: string

Email address of the contact

Source§

readonly firstName?: string

Source§

readonly jsonParameters?: boolean

Source§

readonly lastName?: string

Source§

readonly limit?: number

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

Source§

readonly name?: string

The name of the company to create

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "send"
    | "editContactPoint"
    | "editDoNotContactList"
    | "sendEmail"

Default: "create"

Source§

readonly options?: {
    minimal?: boolean;
    orderBy?: string;
    orderByDir?: "asc" | "desc";
    publishedOnly?: boolean;
    rawData?: boolean;
    search?: string;
}

Default: {}

Source§

readonly points?: number

Source§

readonly position?: string

Source§

readonly resource?:
    | "contact"
    | "company"
    | "campaignContact"
    | "companyContact"
    | "contactSegment"
    | "segmentEmail"

Default: "contact"

Source§

readonly returnAll?: boolean

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

Source§

readonly segmentEmailId?: string

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

Source§

readonly segmentId?: string

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

Source§

readonly simple?: boolean

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

Source§

readonly title?: string

Source§

readonly updateFields?:
    | {
        addressUi?: {
            addressValues: {
                address1?: string;
                address2?: string;
                city?: string;
                country?: string;
                state?: string;
                zipCode?: string;
            };
        };
        annualRevenue?: number;
        companyEmail?: string;
        customFieldsUi?: {
            customFieldValues: {
                fieldId?: string;
                fieldValue?: string;
            }[];
        };
        description?: string;
        fax?: string;
        industry?: string;
        isPublished?: boolean;
        name?: string;
        numberOfEmpoyees?: number;
        overwriteWithBlank?: boolean;
        phone?: string;
        website?: string;
    }
    | {
        addressUi?: {
            addressValues: {
                address1?: string;
                address2?: string;
                city?: string;
                country?: string;
                state?: string;
                zipCode?: string;
            };
        };
        b2bOrb2c?: "B2B"
        | "B2C";
        bodyJson?: string;
        company?: string;
        crmId?: string;
        customFieldsUi?: {
            customFieldValues: {
                fieldId?: string;
                fieldValue?: string;
            }[];
        };
        email?: string;
        fax?: string;
        firstName?: string;
        hasPurchased?: boolean;
        ipAddress?: string;
        lastActive?: string;
        lastName?: string;
        mobile?: string;
        ownerId?: string;
        phone?: string;
        position?: string;
        prospectOrCustomer?: "Prospect"
        | "Customer";
        sandbox?: boolean;
        socialMediaUi?: {
            socialMediaValues: {
                facebook?: string;
                foursquare?: string;
                instagram?: string;
                linkedIn?: string;
                skype?: string;
                twitter?: string;
            };
        };
        stage?: string;
        tags?: unknown[];
        title?: string;
        website?: string;
    }

Default: {}