nodes/generated

Interface TodoistV2NodeParameters

Source
interface TodoistV2NodeParameters {
    authentication?: "apiKey" | "oAuth2";
    commentContent?: string;
    commentFilters?: {
        project_id?: string;
        task_id?: string;
    };
    commentId?: string;
    commentTaskId?: string;
    commentUpdateFields?: { content?: string };
    content?: string;
    date?: string;
    datetime?: string;
    dueDateType?:
        | "natural_language"
        | "full_day"
        | "floating_time"
        | "fixed_timezone";
    filters?: {
        filter?: string;
        ids?: string;
        labelId?: string;
        lang?: string;
        parentId?: string;
        projectId?: string;
        sectionId?: string;
    };
    itemId?: string;
    labelId?: string;
    labelName?: string;
    labelOptions?: {
        color?: | "orange"
        | "yellow"
        | "green"
        | "blue"
        | "red"
        | "berry_red"
        | "olive_green"
        | "lime_green"
        | "mint_green"
        | "teal"
        | "sky_blue"
        | "light_blue"
        | "grape"
        | "violet"
        | "lavender"
        | "magenta"
        | "salmon"
        | "charcoal"
        | "grey"
        | "taupe";
        is_favorite?: boolean;
        order?: number;
    };
    labels?: unknown[];
    labelUpdateFields?: {
        color?: | "orange"
        | "yellow"
        | "green"
        | "blue"
        | "red"
        | "berry_red"
        | "olive_green"
        | "lime_green"
        | "mint_green"
        | "teal"
        | "sky_blue"
        | "light_blue"
        | "grape"
        | "violet"
        | "lavender"
        | "magenta"
        | "salmon"
        | "charcoal"
        | "grey"
        | "taupe";
        is_favorite?: boolean;
        name?: string;
        order?: number;
    };
    limit?: number;
    name?: string;
    natural_language_representation?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "close"
    | "move"
    | "archive"
    | "unarchive"
    | "reopen"
    | "quickAdd"
    | "getCollaborators";
    options?: | { parent?: string; section?: string }
    | {
        auto_reminder?: boolean;
        note?: string;
        reminder?: string;
    }
    | {
        assigneeId?: string;
        deadlineDate?: string;
        description?: string;
        dueDate?: string;
        dueDateTime?: string;
        dueLang?: string;
        dueString?: string;
        duration?: number;
        durationUnit?: "day"
        | "minute";
        order?: number;
        parentId?: string;
        priority?: number;
        section?: string;
    };
    project?: { mode: "id"
    | "list"; value: string };
    projectId?: string;
    projectOptions?: {
        color?:
            | "orange"
            | "yellow"
            | "green"
            | "blue"
            | "red"
            | "berry_red"
            | "olive_green"
            | "lime_green"
            | "mint_green"
            | "teal"
            | "sky_blue"
            | "light_blue"
            | "grape"
            | "violet"
            | "lavender"
            | "magenta"
            | "salmon"
            | "charcoal"
            | "grey"
            | "taupe";
        is_favorite?: boolean;
        parent_id?: string;
        view_style?: "list"
        | "board";
    };
    projectUpdateFields?: {
        color?: | "orange"
        | "yellow"
        | "green"
        | "blue"
        | "red"
        | "berry_red"
        | "olive_green"
        | "lime_green"
        | "mint_green"
        | "teal"
        | "sky_blue"
        | "light_blue"
        | "grape"
        | "violet"
        | "lavender"
        | "magenta"
        | "salmon"
        | "charcoal"
        | "grey"
        | "taupe";
        is_favorite?: boolean;
        name?: string;
        view_style?: "list"
        | "board";
    };
    reminderId?: string;
    reminderOptions?: {
        minute_offset?: number;
        notify_uid?: string;
        type?: "relative"
        | "absolute";
    };
    reminderUpdateFields?: {
        due?: {
            date?: string;
            datetime?: string;
            string?: string;
            timezone?: string;
        };
        minute_offset?: number;
        notify_uid?: string;
        type?: "relative"
        | "absolute";
    };
    resource?: | "comment"
    | "project"
    | "task"
    | "label"
    | "reminder"
    | "section";
    returnAll?: boolean;
    section?: string;
    sectionFilters?: { project_id?: string };
    sectionId?: string;
    sectionName?: string;
    sectionOptions?: { order?: number };
    sectionProject?: { mode: "id" | "list"; value: string };
    sectionUpdateFields?: { name?: string };
    taskId?: string;
    text?: string;
    timezone?: string;
    updateFields?: {
        assigneeId?: string;
        content?: string;
        deadlineDate?: string;
        description?: string;
        dueDate?: string;
        dueDateTime?: string;
        dueLang?: string;
        dueString?: string;
        duration?: number;
        durationUnit?: "day" | "minute";
        labels?: unknown[];
        order?: number;
        priority?: number;
    };
}

