nodes/generated

Interface ZendeskNodeParameters

Source
interface ZendeskNodeParameters {
    additionalFields?:
        | {
            customFieldsUi?: {
                customFieldsValues: {
                    id?: string;
                    value?: string;
                }[];
            };
            externalId?: string;
            group?: string;
            recipient?: string;
            status?: | "new"
            | "open"
            | "pending"
            | "closed"
            | "hold"
            | "solved";
            subject?: string;
            tags?: unknown[];
            type?: "task"
            | "problem"
            | "question"
            | "incident";
        }
        | {
            alias?: string;
            custom_role_id?: number;
            details?: string;
            email?: string;
            external_id?: string;
            locale?: string;
            moderator?: boolean;
            notes?: string;
            only_private_comments?: boolean;
            organization_id?: string;
            phone?: string;
            report_csv?: boolean;
            restricted_agent?: boolean;
            role?: "admin"
            | "agent"
            | "end-user";
            signature?: string;
            suspended?: boolean;
            tags?: unknown[];
            ticket_restriction?:
                | "organization"
                | "groups"
                | "assigned"
                | "requested";
            time_zone?: string;
            userFieldsUi?: {
                userFieldValues: {
                    field?: string;
                    value?: string;
                }[];
            };
            verified?: boolean;
        }
        | {
            details?: string;
            domain_names?: string;
            notes?: string;
            organizationFieldsUi?: {
                organizationFieldValues: {
                    field?: string;
                    value?: string;
                }[];
            };
            tags?: unknown[];
        };
    additionalFieldsJson?: string;
    authentication?: "oAuth2"
    | "apiToken";
    description?: string;
    filters?:
        | { role?: ("admin" | "agent" | "end-user")[] }
        | { external_id?: string; query?: string };
    id?: string;
    jsonParameters?: boolean;
    limit?: number;
    name?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete"
        | "search"
        | "count"
        | "recover"
        | "getOrganizations"
        | "getRelatedData";
    options?: {
        group?: string;
        query?: string;
        sortBy?: | "updated_at"
        | "status"
        | "created_at"
        | "priority"
        | "ticket_type";
        sortOrder?: "asc"
        | "desc";
        status?:
            | "new"
            | "open"
            | "pending"
            | "closed"
            | "hold"
            | "solved";
    };
    resource?: | "organization"
    | "user"
    | "ticket"
    | "ticketField";
    returnAll?: boolean;
    ticketFieldId?: string;
    ticketType?: "suspended"
    | "regular";
    updateFields?:
        | {
            assigneeEmail?: string;
            customFieldsUi?: {
                customFieldsValues: {
                    id?: string;
                    value?: string;
                }[];
            };
            externalId?: string;
            group?: string;
            internalNote?: string;
            publicReply?: string;
            recipient?: string;
            status?: | "new"
            | "open"
            | "pending"
            | "closed"
            | "hold"
            | "solved";
            subject?: string;
            tags?: unknown[];
            type?: "task"
            | "problem"
            | "question"
            | "incident";
        }
        | {
            alias?: string;
            custom_role_id?: number;
            details?: string;
            email?: string;
            external_id?: string;
            locale?: string;
            moderator?: boolean;
            name?: string;
            notes?: string;
            only_private_comments?: boolean;
            organization_id?: string;
            phone?: string;
            report_csv?: boolean;
            restricted_agent?: boolean;
            role?: "admin"
            | "agent"
            | "end-user";
            signature?: string;
            suspended?: boolean;
            tags?: unknown[];
            ticket_restriction?:
                | "organization"
                | "groups"
                | "assigned"
                | "requested";
            time_zone?: string;
            userFieldsUi?: {
                userFieldValues: {
                    field?: string;
                    value?: string;
                }[];
            };
            verified?: boolean;
        }
        | {
            details?: string;
            domain_names?: string;
            name?: string;
            notes?: string;
            organizationFieldsUi?: {
                organizationFieldValues: {
                    field?: string;
                    value?: string;
                }[];
            };
            tags?: unknown[];
        };
    updateFieldsJson?: string;
}

Properties§

Source§

