nodes/generated

Interface ZammadNodeParameters

Source


interface ZammadNodeParameters {
    additionalFields?:
        | {
            active?: boolean;
            customFieldsUi?: {
                customFieldPairs: {
                    name?: string;
                    value?: string;
                }[];
            };
            note?: string;
        }
        | {
            active?: boolean;
            customFieldsUi?: {
                customFieldPairs: {
                    name?: string;
                    value?: string;
                }[];
            };
            domain?: string;
            domain_assignment?: boolean;
            note?: string;
            shared?: boolean;
            vip?: boolean;
        }
        | {
            customFieldsUi?: {
                customFieldPairs: {
                    name?: string;
                    value?: string;
                }[];
            };
        }
        | {
            active?: boolean;
            addressUi?: {
                addressDetails: {
                    address?: string;
                    city?: string;
                    country?: string;
                    zip?: string;
                };
            };
            customFieldsUi?: {
                customFieldPairs: {
                    name?: string;
                    value?: string;
                }[];
            };
            department?: string;
            email?: string;
            fax?: string;
            mobile?: string;
            note?: string;
            organization?: string;
            phone?: string;
            verified?: boolean;
            vip?: boolean;
            web?: string;
        };
    article?: {
        articleDetails: {
            body?: string;
            cc?: string;
            reply_to?: string;
            sender?: "Customer"
            | "Agent"
            | "System";
            subject?: string;
            to: string;
            type?:
                | "email"
                | "phone"
                | "chat"
                | "note"
                | "fax"
                | "sms";
            visibility?: "internal"
            | "external";
        };
    };
    authentication?: "basicAuth"
    | "tokenAuth";
    customer?: string;
    filters?: {
        query?: string;
        sortUi?: {
            sortDetails: {
                order_by?: "asc" | "desc";
                sort_by?: string;
            };
        };
    };
    firstname?: string;
    group?: string;
    id?: string;
    lastname?: string;
    limit?: number;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "getSelf";
    query?: string;
    resource?: "organization"
    | "user"
    | "group"
    | "ticket";
    returnAll?: boolean;
    title?: string;
    updateFields?:
        | {
            active?: boolean;
            customFieldsUi?: {
                customFieldPairs: {
                    name?: string;
                    value?: string;
                }[];
            };
            name?: string;
            note?: string;
        }
        | {
            active?: boolean;
            customFieldsUi?: {
                customFieldPairs: {
                    name?: string;
                    value?: string;
                }[];
            };
            domain?: string;
            domain_assignment?: boolean;
            note?: string;
            shared?: boolean;
            vip?: boolean;
        }
        | {
            customer_id?: string;
            customFieldsUi?: {
                customFieldPairs: {
                    name?: string;
                    value?: string;
                }[];
            };
            group?: string;
            note?: string;
            owner_id?: string;
            pending_time?: string;
            priority_id?: string;
            state_id?: string;
            title?: string;
        }
        | {
            active?: boolean;
            addressUi?: {
                addressDetails: {
                    address?: string;
                    city?: string;
                    country?: string;
                    zip?: string;
                };
            };
            customFieldsUi?: {
                customFieldPairs: {
                    name?: string;
                    value?: string;
                }[];
            };
            department?: string;
            email?: string;
            fax?: string;
            firstname?: string;
            lastname?: string;
            mobile?: string;
            note?: string;
            organization?: string;
            phone?: string;
            verified?: boolean;
            vip?: boolean;
            web?: string;
        };
}

Properties§

§readonly additionalFields?:
    | {
        active?: boolean;
        customFieldsUi?: {
            customFieldPairs: {
                name?: string;
                value?: string;
            }[];
        };
        note?: string;
    }
    | {
        active?: boolean;
        customFieldsUi?: {
            customFieldPairs: {
                name?: string;
                value?: string;
            }[];
        };
        domain?: string;
        domain_assignment?: boolean;
        note?: string;
        shared?: boolean;
        vip?: boolean;
    }
    | {
        customFieldsUi?: {
            customFieldPairs: {
                name?: string;
                value?: string;
            }[];
        };
    }
    | {
        active?: boolean;
        addressUi?: {
            addressDetails: {
                address?: string;
                city?: string;
                country?: string;
                zip?: string;
            };
        };
        customFieldsUi?: {
            customFieldPairs: {
                name?: string;
                value?: string;
            }[];
        };
        department?: string;
        email?: string;
        fax?: string;
        mobile?: string;
        note?: string;
        organization?: string;
        phone?: string;
        verified?: boolean;
        vip?: boolean;
        web?: string;
    }

Default: {}

§readonly article?: { ... }

Default: {}

§readonly authentication?: "basicAuth" | "tokenAuth"

Default: "tokenAuth"

§readonly customer?: string

Email address of the customer concerned in the ticket to create. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"loadCustomerEmails"}

§readonly filters?: { ... }

Default: {}

§readonly firstname?: string
§readonly group?: string

Group that will own the ticket to create. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"loadGroupNames"}

§readonly id?: string

Group to update. Specify an ID using an expression.

§readonly lastname?: string
§readonly limit?: number

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

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

Default: "create"

§readonly query?: string
§readonly resource?: "organization" | "user" | "group" | "ticket"

Default: "user"

§readonly returnAll?: boolean

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

§readonly title?: string

Title of the ticket to create

§readonly updateFields?:
    | {
        active?: boolean;
        customFieldsUi?: {
            customFieldPairs: {
                name?: string;
                value?: string;
            }[];
        };
        name?: string;
        note?: string;
    }
    | {
        active?: boolean;
        customFieldsUi?: {
            customFieldPairs: {
                name?: string;
                value?: string;
            }[];
        };
        domain?: string;
        domain_assignment?: boolean;
        note?: string;
        shared?: boolean;
        vip?: boolean;
    }
    | {
        customer_id?: string;
        customFieldsUi?: {
            customFieldPairs: {
                name?: string;
                value?: string;
            }[];
        };
        group?: string;
        note?: string;
        owner_id?: string;
        pending_time?: string;
        priority_id?: string;
        state_id?: string;
        title?: string;
    }
    | {
        active?: boolean;
        addressUi?: {
            addressDetails: {
                address?: string;
                city?: string;
                country?: string;
                zip?: string;
            };
        };
        customFieldsUi?: {
            customFieldPairs: {
                name?: string;
                value?: string;
            }[];
        };
        department?: string;
        email?: string;
        fax?: string;
        firstname?: string;
        lastname?: string;
        mobile?: string;
        note?: string;
        organization?: string;
        phone?: string;
        verified?: boolean;
        vip?: boolean;
        web?: string;
    }

Default: {}