Properties§

Source§

readonly authentication?: "apiKey" | "oAuth2"

Default: "apiKey"

Source§

readonly commentContent?: string

Comment content Type options: {"rows":3}

Source§

readonly commentFilters?: { project_id?: string; task_id?: string }

Default: {}

Source§

readonly commentId?: string

Source§

readonly commentTaskId?: string

The ID of the task to comment on

Source§

readonly commentUpdateFields?: { content?: string }

Default: {}

Source§

readonly content?: string

Task content Type options: {"rows":5}

Source§

readonly date?: string

Full-day date in YYYY-MM-DD format

Source§

readonly datetime?: string

Floating date and time (no timezone)

Source§

readonly dueDateType?:
    | "natural_language"
    | "full_day"
    | "floating_time"
    | "fixed_timezone"

How to specify when the reminder should trigger Default: "natural_language"

Source§

readonly filters?: {
    filter?: string;
    ids?: string;
    labelId?: string;
    lang?: string;
    parentId?: string;
    projectId?: string;
    sectionId?: string;
}

Default: {}

Source§

readonly itemId?: string

The ID of the task to attach reminder to

Source§

readonly labelId?: string

Source§

readonly labelName?: string

Name of the label

Source§

readonly labelOptions?: {
    color?:
        | "orange"
        | "yellow"
        | "green"
        | "blue"
        | "red"
        | "berry_red"
        | "olive_green"
        | "lime_green"
        | "mint_green"
        | "teal"
        | "sky_blue"
        | "light_blue"
        | "grape"
        | "violet"
        | "lavender"
        | "magenta"
        | "salmon"
        | "charcoal"
        | "grey"
        | "taupe";
    is_favorite?: boolean;
    order?: number;
}

Default: {}

Source§

readonly labels?: unknown[]

Optional labels that will be assigned to a created task. Choose from the list, or specify IDs using an expression. Default: [] Type options: {"loadOptionsMethod":"getLabels"}

Source§

readonly labelUpdateFields?: {
    color?:
        | "orange"
        | "yellow"
        | "green"
        | "blue"
        | "red"
        | "berry_red"
        | "olive_green"
        | "lime_green"
        | "mint_green"
        | "teal"
        | "sky_blue"
        | "light_blue"
        | "grape"
        | "violet"
        | "lavender"
        | "magenta"
        | "salmon"
        | "charcoal"
        | "grey"
        | "taupe";
    is_favorite?: boolean;
    name?: string;
    order?: number;
}

Default: {}

Source§

readonly limit?: number

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

Source§

readonly name?: string

Name of the project

Source§

readonly natural_language_representation?: string

Human-readable date and time

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "close"
    | "move"
    | "archive"
    | "unarchive"
    | "reopen"
    | "quickAdd"
    | "getCollaborators"

Default: "create"

Source§