readonly additionalFields?:
    | {
        customFieldsUi?: {
            customFieldsValues: {
                id?: string;
                value?: string;
            }[];
        };
        externalId?: string;
        group?: string;
        recipient?: string;
        status?: | "new"
        | "open"
        | "pending"
        | "closed"
        | "hold"
        | "solved";
        subject?: string;
        tags?: unknown[];
        type?: "task"
        | "problem"
        | "question"
        | "incident";
    }
    | {
        alias?: string;
        custom_role_id?: number;
        details?: string;
        email?: string;
        external_id?: string;
        locale?: string;
        moderator?: boolean;
        notes?: string;
        only_private_comments?: boolean;
        organization_id?: string;
        phone?: string;
        report_csv?: boolean;
        restricted_agent?: boolean;
        role?: "admin"
        | "agent"
        | "end-user";
        signature?: string;
        suspended?: boolean;
        tags?: unknown[];
        ticket_restriction?:
            | "organization"
            | "groups"
            | "assigned"
            | "requested";
        time_zone?: string;
        userFieldsUi?: {
            userFieldValues: {
                field?: string;
                value?: string;
            }[];
        };
        verified?: boolean;
    }
    | {
        details?: string;
        domain_names?: string;
        notes?: string;
        organizationFieldsUi?: {
            organizationFieldValues: {
                field?: string;
                value?: string;
            }[];
        };
        tags?: unknown[];
    }

Default: {}

Source§

readonly additionalFieldsJson?: string

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

Source§

readonly authentication?: "oAuth2" | "apiToken"

Default: "apiToken"

Source§

readonly description?: string

The first comment on the ticket

Source§

readonly filters?:
    | { role?: ("admin" | "agent" | "end-user")[] }
    | { external_id?: string; query?: string }

Default: {}

Source§

readonly id?: string

Source§

readonly jsonParameters?: boolean

Source§

readonly limit?: number

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

Source§

readonly name?: string

The user's name

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "search"
    | "count"
    | "recover"
    | "getOrganizations"
    | "getRelatedData"

Default: "create"

Source§

readonly options?: {
    group?: string;
    query?: string;
    sortBy?:
        | "updated_at"
        | "status"
        | "created_at"
        | "priority"
        | "ticket_type";
    sortOrder?: "asc"
    | "desc";
    status?:
        | "new"
        | "open"
        | "pending"
        | "closed"
        | "hold"
        | "solved";
}

Default: {}

Source§

readonly resource?: "organization" | "user" | "ticket" | "ticketField"

Default: "ticket"

Source§

readonly returnAll?: boolean

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

Source§

readonly ticketFieldId?: string

Source§

readonly ticketType?: "suspended" | "regular"

Default: "regular"

Source§

readonly updateFields?:
    | {
        assigneeEmail?: string;
        customFieldsUi?: {
            customFieldsValues: {
                id?: string;
                value?: string;
            }[];
        };
        externalId?: string;
        group?: string;
        internalNote?: string;
        publicReply?: string;
        recipient?: string;
        status?: | "new"
        | "open"
        | "pending"
        | "closed"
        | "hold"
        | "solved";
        subject?: string;
        tags?: unknown[];
        type?: "task"
        | "problem"
        | "question"
        | "incident";
    }
    | {
        alias?: string;
        custom_role_id?: number;
        details?: string;
        email?: string;
        external_id?: string;
        locale?: string;
        moderator?: boolean;
        name?: string;
        notes?: string;
        only_private_comments?: boolean;
        organization_id?: string;
        phone?: string;
        report_csv?: boolean;
        restricted_agent?: boolean;
        role?: "admin"
        | "agent"
        | "end-user";
        signature?: string;
        suspended?: boolean;
        tags?: unknown[];
        ticket_restriction?:
            | "organization"
            | "groups"
            | "assigned"
            | "requested";
        time_zone?: string;
        userFieldsUi?: {
            userFieldValues: {
                field?: string;
                value?: string;
            }[];
        };
        verified?: boolean;
    }
    | {
        details?: string;
        domain_names?: string;
        name?: string;
        notes?: string;
        organizationFieldsUi?: {
            organizationFieldValues: {
                field?: string;
                value?: string;
            }[];
        };
        tags?: unknown[];
    }

Default: {}

Source§

readonly updateFieldsJson?: string

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