@doist/todoist-api-typescript 7.5.0 → 7.6.1

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';

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