@doist/todoist-sdk 0.0.1 → 8.0.0

package/dist/types/types/projects/types.d.ts

@@ -0,0 +1,201 @@
+import { z } from 'zod';
+/**
+ * Base schema for all project types in Todoist.
+ * Contains common fields shared between personal and workspace projects.
+ */
+export declare const BaseProjectSchema: z.ZodObject<{
+    id: z.ZodString;
+    canAssignTasks: z.ZodBoolean;
+    childOrder: z.ZodNumber;
+    color: z.ZodString;
+    createdAt: z.ZodNullable<z.ZodString>;
+    isArchived: z.ZodBoolean;
+    isDeleted: z.ZodBoolean;
+    isFavorite: z.ZodBoolean;
+    isFrozen: z.ZodBoolean;
+    name: z.ZodString;
+    updatedAt: z.ZodNullable<z.ZodString>;
+    viewStyle: z.ZodString;
+    defaultOrder: z.ZodNumber;
+    description: z.ZodString;
+    isCollapsed: z.ZodBoolean;
+    isShared: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Schema for personal projects in Todoist.
+ */
+export declare const PersonalProjectSchema: z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    canAssignTasks: z.ZodBoolean;
+    childOrder: z.ZodNumber;
+    color: z.ZodString;
+    createdAt: z.ZodNullable<z.ZodString>;
+    isArchived: z.ZodBoolean;
+    isDeleted: z.ZodBoolean;
+    isFavorite: z.ZodBoolean;
+    isFrozen: z.ZodBoolean;
+    name: z.ZodString;
+    updatedAt: z.ZodNullable<z.ZodString>;
+    viewStyle: z.ZodString;
+    defaultOrder: z.ZodNumber;
+    description: z.ZodString;
+    isCollapsed: z.ZodBoolean;
+    isShared: z.ZodBoolean;
+    parentId: z.ZodNullable<z.ZodString>;
+    inboxProject: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>, z.ZodTransform<{
+    url: string;
+    id: string;
+    canAssignTasks: boolean;
+    childOrder: number;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    updatedAt: string | null;
+    viewStyle: string;
+    defaultOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    isShared: boolean;
+    parentId: string | null;
+    inboxProject: boolean;
+}, {
+    id: string;
+    canAssignTasks: boolean;
+    childOrder: number;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    updatedAt: string | null;
+    viewStyle: string;
+    defaultOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    isShared: boolean;
+    parentId: string | null;
+    inboxProject: boolean;
+}>>;
+/** Available project visibility levels. */
+export declare const PROJECT_VISIBILITIES: readonly ["restricted", "team", "public"];
+/** Visibility level of a workspace project. */
+export type ProjectVisibility = (typeof PROJECT_VISIBILITIES)[number];
+export declare const ProjectVisibilitySchema: z.ZodEnum<{
+    restricted: "restricted";
+    team: "team";
+    public: "public";
+}>;
+/**
+ * Schema for workspace projects in Todoist.
+ */
+export declare const WorkspaceProjectSchema: z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    canAssignTasks: z.ZodBoolean;
+    childOrder: z.ZodNumber;
+    color: z.ZodString;
+    createdAt: z.ZodNullable<z.ZodString>;
+    isArchived: z.ZodBoolean;
+    isDeleted: z.ZodBoolean;
+    isFavorite: z.ZodBoolean;
+    isFrozen: z.ZodBoolean;
+    name: z.ZodString;
+    updatedAt: z.ZodNullable<z.ZodString>;
+    viewStyle: z.ZodString;
+    defaultOrder: z.ZodNumber;
+    description: z.ZodString;
+    isCollapsed: z.ZodBoolean;
+    isShared: z.ZodBoolean;
+    access: z.ZodOptional<z.ZodObject<{
+        visibility: z.ZodEnum<{
+            restricted: "restricted";
+            team: "team";
+            public: "public";
+        }>;
+    }, z.core.$strip>>;
+    collaboratorRoleDefault: z.ZodString;
+    folderId: z.ZodNullable<z.ZodString>;
+    isInviteOnly: z.ZodNullable<z.ZodBoolean>;
+    isLinkSharingEnabled: z.ZodBoolean;
+    role: z.ZodNullable<z.ZodString>;
+    status: z.ZodString;
+    workspaceId: z.ZodString;
+}, z.core.$strip>, z.ZodTransform<{
+    url: string;
+    id: string;
+    canAssignTasks: boolean;
+    childOrder: number;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    updatedAt: string | null;
+    viewStyle: string;
+    defaultOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    isShared: boolean;
+    collaboratorRoleDefault: string;
+    folderId: string | null;
+    isInviteOnly: boolean | null;
+    isLinkSharingEnabled: boolean;
+    role: string | null;
+    status: string;
+    workspaceId: string;
+    access?: {
+        visibility: "restricted" | "team" | "public";
+    } | undefined;
+}, {
+    id: string;
+    canAssignTasks: boolean;
+    childOrder: number;
+    color: string;
+    createdAt: string | null;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isFavorite: boolean;
+    isFrozen: boolean;
+    name: string;
+    updatedAt: string | null;
+    viewStyle: string;
+    defaultOrder: number;
+    description: string;
+    isCollapsed: boolean;
+    isShared: boolean;
+    collaboratorRoleDefault: string;
+    folderId: string | null;
+    isInviteOnly: boolean | null;
+    isLinkSharingEnabled: boolean;
+    role: string | null;
+    status: string;
+    workspaceId: string;
+    access?: {
+        visibility: "restricted" | "team" | "public";
+    } | undefined;
+}>>;
+/**
+ * Represents a personal project in Todoist.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects
+ */
+export type PersonalProject = z.infer<typeof PersonalProjectSchema>;
+/**
+ * Represents a workspace project in Todoist.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects
+ */
+export type WorkspaceProject = z.infer<typeof WorkspaceProjectSchema>;
+/** Available project view styles. */
+export declare const PROJECT_VIEW_STYLES: readonly ["list", "board", "calendar"];
+/**
+ * View style for a project.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects
+ */
+export type ProjectViewStyle = (typeof PROJECT_VIEW_STYLES)[number];

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

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

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

