@doist/todoist-api-typescript 7.6.0 → 7.7.0

package/dist/types/types/tasks/requests.d.ts

@@ -0,0 +1,197 @@
+import type { RequireAllOrNone, RequireOneOrNone, RequireExactlyOne } from 'type-fest';
+import type { Duration, Task } from './types.js';
+/**
+ * Arguments for creating a new task.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/create_task_api_v1_tasks_post
+ */
+export type AddTaskArgs = {
+    content: string;
+    description?: string;
+    projectId?: string;
+    sectionId?: string;
+    parentId?: string;
+    order?: number;
+    labels?: string[];
+    priority?: number;
+    assigneeId?: string;
+    dueString?: string;
+    dueLang?: string;
+    deadlineLang?: string;
+    deadlineDate?: string;
+    isUncompletable?: boolean;
+} & RequireOneOrNone<{
+    dueDate?: string;
+    dueDatetime?: string;
+}> & RequireAllOrNone<{
+    duration?: Duration['amount'];
+    durationUnit?: Duration['unit'];
+}>;
+/**
+ * Arguments for retrieving tasks.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/get_tasks_api_v1_tasks_get
+ */
+export type GetTasksArgs = {
+    projectId?: string;
+    sectionId?: string;
+    parentId?: string;
+    label?: string;
+    ids?: string[];
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for retrieving tasks by filter.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/get_tasks_by_filter_api_v1_tasks_filter_get
+ */
+export type GetTasksByFilterArgs = {
+    query: string;
+    lang?: string;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for retrieving completed tasks by completion date.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/tasks_completed_by_completion_date_api_v1_tasks_completed_by_completion_date_get
+ */
+export type GetCompletedTasksByCompletionDateArgs = {
+    since: string;
+    until: string;
+    workspaceId?: string | null;
+    projectId?: string | null;
+    sectionId?: string | null;
+    parentId?: string | null;
+    filterQuery?: string | null;
+    filterLang?: string | null;
+    cursor?: string | null;
+    limit?: number;
+    publicKey?: string | null;
+};
+/**
+ * Arguments for retrieving completed tasks by due date.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/tasks_completed_by_due_date_api_v1_tasks_completed_by_due_date_get
+ */
+export type GetCompletedTasksByDueDateArgs = {
+    since: string;
+    until: string;
+    workspaceId?: string | null;
+    projectId?: string | null;
+    sectionId?: string | null;
+    parentId?: string | null;
+    filterQuery?: string | null;
+    filterLang?: string | null;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for searching completed tasks.
+ */
+export type SearchCompletedTasksArgs = {
+    query: string;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/get_tasks_api_v1_tasks_get
+ */
+export type GetTasksResponse = {
+    results: Task[];
+    nextCursor: string | null;
+};
+/**
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/tasks_completed_by_due_date_api_v1_tasks_completed_by_due_date_get
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/tasks_completed_by_completion_date_api_v1_tasks_completed_by_completion_date_get
+ */
+export type GetCompletedTasksResponse = {
+    items: Task[];
+    nextCursor: string | null;
+};
+/**
+ * Arguments for updating a task.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/update_task_api_v1_tasks__task_id__post
+ */
+export type UpdateTaskArgs = {
+    content?: string;
+    description?: string;
+    labels?: string[];
+    priority?: number;
+    /**
+     * Sort order of the task within its parent/project.
+     * Internally mapped to `child_order` in the API payload.
+     */
+    order?: number;
+    /**
+     * Natural language due date.
+     * Use `"no date"` to clear a due date, or `null` as an SDK alias for the same behavior.
+     */
+    dueString?: (string & {}) | 'no date' | null;
+    dueLang?: string | null;
+    assigneeId?: string | null;
+    /**
+     * Deadline date in `YYYY-MM-DD` format.
+     * Use `null` to clear a task deadline.
+     */
+    deadlineDate?: string | null;
+    deadlineLang?: string | null;
+    isUncompletable?: boolean;
+} & RequireOneOrNone<{
+    dueDate?: string;
+    dueDatetime?: string;
+}> & RequireAllOrNone<{
+    duration?: Duration['amount'];
+    durationUnit?: Duration['unit'];
+}>;
+/**
+ * Arguments for quick adding a task.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/quick_add_api_v1_tasks_quick_post
+ */
+export type QuickAddTaskArgs = {
+    text: string;
+    note?: string;
+    reminder?: string;
+    autoReminder?: boolean;
+    meta?: boolean;
+    isUncompletable?: boolean;
+};
+/**
+ * Response from quick adding a task.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/quick_add_api_v1_tasks_quick_post
+ */
+/**
+ * Arguments for moving a task.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/move_task_api_v1_tasks__task_id__move_post
+ */
+export type MoveTaskArgs = RequireExactlyOne<{
+    projectId?: string;
+    sectionId?: string;
+    parentId?: string;
+}>;
+/**
+ * Arguments for getting all completed tasks.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/get_all_completed_items_api_v1_tasks_completed_get
+ */
+export type GetAllCompletedTasksArgs = {
+    /** Filter by project ID. */
+    projectId?: string | null;
+    /** Filter by label name. */
+    label?: string | null;
+    /** Number of results to return (max 200, default 30). */
+    limit?: number;
+    /** Number of results to skip (default 0). */
+    offset?: number;
+    /** Return items completed after this date. */
+    since?: Date | null;
+    /** Return items completed before this date. */
+    until?: Date | null;
+    /** Include comment data in the response. */
+    annotateNotes?: boolean;
+    /** Include task data in the response. */
+    annotateItems?: boolean;
+};
+/**
+ * Response from getting all completed tasks.
+ */
+export type GetAllCompletedTasksResponse = {
+    projects: Record<string, Record<string, unknown>>;
+    sections: Record<string, Record<string, unknown>>;
+    items: Task[];
+};

package/dist/types/types/tasks/types.d.ts

@@ -0,0 +1,162 @@
+import { z } from 'zod';
+export declare const DueDateSchema: z.ZodObject<{
+    isRecurring: z.ZodBoolean;
+    string: z.ZodString;
+    date: z.ZodString;
+    datetime: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    lang: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Represents a due date for a task.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/get_tasks_api_v1_tasks_get
+ */
+export type DueDate = z.infer<typeof DueDateSchema>;
+/** Available duration units for task deadlines. */
+export declare const DURATION_UNITS: readonly ["minute", "day"];
+/** Unit of time for a task duration. */
+export type DurationUnit = (typeof DURATION_UNITS)[number];
+export declare const DurationSchema: z.ZodObject<{
+    amount: z.ZodNumber;
+    unit: z.ZodEnum<{
+        minute: "minute";
+        day: "day";
+    }>;
+}, z.core.$strip>;
+/**
+ * Represents a duration for a task deadline.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks
+ */
+export type Duration = z.infer<typeof DurationSchema>;
+export declare const DeadlineSchema: z.ZodObject<{
+    date: z.ZodString;
+    lang: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Represents a task deadline.
+ */
+export type Deadline = z.infer<typeof DeadlineSchema>;
+export declare const TaskSchema: z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    userId: z.ZodString;
+    projectId: z.ZodString;
+    sectionId: z.ZodNullable<z.ZodString>;
+    parentId: z.ZodNullable<z.ZodString>;
+    addedByUid: z.ZodNullable<z.ZodString>;
+    assignedByUid: z.ZodNullable<z.ZodString>;
+    responsibleUid: z.ZodNullable<z.ZodString>;
+    labels: z.ZodArray<z.ZodString>;
+    deadline: z.ZodNullable<z.ZodObject<{
+        date: z.ZodString;
+        lang: z.ZodString;
+    }, z.core.$strip>>;
+    duration: z.ZodNullable<z.ZodObject<{
+        amount: z.ZodNumber;
+        unit: z.ZodEnum<{
+            minute: "minute";
+            day: "day";
+        }>;
+    }, z.core.$strip>>;
+    checked: z.ZodBoolean;
+    isDeleted: z.ZodBoolean;
+    addedAt: z.ZodNullable<z.ZodString>;
+    completedAt: z.ZodNullable<z.ZodString>;
+    updatedAt: z.ZodNullable<z.ZodString>;
+    due: z.ZodNullable<z.ZodObject<{
+        isRecurring: z.ZodBoolean;
+        string: z.ZodString;
+        date: z.ZodString;
+        datetime: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        lang: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>;
+    priority: z.ZodNumber;
+    childOrder: z.ZodNumber;
+    content: z.ZodString;
+    description: z.ZodString;
+    dayOrder: z.ZodNumber;
+    isCollapsed: z.ZodBoolean;
+    isUncompletable: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodTransform<{
+    isUncompletable: boolean;
+    url: string;
+    id: string;
+    userId: string;
+    projectId: string;
+    sectionId: string | null;
+    parentId: string | null;
+    addedByUid: string | null;
+    assignedByUid: string | null;
+    responsibleUid: string | null;
+    labels: string[];
+    deadline: {
+        date: string;
+        lang: string;
+    } | null;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
+    checked: boolean;
+    isDeleted: boolean;
+    addedAt: string | null;
+    completedAt: string | null;
+    updatedAt: string | null;
+    due: {
+        isRecurring: boolean;
+        string: string;
+        date: string;
+        datetime?: string | null | undefined;
+        timezone?: string | null | undefined;
+        lang?: string | null | undefined;
+    } | null;
+    priority: number;
+    childOrder: number;
+    content: string;
+    description: string;
+    dayOrder: number;
+    isCollapsed: boolean;
+}, {
+    id: string;
+    userId: string;
+    projectId: string;
+    sectionId: string | null;
+    parentId: string | null;
+    addedByUid: string | null;
+    assignedByUid: string | null;
+    responsibleUid: string | null;
+    labels: string[];
+    deadline: {
+        date: string;
+        lang: string;
+    } | null;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
+    checked: boolean;
+    isDeleted: boolean;
+    addedAt: string | null;
+    completedAt: string | null;
+    updatedAt: string | null;
+    due: {
+        isRecurring: boolean;
+        string: string;
+        date: string;
+        datetime?: string | null | undefined;
+        timezone?: string | null | undefined;
+        lang?: string | null | undefined;
+    } | null;
+    priority: number;
+    childOrder: number;
+    content: string;
+    description: string;
+    dayOrder: number;
+    isCollapsed: boolean;
+    isUncompletable: boolean;
+}>>;
+/**
+ * Represents a task in Todoist.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks
+ */
+export type Task = z.infer<typeof TaskSchema>;

package/dist/types/types/templates/index.d.ts

@@ -0,0 +1 @@
+export * from './requests.js';

package/dist/types/types/templates/requests.d.ts

@@ -0,0 +1,92 @@
+import type { Comment } from '../comments/types.js';
+import type { PersonalProject, WorkspaceProject } from '../projects/types.js';
+import type { Section } from '../sections/types.js';
+import type { Task } from '../tasks/types.js';
+/**
+ * Arguments for exporting a project as a template file.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/export_as_file_api_v1_templates_file_get
+ */
+export type ExportTemplateFileArgs = {
+    /** The project ID to export. */
+    projectId: string;
+    /** Whether to use relative dates in the export. */
+    useRelativeDates?: boolean;
+};
+/**
+ * Arguments for exporting a project as a template URL.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/export_as_url_api_v1_templates_url_get
+ */
+export type ExportTemplateUrlArgs = {
+    /** The project ID to export. */
+    projectId: string;
+    /** Whether to use relative dates in the export. */
+    useRelativeDates?: boolean;
+};
+/**
+ * Response from exporting a project as a template URL.
+ */
+export type ExportTemplateUrlResponse = {
+    fileName: string;
+    fileUrl: string;
+};
+/**
+ * Arguments for creating a project from a template file.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/create_project_from_file_api_v1_templates_create_project_from_file_post
+ */
+export type CreateProjectFromTemplateArgs = {
+    /** Name for the new project. */
+    name: string;
+    /** The template file content. */
+    file: Buffer | NodeJS.ReadableStream | string | Blob;
+    /** Optional file name (required for Buffer/Stream). */
+    fileName?: string;
+    /** Optional workspace ID. */
+    workspaceId?: string | null;
+};
+/**
+ * Response from creating a project from a template.
+ */
+export type CreateProjectFromTemplateResponse = {
+    status: string;
+    projectId: string;
+    templateType: string;
+    projects: (PersonalProject | WorkspaceProject)[];
+    sections: Section[];
+    tasks: Task[];
+    comments: Comment[];
+};
+/**
+ * Arguments for importing a template file into an existing project.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/import_into_project_from_file_api_v1_templates_import_into_project_from_file_post
+ */
+export type ImportTemplateIntoProjectArgs = {
+    /** The project ID to import into. */
+    projectId: string;
+    /** The template file content. */
+    file: Buffer | NodeJS.ReadableStream | string | Blob;
+    /** Optional file name (required for Buffer/Stream). */
+    fileName?: string;
+};
+/**
+ * Arguments for importing a template by ID into an existing project.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/import_into_project_from_template_id_api_v1_templates_import_into_project_from_template_id_post
+ */
+export type ImportTemplateFromIdArgs = {
+    /** The project ID to import into. */
+    projectId: string;
+    /** The template ID to import. */
+    templateId: string;
+    /** Locale for the import (default: 'en'). */
+    locale?: string;
+};
+/**
+ * Response from importing a template into a project.
+ */
+export type ImportTemplateResponse = {
+    status: string;
+    templateType: string;
+    projects: (PersonalProject | WorkspaceProject)[];
+    sections: Section[];
+    tasks: Task[];
+    comments: Comment[];
+};

package/dist/types/types/uploads/index.d.ts

@@ -0,0 +1 @@
+export * from './requests.js';

package/dist/types/types/uploads/requests.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Arguments for uploading a file.
+ * @see https://developer.todoist.com/api/v1/#tag/Uploads/operation/upload_file_api_v1_uploads_post
+ */
+export type UploadFileArgs = {
+    /**
+     * The file content to upload. Can be:
+     * - Buffer: File content as a Buffer (requires fileName)
+     * - ReadableStream: File content as a stream (requires fileName)
+     * - string: Path to a file on the filesystem (fileName is optional, will be inferred from path)
+     */
+    file: Buffer | NodeJS.ReadableStream | string | Blob;
+    /**
+     * The name of the file. Required for Buffer and Stream inputs.
+     * Optional for file path strings and File objects (will be inferred if not provided).
+     */
+    fileName?: string;
+    /**
+     * The project ID to associate the upload with.
+     */
+    projectId?: string | null;
+};
+/**
+ * Arguments for deleting an uploaded file.
+ * @see https://developer.todoist.com/api/v1/#tag/Uploads/operation/delete_upload_api_v1_uploads_delete
+ */
+export type DeleteUploadArgs = {
+    /**
+     * The URL of the file to delete.
+     */
+    fileUrl: string;
+};

package/dist/types/types/users/index.d.ts

@@ -0,0 +1 @@
+export * from './types.js';

package/dist/types/types/users/types.d.ts

@@ -0,0 +1,66 @@
+import { z } from 'zod';
+export declare const UserSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    email: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Represents a user in Todoist (simplified for collaborators).
+ * @see https://developer.todoist.com/api/v1/#tag/User
+ */
+export type User = z.infer<typeof UserSchema>;
+export declare const TimezoneInfoSchema: z.ZodObject<{
+    gmtString: z.ZodString;
+    hours: z.ZodNumber;
+    isDst: z.ZodNumber;
+    minutes: z.ZodNumber;
+    timezone: z.ZodString;
+}, z.core.$strip>;
+/** Available user premium statuses. */
+export declare const PREMIUM_STATUSES: readonly ["not_premium", "current_personal_plan", "legacy_personal_plan", "teams_business_member"];
+/** Premium subscription status of a user. */
+export type PremiumStatus = (typeof PREMIUM_STATUSES)[number];
+export declare const CurrentUserSchema: z.ZodObject<{
+    id: z.ZodString;
+    email: z.ZodString;
+    fullName: z.ZodString;
+    avatarBig: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarMedium: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarS640: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarSmall: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    businessAccountId: z.ZodNullable<z.ZodString>;
+    isPremium: z.ZodBoolean;
+    premiumStatus: z.ZodEnum<{
+        not_premium: "not_premium";
+        current_personal_plan: "current_personal_plan";
+        legacy_personal_plan: "legacy_personal_plan";
+        teams_business_member: "teams_business_member";
+    }>;
+    dateFormat: z.ZodNumber;
+    timeFormat: z.ZodNumber;
+    weeklyGoal: z.ZodNumber;
+    dailyGoal: z.ZodNumber;
+    completedCount: z.ZodNumber;
+    completedToday: z.ZodNumber;
+    karma: z.ZodNumber;
+    karmaTrend: z.ZodString;
+    lang: z.ZodString;
+    nextWeek: z.ZodNumber;
+    startDay: z.ZodNumber;
+    startPage: z.ZodString;
+    tzInfo: z.ZodObject<{
+        gmtString: z.ZodString;
+        hours: z.ZodNumber;
+        isDst: z.ZodNumber;
+        minutes: z.ZodNumber;
+        timezone: z.ZodString;
+    }, z.core.$strip>;
+    inboxProjectId: z.ZodString;
+    daysOff: z.ZodArray<z.ZodNumber>;
+    weekendStartDay: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Represents the current authenticated user with detailed information.
+ * @see https://developer.todoist.com/api/v1/#tag/User
+ */
+export type CurrentUser = z.infer<typeof CurrentUserSchema>;

package/dist/types/types/workspaces/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './requests.js';