@doist/todoist-api-typescript 7.3.0 → 7.5.0

package/dist/esm/todoist-api.js

@@ -9,9 +9,12 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-import { request, isSuccess } from './rest-client.js';
-import { getSyncBaseUri, ENDPOINT_REST_TASKS, ENDPOINT_REST_TASKS_FILTER, ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE, ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE, ENDPOINT_REST_TASKS_COMPLETED_SEARCH, ENDPOINT_REST_PROJECTS, ENDPOINT_REST_PROJECTS_SEARCH, ENDPOINT_SYNC_QUICK_ADD, ENDPOINT_REST_TASK_CLOSE, ENDPOINT_REST_TASK_REOPEN, ENDPOINT_REST_TASK_MOVE, ENDPOINT_REST_LABELS, ENDPOINT_REST_LABELS_SEARCH, ENDPOINT_REST_PROJECT_COLLABORATORS, ENDPOINT_REST_SECTIONS, ENDPOINT_REST_SECTIONS_SEARCH, ENDPOINT_REST_COMMENTS, ENDPOINT_REST_LABELS_SHARED, ENDPOINT_REST_LABELS_SHARED_RENAME, ENDPOINT_REST_LABELS_SHARED_REMOVE, ENDPOINT_SYNC, PROJECT_ARCHIVE, PROJECT_UNARCHIVE, ENDPOINT_REST_PROJECTS_MOVE_TO_WORKSPACE, ENDPOINT_REST_PROJECTS_MOVE_TO_PERSONAL, ENDPOINT_REST_PROJECTS_ARCHIVED, ENDPOINT_REST_USER, ENDPOINT_REST_PRODUCTIVITY, ENDPOINT_REST_ACTIVITIES, ENDPOINT_REST_UPLOADS, ENDPOINT_WORKSPACE_INVITATIONS, ENDPOINT_WORKSPACE_INVITATIONS_ALL, ENDPOINT_WORKSPACE_INVITATIONS_DELETE, getWorkspaceInvitationAcceptEndpoint, getWorkspaceInvitationRejectEndpoint, ENDPOINT_WORKSPACE_JOIN, ENDPOINT_WORKSPACE_LOGO, ENDPOINT_WORKSPACE_PLAN_DETAILS, ENDPOINT_WORKSPACE_USERS, getWorkspaceActiveProjectsEndpoint, getWorkspaceArchivedProjectsEndpoint, } from './consts/endpoints.js';
-import { validateAttachment, validateComment, validateCommentArray, validateCurrentUser, validateLabel, validateLabelArray, validateProject, validateProjectArray, validateSection, validateSectionArray, validateTask, validateTaskArray, validateUserArray, validateProductivityStats, validateActivityEventArray, validateWorkspaceUserArray, validateWorkspaceInvitation, validateWorkspaceInvitationArray, validateWorkspacePlanDetails, validateJoinWorkspaceResult, validateWorkspaceArray, } from './utils/validators.js';
+import { DueDateSchema, } from './types/entities.js';
+import { LOCATION_TRIGGERS } from './types/sync/resources/reminders.js';
+import { REMINDER_DELIVERY_SERVICES, } from './types/requests.js';
+import { request, isSuccess } from './transport/http-client.js';
+import { getSyncBaseUri, ENDPOINT_REST_TASKS, ENDPOINT_REST_TASKS_FILTER, ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE, ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE, ENDPOINT_REST_TASKS_COMPLETED_SEARCH, ENDPOINT_REST_PROJECTS, ENDPOINT_REST_PROJECTS_SEARCH, ENDPOINT_SYNC_QUICK_ADD, ENDPOINT_REST_TASK_CLOSE, ENDPOINT_REST_TASK_REOPEN, ENDPOINT_REST_TASK_MOVE, ENDPOINT_REST_LABELS, ENDPOINT_REST_LABELS_SEARCH, ENDPOINT_REST_PROJECT_COLLABORATORS, ENDPOINT_REST_SECTIONS, ENDPOINT_REST_SECTIONS_SEARCH, ENDPOINT_REST_COMMENTS, ENDPOINT_REST_LOCATION_REMINDERS, ENDPOINT_REST_REMINDERS, ENDPOINT_REST_LABELS_SHARED, ENDPOINT_REST_LABELS_SHARED_RENAME, ENDPOINT_REST_LABELS_SHARED_REMOVE, ENDPOINT_SYNC, PROJECT_ARCHIVE, PROJECT_UNARCHIVE, ENDPOINT_REST_PROJECTS_MOVE_TO_WORKSPACE, ENDPOINT_REST_PROJECTS_MOVE_TO_PERSONAL, ENDPOINT_REST_PROJECTS_ARCHIVED, ENDPOINT_REST_PROJECTS_ARCHIVED_COUNT, ENDPOINT_REST_PROJECTS_PERMISSIONS, ENDPOINT_REST_PROJECT_FULL, ENDPOINT_REST_PROJECT_JOIN, SECTION_ARCHIVE, SECTION_UNARCHIVE, ENDPOINT_REST_USER, ENDPOINT_REST_PRODUCTIVITY, ENDPOINT_REST_ACTIVITIES, ENDPOINT_REST_UPLOADS, ENDPOINT_REST_WORKSPACES, ENDPOINT_WORKSPACE_INVITATIONS, ENDPOINT_WORKSPACE_INVITATIONS_ALL, ENDPOINT_WORKSPACE_INVITATIONS_DELETE, getWorkspaceInvitationAcceptEndpoint, getWorkspaceInvitationRejectEndpoint, ENDPOINT_WORKSPACE_JOIN, ENDPOINT_WORKSPACE_LOGO, ENDPOINT_WORKSPACE_PLAN_DETAILS, ENDPOINT_WORKSPACE_USERS, getWorkspaceActiveProjectsEndpoint, getWorkspaceArchivedProjectsEndpoint, } from './consts/endpoints.js';
+import { validateAttachment, validateComment, validateCommentArray, validateCurrentUser, validateLabel, validateLabelArray, validateProject, validateProjectArray, validateSection, validateSectionArray, validateTask, validateTaskArray, validateUserArray, validateProductivityStats, validateReminder, validateActivityEventArray, validateWorkspaceUserArray, validateWorkspaceInvitation, validateWorkspaceInvitationArray, validateWorkspacePlanDetails, validateJoinWorkspaceResult, validateWorkspace, validateWorkspaceArray, } from './utils/validators.js';
 import { formatDateToYYYYMMDD } from './utils/url-helpers.js';
 import { uploadMultipartFile } from './utils/multipart-upload.js';
 import { normalizeObjectEventTypeForApi, denormalizeObjectTypeFromApi, } from './utils/activity-helpers.js';
