@doist/todoist-sdk 9.1.0-next.1 → 9.1.0

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

@@ -1,11 +1,11 @@
 import type { Reminder } from './types/index.js';
 import { GetActivityLogsArgs, GetActivityLogsResponse } from './types/activity/index.js';
+import type { AddAppArgs, App, AppByDistributionToken, AppDistributionToken, AppInstallation, AppSecrets, AppTestToken, AppVerificationToken, AppWebhook, AppWithUserCount, InstallAppArgs, RevokeUserAuthorizationArgs, UpdateAppArgs, UpdateAppInstallationArgs, UpdateAppWebhookArgs, UploadAppIconArgs, UserAuthorization } from './types/apps/index.js';
 import { Backup, GetBackupsArgs, DownloadBackupArgs } from './types/backups/index.js';
 import { Attachment, Comment, AddCommentArgs, UpdateCommentArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetCommentsResponse } from './types/comments/index.js';
 import { GetOrCreateEmailArgs, GetOrCreateEmailResponse, DisableEmailArgs } from './types/emails/index.js';
 import { GetFoldersArgs, GetFoldersResponse, AddFolderArgs, UpdateFolderArgs } from './types/folders/index.js';
-import type { Goal, GetGoalsArgs, GetGoalsResponse, SearchGoalsArgs, AddGoalArgs, UpdateGoalArgs, TaskLinkingArgs } from './types/goals/index.js';
-import { CustomFetch, CustomFetchResponse } from './types/http.js';
+import { CustomFetch, FileResponse } from './types/http.js';
 import { IdMapping, MovedId, GetIdMappingsArgs, GetMovedIdsArgs } from './types/id-mappings/index.js';
 import { ProjectActivityStats, ProjectHealth, ProjectHealthContext, ProjectProgress, WorkspaceInsights, GetProjectActivityStatsArgs, GetWorkspaceInsightsArgs } from './types/insights/index.js';
 import { Label, AddLabelArgs, UpdateLabelArgs, GetLabelsArgs, SearchLabelsArgs, GetLabelsResponse, GetSharedLabelsArgs, GetSharedLabelsResponse, RenameSharedLabelArgs, RemoveSharedLabelArgs } from './types/labels/index.js';