readonly options?:
    | { parent?: string; section?: string }
    | {
        auto_reminder?: boolean;
        note?: string;
        reminder?: string;
    }
    | {
        assigneeId?: string;
        deadlineDate?: string;
        description?: string;
        dueDate?: string;
        dueDateTime?: string;
        dueLang?: string;
        dueString?: string;
        duration?: number;
        durationUnit?: "day"
        | "minute";
        order?: number;
        parentId?: string;
        priority?: number;
        section?: string;
    }

Default: {}

Source§

readonly project?: { mode: "id" | "list"; value: string }

The destination project. Choose from the list, or specify an ID. Default: {"mode":"list","value":""}

Source§

readonly projectId?: string

The project ID - can be either a string or number

Source§

readonly projectOptions?: {
    color?:
        | "orange"
        | "yellow"
        | "green"
        | "blue"
        | "red"
        | "berry_red"
        | "olive_green"
        | "lime_green"
        | "mint_green"
        | "teal"
        | "sky_blue"
        | "light_blue"
        | "grape"
        | "violet"
        | "lavender"
        | "magenta"
        | "salmon"
        | "charcoal"
        | "grey"
        | "taupe";
    is_favorite?: boolean;
    parent_id?: string;
    view_style?: "list"
    | "board";
}

Default: {}

Source§

readonly projectUpdateFields?: {
    color?:
        | "orange"
        | "yellow"
        | "green"
        | "blue"
        | "red"
        | "berry_red"
        | "olive_green"
        | "lime_green"
        | "mint_green"
        | "teal"
        | "sky_blue"
        | "light_blue"
        | "grape"
        | "violet"
        | "lavender"
        | "magenta"
        | "salmon"
        | "charcoal"
        | "grey"
        | "taupe";
    is_favorite?: boolean;
    name?: string;
    view_style?: "list"
    | "board";
}

Default: {}

Source§

readonly reminderId?: string

Source§

readonly reminderOptions?: {
    minute_offset?: number;
    notify_uid?: string;
    type?: "relative" | "absolute";
}

Default: {}

Source§

readonly reminderUpdateFields?: {
    due?: {
        date?: string;
        datetime?: string;
        string?: string;
        timezone?: string;
    };
    minute_offset?: number;
    notify_uid?: string;
    type?: "relative"
    | "absolute";
}

Default: {}

Source§

readonly resource?:
    | "comment"
    | "project"
    | "task"
    | "label"
    | "reminder"
    | "section"

Default: "task"

Source§

readonly returnAll?: boolean

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

Source§

readonly section?: string

Section to which you want move the task. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getSections","loadOptionsDependsOn":["project.value"]}

Source§

readonly sectionFilters?: { project_id?: string }

Default: {}

Source§

readonly sectionId?: string

Source§

readonly sectionName?: string

Name of the section

Source§

readonly sectionOptions?: { order?: number }

Default: {}

Source§

readonly sectionProject?: { mode: "id" | "list"; value: string }

The project to add the section to Default: {"mode":"list","value":""}

Source§

readonly sectionUpdateFields?: { name?: string }

Default: {}

Source§

readonly taskId?: string

Source§

readonly text?: string

Natural language text for quick adding task (e.g., "Buy milk

Grocery

#shopping tomorrow"). It can include a due date in free form text, a project name starting with the "#" character (without spaces), a label starting with the "@" character, an assignee starting with the "+" character, a priority (e.g., p1), a deadline between "{}" (e.g. {in 3 days}), or a description starting from "//" until the end of the text. Type options: {"rows":3}

Source§

readonly timezone?: string

Timezone for the fixed timezone date

Source§

readonly updateFields?: {
    assigneeId?: string;
    content?: string;
    deadlineDate?: string;
    description?: string;
    dueDate?: string;
    dueDateTime?: string;
    dueLang?: string;
    dueString?: string;
    duration?: number;
    durationUnit?: "day" | "minute";
    labels?: unknown[];
    order?: number;
    priority?: number;
}

Default: {}