@@ -19,7 +22,7 @@ import { processTaskContent } from './utils/uncompletable-helpers.js';
 import { z } from 'zod';
 import { v4 as uuidv4 } from 'uuid';
 import { DATE_FORMAT_TO_API, TIME_FORMAT_TO_API, DAY_OF_WEEK_TO_API, } from './types/sync/index.js';
-import { TodoistRequestError } from './types/index.js';
+import { TodoistArgumentError, TodoistRequestError } from './types/index.js';
 const MAX_COMMAND_COUNT = 100;
 /**
  * Joins path segments using `/` separator.
@@ -80,6 +83,56 @@ function headersToRecord(headers) {
     });
     return result;
 }
+const ReminderDeliveryServiceSchema = z.enum(REMINDER_DELIVERY_SERVICES);
+const ReminderIdSchema = z.string();
+const ReminderDueDateSchema = DueDateSchema.pick({
+    date: true,
+    string: true,
+    timezone: true,
+    lang: true,
+    isRecurring: true,
+})
+    .partial()
+    .strict();
+const UpdateRelativeReminderArgsSchema = z
+    .object({
+    reminderType: z.literal('relative'),
+    minuteOffset: z.number().int().optional(),
+    notifyUid: z.string().optional(),
+    service: ReminderDeliveryServiceSchema.optional(),
+    isUrgent: z.boolean().optional(),
+})
+    .strict();
+const UpdateAbsoluteReminderArgsSchema = z
+    .object({
+    reminderType: z.literal('absolute'),
+    due: ReminderDueDateSchema.optional(),
+    notifyUid: z.string().optional(),
+    service: ReminderDeliveryServiceSchema.optional(),
+    isUrgent: z.boolean().optional(),
+})
+    .strict();
+const UpdateLocationReminderArgsSchema = z
+    .object({
+    notifyUid: z.string().optional(),
+    name: z.string().optional(),
+    locLat: z.string().optional(),
+    locLong: z.string().optional(),
+    locTrigger: z.enum(LOCATION_TRIGGERS).optional(),
+    radius: z.number().int().optional(),
+})
+    .strict()
+    .refine((args) => Object.values(args).some((value) => value !== undefined), {
+    message: 'At least one reminder field must be provided to updateLocationReminder',
+});
+const UpdateReminderArgsSchema = z
+    .discriminatedUnion('reminderType', [
+    UpdateRelativeReminderArgsSchema,
+    UpdateAbsoluteReminderArgsSchema,
+])
+    .refine((args) => Object.entries(args).some(([key, value]) => key !== 'reminderType' && value !== undefined), {
+    message: 'At least one reminder field must be provided to updateReminder',
+});
 export class TodoistApi {
     constructor(
     /**
@@ -683,6 +736,83 @@ export class TodoistApi {
         });
         return validateProject(response.data.project);
     }
+    /**
+     * 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.
+     */
+    async getArchivedProjectsCount(args = {}) {
+        const { data } = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_PROJECTS_ARCHIVED_COUNT,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return data;
+    }
+    /**
+     * Retrieves the role-to-action permission mappings for projects.
+     *
+     * @returns A promise that resolves to the permission mappings.
+     */
+    async getProjectPermissions() {
+        const { data } = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_PROJECTS_PERMISSIONS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return data;
+    }
+    /**
+     * 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.
+     */
+    async getFullProject(id, args = {}) {
+        z.string().parse(id);
+        const { data } = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_PROJECTS, id, ENDPOINT_REST_PROJECT_FULL),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            project: data.project ? validateProject(data.project) : null,
+            commentsCount: data.commentsCount,
+            tasks: validateTaskArray(data.tasks),
+            sections: validateSectionArray(data.sections),
+            collaborators: validateUserArray(data.collaborators),
+            notes: validateCommentArray(data.notes),
+        };
+    }
+    /**
+     * 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.
+     */
+    async joinProject(id, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_PROJECTS, id, ENDPOINT_REST_PROJECT_JOIN),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return validateProject(response.data);
+    }
     /**
      * Retrieves a list of collaborators for a specific project.
      *
@@ -822,6 +952,44 @@ export class TodoistApi {
         });
         return isSuccess(response);
     }
+    /**
+     * 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.
+     */
+    async archiveSection(id, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_SECTIONS, id, SECTION_ARCHIVE),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return validateSection(response.data);
+    }
+    /**
+     * 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.
+     */
+    async unarchiveSection(id, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_SECTIONS, id, SECTION_UNARCHIVE),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return validateSection(response.data);
+    }
     /**
      * Retrieves a label by its ID.
      *
@@ -846,7 +1014,7 @@ export class TodoistApi {
      * @returns A promise that resolves to an array of labels.
      */
     async getLabels(args = {}) {
-        const { data: { results, nextCursor: nextCursor }, } = await request({
+        const { data: { results, nextCursor }, } = await request({
             httpMethod: 'GET',
             baseUri: this.syncApiBase,
             relativePath: ENDPOINT_REST_LABELS,
@@ -945,7 +1113,7 @@ export class TodoistApi {
      * @returns A promise that resolves to an array of shared labels.
      */
     async getSharedLabels(args) {
-        const { data: { results, nextCursor: nextCursor }, } = await request({
+        const { data: { results, nextCursor }, } = await request({
             httpMethod: 'GET',
             baseUri: this.syncApiBase,
             relativePath: ENDPOINT_REST_LABELS_SHARED,
@@ -1085,6 +1253,208 @@ export class TodoistApi {
         });
         return isSuccess(response);
     }
+    /**
+     * 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.
+     */
+    async getReminder(id) {
+        ReminderIdSchema.parse(id);
+        try {
+            const response = await request({
+                httpMethod: 'GET',
+                baseUri: this.syncApiBase,
+                relativePath: generatePath(ENDPOINT_REST_REMINDERS, id),
+                apiToken: this.authToken,
+                customFetch: this.customFetch,
+            });
+            return validateReminder(response.data);
+        }
+        catch (error) {
+            if (!(error instanceof TodoistRequestError) || error.httpStatusCode !== 404) {
+                throw error;
+            }
+            throw new TodoistArgumentError(`Reminder ${id} was not found on the time-based reminder endpoint. If this is a location reminder, use getLocationReminder instead.`);
+        }
+    }
+    /**
+     * 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.
+     */
+    async getLocationReminder(id) {
+        ReminderIdSchema.parse(id);
+        try {
+            const response = await request({
+                httpMethod: 'GET',
+                baseUri: this.syncApiBase,
+                relativePath: generatePath(ENDPOINT_REST_LOCATION_REMINDERS, id),
+                apiToken: this.authToken,
+                customFetch: this.customFetch,
+            });
+            return validateReminder(response.data);
+        }
+        catch (error) {
+            if (!(error instanceof TodoistRequestError) || error.httpStatusCode !== 404) {
+                throw error;
+            }
+            throw new TodoistArgumentError(`Location reminder ${id} was not found on the location reminder endpoint. If this is a time-based reminder, use getReminder instead.`);
+        }
+    }
+    /**
+     * 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.
+     */
+    async addReminder(args, requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_REMINDERS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return validateReminder(response.data);
+    }
+    /**
+     * 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.
+     */
+    async addLocationReminder(args, requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_LOCATION_REMINDERS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: Object.assign(Object.assign({}, args), { reminderType: 'location' }),
+            requestId: requestId,
+        });
+        return validateReminder(response.data);
+    }
+    /**
+     * 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.
+     */
+    async updateReminder(id, args, requestId) {
+        ReminderIdSchema.parse(id);
+        const payload = UpdateReminderArgsSchema.parse(args);
+        try {
+            const response = await request({
+                httpMethod: 'POST',
+                baseUri: this.syncApiBase,
+                relativePath: generatePath(ENDPOINT_REST_REMINDERS, id),
+                apiToken: this.authToken,
+                customFetch: this.customFetch,
+                payload,
+                requestId: requestId,
+            });
+            return validateReminder(response.data);
+        }
+        catch (error) {
+            if (!(error instanceof TodoistRequestError) || error.httpStatusCode !== 404) {
+                throw error;
+            }
+            throw new TodoistArgumentError(`Reminder ${id} was not found on the time-based reminder endpoint. If this is a location reminder, use updateLocationReminder instead.`);
+        }
+    }
+    /**
+     * 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.
+     */
+    async updateLocationReminder(id, args, requestId) {
+        ReminderIdSchema.parse(id);
+        const payload = UpdateLocationReminderArgsSchema.parse(args);
+        try {
+            const response = await request({
+                httpMethod: 'POST',
+                baseUri: this.syncApiBase,
+                relativePath: generatePath(ENDPOINT_REST_LOCATION_REMINDERS, id),
+                apiToken: this.authToken,
+                customFetch: this.customFetch,
+                payload,
+                requestId: requestId,
+            });
+            return validateReminder(response.data);
+        }
+        catch (error) {
+            if (!(error instanceof TodoistRequestError) || error.httpStatusCode !== 404) {
+                throw error;
+            }
+            throw new TodoistArgumentError(`Location reminder ${id} was not found on the location reminder endpoint. If this is a time-based reminder, use updateReminder instead.`);
+        }
+    }
+    /**
+     * 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.
+     */
+    async deleteReminder(id, requestId) {
+        ReminderIdSchema.parse(id);
+        try {
+            const response = await request({
+                httpMethod: 'DELETE',
+                baseUri: this.syncApiBase,
+                relativePath: generatePath(ENDPOINT_REST_REMINDERS, id),
+                apiToken: this.authToken,
+                customFetch: this.customFetch,
+                requestId: requestId,
+            });
+            return isSuccess(response);
+        }
+        catch (error) {
+            if (!(error instanceof TodoistRequestError) || error.httpStatusCode !== 404) {
+                throw error;
+            }
+            throw new TodoistArgumentError(`Reminder ${id} was not found on the time-based reminder endpoint. If this is a location reminder, use deleteLocationReminder instead.`);
+        }
+    }
+    /**
+     * 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.
+     */
+    async deleteLocationReminder(id, requestId) {
+        ReminderIdSchema.parse(id);
+        try {
+            const response = await request({
+                httpMethod: 'DELETE',
+                baseUri: this.syncApiBase,
+                relativePath: generatePath(ENDPOINT_REST_LOCATION_REMINDERS, id),
+                apiToken: this.authToken,
+                customFetch: this.customFetch,
+                requestId: requestId,
+            });
+            return isSuccess(response);
+        }
+        catch (error) {
+            if (!(error instanceof TodoistRequestError) || error.httpStatusCode !== 404) {
+                throw error;
+            }
+            throw new TodoistArgumentError(`Location reminder ${id} was not found on the location reminder endpoint. If this is a time-based reminder, use deleteReminder instead.`);
+        }
+    }
     /**
      * Retrieves productivity stats for the authenticated user.
      *
@@ -1520,8 +1890,6 @@ export 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.
      *
@@ -1534,17 +1902,93 @@ export class TodoistApi {
      * ```
      */
     async getWorkspaces(requestId) {
-        const syncRequest = {
-            syncToken: '*',
-            resourceTypes: ['workspaces'],
-        };
-        const syncResponse = await this.requestSync(syncRequest, requestId, false);
-        const workspacesData = syncResponse.workspaces;
-        if (!workspacesData || typeof workspacesData !== 'object') {
-            return [];
-        }
-        const workspacesArray = Object.values(workspacesData);
-        return validateWorkspaceArray(workspacesArray);
+        const response = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_WORKSPACES,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return validateWorkspaceArray(response.data);
+    }
+    /**
+     * 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.
+     */
+    async getWorkspace(id, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_WORKSPACES, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return validateWorkspace(response.data);
+    }
+    /**
+     * 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.
+     */
+    async addWorkspace(args, requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_WORKSPACES,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return validateWorkspace(response.data);
+    }
+    /**
+     * 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.
+     */
+    async updateWorkspace(id, args, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_WORKSPACES, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return validateWorkspace(response.data);
+    }
+    /**
+     * 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.
+     */
+    async deleteWorkspace(id, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'DELETE',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_WORKSPACES, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return isSuccess(response);
     }
     /**
      * Gets active projects in a workspace with pagination.
@@ -1571,10 +2015,10 @@ export class TodoistApi {
             payload: queryParams,
             requestId: requestId,
         });
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+        // oxlint-disable-next-line no-unsafe-assignment, no-unsafe-call, no-unsafe-member-access
         const validatedProjects = (_a = response.data.results) === null || _a === void 0 ? void 0 : _a.map((project) => validateProject(project));
         return Object.assign(Object.assign({}, response.data), { 
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            // oxlint-disable-next-line no-unsafe-assignment
             results: validatedProjects || [] });
     }
     /**
@@ -1602,10 +2046,10 @@ export class TodoistApi {
             payload: queryParams,
             requestId: requestId,
         });
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+        // oxlint-disable-next-line no-unsafe-assignment, no-unsafe-call, no-unsafe-member-access
         const validatedProjects = (_a = response.data.results) === null || _a === void 0 ? void 0 : _a.map((project) => validateProject(project));
         return Object.assign(Object.assign({}, response.data), { 
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            // oxlint-disable-next-line no-unsafe-assignment
             results: validatedProjects || [] });
     }
 }