@doist/todoist-sdk 9.0.0 → 9.1.0-next.2

package/dist/cjs/clients/label-client.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LabelClient = void 0;
+const zod_1 = require("zod");
+const endpoints_1 = require("../consts/endpoints");
+const http_client_1 = require("../transport/http-client");
+const request_helpers_1 = require("../utils/request-helpers");
+const validators_1 = require("../utils/validators");
+const base_client_1 = require("./base-client");
+/**
+ * Internal sub-client handling all label-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public label method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+class LabelClient extends base_client_1.BaseClient {
+    async getLabel(id) {
+        zod_1.z.string().parse(id);
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_LABELS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return (0, validators_1.validateLabel)(response.data);
+    }
+    async getLabels(args = {}) {
+        const { data: { results, nextCursor }, } = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_LABELS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: (0, validators_1.validateLabelArray)(results),
+            nextCursor,
+        };
+    }
+    async searchLabels(args) {
+        const { data: { results, nextCursor }, } = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_LABELS_SEARCH,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: (0, validators_1.validateLabelArray)(results),
+            nextCursor,
+        };
+    }
+    async addLabel(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_LABELS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return (0, validators_1.validateLabel)(response.data);
+    }
+    async updateLabel(id, args, requestId) {
+        zod_1.z.string().parse(id);
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_LABELS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return (0, validators_1.validateLabel)(response.data);
+    }
+    async deleteLabel(id, requestId) {
+        zod_1.z.string().parse(id);
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'DELETE',
+            baseUri: this.syncApiBase,
+            relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_LABELS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return (0, http_client_1.isSuccess)(response);
+    }
+    async getSharedLabels(args) {
+        const { data: { results, nextCursor }, } = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_LABELS_SHARED,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return { results, nextCursor };
+    }
+    async renameSharedLabel(args) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_LABELS_SHARED_RENAME,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return (0, http_client_1.isSuccess)(response);
+    }
+    async removeSharedLabel(args) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_LABELS_SHARED_REMOVE,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return (0, http_client_1.isSuccess)(response);
+    }
+}
+exports.LabelClient = LabelClient;

package/dist/cjs/clients/productivity-client.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductivityClient = void 0;
+const endpoints_1 = require("../consts/endpoints");
+const http_client_1 = require("../transport/http-client");
+const validators_1 = require("../utils/validators");
+const base_client_1 = require("./base-client");
+/**
+ * Internal sub-client handling the productivity-stats endpoint.
+ *
+ * Instantiated by `TodoistApi`; the public `getProductivityStats` method
+ * on `TodoistApi` delegates here. See `todoist-api.ts` for user-facing
+ * JSDoc.
+ */
+class ProductivityClient extends base_client_1.BaseClient {
+    async getProductivityStats() {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_PRODUCTIVITY,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return (0, validators_1.validateProductivityStats)(response.data);
+    }
+}
+exports.ProductivityClient = ProductivityClient;

package/dist/cjs/clients/project-client.js

