@doist/todoist-api-typescript 4.0.0-alpha.2 → 4.0.0-alpha.3

package/dist/TodoistApi.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -37,11 +48,14 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TodoistApi = void 0;
-var runtypes_1 = require("runtypes");
 var restClient_1 = require("./restClient");
 var taskConverters_1 = require("./utils/taskConverters");
 var endpoints_1 = require("./consts/endpoints");
 var validators_1 = require("./utils/validators");
+var zod_1 = require("zod");
+var uuid_1 = require("uuid");
+var types_1 = require("./types");
+var MAX_COMMAND_COUNT = 100;
 /**
  * Joins path segments using `/` separator.
  * @param segments A list of **valid** path segments.
@@ -54,18 +68,51 @@ function generatePath() {
     }
     return segments.join('/');
 }
+/**
+ * A client for interacting with the Todoist Sync API.
+ * 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'
+ * });
+ * ```
+ *
+ */
 var TodoistApi = /** @class */ (function () {
-    function TodoistApi(authToken, baseUrl) {
+    function TodoistApi(
+    /**
+     * Your Todoist API token.
+     */
+    authToken, 
+    /**
+     * Optional custom API base URL. If not provided, defaults to Todoist's standard API endpoint
+     */
+    baseUrl) {
         this.authToken = authToken;
         this.syncApiBase = (0, endpoints_1.getSyncBaseUri)(baseUrl);
     }
+    /**
+     * 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.
+     */
     TodoistApi.prototype.getTask = function (id) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_TASKS, id), this.authToken)];
                     case 1:
                         response = _a.sent();
@@ -74,6 +121,12 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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.
+     */
     TodoistApi.prototype.getTasks = function (args) {
         if (args === void 0) { args = {}; }
         return __awaiter(this, void 0, void 0, function () {
@@ -91,6 +144,13 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Creates a new task with the provided parameters.
+     *
+     * @param args - Task creation parameters such as content, due date, or priority.
+     * @param requestId - Optional unique identifier for idempotency.
+     * @returns A promise that resolves to the created task.
+     */
     TodoistApi.prototype.addTask = function (args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
@@ -104,6 +164,12 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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.
+     */
     TodoistApi.prototype.quickAddTask = function (args) {
         return __awaiter(this, void 0, void 0, function () {
             var response, task;
@@ -118,13 +184,21 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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.
+     * @param requestId - Optional unique identifier for idempotency.
+     * @returns A promise that resolves to the updated task.
+     */
     TodoistApi.prototype.updateTask = function (id, args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('POST', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_TASKS, id), this.authToken, args, requestId)];
                     case 1:
                         response = _a.sent();
@@ -133,13 +207,73 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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 unique identifier for idempotency.
+     * @returns - A promise that resolves to an array of the updated tasks.
+     */
+    TodoistApi.prototype.moveTasks = function (ids, args, requestId) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var uuid, commands, syncRequest, response, syncTasks, tasks;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (ids.length > MAX_COMMAND_COUNT) {
+                            throw new types_1.TodoistRequestError("Maximum number of items is ".concat(MAX_COMMAND_COUNT), 400);
+                        }
+                        uuid = (0, uuid_1.v4)();
+                        commands = ids.map(function (id) { return ({
+                            type: 'item_move',
+                            uuid: uuid,
+                            args: __assign(__assign(__assign({ id: id }, (args.projectId && { project_id: args.projectId })), (args.sectionId && { section_id: args.sectionId })), (args.parentId && { parent_id: args.parentId })),
+                        }); });
+                        syncRequest = {
+                            commands: commands,
+                            resource_types: ['items'],
+                        };
+                        return [4 /*yield*/, (0, restClient_1.request)('POST', this.syncApiBase, endpoints_1.ENDPOINT_SYNC, this.authToken, syncRequest, requestId, 
+                            /*hasSyncCommands: */ true)];
+                    case 1:
+                        response = _b.sent();
+                        if (response.data.sync_status) {
+                            Object.entries(response.data.sync_status).forEach(function (_a) {
+                                var _ = _a[0], value = _a[1];
+                                if (value === 'ok')
+                                    return;
+                                throw new types_1.TodoistRequestError(value.error, value.http_code, value.error_extra);
+                            });
+                        }
+                        if (!((_a = response.data.items) === null || _a === void 0 ? void 0 : _a.length)) {
+                            throw new types_1.TodoistRequestError('Tasks not found', 404);
+                        }
+                        syncTasks = response.data.items.filter(function (task) { return ids.includes(task.id); });
+                        if (!syncTasks.length) {
+                            throw new types_1.TodoistRequestError('Tasks not found', 404);
+                        }
+                        tasks = syncTasks.map(taskConverters_1.getTaskFromQuickAddResponse);
+                        return [2 /*return*/, (0, validators_1.validateTaskArray)(tasks)];
+                }
+            });
+        });
+    };
+    /**
+     * Closes (completes) a task by its ID.
+     *
+     * @param id - The unique identifier of the task to close.
+     * @param requestId - Optional unique identifier for idempotency.
+     * @returns A promise that resolves to `true` if successful.
+     */
     TodoistApi.prototype.closeTask = function (id, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('POST', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_TASKS, id, endpoints_1.ENDPOINT_REST_TASK_CLOSE), this.authToken, undefined, requestId)];
                     case 1:
                         response = _a.sent();
