nodes/generated

Interface FreshdeskNodeParameters

Source
interface FreshdeskNodeParameters {
    additionalFields?: {
        address?: string;
        company_id?: number;
        customFields?: {
            customField: { name?: string; value?: string }[];
        };
        description?: string;
        email?: string;
        job_title?: string;
        language?: string;
        mobile?: string;
        name?: string;
        other_companies?: string;
        other_emails?: string;
        phone?: string;
        tags?: string;
        time_zone?: string;
        twitter_id?: string;
        unique_external_id?: string;
        view_all_tickets?: boolean;
    };
    contactId?: string;
    email?: string;
    filters?: {
        company_id?: number;
        email?: string;
        mobile?: string;
        phone?: string;
        state?: | "deleted"
        | "blocked"
        | "unverified"
        | "verified";
        updated_since?: string;
    };
    limit?: number;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete";
    options?: | {
        agent?: string;
        ccEmails?: string;
        company?: string;
        description?: string;
        dueBy?: string;
        emailConfigId?: number;
        frDueBy?: string;
        group?: string;
        name?: string;
        product?: string;
        subject?: string;
        tags?: string;
        type?: | "Feature Request"
        | "Incident"
        | "Problem"
        | "Question"
        | "Refund";
    }
    | {
        companyId?: string;
        include?: (
            "company"
            | "description"
            | "requester"
            | "stats"
        )[];
        order?: "asc" | "desc";
        orderBy?: "createdAt" | "updatedAt" | "dueBy";
        requesterEmail?: string;
        requesterId?: string;
        updatedSince?: string;
    };
    priority?: "low"
    | "high"
    | "medium"
    | "urgent";
    requester?:
        | "email"
        | "facebookId"
        | "phone"
        | "requesterId"
        | "twitterId"
        | "uniqueExternalId";
    requesterIdentificationValue?: string;
    resource?: "contact"
    | "ticket";
    returnAll?: boolean;
    source?:
        | "email"
        | "phone"
        | "chat"
        | "feedbackWidget"
        | "mobileHelp"
        | "OutboundEmail"
        | "portal";
    status?: "open"
    | "pending"
    | "closed"
    | "resolved";
    ticketId?: string;
    updateFields?: {
        agent?: string;
        ccEmails?: string;
        company?: string;
        dueBy?: string;
        emailConfigId?: number;
        frDueBy?: string;
        group?: string;
        name?: string;
        priority?: "low" | "high" | "medium" | "urgent";
        product?: string;
        requester?:
            | "email"
            | "facebookId"
            | "phone"
            | "requesterId"
            | "twitterId"
            | "uniqueExternalId";
        requesterIdentificationValue?: string;
        source?: | "email"
        | "phone"
        | "chat"
        | "feedbackWidget"
        | "mobileHelp"
        | "OutboundEmail"
        | "portal";
        status?: "open"
        | "pending"
        | "closed"
        | "resolved";
        tags?: string;
        type?:
            | "Feature Request"
            | "Incident"
            | "Problem"
            | "Question"
            | "Refund";
    };
}

Properties§

§readonly additionalFields?: { ... }

Default: {}

§readonly contactId?: string
§readonly email?: string

Primary email address of the contact. If you want to associate additional email(s) with this contact, use the other_emails attribute.

§readonly filters?: { ... }

Default: {}

§readonly limit?: number

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

§readonly name?: string

Name of the contact

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

Default: "create"

§readonly options?:
    | {
        agent?: string;
        ccEmails?: string;
        company?: string;
        description?: string;
        dueBy?: string;
        emailConfigId?: number;
        frDueBy?: string;
        group?: string;
        name?: string;
        product?: string;
        subject?: string;
        tags?: string;
        type?: | "Feature Request"
        | "Incident"
        | "Problem"
        | "Question"
        | "Refund";
    }
    | {
        companyId?: string;
        include?: (
            "company"
            | "description"
            | "requester"
            | "stats"
        )[];
        order?: "asc" | "desc";
        orderBy?: "createdAt" | "updatedAt" | "dueBy";
        requesterEmail?: string;
        requesterId?: string;
        updatedSince?: string;
    }

Default: {}

§readonly priority?: "low" | "high" | "medium" | "urgent"

Default: "low"

§readonly requester?:
    | "email"
    | "facebookId"
    | "phone"
    | "requesterId"
    | "twitterId"
    | "uniqueExternalId"

Default: "requesterId"

§readonly requesterIdentificationValue?: string

Value of the identification selected

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

Default: "ticket"

§readonly returnAll?: boolean

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

§readonly source?:
    | "email"
    | "phone"
    | "chat"
    | "feedbackWidget"
    | "mobileHelp"
    | "OutboundEmail"
    | "portal"

The channel through which the ticket was created Default: "portal"

§readonly status?: "open" | "pending" | "closed" | "resolved"

Default: "pending"

§readonly ticketId?: string
§readonly updateFields?: { ... }

Default: {}