@doist/todoist-api-typescript 7.5.0 → 7.6.1

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

@@ -0,0 +1,85 @@
+import type { ActivityEvent, ActivityObjectEventType } from './types.js';
+/**
+ * Common arguments for retrieving activity logs (excluding filter-type params).
+ */
+type GetActivityLogsArgsCommon = {
+    /**
+     * Filter by the ID of a specific object.
+     */
+    objectId?: string;
+    /**
+     * Filter events by parent project ID.
+     */
+    parentProjectId?: string;
+    /**
+     * Filter events by parent task ID.
+     */
+    parentItemId?: string;
+    /**
+     * When true, includes the parent object data in the response.
+     */
+    includeParentObject?: boolean;
+    /**
+     * When true, includes child object data in the response.
+     */
+    includeChildObjects?: boolean;
+    /**
+     * Filter by the user ID who initiated the event.
+     */
+    initiatorId?: string;
+    /**
+     * When true, filters for events with no initiator (system-generated events).
+     * When false, filters for events with an initiator.
+     * When null or undefined, no filtering on initiator is applied.
+     */
+    initiatorIdNull?: boolean | null;
+    /**
+     * When true, ensures the last state of objects is included in the response.
+     */
+    ensureLastState?: boolean;
+    /**
+     * When true, includes comment annotations in the response.
+     */
+    annotateNotes?: boolean;
+    /**
+     * When true, includes parent object annotations in the response.
+     */
+    annotateParents?: boolean;
+    /**
+     * Pagination cursor for retrieving the next page of results.
+     */
+    cursor?: string | null;
+    /**
+     * Maximum number of results to return per page.
+     */
+    limit?: number;
+    /**
+     * Start date for filtering events (inclusive). Replaces deprecated `since`.
+     * Accepts a Date object or YYYY-MM-DD string.
+     */
+    dateFrom?: Date | string;
+    /**
+     * End date for filtering events (inclusive). Replaces deprecated `until`.
+     * Accepts a Date object or YYYY-MM-DD string.
+     */
+    dateTo?: Date | string;
+};
+export type GetActivityLogsArgs = GetActivityLogsArgsCommon & {
+    objectEventTypes?: ActivityObjectEventType | ActivityObjectEventType[];
+    /** @removed Use `objectEventTypes` instead. */
+    objectType?: never;
+    /** @removed Use `objectEventTypes` instead. */
+    eventType?: never;
+    /** @removed Use `dateFrom` instead. */
+    since?: never;
+    /** @removed Use `dateTo` instead. */
+    until?: never;
+};
+/**
+ * Response from retrieving activity logs.
+ */
+export type GetActivityLogsResponse = {
+    results: ActivityEvent[];
+    nextCursor: string | null;
+};
+export {};

package/dist/types/types/activity/types.d.ts

