nodes/generated

Interface HelpScoutNodeParameters

Source
interface HelpScoutNodeParameters {
    additionalFields?:
        | {
            assignTo?: number;
            autoReply?: boolean;
            closedAt?: string;
            createdAt?: string;
            customerEmail?: string;
            customerId?: number;
            imported?: boolean;
            tags?: unknown[];
            user?: number;
        }
        | {
            age?: number;
            background?: string;
            firstName?: string;
            gender?: "female"
            | "male"
            | "unknown";
            jobTitle?: string;
            lastName?: string;
            location?: string;
            organization?: string;
            photoUrl?: string;
        }
        | {
            createdAt?: string;
            customerEmail?: string;
            customerId?: number;
            draft?: boolean;
            imported?: boolean;
        };
    addressUi?: {
        addressValue: {
            city?: string;
            country?: string;
            line1?: string;
            line2?: string;
            postalCode?: string;
            state?: string;
        };
    };
    attachmentsUi?: {
        attachmentsBinary: { property?: string }[];
        attachmentsValues: {
            data?: string;
            fileName?: string;
            mimeType?: string;
        }[];
    };
    chatsUi?: {
        chatsValues: {
            type?: | "other"
            | "skype"
            | "aim"
            | "gtalk"
            | "icq"
            | "msn"
            | "qq"
            | "xmpp"
            | "yahoo";
            value?: string;
        }[];
    };
    conversationId?: string;
    customerId?: string;
    emailsUi?: {
        emailsValues: {
            type?: "home"
            | "work"
            | "other";
            value?: string;
        }[];
    };
    limit?: number;
    mailboxId?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "properties";
    options?: | {
        assignTo?: number;
        embed?: "threads";
        folder?: string;
        mailbox?: string;
        modifiedSince?: string;
        number?: number;
        query?: string;
        sortField?: | "number"
        | "status"
        | "createdAt"
        | "customerEmail"
        | "customerName"
        | "mailboxid"
        | "modifiedAt"
        | "score"
        | "subject";
        sortOrder?: "asc"
        | "desc";
        status?:
            | "all"
            | "open"
            | "spam"
            | "active"
            | "pending"
            | "closed";
        tags?: unknown[];
    }
    | {
        firstName?: string;
        lastName?: string;
        mailbox?: string;
        modifiedSince?: string;
        query?: string;
        sortField?: | "modifiedAt"
        | "score"
        | "firstName"
        | "lastName";
        sortOrder?: "asc"
        | "desc";
    };
    phonesUi?: {
        phonesValues: {
            type?: "home"
            | "work"
            | "other"
            | "pager"
            | "fax";
            value?: string;
        }[];
    };
    resolveData?: boolean;
    resource?: | "customer"
    | "thread"
    | "conversation"
    | "mailbox";
    returnAll?: boolean;
    socialProfilesUi?: {
        socialProfilesValues: {
            type?: | "other"
            | "facebook"
            | "flickr"
            | "linkedin"
            | "twitter"
            | "youtube"
            | "aboutMe"
            | "forsquare"
            | "google"
            | "googleplus"
            | "quora"
            | "tungleme";
            value?: string;
        }[];
    };
    status?: "active"
    | "pending"
    | "closed";
    subject?: string;
    text?: string;
    threadsUi?: {
        threadsValues: {
            bcc?: string;
            cc?: string;
            draft?: boolean;
            text?: string;
            type?:
                | "customer"
                | "phone"
                | "chat"
                | "note"
                | "reply";
        }[];
    };
    type?: | "email"
    | "customer"
    | "phone"
    | "chat"
    | "note"
    | "reply";
    updateFields?: {
        age?: number;
        background?: string;
        firstName?: string;
        gender?: "female"
        | "male"
        | "unknown";
        jobTitle?: string;
        lastName?: string;
        location?: string;
        organization?: string;
        photoUrl?: string;
    };
    websitesUi?: { websitesValues: { value?: string }[] };
}

Properties§

§readonly additionalFields?:
    | {
        assignTo?: number;
        autoReply?: boolean;
        closedAt?: string;
        createdAt?: string;
        customerEmail?: string;
        customerId?: number;
        imported?: boolean;
        tags?: unknown[];
        user?: number;
    }
    | {
        age?: number;
        background?: string;
        firstName?: string;
        gender?: "female"
        | "male"
        | "unknown";
        jobTitle?: string;
        lastName?: string;
        location?: string;
        organization?: string;
        photoUrl?: string;
    }
    | {
        createdAt?: string;
        customerEmail?: string;
        customerId?: number;
        draft?: boolean;
        imported?: boolean;
    }

Default: {}

§readonly addressUi?: { ... }

Default: {}

§readonly attachmentsUi?: { ... }

Array of supported attachments to add to the message Default: {} Type options: {"multipleValues":true}

§readonly chatsUi?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly conversationId?: string
§readonly customerId?: string
§readonly emailsUi?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly limit?: number

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

§readonly mailboxId?: string

ID of a mailbox where the conversation is being created. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getMailboxes"}

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

Default: "create"

§readonly options?:
    | {
        assignTo?: number;
        embed?: "threads";
        folder?: string;
        mailbox?: string;
        modifiedSince?: string;
        number?: number;
        query?: string;
        sortField?: | "number"
        | "status"
        | "createdAt"
        | "customerEmail"
        | "customerName"
        | "mailboxid"
        | "modifiedAt"
        | "score"
        | "subject";
        sortOrder?: "asc"
        | "desc";
        status?:
            | "all"
            | "open"
            | "spam"
            | "active"
            | "pending"
            | "closed";
        tags?: unknown[];
    }
    | {
        firstName?: string;
        lastName?: string;
        mailbox?: string;
        modifiedSince?: string;
        query?: string;
        sortField?: | "modifiedAt"
        | "score"
        | "firstName"
        | "lastName";
        sortOrder?: "asc"
        | "desc";
    }

Default: {}

§readonly phonesUi?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly resolveData?: boolean

By default the response only contain the ID to resource. If this option gets activated, it will resolve the data automatically. Default: true

§readonly resource?: "customer" | "thread" | "conversation" | "mailbox"

Default: "conversation"

§readonly returnAll?: boolean

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

§readonly socialProfilesUi?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly status?: "active" | "pending" | "closed"

Conversation status

§readonly subject?: string

Conversation’s subject

§readonly text?: string

The chat text

§readonly threadsUi?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly type?: "email" | "customer" | "phone" | "chat" | "note" | "reply"

Conversation type

§readonly updateFields?: { ... }

Default: {}

§readonly websitesUi?: { ... }

Default: {} Type options: {"multipleValues":true}