@doist/todoist-api-typescript 7.4.0 → 7.6.0

package/dist/types/todoist-api.d.ts

@@ -1,12 +1,13 @@
-import { Attachment, PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser, ProductivityStats, WorkspaceInvitation, WorkspacePlanDetails, JoinWorkspaceResult, Workspace } from './types/entities.js';
-import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, SearchProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, SearchLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, SearchSectionsArgs, GetSectionsResponse, GetSharedLabelsResponse, GetCommentsResponse, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse, SearchCompletedTasksArgs, GetActivityLogsArgs, GetActivityLogsResponse, UploadFileArgs, DeleteUploadArgs, GetWorkspaceInvitationsArgs, DeleteWorkspaceInvitationArgs, WorkspaceInvitationActionArgs, JoinWorkspaceArgs, WorkspaceLogoArgs, GetWorkspacePlanDetailsArgs, GetWorkspaceUsersArgs, GetWorkspaceUsersResponse, GetWorkspaceProjectsArgs, WorkspaceInvitationsResponse, AllWorkspaceInvitationsResponse, WorkspaceLogoResponse, MoveProjectToWorkspaceArgs, MoveProjectToPersonalArgs } from './types/requests.js';
+import { Attachment, PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser, ProductivityStats, WorkspaceInvitation, WorkspacePlanDetails, JoinWorkspaceResult, Workspace, Backup, IdMapping, MovedId, ProjectActivityStats, ProjectHealth, ProjectHealthContext, ProjectProgress, WorkspaceInsights } from './types/entities.js';
+import { AddCommentArgs, AddLabelArgs, AddLocationReminderArgs, AddProjectArgs, AddReminderArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateLocationReminderArgs, UpdateProjectArgs, UpdateReminderArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, SearchProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, SearchLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, SearchSectionsArgs, GetSectionsResponse, GetSharedLabelsResponse, GetCommentsResponse, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse, SearchCompletedTasksArgs, GetActivityLogsArgs, GetActivityLogsResponse, UploadFileArgs, DeleteUploadArgs, GetWorkspaceInvitationsArgs, DeleteWorkspaceInvitationArgs, WorkspaceInvitationActionArgs, JoinWorkspaceArgs, WorkspaceLogoArgs, GetWorkspacePlanDetailsArgs, GetWorkspaceUsersArgs, GetWorkspaceUsersResponse, GetWorkspaceProjectsArgs, WorkspaceInvitationsResponse, AllWorkspaceInvitationsResponse, WorkspaceLogoResponse, MoveProjectToWorkspaceArgs, MoveProjectToPersonalArgs, GetArchivedProjectsCountArgs, GetArchivedProjectsCountResponse, GetProjectPermissionsResponse, GetFullProjectArgs, GetFullProjectResponse, AddWorkspaceArgs, UpdateWorkspaceArgs, GetWorkspaceMembersActivityArgs, GetWorkspaceMembersActivityResponse, GetWorkspaceUserTasksArgs, GetWorkspaceUserTasksResponse, InviteWorkspaceUsersArgs, InviteWorkspaceUsersResponse, UpdateWorkspaceUserArgs, RemoveWorkspaceUserArgs, GetProjectActivityStatsArgs, GetWorkspaceInsightsArgs, GetRemindersArgs, GetRemindersResponse, GetLocationRemindersArgs, GetLocationRemindersResponse, GetAllCompletedTasksArgs, GetAllCompletedTasksResponse, ExportTemplateFileArgs, ExportTemplateUrlArgs, ExportTemplateUrlResponse, CreateProjectFromTemplateArgs, CreateProjectFromTemplateResponse, ImportTemplateIntoProjectArgs, ImportTemplateFromIdArgs, ImportTemplateResponse, GetBackupsArgs, DownloadBackupArgs, GetOrCreateEmailArgs, GetOrCreateEmailResponse, DisableEmailArgs, GetIdMappingsArgs, GetMovedIdsArgs } from './types/requests.js';
 import { CustomFetch, CustomFetchResponse } from './types/http.js';