@@ -148,13 +282,20 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Reopens a previously closed (completed) task by its ID.
+     *
+     * @param id - The unique identifier of the task to reopen.
+     * @param requestId - Optional unique identifier for idempotency.
+     * @returns A promise that resolves to `true` if successful.
+     */
     TodoistApi.prototype.reopenTask = function (id, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('POST', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_TASKS, id, endpoints_1.ENDPOINT_REST_TASK_REOPEN), this.authToken, undefined, requestId)];
                     case 1:
                         response = _a.sent();
@@ -163,13 +304,20 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Deletes a task by its ID.
+     *
+     * @param id - The unique identifier of the task to delete.
+     * @param requestId - Optional unique identifier for idempotency.
+     * @returns A promise that resolves to `true` if successful.
+     */
     TodoistApi.prototype.deleteTask = function (id, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('DELETE', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_TASKS, id), this.authToken, undefined, requestId)];
                     case 1:
                         response = _a.sent();
@@ -178,13 +326,19 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Retrieves a project by its ID.
+     *
+     * @param id - The unique identifier of the project.
+     * @returns A promise that resolves to the requested project.
+     */
     TodoistApi.prototype.getProject = function (id) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_PROJECTS, id), this.authToken)];
                     case 1:
                         response = _a.sent();
@@ -193,6 +347,12 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Retrieves all projects with optional filters.
+     *
+     * @param args - Optional filters for retrieving projects.
+     * @returns A promise that resolves to an array of projects.
+     */
     TodoistApi.prototype.getProjects = function (args) {
         if (args === void 0) { args = {}; }
         return __awaiter(this, void 0, void 0, function () {
@@ -210,6 +370,13 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Creates a new project with the provided parameters.
+     *
+     * @param args - Project creation parameters such as name or color.
+     * @param requestId - Optional unique identifier for idempotency.
+     * @returns A promise that resolves to the created project.
+     */
     TodoistApi.prototype.addProject = function (args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
@@ -223,13 +390,21 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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 unique identifier for idempotency.
+     * @returns A promise that resolves to the updated project.
+     */
     TodoistApi.prototype.updateProject = function (id, args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('POST', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_PROJECTS, id), this.authToken, args, requestId)];
                     case 1:
                         response = _a.sent();
@@ -238,13 +413,20 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Deletes a project by its ID.
+     *
+     * @param id - The unique identifier of the project to delete.
+     * @param requestId - Optional unique identifier for idempotency.
+     * @returns A promise that resolves to `true` if successful.
+     */
     TodoistApi.prototype.deleteProject = function (id, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('DELETE', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_PROJECTS, id), this.authToken, undefined, requestId)];
                     case 1:
                         response = _a.sent();
@@ -253,6 +435,13 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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.
+     */
     TodoistApi.prototype.getProjectCollaborators = function (projectId, args) {
         if (args === void 0) { args = {}; }
         return __awaiter(this, void 0, void 0, function () {
@@ -260,7 +449,7 @@ var TodoistApi = /** @class */ (function () {
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        runtypes_1.String.check(projectId);
+                        zod_1.z.string().parse(projectId);
                         return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_PROJECTS, projectId, endpoints_1.ENDPOINT_REST_PROJECT_COLLABORATORS), this.authToken, args)];
                     case 1:
                         _a = (_b.sent()).data, results = _a.results, nextCursor = _a.nextCursor;
@@ -272,6 +461,12 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Retrieves all sections within a specific project or matching criteria.
+     *
+     * @param args - Filter parameters such as project ID.
+     * @returns A promise that resolves to an array of sections.
+     */
     TodoistApi.prototype.getSections = function (args) {
         return __awaiter(this, void 0, void 0, function () {
             var _a, results, nextCursor;
@@ -288,13 +483,19 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Retrieves a single section by its ID.
+     *
+     * @param id - The unique identifier of the section.
+     * @returns A promise that resolves to the requested section.
+     */
     TodoistApi.prototype.getSection = function (id) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_SECTIONS, id), this.authToken)];
                     case 1:
                         response = _a.sent();
@@ -303,6 +504,13 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Creates a new section within a project.
+     *
+     * @param args - Section creation parameters such as name or project ID.
+     * @param requestId - Optional unique identifier for idempotency.
+     * @returns A promise that resolves to the created section.
+     */
     TodoistApi.prototype.addSection = function (args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
@@ -316,13 +524,21 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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 unique identifier for idempotency.
+     * @returns A promise that resolves to the updated section.
+     */
     TodoistApi.prototype.updateSection = function (id, args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('POST', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_SECTIONS, id), this.authToken, args, requestId)];
                     case 1:
                         response = _a.sent();
@@ -331,13 +547,20 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Deletes a section by its ID.
+     *
+     * @param id - The unique identifier of the section to delete.
+     * @param requestId - Optional unique identifier for idempotency.
+     * @returns A promise that resolves to `true` if successful.
+     */
     TodoistApi.prototype.deleteSection = function (id, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('DELETE', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_SECTIONS, id), this.authToken, undefined, requestId)];
                     case 1:
                         response = _a.sent();
@@ -347,7 +570,10 @@ var TodoistApi = /** @class */ (function () {
         });
     };
     /**
-     * Fetches a personal label
+     * Retrieves a label by its ID.
+     *
+     * @param id - The unique identifier of the label.
+     * @returns A promise that resolves to the requested label.
      */
     TodoistApi.prototype.getLabel = function (id) {
         return __awaiter(this, void 0, void 0, function () {
@@ -355,7 +581,7 @@ var TodoistApi = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_LABELS, id), this.authToken)];
                     case 1:
                         response = _a.sent();
@@ -365,7 +591,10 @@ var TodoistApi = /** @class */ (function () {
         });
     };
     /**
-     * Fetches the personal labels
+     * Retrieves all labels.
+     *
+     * @param args - Optional filter parameters.
+     * @returns A promise that resolves to an array of labels.
      */
     TodoistApi.prototype.getLabels = function (args) {
         if (args === void 0) { args = {}; }
@@ -385,7 +614,11 @@ var TodoistApi = /** @class */ (function () {
         });
     };
     /**
-     * Adds a personal label
+     * Adds a new label.
+     *
+     * @param args - Label creation parameters such as name.
+     * @param requestId - Optional unique identifier for idempotency.
+     * @returns A promise that resolves to the created label.
      */
     TodoistApi.prototype.addLabel = function (args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
@@ -401,7 +634,12 @@ var TodoistApi = /** @class */ (function () {
         });
     };
     /**
-     * Updates a personal 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 unique identifier for idempotency.
+     * @returns A promise that resolves to the updated label.
      */
     TodoistApi.prototype.updateLabel = function (id, args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
@@ -409,7 +647,7 @@ var TodoistApi = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('POST', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_LABELS, id), this.authToken, args, requestId)];
                     case 1:
                         response = _a.sent();
