@doist/todoist-sdk 15.7.0 → 15.8.0

package/dist/esm/clients/filter-client.js

@@ -0,0 +1,26 @@
+import { ENDPOINT_REST_FILTERS } from '../consts/endpoints.js';
+import { isSuccess, request } from '../transport/http-client.js';
+import { generatePath } from '../utils/request-helpers.js';
+import { IdSchema } from '../utils/validators.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all filter-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public filter method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+export class FilterClient extends BaseClient {
+    async deleteFilter(id, requestId) {
+        IdSchema.parse(id);
+        const response = await request({
+            httpMethod: 'DELETE',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_FILTERS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            customHeaders: this.customHeaders,
+            requestId: requestId,
+        });
+        return isSuccess(response);
+    }
+}

package/dist/esm/consts/endpoints.js

@@ -71,6 +71,7 @@ export const ENDPOINT_GET_TOKEN = 'access_token';
 export const ENDPOINT_REVOKE = 'revoke';
 export const ENDPOINT_REGISTER = 'register';
 export const ENDPOINT_REST_FOLDERS = 'folders';
+export const ENDPOINT_REST_FILTERS = 'filters';
 // Workspace endpoints
 export const ENDPOINT_REST_WORKSPACES = 'workspaces';
 export const ENDPOINT_WORKSPACE_INVITATIONS = 'workspaces/invitations';

package/dist/esm/todoist-api.js

@@ -4,6 +4,7 @@ import { BackupClient } from './clients/backup-client.js';
 import { BillingClient } from './clients/billing-client.js';
 import { CommentClient } from './clients/comment-client.js';
 import { EmailClient } from './clients/email-client.js';
+import { FilterClient } from './clients/filter-client.js';
 import { FolderClient } from './clients/folder-client.js';
 import { IdMappingClient } from './clients/id-mapping-client.js';
 import { InsightsClient } from './clients/insights-client.js';
@@ -54,6 +55,7 @@ export class TodoistApi {
         this.reminderClient = new ReminderClient(clientDeps);
         this.insightsClient = new InsightsClient(clientDeps);
         this.folderClient = new FolderClient(clientDeps);
+        this.filterClient = new FilterClient(clientDeps);
         this.templateClient = new TemplateClient(clientDeps);
         this.uploadClient = new UploadClient(clientDeps);
         this.backupClient = new BackupClient(clientDeps);
@@ -980,6 +982,17 @@ export class TodoistApi {
     async deleteFolder(id, requestId) {
         return this.folderClient.deleteFolder(id, requestId);
     }
+    // ── Filters ──
+    /**
+     * Deletes a personal filter by its ID.
+     *
+     * @param id - The unique identifier of the filter to delete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
+    async deleteFilter(id, requestId) {
+        return this.filterClient.deleteFilter(id, requestId);
+    }
     // ── Billing ──
     /**
      * Retrieves the current user's subscription state.

package/dist/types/clients/filter-client.d.ts

@@ -0,0 +1,10 @@
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all filter-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public filter method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+export declare class FilterClient extends BaseClient {
+    deleteFilter(id: string, requestId?: string): Promise<boolean>;
+}

package/dist/types/consts/endpoints.d.ts

@@ -59,6 +59,7 @@ export declare const ENDPOINT_GET_TOKEN = "access_token";
 export declare const ENDPOINT_REVOKE = "revoke";
 export declare const ENDPOINT_REGISTER = "register";
 export declare const ENDPOINT_REST_FOLDERS = "folders";
+export declare const ENDPOINT_REST_FILTERS = "filters";
 export declare const ENDPOINT_REST_WORKSPACES = "workspaces";
 export declare const ENDPOINT_WORKSPACE_INVITATIONS = "workspaces/invitations";
 export declare const ENDPOINT_WORKSPACE_INVITATIONS_ALL = "workspaces/invitations/all";

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

@@ -76,6 +76,7 @@ export declare class TodoistApi {
     private readonly reminderClient;
     private readonly insightsClient;
     private readonly folderClient;
+    private readonly filterClient;
     private readonly templateClient;
     private readonly uploadClient;
     private readonly backupClient;
@@ -825,6 +826,14 @@ export declare class TodoistApi {
      * @returns A promise that resolves to `true` if successful.
      */
     deleteFolder(id: string, requestId?: string): Promise<boolean>;
+    /**
+     * Deletes a personal filter by its ID.
+     *
+     * @param id - The unique identifier of the filter to delete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
+    deleteFilter(id: string, requestId?: string): Promise<boolean>;
     /**
      * Retrieves the current user's subscription state.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-sdk",
-    "version": "15.7.0",
+    "version": "15.8.0",
     "description": "The official TypeScript SDK for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-sdk-typescript",
@@ -72,7 +72,7 @@
         "ts-node": "10.9.2",
         "type-fest": "^5.0.0",
         "typescript": "5.9.3",
-        "vitest": "4.1.11"
+        "vitest": "4.1.12"
     },
     "peerDependencies": {
         "type-fest": "^4.12.0 || ^5.5.0"