@doist/todoist-api-typescript 7.6.0 → 7.7.0

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

@@ -0,0 +1,169 @@
+import type { ColorKey } from '../../utils/colors.js';
+import type { SearchArgs } from '../common.js';
+import type { Comment } from '../comments/types.js';
+import type { Section } from '../sections/types.js';
+import type { Task } from '../tasks/types.js';
+import type { User } from '../users/types.js';
+import type { CollaboratorRole, WorkspaceRole } from '../workspaces/types.js';
+import type { PersonalProject, ProjectViewStyle, ProjectVisibility, WorkspaceProject } from './types.js';
+/**
+ * Arguments for retrieving projects.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/get_projects_api_v1_projects_get
+ */
+export type GetProjectsArgs = {
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for searching projects.
+ */
+export type SearchProjectsArgs = SearchArgs;
+/**
+ * Response from retrieving projects.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/get_projects_api_v1_projects_get
+ */
+export type GetProjectsResponse = {
+    results: (PersonalProject | WorkspaceProject)[];
+    nextCursor: string | null;
+};
+/**
+ * Arguments for retrieving archived projects.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/get_archived_projects_api_v1_projects_archived_get
+ */
+export type GetArchivedProjectsArgs = {
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Response from retrieving archived projects.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/get_archived_projects_api_v1_projects_archived_get
+ */
+export type GetArchivedProjectsResponse = {
+    results: (PersonalProject | WorkspaceProject)[];
+    nextCursor: string | null;
+};
+/**
+ * Arguments for creating a new project.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/create_project_api_v1_projects_post
+ */
+export type AddProjectArgs = {
+    name: string;
+    parentId?: string;
+    color?: ColorKey;
+    isFavorite?: boolean;
+    viewStyle?: ProjectViewStyle;
+    workspaceId?: string;
+};
+/**
+ * Arguments for updating a project.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/update_project_api_v1_projects__project_id__post
+ */
+export type UpdateProjectArgs = {
+    name?: string;
+    color?: ColorKey;
+    isFavorite?: boolean;
+    viewStyle?: ProjectViewStyle;
+};
+/**
+ * Arguments for retrieving project collaborators.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/get_project_collaborators_api_v1_projects__project_id__collaborators_get
+ */
+export type GetProjectCollaboratorsArgs = {
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Response from retrieving project collaborators.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/get_project_collaborators_api_v1_projects__project_id__collaborators_get
+ */
+export type GetProjectCollaboratorsResponse = {
+    results: User[];
+    nextCursor: string | null;
+};
+/**
+ * Arguments for moving a project to a workspace.
+ */
+export type MoveProjectToWorkspaceArgs = {
+    /** The ID of the project to move. */
+    projectId: string;
+    /** The target workspace ID. */
+    workspaceId: string;
+    /** Optional target folder ID within the workspace. */
+    folderId?: string | null;
+    /** Optional access settings for the project in the workspace. */
+    access?: {
+        visibility: ProjectVisibility;
+    };
+};
+/**
+ * Arguments for moving a project to personal.
+ */
+export type MoveProjectToPersonalArgs = {
+    /** The ID of the project to move. */
+    projectId: string;
+};
+/**
+ * Arguments for counting archived projects.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/count_projects_archived_api_v1_projects_archived_count_get
+ */
+export type GetArchivedProjectsCountArgs = {
+    workspaceId?: number | null;
+    joined?: boolean | null;
+};
+/**
+ * Response from counting archived projects.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/count_projects_archived_api_v1_projects_archived_count_get
+ */
+export type GetArchivedProjectsCountResponse = {
+    count: number;
+};
+/**
+ * An action permitted for a role.
+ */
+export type ActionView = {
+    name: string;
+};
+/**
+ * A project collaborator role with its permitted actions.
+ */
+export type ProjectRoleView = {
+    name: CollaboratorRole;
+    actions: ActionView[];
+};
+/**
+ * A workspace role with its permitted actions.
+ */
+export type WorkspaceRoleView = {
+    name: WorkspaceRole;
+    actions: ActionView[];
+};
+/**
+ * Response from getting project permissions (role-to-action mappings).
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/permissions_api_v1_projects_permissions_get
+ */
+export type GetProjectPermissionsResponse = {
+    projectCollaboratorActions: ProjectRoleView[];
+    workspaceCollaboratorActions: WorkspaceRoleView[];
+};
+/**
+ * Arguments for getting full project data.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/projects_full_data_api_v1_projects__project_id__full_get
+ */
+export type GetFullProjectArgs = {
+    /**
+     * Required to access the public project without authentication.
+     */
+    publicKey?: string | null;
+};
+/**
+ * Response from getting full project data.
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/projects_full_data_api_v1_projects__project_id__full_get
+ */
+export type GetFullProjectResponse = {
+    project: (PersonalProject | WorkspaceProject) | null;
+    commentsCount: number;
+    tasks: Task[];
+    sections: Section[];
+    collaborators: User[];
+    notes: Comment[];
+};

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,91 @@
+import type { DueDate } from '../tasks/types.js';
+import type { LocationTrigger, 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 type ReminderDueDate = Partial<Pick<DueDate, 'date' | 'string' | 'timezone' | 'lang' | 'isRecurring'>>;
+type ReminderTaskArgs = {
+    taskId: string;
+};
+type TimeBasedReminderArgs = {
+    service?: ReminderDeliveryService;
+    notifyUid?: string;
+    isUrgent?: boolean;
+};
+type AddLocationReminderFields = {
+    notifyUid?: string;
+    name: string;
+    locLat: string;
+    locLong: string;
+    locTrigger: LocationTrigger;
+    radius?: number;
+};
+export type AddRelativeReminderArgs = ReminderTaskArgs & {
+    reminderType?: 'relative';
+    minuteOffset: number;
+} & TimeBasedReminderArgs;
+export type AddAbsoluteReminderArgs = ReminderTaskArgs & {
+    reminderType: 'absolute';
+    due: ReminderDueDate;
+} & TimeBasedReminderArgs;
+export type AddLocationReminderArgs = ReminderTaskArgs & AddLocationReminderFields;
+/**
+ * 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 type UpdateRelativeReminderArgs = {
+    reminderType: 'relative';
+} & Partial<Omit<AddRelativeReminderArgs, 'taskId' | 'reminderType'>>;
+export type UpdateAbsoluteReminderArgs = {
+    reminderType: 'absolute';
+} & Partial<Omit<AddAbsoluteReminderArgs, 'taskId' | '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;
+/**
+ * Arguments for updating an existing location reminder.
+ */
+export type UpdateLocationReminderArgs = Partial<Omit<AddLocationReminderArgs, 'taskId'>>;
+/**
+ * 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;
+};
+export {};

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/projects.d.ts

@@ -1,4 +1,5 @@
-import type { ProjectViewStyle, ProjectVisibility, WorkspaceRole, CollaboratorRole } from '../../entities.js';
+import type { ProjectViewStyle, ProjectVisibility } from '../../projects/types.js';
+import type { WorkspaceRole, CollaboratorRole } from '../../workspaces/types.js';
 import type { ProjectStatus } from './shared.js';
 import type { ColorKey } from '../../../utils/colors.js';
 export type ProjectAccessConfig = {

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

@@ -35,7 +35,7 @@ export type TaskPriority = 1 | 2 | 3 | 4;
 export declare const PROJECT_STATUSES: readonly ["PLANNED", "IN_PROGRESS", "PAUSED", "COMPLETED", "CANCELED"];
 /** Project workflow status. */
 export type ProjectStatus = (typeof PROJECT_STATUSES)[number];
-export { COLLABORATOR_ROLES, type CollaboratorRole } from '../../entities.js';
+export { COLLABORATOR_ROLES, type CollaboratorRole } from '../../workspaces/types.js';
 /** Available reminder notification services. */
 export declare const REMINDER_SERVICES: readonly ["default", "email", "mobile", "push", "no_default"];
 /** Reminder notification service. */
@@ -44,7 +44,7 @@ export type ReminderService = (typeof REMINDER_SERVICES)[number];
  * Default access level for workspaces.
  * Same values as {@link ProjectVisibility} from entities.
  */
-export { type ProjectVisibility as DefaultAccessLevel } from '../../entities.js';
+export { type ProjectVisibility as DefaultAccessLevel } from '../../projects/types.js';
 /** Available workspace project sort orders. */
 export declare const WORKSPACE_PROJECT_SORT_ORDERS: readonly ["MANUAL", "A_TO_Z", "Z_TO_A"];
 /** Workspace project sort order preference. */

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

@@ -1,4 +1,4 @@
-import type { WorkspaceRole } from '../../entities.js';
+import type { WorkspaceRole } from '../../workspaces/types.js';
 import type { DefaultAccessLevel, WorkspaceProjectSortOrder } from './shared.js';
 export type SyncWorkspaceProperties = {
     organizationSize?: string;

package/dist/types/types/sync/resources/notes.d.ts

@@ -17,8 +17,8 @@ export declare const NoteSchema: z.ZodObject<{
         fileUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         fileDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
         uploadState: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
-            pending: "pending";
             completed: "completed";
+            pending: "pending";
         }>>>;
         image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;

package/dist/types/types/sync/response.d.ts

@@ -1,4 +1,8 @@
-import type { Task, Label, Section, PersonalProject, WorkspaceProject, WorkspaceUser } from '../entities.js';
+import type { Task } from '../tasks/types.js';
+import type { PersonalProject, WorkspaceProject } from '../projects/types.js';
+import type { Section } from '../sections/types.js';
+import type { Label } from '../labels/types.js';
+import type { WorkspaceUser } from '../workspaces/types.js';
 import type { Filter, Collaborator, CollaboratorState, Folder, Note, Tooltips, WorkspaceFilter, WorkspaceGoal, Calendar, CalendarAccount, Reminder, CompletedInfo, ViewOptions, ProjectViewOptionsDefaults, UserPlanLimits, LiveNotification, SyncWorkspace, SyncUser, UserSettings, LocationReminder, Suggestion } from './resources/index.js';
 export type SyncError = {
     error: string;

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

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