@@ -16,17 +16,32 @@ import { Section, AddSectionArgs, UpdateSectionArgs, GetSectionsArgs, SearchSect
 import type { Folder } from './types/sync/resources/folders.js';
 import { Task, AddTaskArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateTaskArgs, QuickAddTaskArgs, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, SearchCompletedTasksArgs, GetTasksResponse, GetAllCompletedTasksArgs, GetAllCompletedTasksResponse } from './types/tasks/index.js';
 import { ExportTemplateFileArgs, ExportTemplateUrlArgs, ExportTemplateUrlResponse, CreateProjectFromTemplateArgs, CreateProjectFromTemplateResponse, ImportTemplateIntoProjectArgs, ImportTemplateFromIdArgs, ImportTemplateResponse } from './types/templates/index.js';
+import type { AddUiExtensionArgs, UiExtension, UpdateUiExtensionArgs, UploadUiExtensionIconArgs } from './types/ui-extensions/index.js';
 import { UploadFileArgs, DeleteUploadArgs } from './types/uploads/index.js';
 import { CurrentUser } from './types/users/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 { type SyncResponse, type SyncRequest } from './types/sync/index.js';
 /**
- * Response from viewAttachment, extending CustomFetchResponse with
- * arrayBuffer() support for binary file content.
+ * A client for interacting with the Todoist API v1.
+ * This class provides methods to manage tasks, projects, sections, labels, and comments in Todoist.
+ *
+ * @example
+ * ```typescript
+ * const api = new TodoistApi('your-api-token');
+ *
+ * // Get all tasks
+ * const tasks = await api.getTasks();
+ *
+ * // Create a new task
+ * const newTask = await api.addTask({
+ *   content: 'My new task',
+ *   projectId: '12345'
+ * });
+ * ```
+ *
+ * For more information about the Todoist API v1, see the [official documentation](https://todoist.com/api/v1).
+ * If you're migrating from v9, please refer to the [migration guide](https://todoist.com/api/v1/docs#tag/Migrating-from-v9).
  */
-export type FileResponse = CustomFetchResponse & {
-    arrayBuffer(): Promise<ArrayBuffer>;
-};
 /**
  * Configuration options for the TodoistApi constructor
  */
@@ -44,6 +59,24 @@ export declare class TodoistApi {
     private authToken;
     private syncApiBase;
     private customFetch?;
+    private readonly taskClient;
+    private readonly projectClient;
+    private readonly sectionClient;
+    private readonly labelClient;
+    private readonly commentClient;
+    private readonly reminderClient;
+    private readonly insightsClient;
+    private readonly folderClient;
+    private readonly templateClient;
+    private readonly uploadClient;
+    private readonly backupClient;
+    private readonly emailClient;
+    private readonly idMappingClient;
+    private readonly activityClient;
+    private readonly productivityClient;
+    private readonly workspaceClient;
+    private readonly appClient;
+    private readonly uiExtensionClient;
     constructor(
     /**
      * Your Todoist API token.
@@ -53,16 +86,6 @@ export declare class TodoistApi {
      * 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.
      *
@@ -764,16 +787,6 @@ export declare class TodoistApi {
      * @returns A promise that resolves to `true` if successful.
      */
     deleteFolder(id: string, requestId?: string): Promise<boolean>;
-    getGoals(args?: GetGoalsArgs): Promise<GetGoalsResponse>;
-    searchGoals(args: SearchGoalsArgs): Promise<GetGoalsResponse>;
-    getGoal(id: string): Promise<Goal>;
-    addGoal(args: AddGoalArgs, requestId?: string): Promise<Goal>;
-    updateGoal(id: string, args: UpdateGoalArgs, requestId?: string): Promise<Goal>;
-    deleteGoal(id: string, requestId?: string): Promise<boolean>;
-    completeGoal(id: string, requestId?: string): Promise<Goal>;
-    uncompleteGoal(id: string, requestId?: string): Promise<Goal>;
-    linkTaskToGoal({ goalId, taskId }: TaskLinkingArgs, requestId?: string): Promise<Goal>;
-    unlinkTaskFromGoal({ goalId, taskId }: TaskLinkingArgs, requestId?: string): Promise<boolean>;
     /**
      * Retrieves a list of available backups.
      *
@@ -856,7 +869,6 @@ export declare class TodoistApi {
      * @returns A promise that resolves to the import result.
      */
     importTemplateFromId(args: ImportTemplateFromIdArgs, requestId?: string): Promise<ImportTemplateResponse>;
-    private validateTemplateResponse;
     /**
      * Gets pending invitations for a workspace.
      *
@@ -1034,4 +1046,202 @@ export declare class TodoistApi {
      * @returns Paginated list of archived workspace projects.
      */
     getWorkspaceArchivedProjects(args: GetWorkspaceProjectsArgs, requestId?: string): Promise<GetProjectsResponse>;
+    /**
+     * Lists all developer applications owned by the authenticated user.
+     *
+     * Requires the `dev:app_console` scope.
+     *
+     * @param requestId - Optional request ID for idempotency.
+     * @returns A promise that resolves to the list of apps.
+     */
+    getApps(requestId?: string): Promise<App[]>;
+    /**
+     * Retrieves a single developer application by ID.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    getApp(appId: string, requestId?: string): Promise<AppWithUserCount>;
+    /**
+     * Creates a new developer application.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    addApp(args: AddAppArgs, requestId?: string): Promise<App>;
+    /**
+     * Updates a developer application.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    updateApp(appId: string, args: UpdateAppArgs, requestId?: string): Promise<AppWithUserCount>;
+    /**
+     * Deletes a developer application.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    deleteApp(appId: string, requestId?: string): Promise<boolean>;
+    /**
+     * Retrieves the OAuth client credentials (client ID and secret) for an app.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    getAppSecrets(appId: string, requestId?: string): Promise<AppSecrets>;
+    /**
+     * Rotates the app's OAuth client secret, returning the updated app record.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    resetAppClientSecret(appId: string, requestId?: string): Promise<AppWithUserCount>;
+    /**
+     * Revokes every access token issued for the given app.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    revokeAppTokens(appId: string, requestId?: string): Promise<AppWithUserCount>;
+    /**
+     * Uploads an icon for a developer application. The `size` argument
+     * selects which icon slot to update (defaults to `'medium'`).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    uploadAppIcon(args: UploadAppIconArgs, requestId?: string): Promise<AppWithUserCount>;
+    /**
+     * Gets the currently issued developer test token for an app (null if none exists).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    getAppTestToken(appId: string, requestId?: string): Promise<AppTestToken>;
+    /**
+     * Creates (or rotates) a developer test token for an app.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    createAppTestToken(appId: string, requestId?: string): Promise<AppTestToken>;
+    /**
+     * Gets the distribution token for an app, which third parties use to install it.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    getAppDistributionToken(appId: string, requestId?: string): Promise<AppDistributionToken>;
+    /**
+     * Gets the current webhook verification token for an app.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    getAppVerificationToken(appId: string, requestId?: string): Promise<AppVerificationToken>;
+    /**
+     * Resets the webhook verification token for an app, returning the new value.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    resetAppVerificationToken(appId: string, requestId?: string): Promise<AppVerificationToken>;
+    /**
+     * Resolves a public-facing app view from a distribution token. Used during
+     * the installation flow to show prospective installers what the app does
+     * and which scopes it requests.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    getAppByDistributionToken(distributionToken: string, requestId?: string): Promise<AppByDistributionToken>;
+    /**
+     * Gets the webhook configuration for an app (null if no webhook is configured).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    getAppWebhook(appId: string, requestId?: string): Promise<AppWebhook | null>;
+    /**
+     * Creates or updates an app webhook configuration (upsert).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    updateAppWebhook(args: UpdateAppWebhookArgs, requestId?: string): Promise<AppWebhook>;
+    /**
+     * Deletes an app webhook configuration.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    deleteAppWebhook(appId: string, requestId?: string): Promise<boolean>;
+    /**
+     * Lists all apps installed on the authenticated user's account.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    getAppInstallations(requestId?: string): Promise<AppInstallation[]>;
+    /**
+     * Installs an application via its distribution token.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    installApp(args: InstallAppArgs, requestId?: string): Promise<AppInstallation>;
+    /**
+     * Retrieves a single app installation by ID.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    getAppInstallation(installationId: string, requestId?: string): Promise<AppInstallation>;
+    /**
+     * Updates an app installation.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    updateAppInstallation(installationId: string, args: UpdateAppInstallationArgs, requestId?: string): Promise<AppInstallation>;
+    /**
+     * Uninstalls (removes) an app installation.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    uninstallApp(installationId: string, requestId?: string): Promise<boolean>;
+    /**
+     * Retrieves a single UI extension by ID.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    getUiExtension(uiExtensionId: string, requestId?: string): Promise<UiExtension>;
+    /**
+     * Lists UI extensions available (installed) in the web client for the current user.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    getInstalledUiExtensions(requestId?: string): Promise<UiExtension[]>;
+    /**
+     * Lists all UI extensions belonging to a given app (integration).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    getUiExtensionsForApp(appId: string, requestId?: string): Promise<UiExtension[]>;
+    /**
+     * Adds a new UI extension to an app.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    addUiExtension(args: AddUiExtensionArgs, requestId?: string): Promise<UiExtension>;
+    /**
+     * Updates an existing UI extension.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    updateUiExtension(uiExtensionId: string, args: UpdateUiExtensionArgs, requestId?: string): Promise<UiExtension>;
+    /**
+     * Deletes a UI extension.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    deleteUiExtension(uiExtensionId: string, requestId?: string): Promise<boolean>;
+    /**
+     * Uploads an icon for a UI extension.
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    uploadUiExtensionIcon(args: UploadUiExtensionIconArgs, requestId?: string): Promise<UiExtension>;
+    /**
+     * Lists all apps the user has authorized (granted a token to).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    getUserAuthorizations(requestId?: string): Promise<UserAuthorization[]>;
+    /**
+     * Revokes a specific user authorization (access token granted to a third-party app).
+     *
+     * Requires the `dev:app_console` scope.
+     */
+    revokeUserAuthorization(args: RevokeUserAuthorizationArgs, requestId?: string): Promise<boolean>;
 }

package/dist/types/transport/sync-request.d.ts

@@ -0,0 +1,27 @@
+import type { CustomFetch } from '../types/http.js';
+import { type SyncRequest, type SyncResponse } from '../types/sync/index.js';
+/**
+ * Shared context needed to issue Sync API requests.
+ *
+ * Constructed by {@link TodoistApi} and each {@link BaseClient} subclass so
+ * that sub-clients can delegate to {@link performSyncRequest} without
+ * rebuilding the HTTP identity on every call.
+ */
+export type SyncRequestContext = {
+    authToken: string;
+    syncApiBase: string;
+    customFetch?: CustomFetch;
+};
+/**
+ * Makes a request to the Sync API and handles error checking.
+ *
+ * @param ctx - HTTP identity (auth token, sync API base URI, optional custom fetch).
+ * @param syncRequest - The sync request payload.
+ * @param options - Optional request identifier and commands flag.
+ * @returns The sync response data.
+ * @throws TodoistRequestError if sync status contains errors.
+ */
+export declare function performSyncRequest(ctx: SyncRequestContext, syncRequest: SyncRequest, options?: {
+    requestId?: string;
+    hasSyncCommands?: boolean;
+}): Promise<SyncResponse>;

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

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

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

@@ -0,0 +1,89 @@
+import type { Permission } from '../../authentication.js';
+import type { AppIconSize } from '../../consts/endpoints.js';
+import type { InstallationType, WebhookEvent, WebhookVersion } from './types.js';
+/**
+ * Arguments for creating a new developer application.
+ */
+export type AddAppArgs = {
+    /** Display name of the application. */
+    displayName: string;
+    /** The application's service URL. */
+    serviceUrl: string;
+};
+/**
+ * Arguments for updating a developer application.
+ * All fields are optional — only provided fields are updated.
+ *
+ * Pass `appTokenScopes` as an array (e.g. `['data:read', 'task:add']`);
+ * the SDK serializes it to the comma-separated string the backend expects.
+ */
+export type UpdateAppArgs = {
+    /** Updated display name. */
+    displayName?: string;
+    /** Updated OAuth redirect URI. Pass `null` to clear. */
+    oauthRedirectUri?: string | null;
+    /** Updated service URL. */
+    serviceUrl?: string;
+    /** Updated app description. */
+    description?: string;
+    /**
+     * Updated list of scopes the app may request. Pass `null` to clear.
+     *
+     * Typed as `Permission | (string & {})` so known scopes get autocomplete
+     * while still permitting plain strings — needed so a fetched
+     * `App['appTokenScopes']` (typed `string[] | null`) can be passed back
+     * to `updateApp()` without casts.
+     */
+    appTokenScopes?: readonly (Permission | (string & {}))[] | null;
+};
+/**
+ * Arguments for uploading an app icon.
+ */
+export type UploadAppIconArgs = {
+    /** The application ID. */
+    appId: string;
+    /** The icon file to upload (Buffer, Stream, or file path). */
+    file: Buffer | NodeJS.ReadableStream | string | Blob;
+    /** The file name (required for Buffer/Stream uploads). */
+    fileName?: string;
+    /** Icon size variant. Defaults to `'medium'`. */
+    size?: AppIconSize;
+};
+/**
+ * Arguments for configuring (creating or updating) an app webhook.
+ */
+export type UpdateAppWebhookArgs = {
+    /** The application ID. */
+    appId: string;
+    /** The URL the webhook will POST events to. */
+    callbackUrl: string;
+    /** Events the webhook should receive. Must be unique. */
+    events: readonly WebhookEvent[];
+    /** Webhook payload version. Defaults to the backend's latest supported version. */
+    version?: WebhookVersion;
+};
+/**
+ * Arguments for installing a developer application via its distribution token.
+ */
+export type InstallAppArgs = {
+    /** The distribution token for the app being installed. */
+    distributionToken: string;
+    /** Type of installation to create. */
+    installationType: InstallationType;
+    /** Whether the requesting client has validated the app's requested scopes with the user. */
+    appTokenScopesValidated?: boolean;
+};
+/**
+ * Arguments for updating an app installation.
+ */
+export type UpdateAppInstallationArgs = {
+    /** Updated validated-scopes flag. */
+    appTokenScopesValidated?: boolean;
+};
+/**
+ * Arguments for revoking a user's authorization of a third-party app.
+ */
+export type RevokeUserAuthorizationArgs = {
+    /** The ID of the access token to revoke. */
+    accessTokenId: string;
+};