@@ -0,0 +1,49 @@
+import { z } from 'zod';
+/**
+ * Type hints for known object types. Accepts any string for forward compatibility.
+ */
+export type ActivityObjectType = 'task' | 'comment' | 'project' | (string & Record<string, never>);
+/**
+ * Type hints for known event types. Accepts any string for forward compatibility.
+ */
+export type ActivityEventType = 'added' | 'updated' | 'deleted' | 'completed' | 'uncompleted' | 'archived' | 'unarchived' | 'shared' | 'left' | (string & Record<string, never>);
+type ModernActivityObjectType = 'task' | 'comment' | 'project' | (string & Record<string, never>);
+/**
+ * Combined object:event filter string for the `objectEventTypes` parameter of `getActivityLogs`.
+ *
+ * Uses modern object type names (`task`, `comment`) rather than legacy API names (`item`, `note`).
+ * Either part may be omitted:
+ * - `'task:added'` — task additions only
+ * - `'task:'` — all events for tasks
+ * - `':deleted'` — all deleted events across all object types
+ *
+ * The final `string & Record<string, never>` member allows any arbitrary string
+ * to be passed for forward compatibility, while still providing autocomplete for
+ * the known combinations above.
+ */
+export type ActivityObjectEventType = `${ModernActivityObjectType}:${ActivityEventType}` | `${ModernActivityObjectType}:` | `:${ActivityEventType}` | (string & Record<string, never>);
+/**
+ * Flexible object containing event-specific data.
+ * Uses z.record to accept any properties for forward compatibility.
+ */
+export declare const ActivityEventExtraDataSchema: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+export type ActivityEventExtraData = z.infer<typeof ActivityEventExtraDataSchema>;
+/**
+ * Activity log event schema. Accepts unknown fields for forward compatibility.
+ */
+export declare const ActivityEventSchema: z.ZodObject<{
+    objectType: z.ZodString;
+    objectId: z.ZodString;
+    eventType: z.ZodString;
+    eventDate: z.ZodString;
+    id: z.ZodNullable<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    parentProjectId: z.ZodNullable<z.ZodString>;
+    parentItemId: z.ZodNullable<z.ZodString>;
+    initiatorId: z.ZodNullable<z.ZodString>;
+    extraData: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$catchall<z.ZodAny>>;
+/**
+ * Represents an activity log event in Todoist.
+ */
+export type ActivityEvent = z.infer<typeof ActivityEventSchema>;
+export {};

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * Arguments for listing backups.
+ * @see https://developer.todoist.com/api/v1/#tag/Backups/operation/get_backups_api_v1_backups_get
+ */
+export type GetBackupsArgs = {
+    /** MFA token if required. Not needed when using an OAuth token with the `backups:read` scope. */
+    mfaToken?: string | null;
+};
+/**
+ * Arguments for downloading a backup.
+ * @see https://developer.todoist.com/api/v1/#tag/Backups/operation/download_backup_api_v1_backups_download_get
+ */
+export type DownloadBackupArgs = {
+    /** The backup file URL. */
+    file: string;
+};

package/dist/types/types/backups/types.d.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+export declare const BackupSchema: z.ZodObject<{
+    version: z.ZodString;
+    url: z.ZodString;
+}, z.core.$strip>;
+/** Represents a backup snapshot. */
+export type Backup = z.infer<typeof BackupSchema>;

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

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

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

@@ -0,0 +1,63 @@
+import type { RequireExactlyOne } from 'type-fest';
+import type { Comment } from './types.js';
+/**
+ * Arguments for retrieving comments.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments/operation/get_comments_api_v1_comments_get
+ */
+export type GetCommentsArgs = {
+    taskId: string;
+    projectId?: never;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for retrieving task comments.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments/operation/get_comments_api_v1_comments_get
+ */
+export type GetTaskCommentsArgs = {
+    taskId: string;
+    projectId?: never;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for retrieving project comments.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments/operation/get_comments_api_v1_comments_get
+ */
+export type GetProjectCommentsArgs = {
+    projectId: string;
+    taskId?: never;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Response from retrieving comments.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments/operation/get_comments_api_v1_comments_get
+ */
+export type GetCommentsResponse = {
+    results: Comment[];
+    nextCursor: string | null;
+};
+/**
+ * Arguments for creating a new comment.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments/operation/create_comment_api_v1_comments_post
+ */
+export type AddCommentArgs = {
+    content: string;
+    attachment?: {
+        fileName?: string;
+        fileUrl: string;
+        fileType?: string;
+        resourceType?: string;
+    } | null;
+} & RequireExactlyOne<{
+    taskId?: string;
+    projectId?: string;
+}>;
+/**
+ * Arguments for updating a comment.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments/operation/update_comment_api_v1_comments__comment_id__post
+ */
+export type UpdateCommentArgs = {
+    content: string;
+};

package/dist/types/types/comments/types.d.ts

@@ -0,0 +1,141 @@
+import { z } from 'zod';
+/** Available file attachment upload states. */
+export declare const UPLOAD_STATES: readonly ["pending", "completed"];
+/** Upload state of a file attachment. */
+export type UploadState = (typeof UPLOAD_STATES)[number];
+export declare const AttachmentSchema: z.ZodObject<{
+    resourceType: z.ZodString;
+    fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    fileType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fileUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fileDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    uploadState: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        completed: "completed";
+        pending: "pending";
+    }>>>;
+    image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Represents a file attachment in a comment.
+ * @see https://developer.todoist.com/api/v1/#tag/Sync/Comments/File-Attachments
+ */
+export type Attachment = z.infer<typeof AttachmentSchema>;
+export declare const RawCommentSchema: z.ZodObject<{
+    id: z.ZodString;
+    itemId: z.ZodOptional<z.ZodString>;
+    projectId: z.ZodOptional<z.ZodString>;
+    content: z.ZodString;
+    postedAt: z.ZodString;
+    fileAttachment: z.ZodNullable<z.ZodObject<{
+        resourceType: z.ZodString;
+        fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        fileType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        uploadState: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            completed: "completed";
+            pending: "pending";
+        }>>>;
+        image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>;
+    postedUid: z.ZodString;
+    uidsToNotify: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    reactions: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>;
+    isDeleted: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Represents a raw comment response from the API.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments
+ */
+export type RawComment = z.infer<typeof RawCommentSchema>;
+export declare const CommentSchema: z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    itemId: z.ZodOptional<z.ZodString>;
+    projectId: z.ZodOptional<z.ZodString>;
+    content: z.ZodString;
+    postedAt: z.ZodString;
+    fileAttachment: z.ZodNullable<z.ZodObject<{
+        resourceType: z.ZodString;
+        fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        fileType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        uploadState: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            completed: "completed";
+            pending: "pending";
+        }>>>;
+        image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>;
+    postedUid: z.ZodString;
+    uidsToNotify: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    reactions: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>;
+    isDeleted: z.ZodBoolean;
+}, z.core.$strip>, z.ZodTransform<{
+    taskId: string | undefined;
+    id: string;
+    content: string;
+    postedAt: string;
+    fileAttachment: {
+        resourceType: string;
+        fileName?: string | null | undefined;
+        fileSize?: number | null | undefined;
+        fileType?: string | null | undefined;
+        fileUrl?: string | null | undefined;
+        fileDuration?: number | null | undefined;
+        uploadState?: "completed" | "pending" | null | undefined;
+        image?: string | null | undefined;
+        imageWidth?: number | null | undefined;
+        imageHeight?: number | null | undefined;
+        url?: string | null | undefined;
+        title?: string | null | undefined;
+    } | null;
+    postedUid: string;
+    uidsToNotify: string[] | null;
+    reactions: Record<string, string[]> | null;
+    isDeleted: boolean;
+    projectId?: string | undefined;
+}, {
+    id: string;
+    content: string;
+    postedAt: string;
+    fileAttachment: {
+        resourceType: string;
+        fileName?: string | null | undefined;
+        fileSize?: number | null | undefined;
+        fileType?: string | null | undefined;
+        fileUrl?: string | null | undefined;
+        fileDuration?: number | null | undefined;
+        uploadState?: "completed" | "pending" | null | undefined;
+        image?: string | null | undefined;
+        imageWidth?: number | null | undefined;
+        imageHeight?: number | null | undefined;
+        url?: string | null | undefined;
+        title?: string | null | undefined;
+    } | null;
+    postedUid: string;
+    uidsToNotify: string[] | null;
+    reactions: Record<string, string[]> | null;
+    isDeleted: boolean;
+    itemId?: string | undefined;
+    projectId?: string | undefined;
+}>>;
+/**
+ * Represents a comment in Todoist.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments
+ */
+export type Comment = z.infer<typeof CommentSchema>;

package/dist/types/types/common.d.ts

@@ -0,0 +1,6 @@
+type SearchArgs = {
+    query: string;
+    cursor?: string | null;
+    limit?: number;
+};
+export type { SearchArgs };

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

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

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

@@ -0,0 +1,30 @@
+/** Object types that support email forwarding. */
+export declare const EMAIL_OBJECT_TYPES: readonly ["project", "project_comments", "task"];
+/** Object type that supports email forwarding. */
+export type EmailObjectType = (typeof EMAIL_OBJECT_TYPES)[number];
+/**
+ * Arguments for getting or creating an email forwarding address.
+ * @see https://developer.todoist.com/api/v1/#tag/Emails/operation/email_get_or_create_api_v1_emails_put
+ */
+export type GetOrCreateEmailArgs = {
+    /** The type of object to forward emails to. */
+    objType: EmailObjectType;
+    /** The ID of the object. */
+    objId: string;
+};
+/**
+ * Response from getting or creating an email forwarding address.
+ */
+export type GetOrCreateEmailResponse = {
+    email: string;
+};
+/**
+ * Arguments for disabling email forwarding.
+ * @see https://developer.todoist.com/api/v1/#tag/Emails/operation/email_disable_api_v1_emails_delete
+ */
+export type DisableEmailArgs = {
+    /** The type of object to disable forwarding for. */
+    objType: EmailObjectType;
+    /** The ID of the object. */
+    objId: string;
+};

package/dist/types/types/id-mappings/index.d.ts

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

package/dist/types/types/id-mappings/requests.d.ts

@@ -0,0 +1,28 @@
+/** Object types that support ID mappings. */
+export declare const ID_MAPPING_OBJECT_TYPES: readonly ["sections", "tasks", "comments", "reminders", "location_reminders", "projects"];
+/** Object type that supports ID mappings. */
+export type IdMappingObjectType = (typeof ID_MAPPING_OBJECT_TYPES)[number];
+/** Object types that support moved ID lookups. */
+export declare const MOVED_ID_OBJECT_TYPES: readonly ["sections", "tasks", "comments", "reminders", "location_reminders"];
+/** Object type that supports moved ID lookups. */
+export type MovedIdObjectType = (typeof MOVED_ID_OBJECT_TYPES)[number];
+/**
+ * Arguments for getting ID mappings between old and new IDs.
+ * @see https://developer.todoist.com/api/v1/#tag/Ids/operation/id_mappings_api_v1_id_mappings__obj_name___obj_ids__get
+ */
+export type GetIdMappingsArgs = {
+    /** The type of object to look up. */
+    objName: IdMappingObjectType;
+    /** Array of IDs to look up. */
+    objIds: [string, ...string[]];
+};
+/**
+ * Arguments for getting moved IDs.
+ * @see https://developer.todoist.com/api/v1/#tag/Ids/operation/moved_ids_api_v1_moved_ids__obj_name__get
+ */
+export type GetMovedIdsArgs = {
+    /** The type of object to look up. */
+    objName: MovedIdObjectType;
+    /** Array of old IDs to look up. */
+    oldIds?: string[];
+};

package/dist/types/types/id-mappings/types.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export declare const IdMappingSchema: z.ZodObject<{
+    oldId: z.ZodNullable<z.ZodString>;
+    newId: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/** Mapping between old and new IDs after migration. */
+export type IdMapping = z.infer<typeof IdMappingSchema>;
+export declare const MovedIdSchema: z.ZodObject<{
+    oldId: z.ZodString;
+    newId: z.ZodString;
+}, z.core.$strip>;
+/** A moved ID pair (old to new). */
+export type MovedId = z.infer<typeof MovedIdSchema>;

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

@@ -1,5 +1,19 @@
-export * from './entities.js';
+export * from './tasks/index.js';
+export * from './projects/index.js';
+export * from './sections/index.js';
+export * from './labels/index.js';
+export * from './comments/index.js';
+export * from './reminders/index.js';
+export * from './users/index.js';
+export * from './productivity/index.js';
+export * from './activity/index.js';
+export * from './workspaces/index.js';
+export * from './insights/index.js';
+export * from './backups/index.js';
+export * from './id-mappings/index.js';
+export * from './emails/index.js';
+export * from './uploads/index.js';
+export * from './templates/index.js';
 export * from './errors.js';
-export * from './requests.js';
 export * from './http.js';
 export * from './sync/index.js';

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

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

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

@@ -0,0 +1,26 @@
+/** Known activity object types. Accepts any string for forward compatibility. */
+export type InsightsObjectType = 'ITEM' | 'PROJECT' | 'NOTE' | (string & Record<string, never>);
+/** Known activity event types. Accepts any string for forward compatibility. */
+export type InsightsEventType = 'ADDED' | 'DELETED' | 'UPDATED' | 'ARCHIVED' | 'UNARCHIVED' | 'COMPLETED' | 'UNCOMPLETED' | 'SHARED' | 'LEFT' | (string & Record<string, never>);
+/**
+ * Arguments for getting project activity stats.
+ * @see https://developer.todoist.com/api/v1/#tag/Insights/operation/get_project_activity_stats_api_v1_projects__project_id__insights_activity_stats_get
+ */
+export type GetProjectActivityStatsArgs = {
+    /** The type of object to get activity counts for (default: 'ITEM'). */
+    objectType?: InsightsObjectType;
+    /** The type of event to count (default: 'COMPLETED'). */
+    eventType?: InsightsEventType;
+    /** Number of weeks of activity counts to retrieve (1-12, default 2). */
+    weeks?: number;
+    /** Whether to include weekly rollup counts in the response. */
+    includeWeeklyCounts?: boolean;
+};
+/**
+ * Arguments for getting workspace insights.
+ * @see https://developer.todoist.com/api/v1/#tag/Insights/operation/get_workspace_insights_api_v1_workspaces__workspace_id__insights_get
+ */
+export type GetWorkspaceInsightsArgs = {
+    /** Project IDs to get insights for. */
+    projectIds?: string[];
+};