@@ -0,0 +1,205 @@
+import { z } from 'zod';
+import type { Reminder, LocationReminder } from '../sync/resources/reminders.js';
+/** Available reminder delivery services. */
+export declare const REMINDER_DELIVERY_SERVICES: readonly ["email", "push"];
+/** Delivery service for a reminder notification. */
+export type ReminderDeliveryService = (typeof REMINDER_DELIVERY_SERVICES)[number];
+export declare const ReminderDeliveryServiceSchema: z.ZodEnum<{
+    email: "email";
+    push: "push";
+}>;
+export declare const ReminderIdSchema: z.ZodString;
+export declare const ReminderDueDateSchema: z.ZodObject<{
+    string: z.ZodOptional<z.ZodString>;
+    isRecurring: z.ZodOptional<z.ZodBoolean>;
+    date: z.ZodOptional<z.ZodString>;
+    timezone: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    lang: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+}, z.core.$strict>;
+export type ReminderDueDate = z.infer<typeof ReminderDueDateSchema>;
+export declare const AddRelativeReminderArgsSchema: z.ZodObject<{
+    taskId: z.ZodString;
+    reminderType: z.ZodOptional<z.ZodLiteral<"relative">>;
+    minuteOffset: z.ZodNumber;
+    service: z.ZodOptional<z.ZodEnum<{
+        email: "email";
+        push: "push";
+    }>>;
+    notifyUid: z.ZodOptional<z.ZodString>;
+    isUrgent: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export type AddRelativeReminderArgs = z.infer<typeof AddRelativeReminderArgsSchema>;
+export declare const AddAbsoluteReminderArgsSchema: z.ZodObject<{
+    taskId: z.ZodString;
+    reminderType: z.ZodLiteral<"absolute">;
+    due: z.ZodObject<{
+        string: z.ZodOptional<z.ZodString>;
+        isRecurring: z.ZodOptional<z.ZodBoolean>;
+        date: z.ZodOptional<z.ZodString>;
+        timezone: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+        lang: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    }, z.core.$strict>;
+    service: z.ZodOptional<z.ZodEnum<{
+        email: "email";
+        push: "push";
+    }>>;
+    notifyUid: z.ZodOptional<z.ZodString>;
+    isUrgent: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export type AddAbsoluteReminderArgs = z.infer<typeof AddAbsoluteReminderArgsSchema>;
+export declare const AddReminderArgsSchema: z.ZodUnion<readonly [z.ZodObject<{
+    taskId: z.ZodString;
+    reminderType: z.ZodOptional<z.ZodLiteral<"relative">>;
+    minuteOffset: z.ZodNumber;
+    service: z.ZodOptional<z.ZodEnum<{
+        email: "email";
+        push: "push";
+    }>>;
+    notifyUid: z.ZodOptional<z.ZodString>;
+    isUrgent: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>, z.ZodObject<{
+    taskId: z.ZodString;
+    reminderType: z.ZodLiteral<"absolute">;
+    due: z.ZodObject<{
+        string: z.ZodOptional<z.ZodString>;
+        isRecurring: z.ZodOptional<z.ZodBoolean>;
+        date: z.ZodOptional<z.ZodString>;
+        timezone: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+        lang: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    }, z.core.$strict>;
+    service: z.ZodOptional<z.ZodEnum<{
+        email: "email";
+        push: "push";
+    }>>;
+    notifyUid: z.ZodOptional<z.ZodString>;
+    isUrgent: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>]>;
+/**
+ * Arguments for creating a new reminder.
+ * @see https://developer.todoist.com/api/v1/#tag/Reminders/operation/create_reminder_api_v1_reminders_post
+ */
+export type AddReminderArgs = AddRelativeReminderArgs | AddAbsoluteReminderArgs;
+export declare const AddLocationReminderArgsSchema: z.ZodObject<{
+    taskId: z.ZodString;
+    notifyUid: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    locLat: z.ZodString;
+    locLong: z.ZodString;
+    locTrigger: z.ZodEnum<{
+        on_enter: "on_enter";
+        on_leave: "on_leave";
+    }>;
+    radius: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type AddLocationReminderArgs = z.infer<typeof AddLocationReminderArgsSchema>;
+export declare const UpdateRelativeReminderArgsSchema: z.ZodObject<{
+    reminderType: z.ZodLiteral<"relative">;
+    minuteOffset: z.ZodOptional<z.ZodNumber>;
+    notifyUid: z.ZodOptional<z.ZodString>;
+    service: z.ZodOptional<z.ZodEnum<{
+        email: "email";
+        push: "push";
+    }>>;
+    isUrgent: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export type UpdateRelativeReminderArgs = z.infer<typeof UpdateRelativeReminderArgsSchema>;
+export declare const UpdateAbsoluteReminderArgsSchema: z.ZodObject<{
+    reminderType: z.ZodLiteral<"absolute">;
+    due: z.ZodOptional<z.ZodObject<{
+        string: z.ZodOptional<z.ZodString>;
+        isRecurring: z.ZodOptional<z.ZodBoolean>;
+        date: z.ZodOptional<z.ZodString>;
+        timezone: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+        lang: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    }, z.core.$strict>>;
+    notifyUid: z.ZodOptional<z.ZodString>;
+    service: z.ZodOptional<z.ZodEnum<{
+        email: "email";
+        push: "push";
+    }>>;
+    isUrgent: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export type UpdateAbsoluteReminderArgs = z.infer<typeof UpdateAbsoluteReminderArgsSchema>;
+export declare const UpdateReminderArgsSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    reminderType: z.ZodLiteral<"relative">;
+    minuteOffset: z.ZodOptional<z.ZodNumber>;
+    notifyUid: z.ZodOptional<z.ZodString>;
+    service: z.ZodOptional<z.ZodEnum<{
+        email: "email";
+        push: "push";
+    }>>;
+    isUrgent: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>, z.ZodObject<{
+    reminderType: z.ZodLiteral<"absolute">;
+    due: z.ZodOptional<z.ZodObject<{
+        string: z.ZodOptional<z.ZodString>;
+        isRecurring: z.ZodOptional<z.ZodBoolean>;
+        date: z.ZodOptional<z.ZodString>;
+        timezone: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+        lang: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    }, z.core.$strict>>;
+    notifyUid: z.ZodOptional<z.ZodString>;
+    service: z.ZodOptional<z.ZodEnum<{
+        email: "email";
+        push: "push";
+    }>>;
+    isUrgent: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>], "reminderType">;
+/**
+ * Arguments for updating an existing reminder.
+ * @see https://developer.todoist.com/api/v1/#tag/Reminders/operation/update_reminder_api_v1_reminders__reminder_id__post
+ */
+export type UpdateReminderArgs = UpdateRelativeReminderArgs | UpdateAbsoluteReminderArgs;
+export declare const UpdateLocationReminderArgsSchema: z.ZodObject<{
+    notifyUid: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    locLat: z.ZodOptional<z.ZodString>;
+    locLong: z.ZodOptional<z.ZodString>;
+    locTrigger: z.ZodOptional<z.ZodEnum<{
+        on_enter: "on_enter";
+        on_leave: "on_leave";
+    }>>;
+    radius: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+/**
+ * Arguments for updating an existing location reminder.
+ */
+export type UpdateLocationReminderArgs = z.infer<typeof UpdateLocationReminderArgsSchema>;
+/**
+ * Arguments for listing reminders.
+ * @see https://developer.todoist.com/api/v1/#tag/Reminders/operation/get_reminders_api_v1_reminders_get
+ */
+export type GetRemindersArgs = {
+    /** Filter by task ID. */
+    taskId?: string | null;
+    /** Cursor for pagination. */
+    cursor?: string | null;
+    /** Number of results per page (max 200, default 50). */
+    limit?: number;
+};
+/**
+ * Paginated response for reminders.
+ */
+export type GetRemindersResponse = {
+    results: Reminder[];
+    nextCursor: string | null;
+};
+/**
+ * Arguments for listing location reminders.
+ * @see https://developer.todoist.com/api/v1/#tag/Location-reminders/operation/get_location_reminders_api_v1_location_reminders_get
+ */
+export type GetLocationRemindersArgs = {
+    /** Filter by task ID. */
+    taskId?: string | null;
+    /** Cursor for pagination. */
+    cursor?: string | null;
+    /** Number of results per page (max 200, default 50). */
+    limit?: number;
+};
+/**
+ * Paginated response for location reminders.
+ */
+export type GetLocationRemindersResponse = {
+    results: LocationReminder[];
+    nextCursor: string | null;
+};

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

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

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

@@ -0,0 +1,41 @@
+import type { SearchArgs } from '../common.js';
+import type { Section } from './types.js';
+/**
+ * Arguments for retrieving sections.
+ * @see https://developer.todoist.com/api/v1/#tag/Sections/operation/get_sections_api_v1_sections_get
+ */
+export type GetSectionsArgs = {
+    projectId?: string | null;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for searching sections.
+ */
+export type SearchSectionsArgs = SearchArgs & {
+    projectId?: string | null;
+};
+/**
+ * Response from retrieving sections.
+ * @see https://developer.todoist.com/api/v1/#tag/Sections/operation/get_sections_api_v1_sections_get
+ */
+export type GetSectionsResponse = {
+    results: Section[];
+    nextCursor: string | null;
+};
+/**
+ * Arguments for creating a new section.
+ * @see https://developer.todoist.com/api/v1/#tag/Sections/operation/create_section_api_v1_sections_post
+ */
+export type AddSectionArgs = {
+    name: string;
+    projectId: string;
+    order?: number | null;
+};
+/**
+ * Arguments for updating a section.
+ * @see https://developer.todoist.com/api/v1/#tag/Sections/operation/update_section_api_v1_sections__section_id__post
+ */
+export type UpdateSectionArgs = {
+    name: string;
+};

package/dist/types/types/sections/types.d.ts

@@ -0,0 +1,44 @@
+import { z } from 'zod';
+export declare const SectionSchema: z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    userId: z.ZodString;
+    projectId: z.ZodString;
+    addedAt: z.ZodString;
+    updatedAt: z.ZodString;
+    archivedAt: z.ZodNullable<z.ZodString>;
+    name: z.ZodString;
+    sectionOrder: z.ZodNumber;
+    isArchived: z.ZodBoolean;
+    isDeleted: z.ZodBoolean;
+    isCollapsed: z.ZodBoolean;
+}, z.core.$strip>, z.ZodTransform<{
+    url: string;
+    id: string;
+    userId: string;
+    projectId: string;
+    addedAt: string;
+    updatedAt: string;
+    archivedAt: string | null;
+    name: string;
+    sectionOrder: number;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isCollapsed: boolean;
+}, {
+    id: string;
+    userId: string;
+    projectId: string;
+    addedAt: string;
+    updatedAt: string;
+    archivedAt: string | null;
+    name: string;
+    sectionOrder: number;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isCollapsed: boolean;
+}>>;
+/**
+ * Represents a section in a Todoist project.
+ * @see https://developer.todoist.com/api/v1/#tag/Sections
+ */
+export type Section = z.infer<typeof SectionSchema>;

package/dist/types/types/sync/commands/calendars.d.ts

@@ -0,0 +1,14 @@
+export type CalendarUpdateArgs = {
+    id: string;
+    isVisible: boolean;
+};
+export type CalendarAccountUpdateArgs = {
+    id: string;
+    isEventsEnabled?: boolean;
+    isTasksEnabled?: boolean;
+    isAllDayTasksEnabled?: boolean;
+    pendingOperationUntil?: string | null;
+};
+export type CalendarAccountRestoreTaskCalendarArgs = {
+    id: string;
+};

package/dist/types/types/sync/commands/filters.d.ts

@@ -0,0 +1,22 @@
+import type { ColorKey } from '../../../utils/colors.js';
+export type FilterAddArgs = {
+    name: string;
+    query: string;
+    color?: ColorKey;
+    itemOrder?: number;
+    isFavorite?: boolean;
+};
+export type FilterUpdateArgs = {
+    id: string;
+    name?: string;
+    query?: string;
+    color?: ColorKey;
+    itemOrder?: number;
+    isFavorite?: boolean;
+};
+export type FilterUpdateOrdersArgs = {
+    idOrderMapping: Record<string, number>;
+};
+export type FilterDeleteArgs = {
+    id: string;
+};

package/dist/types/types/sync/commands/folders.d.ts

@@ -0,0 +1,18 @@
+export type FolderAddArgs = {
+    name: string;
+    workspaceId: string;
+    childOrder?: number;
+    defaultOrder?: number;
+    addProjectIds?: string[];
+};
+export type FolderUpdateArgs = {
+    id: string;
+    workspaceId: string;
+    name?: string;
+    addProjectIds?: string[];
+    removeProjectIds?: string[];
+};
+export type FolderDeleteArgs = {
+    id: string;
+    workspaceId: string;
+};