@doist/todoist-api-typescript 7.6.0 → 7.6.1

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

@@ -0,0 +1,162 @@
+import { z } from 'zod';
+export declare const DueDateSchema: z.ZodObject<{
+    isRecurring: z.ZodBoolean;
+    string: z.ZodString;
+    date: z.ZodString;
+    datetime: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    lang: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Represents a due date for a task.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks/operation/get_tasks_api_v1_tasks_get
+ */
+export type DueDate = z.infer<typeof DueDateSchema>;
+/** Available duration units for task deadlines. */
+export declare const DURATION_UNITS: readonly ["minute", "day"];
+/** Unit of time for a task duration. */
+export type DurationUnit = (typeof DURATION_UNITS)[number];
+export declare const DurationSchema: z.ZodObject<{
+    amount: z.ZodNumber;
+    unit: z.ZodEnum<{
+        minute: "minute";
+        day: "day";
+    }>;
+}, z.core.$strip>;
+/**
+ * Represents a duration for a task deadline.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks
+ */
+export type Duration = z.infer<typeof DurationSchema>;
+export declare const DeadlineSchema: z.ZodObject<{
+    date: z.ZodString;
+    lang: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Represents a task deadline.
+ */
+export type Deadline = z.infer<typeof DeadlineSchema>;
+export declare const TaskSchema: z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    userId: z.ZodString;
+    projectId: z.ZodString;
+    sectionId: z.ZodNullable<z.ZodString>;
+    parentId: z.ZodNullable<z.ZodString>;
+    addedByUid: z.ZodNullable<z.ZodString>;
+    assignedByUid: z.ZodNullable<z.ZodString>;
+    responsibleUid: z.ZodNullable<z.ZodString>;
+    labels: z.ZodArray<z.ZodString>;
+    deadline: z.ZodNullable<z.ZodObject<{
+        date: z.ZodString;
+        lang: z.ZodString;
+    }, z.core.$strip>>;
+    duration: z.ZodNullable<z.ZodObject<{
+        amount: z.ZodNumber;
+        unit: z.ZodEnum<{
+            minute: "minute";
+            day: "day";
+        }>;
+    }, z.core.$strip>>;
+    checked: z.ZodBoolean;
+    isDeleted: z.ZodBoolean;
+    addedAt: z.ZodNullable<z.ZodString>;
+    completedAt: z.ZodNullable<z.ZodString>;
+    updatedAt: z.ZodNullable<z.ZodString>;
+    due: z.ZodNullable<z.ZodObject<{
+        isRecurring: z.ZodBoolean;
+        string: z.ZodString;
+        date: z.ZodString;
+        datetime: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        lang: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>;
+    priority: z.ZodNumber;
+    childOrder: z.ZodNumber;
+    content: z.ZodString;
+    description: z.ZodString;
+    dayOrder: z.ZodNumber;
+    isCollapsed: z.ZodBoolean;
+    isUncompletable: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodTransform<{
+    isUncompletable: boolean;
+    url: string;
+    id: string;
+    userId: string;
+    projectId: string;
+    sectionId: string | null;
+    parentId: string | null;
+    addedByUid: string | null;
+    assignedByUid: string | null;
+    responsibleUid: string | null;
+    labels: string[];
+    deadline: {
+        date: string;
+        lang: string;
+    } | null;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
+    checked: boolean;
+    isDeleted: boolean;
+    addedAt: string | null;
+    completedAt: string | null;
+    updatedAt: string | null;
+    due: {
+        isRecurring: boolean;
+        string: string;
+        date: string;
+        datetime?: string | null | undefined;
+        timezone?: string | null | undefined;
+        lang?: string | null | undefined;
+    } | null;
+    priority: number;
+    childOrder: number;
+    content: string;
+    description: string;
+    dayOrder: number;
+    isCollapsed: boolean;
+}, {
+    id: string;
+    userId: string;
+    projectId: string;
+    sectionId: string | null;
+    parentId: string | null;
+    addedByUid: string | null;
+    assignedByUid: string | null;
+    responsibleUid: string | null;
+    labels: string[];
+    deadline: {
+        date: string;
+        lang: string;
+    } | null;
+    duration: {
+        amount: number;
+        unit: "minute" | "day";
+    } | null;
+    checked: boolean;
+    isDeleted: boolean;
+    addedAt: string | null;
+    completedAt: string | null;
+    updatedAt: string | null;
+    due: {
+        isRecurring: boolean;
+        string: string;
+        date: string;
+        datetime?: string | null | undefined;
+        timezone?: string | null | undefined;
+        lang?: string | null | undefined;
+    } | null;
+    priority: number;
+    childOrder: number;
+    content: string;
+    description: string;
+    dayOrder: number;
+    isCollapsed: boolean;
+    isUncompletable: boolean;
+}>>;
+/**
+ * Represents a task in Todoist.
+ * @see https://developer.todoist.com/api/v1/#tag/Tasks
+ */
+export type Task = z.infer<typeof TaskSchema>;

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

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

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

@@ -0,0 +1,92 @@
+import type { Comment } from '../comments/types.js';
+import type { PersonalProject, WorkspaceProject } from '../projects/types.js';
+import type { Section } from '../sections/types.js';
+import type { Task } from '../tasks/types.js';
+/**
+ * Arguments for exporting a project as a template file.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/export_as_file_api_v1_templates_file_get
+ */
+export type ExportTemplateFileArgs = {
+    /** The project ID to export. */
+    projectId: string;
+    /** Whether to use relative dates in the export. */
+    useRelativeDates?: boolean;
+};
+/**
+ * Arguments for exporting a project as a template URL.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/export_as_url_api_v1_templates_url_get
+ */
+export type ExportTemplateUrlArgs = {
+    /** The project ID to export. */
+    projectId: string;
+    /** Whether to use relative dates in the export. */
+    useRelativeDates?: boolean;
+};
+/**
+ * Response from exporting a project as a template URL.
+ */
+export type ExportTemplateUrlResponse = {
+    fileName: string;
+    fileUrl: string;
+};
+/**
+ * Arguments for creating a project from a template file.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/create_project_from_file_api_v1_templates_create_project_from_file_post
+ */
+export type CreateProjectFromTemplateArgs = {
+    /** Name for the new project. */
+    name: string;
+    /** The template file content. */
+    file: Buffer | NodeJS.ReadableStream | string | Blob;
+    /** Optional file name (required for Buffer/Stream). */
+    fileName?: string;
+    /** Optional workspace ID. */
+    workspaceId?: string | null;
+};
+/**
+ * Response from creating a project from a template.
+ */
+export type CreateProjectFromTemplateResponse = {
+    status: string;
+    projectId: string;
+    templateType: string;
+    projects: (PersonalProject | WorkspaceProject)[];
+    sections: Section[];
+    tasks: Task[];
+    comments: Comment[];
+};
+/**
+ * Arguments for importing a template file into an existing project.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/import_into_project_from_file_api_v1_templates_import_into_project_from_file_post
+ */
+export type ImportTemplateIntoProjectArgs = {
+    /** The project ID to import into. */
+    projectId: string;
+    /** The template file content. */
+    file: Buffer | NodeJS.ReadableStream | string | Blob;
+    /** Optional file name (required for Buffer/Stream). */
+    fileName?: string;
+};
+/**
+ * Arguments for importing a template by ID into an existing project.
+ * @see https://developer.todoist.com/api/v1/#tag/Templates/operation/import_into_project_from_template_id_api_v1_templates_import_into_project_from_template_id_post
+ */
+export type ImportTemplateFromIdArgs = {
+    /** The project ID to import into. */
+    projectId: string;
+    /** The template ID to import. */
+    templateId: string;
+    /** Locale for the import (default: 'en'). */
+    locale?: string;
+};
+/**
+ * Response from importing a template into a project.
+ */
+export type ImportTemplateResponse = {
+    status: string;
+    templateType: string;
+    projects: (PersonalProject | WorkspaceProject)[];
+    sections: Section[];
+    tasks: Task[];
+    comments: Comment[];
+};

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

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

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

@@ -0,0 +1,32 @@
+/**
+ * Arguments for uploading a file.
+ * @see https://developer.todoist.com/api/v1/#tag/Uploads/operation/upload_file_api_v1_uploads_post
+ */
+export type UploadFileArgs = {
+    /**
+     * The file content to upload. Can be:
+     * - Buffer: File content as a Buffer (requires fileName)
+     * - ReadableStream: File content as a stream (requires fileName)
+     * - string: Path to a file on the filesystem (fileName is optional, will be inferred from path)
+     */
+    file: Buffer | NodeJS.ReadableStream | string | Blob;
+    /**
+     * The name of the file. Required for Buffer and Stream inputs.
+     * Optional for file path strings and File objects (will be inferred if not provided).
+     */
+    fileName?: string;
+    /**
+     * The project ID to associate the upload with.
+     */
+    projectId?: string | null;
+};
+/**
+ * Arguments for deleting an uploaded file.
+ * @see https://developer.todoist.com/api/v1/#tag/Uploads/operation/delete_upload_api_v1_uploads_delete
+ */
+export type DeleteUploadArgs = {
+    /**
+     * The URL of the file to delete.
+     */
+    fileUrl: string;
+};

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

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

package/dist/types/types/users/types.d.ts

@@ -0,0 +1,66 @@
+import { z } from 'zod';
+export declare const UserSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    email: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Represents a user in Todoist (simplified for collaborators).
+ * @see https://developer.todoist.com/api/v1/#tag/User
+ */
+export type User = z.infer<typeof UserSchema>;
+export declare const TimezoneInfoSchema: z.ZodObject<{
+    gmtString: z.ZodString;
+    hours: z.ZodNumber;
+    isDst: z.ZodNumber;
+    minutes: z.ZodNumber;
+    timezone: z.ZodString;
+}, z.core.$strip>;
+/** Available user premium statuses. */
+export declare const PREMIUM_STATUSES: readonly ["not_premium", "current_personal_plan", "legacy_personal_plan", "teams_business_member"];
+/** Premium subscription status of a user. */
+export type PremiumStatus = (typeof PREMIUM_STATUSES)[number];
+export declare const CurrentUserSchema: z.ZodObject<{
+    id: z.ZodString;
+    email: z.ZodString;
+    fullName: z.ZodString;
+    avatarBig: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarMedium: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarS640: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarSmall: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    businessAccountId: z.ZodNullable<z.ZodString>;
+    isPremium: z.ZodBoolean;
+    premiumStatus: z.ZodEnum<{
+        not_premium: "not_premium";
+        current_personal_plan: "current_personal_plan";
+        legacy_personal_plan: "legacy_personal_plan";
+        teams_business_member: "teams_business_member";
+    }>;
+    dateFormat: z.ZodNumber;
+    timeFormat: z.ZodNumber;
+    weeklyGoal: z.ZodNumber;
+    dailyGoal: z.ZodNumber;
+    completedCount: z.ZodNumber;
+    completedToday: z.ZodNumber;
+    karma: z.ZodNumber;
+    karmaTrend: z.ZodString;
+    lang: z.ZodString;
+    nextWeek: z.ZodNumber;
+    startDay: z.ZodNumber;
+    startPage: z.ZodString;
+    tzInfo: z.ZodObject<{
+        gmtString: z.ZodString;
+        hours: z.ZodNumber;
+        isDst: z.ZodNumber;
+        minutes: z.ZodNumber;
+        timezone: z.ZodString;
+    }, z.core.$strip>;
+    inboxProjectId: z.ZodString;
+    daysOff: z.ZodArray<z.ZodNumber>;
+    weekendStartDay: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Represents the current authenticated user with detailed information.
+ * @see https://developer.todoist.com/api/v1/#tag/User
+ */
+export type CurrentUser = z.infer<typeof CurrentUserSchema>;

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

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

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

@@ -0,0 +1,260 @@
+import type { MemberActivityInfo, WorkspaceInvitation, WorkspaceRole, WorkspaceUser, WorkspaceUserTask } from './types.js';
+/**
+ * Arguments for creating a new workspace.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/create_workspace_api_v1_workspaces_post
+ */
+export type AddWorkspaceArgs = {
+    /** Name of the workspace. */
+    name: string;
+    /** Description of the workspace. */
+    description?: string | null;
+    /** Whether link sharing is enabled for the workspace. */
+    isLinkSharingEnabled?: boolean;
+    /** Whether guests are allowed in the workspace. */
+    isGuestAllowed?: boolean;
+    /** Workspace email domain. */
+    domainName?: string | null;
+    /** Whether users with matching email domains can discover this workspace. */
+    domainDiscovery?: boolean;
+    /** Whether workspace invites are restricted to workspace domain. */
+    restrictEmailDomains?: boolean;
+    /** Workspace properties. */
+    properties?: Record<string, unknown> | null;
+};
+/**
+ * Arguments for updating an existing workspace.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/update_workspace_api_v1_workspaces__workspace_id__post
+ */
+export type UpdateWorkspaceArgs = {
+    /** Updated workspace name. */
+    name?: string;
+    /** Updated workspace description. */
+    description?: string | null;
+    /** Updated link sharing status. */
+    isLinkSharingEnabled?: boolean;
+    /** Updated guest access status. */
+    isGuestAllowed?: boolean | null;
+    /** Updated workspace email domain. */
+    domainName?: string | null;
+    /** Updated domain discovery setting. */
+    domainDiscovery?: boolean;
+    /** Updated email domain restriction setting. */
+    restrictEmailDomains?: boolean;
+    /** Updated workspace properties. */
+    properties?: Record<string, unknown> | null;
+    /** Updated collapse state for current user. */
+    isCollapsed?: boolean;
+};
+/**
+ * Arguments for getting workspace members activity.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/get_workspace_members_activity_api_v1_workspaces_members_get
+ */
+export type GetWorkspaceMembersActivityArgs = {
+    /** The workspace ID. */
+    workspaceId: string;
+    /** Comma-separated list of user IDs to filter by. */
+    userIds?: string | null;
+    /** Comma-separated list of project IDs to filter by. */
+    projectIds?: string | null;
+};
+/**
+ * Response from getting workspace members activity.
+ */
+export type GetWorkspaceMembersActivityResponse = {
+    members: MemberActivityInfo[];
+};
+/**
+ * Arguments for getting tasks assigned to a workspace user.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/get_workspace_user_tasks_api_v1_workspaces__workspace_id__users__user_id__tasks_get
+ */
+export type GetWorkspaceUserTasksArgs = {
+    /** The workspace ID. */
+    workspaceId: string;
+    /** The user ID. */
+    userId: string;
+    /** Comma-separated list of project IDs to filter by. */
+    projectIds?: string | null;
+};
+/**
+ * Response from getting workspace user tasks.
+ */
+export type GetWorkspaceUserTasksResponse = {
+    tasks: WorkspaceUserTask[];
+};
+/**
+ * Arguments for inviting users to a workspace.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/invite_workspace_users_api_v1_workspaces__workspace_id__users_invite_post
+ */
+export type InviteWorkspaceUsersArgs = {
+    /** The workspace ID. */
+    workspaceId: string;
+    /** List of user emails to invite. */
+    emailList: string[];
+    /** Role assigned to invited users. */
+    role?: WorkspaceRole;
+};
+/**
+ * Response from inviting workspace users.
+ */
+export type InviteWorkspaceUsersResponse = {
+    invitedEmails: string[];
+};
+/**
+ * Arguments for updating a workspace user's role.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/update_workspace_user_api_v1_workspaces__workspace_id__users__user_id__post
+ */
+export type UpdateWorkspaceUserArgs = {
+    /** The workspace ID. */
+    workspaceId: string;
+    /** The user ID. */
+    userId: string;
+    /** Updated role for the user. */
+    role: WorkspaceRole;
+};
+/**
+ * Arguments for removing a user from a workspace.
+ * @see https://developer.todoist.com/api/v1/#tag/Workspace/operation/remove_workspace_user_api_v1_workspaces__workspace_id__users__user_id__delete
+ */
+export type RemoveWorkspaceUserArgs = {
+    /** The workspace ID. */
+    workspaceId: string;
+    /** The user ID. */
+    userId: string;
+};
+/**
+ * Arguments for getting workspace invitations.
+ */
+export type GetWorkspaceInvitationsArgs = {
+    /**
+     * The workspace ID to get invitations for.
+     */
+    workspaceId: number;
+};
+/**
+ * Arguments for deleting a workspace invitation.
+ */
+export type DeleteWorkspaceInvitationArgs = {
+    /**
+     * The workspace ID.
+     */
+    workspaceId: number;
+    /**
+     * The email address of the invitation to delete.
+     */
+    userEmail: string;
+};
+/**
+ * Arguments for accepting/rejecting a workspace invitation.
+ */
+export type WorkspaceInvitationActionArgs = {
+    /**
+     * The invitation code from the email.
+     */
+    inviteCode: string;
+};
+/**
+ * Arguments for joining a workspace.
+ */
+export type JoinWorkspaceArgs = {
+    /**
+     * Optional invitation code/link to join via.
+     */
+    inviteCode?: string | null;
+    /**
+     * Optional workspace ID to join via domain auto-join.
+     */
+    workspaceId?: number | null;
+};
+/**
+ * Arguments for uploading/updating workspace logo.
+ */
+export type WorkspaceLogoArgs = {
+    /**
+     * The workspace ID.
+     */
+    workspaceId: number;
+    /**
+     * The image file to upload (Buffer, Stream, or file path).
+     */
+    file?: Buffer | NodeJS.ReadableStream | string | Blob;
+    /**
+     * The file name (required for Buffer/Stream uploads).
+     */
+    fileName?: string;
+    /**
+     * Whether to delete the logo instead of updating it.
+     */
+    delete?: boolean;
+};
+/**
+ * Arguments for getting workspace plan details.
+ */
+export type GetWorkspacePlanDetailsArgs = {
+    /**
+     * The workspace ID.
+     */
+    workspaceId: number;
+};
+/**
+ * Arguments for getting workspace users (paginated).
+ */
+export type GetWorkspaceUsersArgs = {
+    /**
+     * Optional workspace ID. If not provided, returns users for all workspaces.
+     */
+    workspaceId?: number | null;
+    /**
+     * Cursor for pagination.
+     */
+    cursor?: string | null;
+    /**
+     * Maximum number of users to return (default: 100).
+     */
+    limit?: number;
+};
+/**
+ * Arguments for getting workspace projects (paginated).
+ */
+export type GetWorkspaceProjectsArgs = {
+    /**
+     * The workspace ID.
+     */
+    workspaceId: number;
+    /**
+     * Cursor for pagination.
+     */
+    cursor?: string | null;
+    /**
+     * Maximum number of projects to return (default: 100).
+     */
+    limit?: number;
+};
+/**
+ * Paginated response for workspace users.
+ */
+export type GetWorkspaceUsersResponse = {
+    /**
+     * Whether there are more users available.
+     */
+    hasMore: boolean;
+    /**
+     * Cursor for the next page of results.
+     */
+    nextCursor?: string;
+    /**
+     * Array of workspace users.
+     */
+    workspaceUsers: WorkspaceUser[];
+};
+/**
+ * Response type for workspace invitations endpoint (simple email list).
+ */
+export type WorkspaceInvitationsResponse = string[];
+/**
+ * Response type for all workspace invitations endpoint (detailed objects).
+ */
+export type AllWorkspaceInvitationsResponse = WorkspaceInvitation[];
+/**
+ * Response type for workspace logo upload.
+ */
+export type WorkspaceLogoResponse = Record<string, unknown> | null;