@@ -0,0 +1,232 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectClient = void 0;
+const zod_1 = require("zod");
+const endpoints_1 = require("../consts/endpoints");
+const http_client_1 = require("../transport/http-client");
+const request_helpers_1 = require("../utils/request-helpers");
+const validators_1 = require("../utils/validators");
+const base_client_1 = require("./base-client");
+/**
+ * Internal sub-client handling all project-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public project method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+class ProjectClient extends base_client_1.BaseClient {
+    async getProject(id) {
+        zod_1.z.string().parse(id);
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_PROJECTS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return (0, validators_1.validateProject)(response.data);
+    }
+    async getProjects(args = {}) {
+        const { data: { results, nextCursor }, } = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_PROJECTS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: (0, validators_1.validateProjectArray)(results),
+            nextCursor,
+        };
+    }
+    async searchProjects(args) {
+        const { data: { results, nextCursor }, } = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_PROJECTS_SEARCH,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: (0, validators_1.validateProjectArray)(results),
+            nextCursor,
+        };
+    }
+    async getArchivedProjects(args = {}) {
+        const { data: { results, nextCursor }, } = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_PROJECTS_ARCHIVED,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: (0, validators_1.validateProjectArray)(results),
+            nextCursor,
+        };
+    }
+    async addProject(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_PROJECTS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return (0, validators_1.validateProject)(response.data);
+    }
+    async updateProject(id, args, requestId) {
+        zod_1.z.string().parse(id);
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_PROJECTS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return (0, validators_1.validateProject)(response.data);
+    }
+    async deleteProject(id, requestId) {
+        zod_1.z.string().parse(id);
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'DELETE',
+            baseUri: this.syncApiBase,
+            relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_PROJECTS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return (0, http_client_1.isSuccess)(response);
+    }
+    async archiveProject(id, requestId) {
+        zod_1.z.string().parse(id);
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_PROJECTS, id, endpoints_1.PROJECT_ARCHIVE),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return (0, validators_1.validateProject)(response.data);
+    }
+    async unarchiveProject(id, requestId) {
+        zod_1.z.string().parse(id);
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_PROJECTS, id, endpoints_1.PROJECT_UNARCHIVE),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return (0, validators_1.validateProject)(response.data);
+    }
+    async moveProjectToWorkspace(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_PROJECTS_MOVE_TO_WORKSPACE,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return (0, validators_1.validateProject)(response.data.project);
+    }
+    async moveProjectToPersonal(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_PROJECTS_MOVE_TO_PERSONAL,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return (0, validators_1.validateProject)(response.data.project);
+    }
+    async getArchivedProjectsCount(args = {}) {
+        const { data } = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_PROJECTS_ARCHIVED_COUNT,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return data;
+    }
+    async getProjectPermissions() {
+        const { data } = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_PROJECTS_PERMISSIONS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return data;
+    }
+    async getFullProject(id, args = {}) {
+        zod_1.z.string().parse(id);
+        const { data } = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_PROJECTS, id, endpoints_1.ENDPOINT_REST_PROJECT_FULL),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            project: data.project ? (0, validators_1.validateProject)(data.project) : null,
+            commentsCount: data.commentsCount,
+            tasks: (0, validators_1.validateTaskArray)(data.tasks),
+            sections: (0, validators_1.validateSectionArray)(data.sections),
+            collaborators: (0, validators_1.validateUserArray)(data.collaborators),
+            notes: (0, validators_1.validateCommentArray)(data.notes),
+        };
+    }
+    async joinProject(id, requestId) {
+        zod_1.z.string().parse(id);
+        const { data } = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_PROJECTS, id, endpoints_1.ENDPOINT_REST_PROJECT_JOIN),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return {
+            project: (0, validators_1.validateWorkspaceProject)(data.project),
+            tasks: (0, validators_1.validateTaskArray)(data.tasks),
+            sections: (0, validators_1.validateSectionArray)(data.sections),
+            comments: (0, validators_1.validateNoteArray)(data.comments),
+            collaborators: (0, validators_1.validateCollaboratorArray)(data.collaborators),
+            collaboratorStates: (0, validators_1.validateCollaboratorStateArray)(data.collaboratorStates),
+            folder: data.folder ? (0, validators_1.validateFolder)(data.folder) : null,
+            subprojects: (0, validators_1.validateWorkspaceProjectArray)(data.subprojects),
+        };
+    }
+    async getProjectCollaborators(projectId, args = {}) {
+        zod_1.z.string().parse(projectId);
+        const { data: { results, nextCursor }, } = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_PROJECTS, projectId, endpoints_1.ENDPOINT_REST_PROJECT_COLLABORATORS),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: (0, validators_1.validateUserArray)(results),
+            nextCursor,
+        };
+    }
+}
+exports.ProjectClient = ProjectClient;

package/dist/cjs/clients/reminder-client.js

@@ -0,0 +1,198 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReminderClient = void 0;
+const endpoints_1 = require("../consts/endpoints");
+const http_client_1 = require("../transport/http-client");
+const types_1 = require("../types");
+const reminders_1 = require("../types/reminders");
+const reminders_2 = require("../types/sync/resources/reminders");
+const request_helpers_1 = require("../utils/request-helpers");
+const validators_1 = require("../utils/validators");
+const base_client_1 = require("./base-client");
+/**
+ * Internal sub-client handling all reminder-domain endpoints
+ * (both time-based and location-based reminders).
+ *
+ * Instantiated by `TodoistApi`; every public reminder method on
+ * `TodoistApi` delegates here. See `todoist-api.ts` for user-facing
+ * JSDoc. The time-vs-location 404 translation is preserved here so a
+ * caller who used the wrong endpoint gets a TodoistArgumentError
+ * pointing at the correct method, rather than a bare 404.
+ */
+class ReminderClient extends base_client_1.BaseClient {
+    async getReminders(args = {}) {
+        const { data: { results, nextCursor }, } = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_REMINDERS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: (0, validators_1.validateReminderArray)(results),
+            nextCursor,
+        };
+    }
+    async getLocationReminders(args = {}) {
+        const { data: { results, nextCursor }, } = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_LOCATION_REMINDERS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: (0, validators_1.validateLocationReminderArray)(results),
+            nextCursor,
+        };
+    }
+    async getReminder(id) {
+        reminders_1.ReminderIdSchema.parse(id);
+        try {
+            const response = await (0, http_client_1.request)({
+                httpMethod: 'GET',
+                baseUri: this.syncApiBase,
+                relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_REMINDERS, id),
+                apiToken: this.authToken,
+                customFetch: this.customFetch,
+            });
+            return (0, validators_1.validateReminder)(response.data);
+        }
+        catch (error) {
+            if (!(error instanceof types_1.TodoistRequestError) || error.httpStatusCode !== 404) {
+                throw error;
+            }
+            throw new types_1.TodoistArgumentError(`Reminder ${id} was not found on the time-based reminder endpoint. If this is a location reminder, use getLocationReminder instead.`);
+        }
+    }
+    async getLocationReminder(id) {
+        reminders_1.ReminderIdSchema.parse(id);
+        try {
+            const response = await (0, http_client_1.request)({
+                httpMethod: 'GET',
+                baseUri: this.syncApiBase,
+                relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_LOCATION_REMINDERS, id),
+                apiToken: this.authToken,
+                customFetch: this.customFetch,
+            });
+            return (0, validators_1.validateReminder)(response.data);
+        }
+        catch (error) {
+            if (!(error instanceof types_1.TodoistRequestError) || error.httpStatusCode !== 404) {
+                throw error;
+            }
+            throw new types_1.TodoistArgumentError(`Location reminder ${id} was not found on the location reminder endpoint. If this is a time-based reminder, use getReminder instead.`);
+        }
+    }
+    async addReminder(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_REMINDERS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return (0, validators_1.validateReminder)(response.data);
+    }
+    async addLocationReminder(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_LOCATION_REMINDERS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: Object.assign(Object.assign({}, args), { reminderType: reminders_2.ReminderTypeEnum.Location }),
+            requestId: requestId,
+        });
+        return (0, validators_1.validateReminder)(response.data);
+    }
+    async updateReminder(id, args, requestId) {
+        reminders_1.ReminderIdSchema.parse(id);
+        const payload = reminders_1.UpdateReminderArgsSchema.parse(args);
+        try {
+            const response = await (0, http_client_1.request)({
+                httpMethod: 'POST',
+                baseUri: this.syncApiBase,
+                relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_REMINDERS, id),
+                apiToken: this.authToken,
+                customFetch: this.customFetch,
+                payload,
+                requestId: requestId,
+            });
+            return (0, validators_1.validateReminder)(response.data);
+        }
+        catch (error) {
+            if (!(error instanceof types_1.TodoistRequestError) || error.httpStatusCode !== 404) {
+                throw error;
+            }
+            throw new types_1.TodoistArgumentError(`Reminder ${id} was not found on the time-based reminder endpoint. If this is a location reminder, use updateLocationReminder instead.`);
+        }
+    }
+    async updateLocationReminder(id, args, requestId) {
+        reminders_1.ReminderIdSchema.parse(id);
+        const payload = reminders_1.UpdateLocationReminderArgsSchema.parse(args);
+        try {
+            const response = await (0, http_client_1.request)({
+                httpMethod: 'POST',
+                baseUri: this.syncApiBase,
+                relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_LOCATION_REMINDERS, id),
+                apiToken: this.authToken,
+                customFetch: this.customFetch,
+                payload,
+                requestId: requestId,
+            });
+            return (0, validators_1.validateReminder)(response.data);
+        }
+        catch (error) {
+            if (!(error instanceof types_1.TodoistRequestError) || error.httpStatusCode !== 404) {
+                throw error;
+            }
+            throw new types_1.TodoistArgumentError(`Location reminder ${id} was not found on the location reminder endpoint. If this is a time-based reminder, use updateReminder instead.`);
+        }
+    }
+    async deleteReminder(id, requestId) {
+        reminders_1.ReminderIdSchema.parse(id);
+        try {
+            const response = await (0, http_client_1.request)({
+                httpMethod: 'DELETE',
+                baseUri: this.syncApiBase,
+                relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_REMINDERS, id),
+                apiToken: this.authToken,
+                customFetch: this.customFetch,
+                requestId: requestId,
+            });
+            return (0, http_client_1.isSuccess)(response);
+        }
+        catch (error) {
+            if (!(error instanceof types_1.TodoistRequestError) || error.httpStatusCode !== 404) {
+                throw error;
+            }
+            throw new types_1.TodoistArgumentError(`Reminder ${id} was not found on the time-based reminder endpoint. If this is a location reminder, use deleteLocationReminder instead.`);
+        }
+    }
+    async deleteLocationReminder(id, requestId) {
+        reminders_1.ReminderIdSchema.parse(id);
+        try {
+            const response = await (0, http_client_1.request)({
+                httpMethod: 'DELETE',
+                baseUri: this.syncApiBase,
+                relativePath: (0, request_helpers_1.generatePath)(endpoints_1.ENDPOINT_REST_LOCATION_REMINDERS, id),
+                apiToken: this.authToken,
+                customFetch: this.customFetch,
+                requestId: requestId,
+            });
+            return (0, http_client_1.isSuccess)(response);
+        }
+        catch (error) {
+            if (!(error instanceof types_1.TodoistRequestError) || error.httpStatusCode !== 404) {
+                throw error;
+            }
+            throw new types_1.TodoistArgumentError(`Location reminder ${id} was not found on the location reminder endpoint. If this is a time-based reminder, use deleteReminder instead.`);
+        }
+    }
+}
+exports.ReminderClient = ReminderClient;