@doist/todoist-api-typescript 7.9.0 → 7.10.0

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

@@ -1,1018 +0,0 @@
-import { Task, AddTaskArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateTaskArgs, QuickAddTaskArgs, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, SearchCompletedTasksArgs, GetTasksResponse, GetAllCompletedTasksArgs, GetAllCompletedTasksResponse } from './types/tasks/index.js';
-import { PersonalProject, WorkspaceProject, AddProjectArgs, UpdateProjectArgs, GetProjectsArgs, SearchProjectsArgs, GetProjectCollaboratorsArgs, GetProjectsResponse, GetProjectCollaboratorsResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse, MoveProjectToWorkspaceArgs, MoveProjectToPersonalArgs, GetArchivedProjectsCountArgs, GetArchivedProjectsCountResponse, GetProjectPermissionsResponse, GetFullProjectArgs, GetFullProjectResponse } from './types/projects/index.js';
-import { Section, AddSectionArgs, UpdateSectionArgs, GetSectionsArgs, SearchSectionsArgs, GetSectionsResponse } from './types/sections/index.js';
-import { Label, AddLabelArgs, UpdateLabelArgs, GetLabelsArgs, SearchLabelsArgs, GetLabelsResponse, GetSharedLabelsArgs, GetSharedLabelsResponse, RenameSharedLabelArgs, RemoveSharedLabelArgs } from './types/labels/index.js';
-import { Attachment, Comment, AddCommentArgs, UpdateCommentArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetCommentsResponse } from './types/comments/index.js';
-import { AddReminderArgs, UpdateReminderArgs, AddLocationReminderArgs, UpdateLocationReminderArgs, GetRemindersArgs, GetRemindersResponse, GetLocationRemindersArgs, GetLocationRemindersResponse } from './types/reminders/index.js';
-import { CurrentUser } from './types/users/index.js';
-import { ProductivityStats } from './types/productivity/index.js';
-import { GetActivityLogsArgs, GetActivityLogsResponse } from './types/activity/index.js';
-import { WorkspaceInvitation, WorkspacePlanDetails, JoinWorkspaceResult, Workspace, AddWorkspaceArgs, UpdateWorkspaceArgs, GetWorkspaceMembersActivityArgs, GetWorkspaceMembersActivityResponse, GetWorkspaceUserTasksArgs, GetWorkspaceUserTasksResponse, InviteWorkspaceUsersArgs, InviteWorkspaceUsersResponse, UpdateWorkspaceUserArgs, RemoveWorkspaceUserArgs, GetWorkspaceInvitationsArgs, DeleteWorkspaceInvitationArgs, WorkspaceInvitationActionArgs, JoinWorkspaceArgs, WorkspaceLogoArgs, GetWorkspacePlanDetailsArgs, GetWorkspaceUsersArgs, GetWorkspaceUsersResponse, GetWorkspaceProjectsArgs, WorkspaceInvitationsResponse, AllWorkspaceInvitationsResponse, WorkspaceLogoResponse } from './types/workspaces/index.js';
-import { GetFoldersArgs, GetFoldersResponse, AddFolderArgs, UpdateFolderArgs } from './types/folders/index.js';
-import type { Folder } from './types/sync/resources/folders.js';
-import { ProjectActivityStats, ProjectHealth, ProjectHealthContext, ProjectProgress, WorkspaceInsights, GetProjectActivityStatsArgs, GetWorkspaceInsightsArgs } from './types/insights/index.js';
-import { Backup, GetBackupsArgs, DownloadBackupArgs } from './types/backups/index.js';
-import { IdMapping, MovedId, GetIdMappingsArgs, GetMovedIdsArgs } from './types/id-mappings/index.js';
-import { GetOrCreateEmailArgs, GetOrCreateEmailResponse, DisableEmailArgs } from './types/emails/index.js';
-import { UploadFileArgs, DeleteUploadArgs } from './types/uploads/index.js';
-import { ExportTemplateFileArgs, ExportTemplateUrlArgs, ExportTemplateUrlResponse, CreateProjectFromTemplateArgs, CreateProjectFromTemplateResponse, ImportTemplateIntoProjectArgs, ImportTemplateFromIdArgs, ImportTemplateResponse } from './types/templates/index.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 FileResponse = CustomFetchResponse & {
-    arrayBuffer(): Promise<ArrayBuffer>;
-};
-/**
- * Configuration options for the TodoistApi constructor
- */
-export type TodoistApiOptions = {
-    /**
-     * Optional custom API base URL. If not provided, defaults to Todoist's standard API endpoint
-     */
-    baseUrl?: string;
-    /**
-     * Optional custom fetch function for alternative HTTP clients (e.g., Obsidian's requestUrl, React Native fetch)
-     */
-    customFetch?: CustomFetch;
-};
-export declare class TodoistApi {
-    private authToken;
-    private syncApiBase;
-    private customFetch?;
-    constructor(
-    /**
-     * Your Todoist API token.
-     */
-    authToken: string, 
-    /**
-     * Optional configuration options
-     */
-    options?: TodoistApiOptions);
-    /**
-     * Makes a request to the Sync API and handles error checking.
-     *
-     * @param syncRequest - The sync request payload
-     * @param requestId - Optional request identifier
-     * @param hasSyncCommands - Whether this request contains sync commands (write operations)
-     * @returns The sync response data
-     * @throws TodoistRequestError if sync status contains errors
-     */
-    private requestSync;
-    /**
-     * Executes a raw Sync API request.
-     *
-     * This method provides direct access to the Sync API, allowing you to send
-     * strongly-typed commands and request specific resource types.
-     *
-     * @param request - The sync request payload containing commands and/or resource types.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the sync response.
-     * @throws TodoistRequestError if the sync status contains errors.
-     *
-     * @example
-     * ```typescript
-     * import { createCommand } from '@doist/todoist-api-typescript'
-     *
-     * const response = await api.sync({
-     *     commands: [
-     *         createCommand('item_add', { content: 'Buy milk' }),
-     *     ],
-     *     resourceTypes: ['items'],
-     *     syncToken: '*',
-     * })
-     * ```
-     */
-    sync(syncRequest: SyncRequest, requestId?: string): Promise<SyncResponse>;
-    /**
-     * Retrieves information about the authenticated user.
-     *
-     * @returns A promise that resolves to the current user's information.
-     */
-    getUser(): Promise<CurrentUser>;
-    /**
-     * Retrieves a single active (non-completed) task by its ID.
-     *
-     * @param id - The unique identifier of the task.
-     * @returns A promise that resolves to the requested task.
-     */
-    getTask(id: string): Promise<Task>;
-    /**
-     * Retrieves a list of active tasks filtered by specific parameters.
-     *
-     * @param args - Filter parameters such as project ID, label ID, or due date.
-     * @returns A promise that resolves to an array of tasks.
-     */
-    getTasks(args?: GetTasksArgs): Promise<GetTasksResponse>;
-    /**
-     * Retrieves tasks filtered by a filter string.
-     *
-     * @param args - Parameters for filtering tasks, including the query string and optional language.
-     * @returns A promise that resolves to a paginated response of tasks.
-     */
-    getTasksByFilter(args: GetTasksByFilterArgs): Promise<GetTasksResponse>;
-    /**
-     * Retrieves completed tasks by completion date.
-     *
-     * @param args - Parameters for filtering, including required since, until.
-     * @returns A promise that resolves to a paginated response of completed tasks.
-     */
-    getCompletedTasksByCompletionDate(args: GetCompletedTasksByCompletionDateArgs): Promise<GetCompletedTasksResponse>;
-    /**
-     * Retrieves completed tasks by due date.
-     *
-     * @param args - Parameters for filtering, including required since, until.
-     * @returns A promise that resolves to a paginated response of completed tasks.
-     */
-    getCompletedTasksByDueDate(args: GetCompletedTasksByDueDateArgs): Promise<GetCompletedTasksResponse>;
-    /**
-     * Searches completed tasks by query string.
-     *
-     * @param args - Parameters for searching, including the query string.
-     * @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.
-     *
-     * @param args - Task creation parameters such as content, due date, or priority.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the created task.
-     */
-    addTask(args: AddTaskArgs, requestId?: string): Promise<Task>;
-    /**
-     * Quickly adds a task using natural language processing for due dates.
-     *
-     * @param args - Quick add task parameters, including content and due date.
-     * @returns A promise that resolves to the created task.
-     */
-    quickAddTask(args: QuickAddTaskArgs): Promise<Task>;
-    /**
-     * Updates an existing task by its ID with the provided parameters.
-     *
-     * @param id - The unique identifier of the task to update.
-     * @param args - Update parameters such as content, priority, or due date. Pass
-     * `dueString: null` (or `"no date"`) to clear the due date.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the updated task.
-     */
-    updateTask(id: string, args: UpdateTaskArgs, requestId?: string): Promise<Task>;
-    /**
-     * Moves existing tasks by their ID to either a different parent/section/project.
-     *
-     * @param ids - The unique identifier of the tasks to be moved.
-     * @param args - The paramets that should contain only one of projectId, sectionId, or parentId
-     * @param requestId - Optional custom identifier for the request.
-     * @returns - A promise that resolves to an array of the updated tasks.
-     */
-    moveTasks(ids: string[], args: MoveTaskArgs, requestId?: string): Promise<Task[]>;
-    /**
-     * Moves a task by its ID to either a different parent/section/project.
-     *
-     * @param id - The unique identifier of the task to be moved.
-     * @param args - The parameters that should contain exactly one of projectId, sectionId, or parentId
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the updated task.
-     */
-    moveTask(id: string, args: MoveTaskArgs, requestId?: string): Promise<Task>;
-    /**
-     * Closes (completes) a task by its ID.
-     *
-     * @param id - The unique identifier of the task to close.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to `true` if successful.
-     */
-    closeTask(id: string, requestId?: string): Promise<boolean>;
-    /**
-     * Reopens a previously closed (completed) task by its ID.
-     *
-     * @param id - The unique identifier of the task to reopen.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to `true` if successful.
-     */
-    reopenTask(id: string, requestId?: string): Promise<boolean>;
-    /**
-     * Deletes a task by its ID.
-     *
-     * @param id - The unique identifier of the task to delete.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to `true` if successful.
-     */
-    deleteTask(id: string, requestId?: string): Promise<boolean>;
-    /**
-     * Retrieves a project by its ID.
-     *
-     * @param id - The unique identifier of the project.
-     * @returns A promise that resolves to the requested project.
-     */
-    getProject(id: string): Promise<PersonalProject | WorkspaceProject>;
-    /**
-     * Retrieves all projects with optional filters.
-     *
-     * @param args - Optional filters for retrieving projects.
-     * @returns A promise that resolves to an array of projects.
-     */
-    getProjects(args?: GetProjectsArgs): Promise<GetProjectsResponse>;
-    /**
-     * Searches projects by name.
-     *
-     * @param args - Search parameters including the query string.
-     * @returns A promise that resolves to a paginated response of projects.
-     */
-    searchProjects(args: SearchProjectsArgs): Promise<GetProjectsResponse>;
-    /**
-     * Retrieves all archived projects with optional filters.
-     *
-     * @param args - Optional filters for retrieving archived projects.
-     * @returns A promise that resolves to an array of archived projects.
-     */
-    getArchivedProjects(args?: GetArchivedProjectsArgs): Promise<GetArchivedProjectsResponse>;
-    /**
-     * Creates a new project with the provided parameters.
-     *
-     * @param args - Project creation parameters such as name or color.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the created project.
-     */
-    addProject(args: AddProjectArgs, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
-    /**
-     * Updates an existing project by its ID with the provided parameters.
-     *
-     * @param id - The unique identifier of the project to update.
-     * @param args - Update parameters such as name or color.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the updated project.
-     */
-    updateProject(id: string, args: UpdateProjectArgs, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
-    /**
-     * Deletes a project by its ID.
-     *
-     * @param id - The unique identifier of the project to delete.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to `true` if successful.
-     */
-    deleteProject(id: string, requestId?: string): Promise<boolean>;
-    /**
-     * Archives a project by its ID.
-     *
-     * @param id - The unique identifier of the project to archive.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the updated project.
-     */
-    archiveProject(id: string, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
-    /**
-     * Unarchives a project by its ID.
-     *
-     * @param id - The unique identifier of the project to unarchive.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the updated project.
-     */
-    unarchiveProject(id: string, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
-    /**
-     * Moves a project to a workspace.
-     *
-     * @param args - The arguments for moving the project.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the moved project.
-     */
-    moveProjectToWorkspace(args: MoveProjectToWorkspaceArgs, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
-    /**
-     * Moves a project to personal.
-     *
-     * @param args - The arguments for moving the project.
-     * @param requestId - Optional custom identifier for the request.
-     * @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.
-     *
-     * @param projectId - The unique identifier of the project.
-     * @param args - Optional parameters to filter collaborators.
-     * @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.
-     *
-     * @param args - Filter parameters such as project ID. If no projectId is provided,
-     * all sections are returned.
-     * @returns A promise that resolves to an array of sections.
-     */
-    getSections(args?: GetSectionsArgs): Promise<GetSectionsResponse>;
-    /**
-     * Searches sections by name.
-     *
-     * @param args - Search parameters including the query string.
-     * @returns A promise that resolves to a paginated response of sections.
-     */
-    searchSections(args: SearchSectionsArgs): Promise<GetSectionsResponse>;
-    /**
-     * Retrieves a single section by its ID.
-     *
-     * @param id - The unique identifier of the section.
-     * @returns A promise that resolves to the requested section.
-     */
-    getSection(id: string): Promise<Section>;
-    /**
-     * Creates a new section within a project.
-     *
-     * @param args - Section creation parameters such as name or project ID.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the created section.
-     */
-    addSection(args: AddSectionArgs, requestId?: string): Promise<Section>;
-    /**
-     * Updates a section by its ID with the provided parameters.
-     *
-     * @param id - The unique identifier of the section to update.
-     * @param args - Update parameters such as name or project ID.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the updated section.
-     */
-    updateSection(id: string, args: UpdateSectionArgs, requestId?: string): Promise<Section>;
-    /**
-     * Deletes a section by its ID.
-     *
-     * @param id - The unique identifier of the section to delete.
-     * @param requestId - Optional custom identifier for the request.
-     * @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.
-     *
-     * @param id - The unique identifier of the label.
-     * @returns A promise that resolves to the requested label.
-     */
-    getLabel(id: string): Promise<Label>;
-    /**
-     * Retrieves all labels.
-     *
-     * @param args - Optional filter parameters.
-     * @returns A promise that resolves to an array of labels.
-     */
-    getLabels(args?: GetLabelsArgs): Promise<GetLabelsResponse>;
-    /**
-     * Searches labels by name.
-     *
-     * @param args - Search parameters including the query string.
-     * @returns A promise that resolves to a paginated response of labels.
-     */
-    searchLabels(args: SearchLabelsArgs): Promise<GetLabelsResponse>;
-    /**
-     * Adds a new label.
-     *
-     * @param args - Label creation parameters such as name.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the created label.
-     */
-    addLabel(args: AddLabelArgs, requestId?: string): Promise<Label>;
-    /**
-     * Updates an existing label by its ID.
-     *
-     * @param id - The unique identifier of the label to update.
-     * @param args - Update parameters such as name or color.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the updated label.
-     */
-    updateLabel(id: string, args: UpdateLabelArgs, requestId?: string): Promise<Label>;
-    /**
-     * Deletes a label by its ID.
-     *
-     * @param id - The unique identifier of the label to delete.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to `true` if successful.
-     */
-    deleteLabel(id: string, requestId?: string): Promise<boolean>;
-    /**
-     * Retrieves a list of shared labels.
-     *
-     * @param args - Optional parameters to filter shared labels.
-     * @returns A promise that resolves to an array of shared labels.
-     */
-    getSharedLabels(args?: GetSharedLabelsArgs): Promise<GetSharedLabelsResponse>;
-    /**
-     * Renames an existing shared label.
-     *
-     * @param args - Parameters for renaming the shared label, including the current and new name.
-     * @returns A promise that resolves to `true` if successful.
-     */
-    renameSharedLabel(args: RenameSharedLabelArgs): Promise<boolean>;
-    /**
-     * Removes a shared label.
-     *
-     * @param args - Parameters for removing the shared label.
-     * @returns A promise that resolves to `true` if successful.
-     */
-    removeSharedLabel(args: RemoveSharedLabelArgs): Promise<boolean>;
-    /**
-     * Retrieves all comments associated with a task or project.
-     *
-     * @param args - Parameters for retrieving comments, such as task ID or project ID.
-     * @returns A promise that resolves to an array of comments.
-     */
-    getComments(args: GetTaskCommentsArgs | GetProjectCommentsArgs): Promise<GetCommentsResponse>;
-    /**
-     * Retrieves a specific comment by its ID.
-     *
-     * @param id - The unique identifier of the comment to retrieve.
-     * @returns A promise that resolves to the requested comment.
-     */
-    getComment(id: string): Promise<Comment>;
-    /**
-     * Adds a comment to a task or project.
-     *
-     * @param args - Parameters for creating the comment, such as content and the target task or project ID.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the created comment.
-     */
-    addComment(args: AddCommentArgs, requestId?: string): Promise<Comment>;
-    /**
-     * Updates an existing comment by its ID.
-     *
-     * @param id - The unique identifier of the comment to update.
-     * @param args - Update parameters such as new content.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the updated comment.
-     */
-    updateComment(id: string, args: UpdateCommentArgs, requestId?: string): Promise<Comment>;
-    /**
-     * Deletes a comment by its ID.
-     *
-     * @param id - The unique identifier of the comment to delete.
-     * @param requestId - Optional custom identifier for the request.
-     * @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.
-     *
-     * @returns A promise that resolves to the productivity stats.
-     */
-    getProductivityStats(): Promise<ProductivityStats>;
-    /**
-     * Retrieves activity logs with optional filters.
-     *
-     * @param args - Optional filter parameters for activity logs.
-     * @returns A promise that resolves to a paginated response of activity events.
-     */
-    getActivityLogs(args?: GetActivityLogsArgs): Promise<GetActivityLogsResponse>;
-    /**
-     * Uploads a file and returns attachment metadata.
-     * This creates an upload record that can be referenced in tasks or comments.
-     *
-     * @param args - Upload parameters including file content, filename, and optional project ID.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the uploaded file's attachment metadata.
-     *
-     * @example
-     * ```typescript
-     * // Upload from a file path
-     * const upload = await api.uploadFile({
-     *   file: '/path/to/document.pdf',
-     *   projectId: '12345'
-     * })
-     *
-     * // Upload from a Buffer
-     * const buffer = fs.readFileSync('/path/to/document.pdf')
-     * const upload = await api.uploadFile({
-     *   file: buffer,
-     *   fileName: 'document.pdf',  // Required for Buffer/Stream
-     *   projectId: '12345'
-     * })
-     *
-     * // Use the returned fileUrl in a comment
-     * await api.addComment({
-     *   content: 'See attached document',
-     *   taskId: '67890',
-     *   attachment: {
-     *     fileUrl: upload.fileUrl,
-     *     fileName: upload.fileName,
-     *     fileType: upload.fileType,
-     *     resourceType: upload.resourceType
-     *   }
-     * })
-     * ```
-     */
-    uploadFile(args: UploadFileArgs, requestId?: string): Promise<Attachment>;
-    /**
-     * Deletes an uploaded file by its URL.
-     *
-     * @param args - The file URL to delete.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to `true` if deletion was successful.
-     *
-     * @example
-     * ```typescript
-     * await api.deleteUpload({
-     *   fileUrl: 'https://cdn.todoist.com/...'
-     * })
-     * ```
-     */
-    deleteUpload(args: DeleteUploadArgs, requestId?: string): Promise<boolean>;
-    /**
-     * Fetches the content of a file attachment from a Todoist comment.
-     *
-     * Accepts either a Comment object (extracts the file URL from its attachment)
-     * or a direct file URL string. Returns the raw Response object so the caller
-     * can read the body in the appropriate format (.arrayBuffer(), .text(), etc.).
-     *
-     * @param commentOrUrl - A Comment object with a file attachment, or a file URL string.
-     * @returns The raw fetch Response for the file content.
-     * @throws Error if a Comment is provided without a file attachment or file URL.
-     *
-     * @example
-     * ```typescript
-     * // From a comment object
-     * const comments = await api.getComments({ taskId: '12345' })
-     * const comment = comments.results[0]
-     * const response = await api.viewAttachment(comment)
-     * const imageData = await response.arrayBuffer()
-     *
-     * // From a URL string
-     * const response = await api.viewAttachment('https://files.todoist.com/...')
-     * const text = await response.text()
-     * ```
-     */
-    viewAttachment(commentOrUrl: Comment | string): Promise<FileResponse>;
-    /**
-     * Retrieves a paginated list of folders.
-     *
-     * @param args - Filter parameters such as workspace ID.
-     * @returns A promise that resolves to a paginated response of folders.
-     */
-    getFolders(args: GetFoldersArgs): Promise<GetFoldersResponse>;
-    /**
-     * Retrieves a single folder by its ID.
-     *
-     * @param id - The unique identifier of the folder.
-     * @returns A promise that resolves to the requested folder.
-     */
-    getFolder(id: string): Promise<Folder>;
-    /**
-     * Creates a new folder.
-     *
-     * @param args - Folder creation parameters including name and workspace ID.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the created folder.
-     */
-    addFolder(args: AddFolderArgs, requestId?: string): Promise<Folder>;
-    /**
-     * Updates an existing folder by its ID.
-     *
-     * @param id - The unique identifier of the folder to update.
-     * @param args - Update parameters such as name or default order.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the updated folder.
-     */
-    updateFolder(id: string, args: UpdateFolderArgs, requestId?: string): Promise<Folder>;
-    /**
-     * Deletes a folder by its ID.
-     *
-     * @param id - The unique identifier of the folder to delete.
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to `true` if successful.
-     */
-    deleteFolder(id: string, requestId?: string): Promise<boolean>;
-    /**
-     * 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.
-     *
-     * @param args - Arguments including workspace ID.
-     * @param requestId - Optional request ID for idempotency.
-     * @returns Array of email addresses with pending invitations.
-     */
-    getWorkspaceInvitations(args: GetWorkspaceInvitationsArgs, requestId?: string): Promise<WorkspaceInvitationsResponse>;
-    /**
-     * Gets all workspace invitations (admin only).
-     *
-     * @param requestId - Optional request ID for idempotency.
-     * @returns Array of email addresses with pending invitations.
-     */
-    getAllWorkspaceInvitations(args?: {
-        workspaceId?: number;
-    }, requestId?: string): Promise<AllWorkspaceInvitationsResponse>;
-    /**
-     * Deletes a workspace invitation (admin only).
-     *
-     * @param args - Arguments including workspace ID and user email.
-     * @param requestId - Optional request ID for idempotency.
-     * @returns The deleted invitation.
-     */
-    deleteWorkspaceInvitation(args: DeleteWorkspaceInvitationArgs, requestId?: string): Promise<WorkspaceInvitation>;
-    /**
-     * Accepts a workspace invitation.
-     *
-     * @param args - Arguments including invite code.
-     * @param requestId - Optional request ID for idempotency.
-     * @returns The accepted invitation.
-     */
-    acceptWorkspaceInvitation(args: WorkspaceInvitationActionArgs, requestId?: string): Promise<WorkspaceInvitation>;
-    /**
-     * Rejects a workspace invitation.
-     *
-     * @param args - Arguments including invite code.
-     * @param requestId - Optional request ID for idempotency.
-     * @returns The rejected invitation.
-     */
-    rejectWorkspaceInvitation(args: WorkspaceInvitationActionArgs, requestId?: string): Promise<WorkspaceInvitation>;
-    /**
-     * Joins a workspace via invitation link or domain auto-join.
-     *
-     * @param args - Arguments including invite code or workspace ID.
-     * @param requestId - Optional request ID for idempotency.
-     * @returns Workspace user information.
-     */
-    joinWorkspace(args: JoinWorkspaceArgs, requestId?: string): Promise<JoinWorkspaceResult>;
-    /**
-     * Uploads or updates a workspace logo.
-     *
-     * @param args - Arguments including workspace ID, file, and options.
-     * @param requestId - Optional request ID for idempotency.
-     * @returns Logo information or null if deleted.
-     */
-    uploadWorkspaceLogo(args: WorkspaceLogoArgs, requestId?: string): Promise<WorkspaceLogoResponse>;
-    /**
-     * Gets workspace plan and billing details.
-     *
-     * @param args - Arguments including workspace ID.
-     * @param requestId - Optional request ID for idempotency.
-     * @returns Workspace plan details.
-     */
-    getWorkspacePlanDetails(args: GetWorkspacePlanDetailsArgs, requestId?: string): Promise<WorkspacePlanDetails>;
-    /**
-     * Gets workspace users with pagination.
-     *
-     * @param args - Arguments including optional workspace ID, cursor, and limit.
-     * @param requestId - Optional request ID for idempotency.
-     * @returns Paginated list of workspace users.
-     */
-    getWorkspaceUsers(args?: GetWorkspaceUsersArgs, requestId?: string): Promise<GetWorkspaceUsersResponse>;
-    /**
-     * Retrieves all workspaces for the authenticated user.
-     *
-     * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to an array of workspaces.
-     *
-     * @example
-     * ```typescript
-     * const workspaces = await api.getWorkspaces()
-     * workspaces.forEach(workspace => {
-     *   console.log(`${workspace.name} (${workspace.plan}) - Role: ${workspace.role}`)
-     * })
-     * ```
-     */
-    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.
-     *
-     * @param args - Arguments including workspace ID, cursor, and limit.
-     * @param requestId - Optional request ID for idempotency.
-     * @returns Paginated list of active workspace projects.
-     */
-    getWorkspaceActiveProjects(args: GetWorkspaceProjectsArgs, requestId?: string): Promise<GetProjectsResponse>;
-    /**
-     * Gets archived projects in a workspace with pagination.
-     *
-     * @param args - Arguments including workspace ID, cursor, and limit.
-     * @param requestId - Optional request ID for idempotency.
-     * @returns Paginated list of archived workspace projects.
-     */
-    getWorkspaceArchivedProjects(args: GetWorkspaceProjectsArgs, requestId?: string): Promise<GetProjectsResponse>;
-}