nodes/generated

Interface SyncroMspV1NodeParameters

Source
interface SyncroMspV1NodeParameters {
    additionalFields?:
        | {
            address?: {
                addressFields: {
                    address?: string;
                    address2?: string;
                    city?: string;
                    state?: string;
                    zip?: string;
                };
            };
            businessName?: string;
            firstName?: string;
            getSms?: boolean;
            invoiceCcEmails?: string;
            lastname?: string;
            noEmail?: boolean;
            notes?: string;
            notificationEmail?: string;
            phone?: string;
            referredBy?: string;
        }
        | {
            assetId?: string;
            contactId?: string;
            issueType?: | "Contract Work"
            | "Network Project"
            | "Other"
            | "Regular Maintenance"
            | "Remote Support";
            status?: | "New"
            | "Customer Reply"
            | "In Progress"
            | "Resolved"
            | "Scheduled"
            | "Waiting for Parts"
            | "Waiting on Customer";
        }
        | {
            address?: {
                addressFields: {
                    address?: string;
                    address2?: string;
                    city?: string;
                    state?: string;
                    zip?: string;
                };
            };
            name?: string;
            notes?: string;
            phone?: string;
        }
        | { resolved?: boolean };
    alertId?: string;
    assetId?: string;
    contactId?: string;
    customerId?: string;
    description?: string;
    email?: string;
    filters?:
        | {
            businessName?: string;
            email?: string;
            firstName?: string;
            includeDisabled?: boolean;
            lastname?: string;
            query?: string;
            sort?: string;
        }
        | {
            query?: string;
            status?: | "New"
            | "Customer Reply"
            | "In Progress"
            | "Resolved"
            | "Scheduled"
            | "Waiting for Parts"
            | "Waiting on Customer";
        }
        | { status?: "all"
        | "active"
        | "resolved" };
    limit?: number;
    muteFor?:
        | "forever"
        | "1-hour"
        | "1-day"
        | "2-days"
        | "1-week"
        | "2-weeks"
        | "1-month";
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "mute";
    resource?: "contact"
    | "customer"
    | "ticket"
    | "rmm";
    returnAll?: boolean;
    subject?: string;
    ticketId?: string;
    updateFields?:
        | {
            address?: {
                addressFields: {
                    address?: string;
                    address2?: string;
                    city?: string;
                    state?: string;
                    zip?: string;
                };
            };
            businessName?: string;
            email?: string;
            firstName?: string;
            getSms?: boolean;
            invoiceCcEmails?: string;
            lastName?: string;
            noEmail?: boolean;
            notes?: string;
            notificationEmail?: string;
            phone?: string;
            referredBy?: string;
        }
        | {
            assetId?: string;
            contactId?: string;
            customerId?: string;
            dueDate?: string;
            issueType?: | "Contract Work"
            | "Network Project"
            | "Other"
            | "Regular Maintenance"
            | "Remote Support";
            status?: | "New"
            | "Customer Reply"
            | "In Progress"
            | "Resolved"
            | "Scheduled"
            | "Waiting for Parts"
            | "Waiting on Customer";
            subject?: string;
        }
        | {
            address?: {
                addressFields: {
                    address?: string;
                    address2?: string;
                    city?: string;
                    state?: string;
                    zip?: string;
                };
            };
            customerId?: string;
            email?: string;
            name?: string;
            notes?: string;
            phone?: string;
        };
}

Properties§

§readonly additionalFields?:
    | {
        address?: {
            addressFields: {
                address?: string;
                address2?: string;
                city?: string;
                state?: string;
                zip?: string;
            };
        };
        businessName?: string;
        firstName?: string;
        getSms?: boolean;
        invoiceCcEmails?: string;
        lastname?: string;
        noEmail?: boolean;
        notes?: string;
        notificationEmail?: string;
        phone?: string;
        referredBy?: string;
    }
    | {
        assetId?: string;
        contactId?: string;
        issueType?: | "Contract Work"
        | "Network Project"
        | "Other"
        | "Regular Maintenance"
        | "Remote Support";
        status?: | "New"
        | "Customer Reply"
        | "In Progress"
        | "Resolved"
        | "Scheduled"
        | "Waiting for Parts"
        | "Waiting on Customer";
    }
    | {
        address?: {
            addressFields: {
                address?: string;
                address2?: string;
                city?: string;
                state?: string;
                zip?: string;
            };
        };
        name?: string;
        notes?: string;
        phone?: string;
    }
    | { resolved?: boolean }

Default: {}

§readonly alertId?: string

Get specific RMM alert by ID

§readonly assetId?: string
§readonly contactId?: string

Get specific contact by ID

§readonly customerId?: string

Get specific customer by ID

§readonly description?: string
§readonly email?: string
§readonly filters?:
    | {
        businessName?: string;
        email?: string;
        firstName?: string;
        includeDisabled?: boolean;
        lastname?: string;
        query?: string;
        sort?: string;
    }
    | {
        query?: string;
        status?: | "New"
        | "Customer Reply"
        | "In Progress"
        | "Resolved"
        | "Scheduled"
        | "Waiting for Parts"
        | "Waiting on Customer";
    }
    | { status?: "all"
    | "active"
    | "resolved" }

Default: {}

§readonly limit?: number

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

§readonly muteFor?:
    | "forever"
    | "1-hour"
    | "1-day"
    | "2-days"
    | "1-week"
    | "2-weeks"
    | "1-month"

Length of time to mute alert for

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

Default: "getAll"

§readonly resource?: "contact" | "customer" | "ticket" | "rmm"

Default: "contact"

§readonly returnAll?: boolean

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

§readonly subject?: string
§readonly ticketId?: string

Get specific customer by ID

§readonly updateFields?:
    | {
        address?: {
            addressFields: {
                address?: string;
                address2?: string;
                city?: string;
                state?: string;
                zip?: string;
            };
        };
        businessName?: string;
        email?: string;
        firstName?: string;
        getSms?: boolean;
        invoiceCcEmails?: string;
        lastName?: string;
        noEmail?: boolean;
        notes?: string;
        notificationEmail?: string;
        phone?: string;
        referredBy?: string;
    }
    | {
        assetId?: string;
        contactId?: string;
        customerId?: string;
        dueDate?: string;
        issueType?: | "Contract Work"
        | "Network Project"
        | "Other"
        | "Regular Maintenance"
        | "Remote Support";
        status?: | "New"
        | "Customer Reply"
        | "In Progress"
        | "Resolved"
        | "Scheduled"
        | "Waiting for Parts"
        | "Waiting on Customer";
        subject?: string;
    }
    | {
        address?: {
            addressFields: {
                address?: string;
                address2?: string;
                city?: string;
                state?: string;
                zip?: string;
            };
        };
        customerId?: string;
        email?: string;
        name?: string;
        notes?: string;
        phone?: string;
    }

Default: {}