+import type { Reminder } from './types/index.js';
 import { type SyncResponse, type SyncRequest } from './types/sync/index.js';
 /**
  * Response from viewAttachment, extending CustomFetchResponse with
  * arrayBuffer() support for binary file content.
  */
-export type ViewAttachmentResponse = CustomFetchResponse & {
+export type FileResponse = CustomFetchResponse & {
     arrayBuffer(): Promise<ArrayBuffer>;
 };
 /**
@@ -118,6 +119,15 @@ export declare class TodoistApi {
      * @returns A promise that resolves to a paginated response of completed tasks.
      */
     searchCompletedTasks(args: SearchCompletedTasksArgs): Promise<GetCompletedTasksResponse>;
+    /**
+     * Retrieves all completed tasks with optional filters.
+     *
+     * Uses offset-based pagination rather than cursor-based.
+     *
+     * @param args - Optional parameters including project ID, label, date range, and pagination.
+     * @returns A promise that resolves to completed tasks with associated project and section data.
+     */
+    getAllCompletedTasks(args?: GetAllCompletedTasksArgs): Promise<GetAllCompletedTasksResponse>;
     /**
      * Creates a new task with the provided parameters.
      *
@@ -270,6 +280,35 @@ export declare class TodoistApi {
      * @returns A promise that resolves to the moved project.
      */
     moveProjectToPersonal(args: MoveProjectToPersonalArgs, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
+    /**
+     * Counts the number of archived projects.
+     *
+     * @param args - Optional parameters to filter the count.
+     * @returns A promise that resolves to the count of archived projects.
+     */
+    getArchivedProjectsCount(args?: GetArchivedProjectsCountArgs): Promise<GetArchivedProjectsCountResponse>;
+    /**
+     * Retrieves the role-to-action permission mappings for projects.
+     *
+     * @returns A promise that resolves to the permission mappings.
+     */
+    getProjectPermissions(): Promise<GetProjectPermissionsResponse>;
+    /**
+     * Retrieves full project data including tasks, sections, collaborators, and notes.
+     *
+     * @param id - The unique identifier of the project.
+     * @param args - Optional parameters.
+     * @returns A promise that resolves to the full project data.
+     */
+    getFullProject(id: string, args?: GetFullProjectArgs): Promise<GetFullProjectResponse>;
+    /**
+     * Joins a shared project by its ID.
+     *
+     * @param id - The unique identifier of the project to join.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the joined project.
+     */
+    joinProject(id: string, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
     /**
      * Retrieves a list of collaborators for a specific project.
      *
@@ -278,6 +317,51 @@ export declare class TodoistApi {
      * @returns A promise that resolves to an array of collaborators for the project.
      */
     getProjectCollaborators(projectId: string, args?: GetProjectCollaboratorsArgs): Promise<GetProjectCollaboratorsResponse>;
+    /**
+     * Retrieves activity statistics for a project.
+     *
+     * @param projectId - The unique identifier of the project.
+     * @param args - Optional parameters including weeks and weekly counts flag.
+     * @returns A promise that resolves to the project activity stats.
+     */
+    getProjectActivityStats(projectId: string, args?: GetProjectActivityStatsArgs): Promise<ProjectActivityStats>;
+    /**
+     * Retrieves the health status of a project.
+     *
+     * @param projectId - The unique identifier of the project.
+     * @returns A promise that resolves to the project health data.
+     */
+    getProjectHealth(projectId: string): Promise<ProjectHealth>;
+    /**
+     * Retrieves the health context for a project, including metrics and task details.
+     *
+     * @param projectId - The unique identifier of the project.
+     * @returns A promise that resolves to the project health context.
+     */
+    getProjectHealthContext(projectId: string): Promise<ProjectHealthContext>;
+    /**
+     * Retrieves progress information for a project.
+     *
+     * @param projectId - The unique identifier of the project.
+     * @returns A promise that resolves to the project progress data.
+     */
+    getProjectProgress(projectId: string): Promise<ProjectProgress>;
+    /**
+     * Retrieves insights for all projects in a workspace.
+     *
+     * @param workspaceId - The unique identifier of the workspace.
+     * @param args - Optional parameters including project IDs filter.
+     * @returns A promise that resolves to workspace insights data.
+     */
+    getWorkspaceInsights(workspaceId: string, args?: GetWorkspaceInsightsArgs): Promise<WorkspaceInsights>;
+    /**
+     * Triggers a health analysis for a project.
+     *
+     * @param projectId - The unique identifier of the project.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated project health data.
+     */
+    analyzeProjectHealth(projectId: string, requestId?: string): Promise<ProjectHealth>;
     /**
      * Retrieves all sections within a specific project or matching criteria.
      *
@@ -325,6 +409,22 @@ export declare class TodoistApi {
      * @returns A promise that resolves to `true` if successful.
      */
     deleteSection(id: string, requestId?: string): Promise<boolean>;
+    /**
+     * Archives a section by its ID.
+     *
+     * @param id - The unique identifier of the section to archive.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated section.
+     */
+    archiveSection(id: string, requestId?: string): Promise<Section>;
+    /**
+     * Unarchives a section by its ID.
+     *
+     * @param id - The unique identifier of the section to unarchive.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated section.
+     */
+    unarchiveSection(id: string, requestId?: string): Promise<Section>;
     /**
      * Retrieves a label by its ID.
      *
@@ -431,6 +531,84 @@ export declare class TodoistApi {
      * @returns A promise that resolves to `true` if successful.
      */
     deleteComment(id: string, requestId?: string): Promise<boolean>;
+    /**
+     * Retrieves a paginated list of time-based reminders.
+     *
+     * @param args - Optional parameters including task ID filter and pagination.
+     * @returns A promise that resolves to a paginated list of reminders.
+     */
+    getReminders(args?: GetRemindersArgs): Promise<GetRemindersResponse>;
+    /**
+     * Retrieves a paginated list of location-based reminders.
+     *
+     * @param args - Optional parameters including task ID filter and pagination.
+     * @returns A promise that resolves to a paginated list of location reminders.
+     */
+    getLocationReminders(args?: GetLocationRemindersArgs): Promise<GetLocationRemindersResponse>;
+    /**
+     * Retrieves a time-based reminder by its ID.
+     *
+     * @param id - The unique identifier of the reminder to retrieve.
+     * @returns A promise that resolves to the requested reminder.
+     */
+    getReminder(id: string): Promise<Reminder>;
+    /**
+     * Retrieves a location reminder by its ID.
+     *
+     * @param id - The unique identifier of the location reminder to retrieve.
+     * @returns A promise that resolves to the requested reminder.
+     */
+    getLocationReminder(id: string): Promise<Reminder>;
+    /**
+     * Creates a time-based reminder for a task.
+     *
+     * @param args - Reminder creation parameters for relative or absolute reminders.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the created reminder.
+     */
+    addReminder(args: AddReminderArgs, requestId?: string): Promise<Reminder>;
+    /**
+     * Creates a location reminder for a task.
+     *
+     * @param args - Location reminder creation parameters.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the created reminder.
+     */
+    addLocationReminder(args: AddLocationReminderArgs, requestId?: string): Promise<Reminder>;
+    /**
+     * Updates an existing time-based reminder.
+     *
+     * @param id - The unique identifier of the reminder to update.
+     * @param args - Reminder update parameters.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated reminder.
+     */
+    updateReminder(id: string, args: UpdateReminderArgs, requestId?: string): Promise<Reminder>;
+    /**
+     * Updates an existing location reminder.
+     *
+     * @param id - The unique identifier of the location reminder to update.
+     * @param args - Location reminder update parameters.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated reminder.
+     */
+    updateLocationReminder(id: string, args: UpdateLocationReminderArgs, requestId?: string): Promise<Reminder>;
+    /**
+     * Deletes a time-based reminder by its ID.
+     *
+     * @param id - The unique identifier of the reminder to delete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
+    deleteReminder(id: string, requestId?: string): Promise<boolean>;
+    /**
+     * Deletes a location reminder by its ID.
+     *
+     * @param id - The unique identifier of the location reminder to delete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
+    deleteLocationReminder(id: string, requestId?: string): Promise<boolean>;
     /**
      * Retrieves productivity stats for the authenticated user.
      *
@@ -521,7 +699,90 @@ export declare class TodoistApi {
      * const text = await response.text()
      * ```
      */
-    viewAttachment(commentOrUrl: Comment | string): Promise<ViewAttachmentResponse>;
+    viewAttachment(commentOrUrl: Comment | string): Promise<FileResponse>;
+    /**
+     * Retrieves a list of available backups.
+     *
+     * @param args - Optional parameters including MFA token.
+     * @returns A promise that resolves to an array of backups.
+     */
+    getBackups(args?: GetBackupsArgs): Promise<Backup[]>;
+    /**
+     * Downloads a backup file as binary data.
+     *
+     * @param args - Arguments including the backup file URL (from getBackups).
+     * @returns A promise that resolves to a response with binary data accessible via arrayBuffer().
+     */
+    downloadBackup(args: DownloadBackupArgs): Promise<FileResponse>;
+    /**
+     * Gets or creates an email forwarding address for an object.
+     *
+     * @param args - Arguments including object type and ID.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the email address.
+     */
+    getOrCreateEmailForwarding(args: GetOrCreateEmailArgs, requestId?: string): Promise<GetOrCreateEmailResponse>;
+    /**
+     * Disables email forwarding for an object.
+     *
+     * @param args - Arguments including object type and ID.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
+    disableEmailForwarding(args: DisableEmailArgs, requestId?: string): Promise<boolean>;
+    /**
+     * Retrieves ID mappings between old and new IDs.
+     *
+     * @param args - Arguments including object type and IDs to look up.
+     * @returns A promise that resolves to an array of ID mappings.
+     */
+    getIdMappings(args: GetIdMappingsArgs): Promise<IdMapping[]>;
+    /**
+     * Retrieves moved IDs for objects that have been migrated.
+     *
+     * @param args - Arguments including object type and optional old IDs to look up.
+     * @returns A promise that resolves to an array of moved ID pairs.
+     */
+    getMovedIds(args: GetMovedIdsArgs): Promise<MovedId[]>;
+    /**
+     * Exports a project as a template file (CSV format).
+     *
+     * @param args - Arguments including project ID and optional date format preference.
+     * @returns A promise that resolves to the template file content as a string.
+     */
+    exportTemplateAsFile(args: ExportTemplateFileArgs): Promise<string>;
+    /**
+     * Exports a project as a template URL.
+     *
+     * @param args - Arguments including project ID and optional date format preference.
+     * @returns A promise that resolves to the file name and URL.
+     */
+    exportTemplateAsUrl(args: ExportTemplateUrlArgs): Promise<ExportTemplateUrlResponse>;
+    /**
+     * Creates a new project from a template file.
+     *
+     * @param args - Arguments including project name, template file, and optional workspace ID.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the created project data.
+     */
+    createProjectFromTemplate(args: CreateProjectFromTemplateArgs, requestId?: string): Promise<CreateProjectFromTemplateResponse>;
+    /**
+     * Imports a template file into an existing project.
+     *
+     * @param args - Arguments including project ID and template file.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the import result.
+     */
+    importTemplateIntoProject(args: ImportTemplateIntoProjectArgs, requestId?: string): Promise<ImportTemplateResponse>;
+    /**
+     * Imports a template by ID into an existing project.
+     *
+     * @param args - Arguments including project ID, template ID, and optional locale.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the import result.
+     */
+    importTemplateFromId(args: ImportTemplateFromIdArgs, requestId?: string): Promise<ImportTemplateResponse>;
+    private validateTemplateResponse;
     /**
      * Gets pending invitations for a workspace.
      *
@@ -598,8 +859,6 @@ export declare class TodoistApi {
     /**
      * Retrieves all workspaces for the authenticated user.
      *
-     * Uses the Sync API internally to fetch workspace data.
-     *
      * @param requestId - Optional custom identifier for the request.
      * @returns A promise that resolves to an array of workspaces.
      *
@@ -612,6 +871,79 @@ export declare class TodoistApi {
      * ```
      */
     getWorkspaces(requestId?: string): Promise<Workspace[]>;
+    /**
+     * Retrieves a workspace by its ID.
+     *
+     * @param id - The unique identifier of the workspace.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the requested workspace.
+     */
+    getWorkspace(id: string, requestId?: string): Promise<Workspace>;
+    /**
+     * Creates a new workspace.
+     *
+     * @param args - The arguments for creating the workspace.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the created workspace.
+     */
+    addWorkspace(args: AddWorkspaceArgs, requestId?: string): Promise<Workspace>;
+    /**
+     * Updates an existing workspace.
+     *
+     * @param id - The unique identifier of the workspace to update.
+     * @param args - The arguments for updating the workspace.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated workspace.
+     */
+    updateWorkspace(id: string, args: UpdateWorkspaceArgs, requestId?: string): Promise<Workspace>;
+    /**
+     * Deletes a workspace by its ID.
+     *
+     * @param id - The unique identifier of the workspace to delete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
+    deleteWorkspace(id: string, requestId?: string): Promise<boolean>;
+    /**
+     * Retrieves activity information for workspace members.
+     *
+     * @param args - Arguments including workspace ID and optional user/project filters.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to workspace members activity data.
+     */
+    getWorkspaceMembersActivity(args: GetWorkspaceMembersActivityArgs, requestId?: string): Promise<GetWorkspaceMembersActivityResponse>;
+    /**
+     * Retrieves tasks assigned to a specific user in a workspace.
+     *
+     * @param args - Arguments including workspace ID, user ID, and optional project filter.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to workspace user tasks.
+     */
+    getWorkspaceUserTasks(args: GetWorkspaceUserTasksArgs, requestId?: string): Promise<GetWorkspaceUserTasksResponse>;
+    /**
+     * Invites users to a workspace by email.
+     *
+     * @param args - Arguments including workspace ID, email list, and optional role.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the list of invited emails.
+     */
+    inviteWorkspaceUsers(args: InviteWorkspaceUsersArgs, requestId?: string): Promise<InviteWorkspaceUsersResponse>;
+    /**
+     * Updates a workspace user's role.
+     *
+     * @param args - Arguments including workspace ID, user ID, and new role.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated workspace user view.
+     */
+    updateWorkspaceUser(args: UpdateWorkspaceUserArgs, requestId?: string): Promise<JoinWorkspaceResult>;
+    /**
+     * Removes a user from a workspace.
+     *
+     * @param args - Arguments including workspace ID and user ID.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
+    removeWorkspaceUser(args: RemoveWorkspaceUserArgs, requestId?: string): Promise<boolean>;
     /**
      * Gets active projects in a workspace with pagination.
      *

package/dist/types/{utils → transport}/fetch-with-retry.d.ts

@@ -1,4 +1,4 @@
-import type { HttpResponse, RetryConfig, CustomFetch } from '../types/http.js';
+import type { CustomFetch, HttpResponse, RetryConfig } from '../types/http.js';
 /**
  * Performs a fetch request with retry logic and timeout support
  */

package/dist/types/{rest-client.d.ts → transport/http-client.d.ts}

@@ -1,4 +1,4 @@
-import { HttpMethod, HttpResponse, CustomFetch } from './types/http.js';
+import type { CustomFetch, HttpMethod, HttpResponse } from '../types/http.js';
 type RequestArgs = {
     httpMethod: HttpMethod;
     baseUri: string;

package/dist/types/transport/http-dispatcher.d.ts

@@ -0,0 +1,3 @@
+import type { Dispatcher } from 'undici';
+export declare function getDefaultDispatcher(): Promise<Dispatcher | undefined>;
+export declare function resetDefaultDispatcherForTests(): Promise<void>;