@doist/todoist-api-typescript 7.6.0 → 7.7.0

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[];
+};

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

@@ -0,0 +1,186 @@
+import { z } from 'zod';
+export declare const DayActivitySchema: z.ZodObject<{
+    date: z.ZodString;
+    totalCount: z.ZodNumber;
+}, z.core.$strip>;
+/** Daily activity count for a specific date. */
+export type DayActivity = z.infer<typeof DayActivitySchema>;
+export declare const WeekRollupSchema: z.ZodObject<{
+    fromDate: z.ZodString;
+    toDate: z.ZodString;
+    totalCount: z.ZodNumber;
+}, z.core.$strip>;
+/** Weekly rollup of activity data. */
+export type WeekRollup = z.infer<typeof WeekRollupSchema>;
+export declare const ProjectActivityStatsSchema: z.ZodObject<{
+    dayItems: z.ZodArray<z.ZodObject<{
+        date: z.ZodString;
+        totalCount: z.ZodNumber;
+    }, z.core.$strip>>;
+    weekItems: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        fromDate: z.ZodString;
+        toDate: z.ZodString;
+        totalCount: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/** Project activity statistics with daily and optional weekly rollups. */
+export type ProjectActivityStats = z.infer<typeof ProjectActivityStatsSchema>;
+/** Available project health statuses. */
+export declare const HEALTH_STATUSES: readonly ["UNKNOWN", "ON_TRACK", "AT_RISK", "CRITICAL", "EXCELLENT", "ERROR"];
+/** Health status of a project. */
+export type HealthStatus = (typeof HEALTH_STATUSES)[number];
+export declare const TaskRecommendationSchema: z.ZodObject<{
+    taskId: z.ZodString;
+    recommendation: z.ZodString;
+}, z.core.$strip>;
+/** A recommendation for a specific task. */
+export type TaskRecommendation = z.infer<typeof TaskRecommendationSchema>;
+export declare const ProjectHealthSchema: z.ZodObject<{
+    status: z.ZodEnum<{
+        UNKNOWN: "UNKNOWN";
+        ON_TRACK: "ON_TRACK";
+        AT_RISK: "AT_RISK";
+        CRITICAL: "CRITICAL";
+        EXCELLENT: "EXCELLENT";
+        ERROR: "ERROR";
+    }>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    descriptionSummary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    taskRecommendations: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        taskId: z.ZodString;
+        recommendation: z.ZodString;
+    }, z.core.$strip>>>>;
+    projectId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    updatedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    isStale: z.ZodDefault<z.ZodBoolean>;
+    updateInProgress: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+/** Project health status and recommendations. */
+export type ProjectHealth = z.infer<typeof ProjectHealthSchema>;
+export declare const ProjectMetricsSchema: z.ZodObject<{
+    totalTasks: z.ZodNumber;
+    completedTasks: z.ZodNumber;
+    overdueTasks: z.ZodNumber;
+    tasksCreatedThisWeek: z.ZodNumber;
+    tasksCompletedThisWeek: z.ZodNumber;
+    averageCompletionTime: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+/** Project metrics summary. */
+export type ProjectMetrics = z.infer<typeof ProjectMetricsSchema>;
+export declare const TaskContextSchema: z.ZodObject<{
+    id: z.ZodString;
+    content: z.ZodString;
+    due: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    deadline: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    priority: z.ZodString;
+    isCompleted: z.ZodBoolean;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+    completedAt: z.ZodNullable<z.ZodString>;
+    completedByUid: z.ZodNullable<z.ZodString>;
+    labels: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+/** Task context used in health analysis. */
+export type TaskContext = z.infer<typeof TaskContextSchema>;
+export declare const ProjectHealthContextSchema: z.ZodObject<{
+    projectId: z.ZodString;
+    projectName: z.ZodString;
+    projectDescription: z.ZodNullable<z.ZodString>;
+    projectMetrics: z.ZodObject<{
+        totalTasks: z.ZodNumber;
+        completedTasks: z.ZodNumber;
+        overdueTasks: z.ZodNumber;
+        tasksCreatedThisWeek: z.ZodNumber;
+        tasksCompletedThisWeek: z.ZodNumber;
+        averageCompletionTime: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>;
+    tasks: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        content: z.ZodString;
+        due: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        deadline: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        priority: z.ZodString;
+        isCompleted: z.ZodBoolean;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        completedAt: z.ZodNullable<z.ZodString>;
+        completedByUid: z.ZodNullable<z.ZodString>;
+        labels: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>;
+    language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+/** Full project context for health analysis. */
+export type ProjectHealthContext = z.infer<typeof ProjectHealthContextSchema>;
+export declare const ProjectProgressSchema: z.ZodObject<{
+    projectId: z.ZodString;
+    completedCount: z.ZodNumber;
+    activeCount: z.ZodNumber;
+    progressPercent: z.ZodNumber;
+}, z.core.$strip>;
+/** Project progress with completion counts and percentage. */
+export type ProjectProgress = z.infer<typeof ProjectProgressSchema>;
+export declare const ProjectInsightSchema: z.ZodObject<{
+    projectId: z.ZodString;
+    health: z.ZodNullable<z.ZodObject<{
+        status: z.ZodEnum<{
+            UNKNOWN: "UNKNOWN";
+            ON_TRACK: "ON_TRACK";
+            AT_RISK: "AT_RISK";
+            CRITICAL: "CRITICAL";
+            EXCELLENT: "EXCELLENT";
+            ERROR: "ERROR";
+        }>;
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        descriptionSummary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        taskRecommendations: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+            taskId: z.ZodString;
+            recommendation: z.ZodString;
+        }, z.core.$strip>>>>;
+        projectId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        updatedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        isStale: z.ZodDefault<z.ZodBoolean>;
+        updateInProgress: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    progress: z.ZodNullable<z.ZodObject<{
+        projectId: z.ZodString;
+        completedCount: z.ZodNumber;
+        activeCount: z.ZodNumber;
+        progressPercent: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Insight data for a single project within a workspace. */
+export type ProjectInsight = z.infer<typeof ProjectInsightSchema>;
+export declare const WorkspaceInsightsSchema: z.ZodObject<{
+    folderId: z.ZodNullable<z.ZodString>;
+    projectInsights: z.ZodArray<z.ZodObject<{
+        projectId: z.ZodString;
+        health: z.ZodNullable<z.ZodObject<{
+            status: z.ZodEnum<{
+                UNKNOWN: "UNKNOWN";
+                ON_TRACK: "ON_TRACK";
+                AT_RISK: "AT_RISK";
+                CRITICAL: "CRITICAL";
+                EXCELLENT: "EXCELLENT";
+                ERROR: "ERROR";
+            }>;
+            description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            descriptionSummary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            taskRecommendations: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+                taskId: z.ZodString;
+                recommendation: z.ZodString;
+            }, z.core.$strip>>>>;
+            projectId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            updatedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            isStale: z.ZodDefault<z.ZodBoolean>;
+            updateInProgress: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>>;
+        progress: z.ZodNullable<z.ZodObject<{
+            projectId: z.ZodString;
+            completedCount: z.ZodNumber;
+            activeCount: z.ZodNumber;
+            progressPercent: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Workspace insights grouped by folder. */
+export type WorkspaceInsights = z.infer<typeof WorkspaceInsightsSchema>;

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

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

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

@@ -0,0 +1,75 @@
+import type { ColorKey } from '../../utils/colors.js';
+import type { SearchArgs } from '../common.js';
+import type { Label } from './types.js';
+/**
+ * Arguments for retrieving labels.
+ * @see https://developer.todoist.com/api/v1/#tag/Labels/operation/get_labels_api_v1_labels_get
+ */
+export type GetLabelsArgs = {
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for searching labels.
+ */
+export type SearchLabelsArgs = SearchArgs;
+/**
+ * Response from retrieving labels.
+ * @see https://developer.todoist.com/api/v1/#tag/Labels/operation/get_labels_api_v1_labels_get
+ */
+export type GetLabelsResponse = {
+    results: Label[];
+    nextCursor: string | null;
+};
+/**
+ * Arguments for creating a new label.
+ * @see https://developer.todoist.com/api/v1/#tag/Labels/operation/create_label_api_v1_labels_post
+ */
+export type AddLabelArgs = {
+    name: string;
+    order?: number | null;
+    color?: ColorKey;
+    isFavorite?: boolean;
+};
+/**
+ * Arguments for updating a label.
+ * @see https://developer.todoist.com/api/v1/#tag/Labels/operation/update_label_api_v1_labels__label_id__post
+ */
+export type UpdateLabelArgs = {
+    name?: string;
+    order?: number | null;
+    color?: ColorKey;
+    isFavorite?: boolean;
+};
+/**
+ * Arguments for retrieving shared labels.
+ * @see https://developer.todoist.com/api/v1/#tag/Labels/operation/shared_labels_api_v1_labels_shared_get
+ */
+export type GetSharedLabelsArgs = {
+    omitPersonal?: boolean;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Response from retrieving shared labels.
+ * @see https://developer.todoist.com/api/v1/#tag/Labels/operation/shared_labels_api_v1_labels_shared_get
+ */
+export type GetSharedLabelsResponse = {
+    results: string[];
+    nextCursor: string | null;
+};
+/**
+ * Arguments for renaming a shared label.
+ * @see https://developer.todoist.com/api/v1/#tag/Labels/operation/shared_labels_rename_api_v1_labels_shared_rename_post
+ */
+export type RenameSharedLabelArgs = {
+    name: string;
+    newName: string;
+};
+/**
+ * Arguments for removing a shared label.
+ * @see https://developer.todoist.com/api/v1/#tag/Labels/operation/shared_labels_remove_api_v1_labels_shared_remove_post
+ */
+export type RemoveSharedLabelArgs = {
+    name: string;
+};

package/dist/types/types/labels/types.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export declare const LabelSchema: z.ZodObject<{
+    id: z.ZodString;
+    order: z.ZodNullable<z.ZodNumber>;
+    name: z.ZodString;
+    color: z.ZodString;
+    isFavorite: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Represents a label in Todoist.
+ * @see https://developer.todoist.com/api/v1/#tag/Labels
+ */
+export type Label = z.infer<typeof LabelSchema>;

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

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

package/dist/types/types/productivity/types.d.ts

@@ -0,0 +1,115 @@
+import { z } from 'zod';
+export declare const StreakSchema: z.ZodObject<{
+    count: z.ZodNumber;
+    start: z.ZodString;
+    end: z.ZodString;
+}, z.core.$strip>;
+export declare const CompletedItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    completed: z.ZodNumber;
+}, z.core.$strip>;
+export declare const ItemsWithDateSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        completed: z.ZodNumber;
+    }, z.core.$strip>>;
+    totalCompleted: z.ZodNumber;
+}, z.core.$strip>;
+export declare const KarmaUpdateSchema: z.ZodObject<{
+    time: z.ZodString;
+    newKarma: z.ZodNumber;
+    positiveKarma: z.ZodNumber;
+    negativeKarma: z.ZodNumber;
+    positiveKarmaReasons: z.ZodArray<z.ZodAny>;
+    negativeKarmaReasons: z.ZodArray<z.ZodAny>;
+}, z.core.$strip>;
+export declare const ProductivityStatsSchema: z.ZodObject<{
+    completedCount: z.ZodNumber;
+    daysItems: z.ZodArray<z.ZodObject<{
+        items: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            completed: z.ZodNumber;
+        }, z.core.$strip>>;
+        totalCompleted: z.ZodNumber;
+        date: z.ZodString;
+    }, z.core.$strip>>;
+    goals: z.ZodObject<{
+        currentDailyStreak: z.ZodObject<{
+            count: z.ZodNumber;
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        currentWeeklyStreak: z.ZodObject<{
+            count: z.ZodNumber;
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        dailyGoal: z.ZodNumber;
+        ignoreDays: z.ZodArray<z.ZodNumber>;
+        karmaDisabled: z.ZodNumber;
+        lastDailyStreak: z.ZodObject<{
+            count: z.ZodNumber;
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        lastWeeklyStreak: z.ZodObject<{
+            count: z.ZodNumber;
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        maxDailyStreak: z.ZodObject<{
+            count: z.ZodNumber;
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        maxWeeklyStreak: z.ZodObject<{
+            count: z.ZodNumber;
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>;
+        user: z.ZodString;
+        userId: z.ZodString;
+        vacationMode: z.ZodNumber;
+        weeklyGoal: z.ZodNumber;
+    }, z.core.$strip>;
+    karma: z.ZodNumber;
+    karmaGraphData: z.ZodArray<z.ZodObject<{
+        date: z.ZodString;
+        karmaAvg: z.ZodNumber;
+    }, z.core.$strip>>;
+    karmaLastUpdate: z.ZodNumber;
+    karmaTrend: z.ZodString;
+    karmaUpdateReasons: z.ZodArray<z.ZodObject<{
+        time: z.ZodString;
+        newKarma: z.ZodNumber;
+        positiveKarma: z.ZodNumber;
+        negativeKarma: z.ZodNumber;
+        positiveKarmaReasons: z.ZodArray<z.ZodAny>;
+        negativeKarmaReasons: z.ZodArray<z.ZodAny>;
+    }, z.core.$strip>>;
+    projectColors: z.ZodRecord<z.ZodString, z.ZodString>;
+    weekItems: z.ZodArray<z.ZodObject<{
+        items: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            completed: z.ZodNumber;
+        }, z.core.$strip>>;
+        totalCompleted: z.ZodNumber;
+        from: z.ZodString;
+        to: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Represents the Productivity stats for the authenticated user.
+ * @see https://developer.todoist.com/api/v1/#tag/User/operation/get_productivity_stats_api_v1_tasks_completed_stats_get
+ */
+export type ProductivityStats = z.infer<typeof ProductivityStatsSchema>;
+export declare const ColorSchema: z.ZodObject<{
+    key: z.ZodString;
+    displayName: z.ZodString;
+    hexValue: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Represents a color in Todoist.
+ * @see https://developer.todoist.com/api/v1/#tag/Colors
+ */
+export type Color = z.infer<typeof ColorSchema>;

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

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