@@ -419,7 +657,11 @@ var TodoistApi = /** @class */ (function () {
         });
     };
     /**
-     * Deletes a personal label
+     * Deletes a label by its ID.
+     *
+     * @param id - The unique identifier of the label to delete.
+     * @param requestId - Optional unique identifier for idempotency.
+     * @returns A promise that resolves to `true` if successful.
      */
     TodoistApi.prototype.deleteLabel = function (id, requestId) {
         return __awaiter(this, void 0, void 0, function () {
@@ -427,7 +669,7 @@ var TodoistApi = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('DELETE', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_LABELS, id), this.authToken, undefined, requestId)];
                     case 1:
                         response = _a.sent();
@@ -436,6 +678,12 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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.
+     */
     TodoistApi.prototype.getSharedLabels = function (args) {
         return __awaiter(this, void 0, void 0, function () {
             var _a, results, nextCursor;
@@ -449,6 +697,12 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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.
+     */
     TodoistApi.prototype.renameSharedLabel = function (args) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
@@ -462,6 +716,12 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Removes a shared label.
+     *
+     * @param args - Parameters for removing the shared label.
+     * @returns A promise that resolves to `true` if successful.
+     */
     TodoistApi.prototype.removeSharedLabel = function (args) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
@@ -475,6 +735,12 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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.
+     */
     TodoistApi.prototype.getComments = function (args) {
         return __awaiter(this, void 0, void 0, function () {
             var _a, results, nextCursor;
@@ -491,13 +757,19 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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.
+     */
     TodoistApi.prototype.getComment = function (id) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('GET', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_COMMENTS, id), this.authToken)];
                     case 1:
                         response = _a.sent();
@@ -506,6 +778,13 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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 unique identifier for idempotency.
+     * @returns A promise that resolves to the created comment.
+     */
     TodoistApi.prototype.addComment = function (args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
@@ -519,13 +798,21 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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 unique identifier for idempotency.
+     * @returns A promise that resolves to the updated comment.
+     */
     TodoistApi.prototype.updateComment = function (id, args, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('POST', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_COMMENTS, id), this.authToken, args, requestId)];
                     case 1:
                         response = _a.sent();
@@ -534,13 +821,20 @@ var TodoistApi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Deletes a comment by its ID.
+     *
+     * @param id - The unique identifier of the comment to delete.
+     * @param requestId - Optional unique identifier for idempotency.
+     * @returns A promise that resolves to `true` if successful.
+     */
     TodoistApi.prototype.deleteComment = function (id, requestId) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        runtypes_1.String.check(id);
+                        zod_1.z.string().parse(id);
                         return [4 /*yield*/, (0, restClient_1.request)('DELETE', this.syncApiBase, generatePath(endpoints_1.ENDPOINT_REST_COMMENTS, id), this.authToken, undefined, requestId)];
                     case 1:
                         response = _a.sent();