@doist/todoist-api-typescript 6.2.1 → 6.4.0

package/dist/cjs/consts/endpoints.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ENDPOINT_WORKSPACE_USERS = exports.ENDPOINT_WORKSPACE_PLAN_DETAILS = exports.ENDPOINT_WORKSPACE_LOGO = exports.ENDPOINT_WORKSPACE_JOIN = exports.ENDPOINT_WORKSPACE_INVITATIONS_DELETE = exports.ENDPOINT_WORKSPACE_INVITATIONS_ALL = exports.ENDPOINT_WORKSPACE_INVITATIONS = exports.ENDPOINT_REVOKE = exports.ENDPOINT_REVOKE_TOKEN = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.PROJECT_UNARCHIVE = exports.PROJECT_ARCHIVE = exports.ENDPOINT_REST_UPLOADS = exports.ENDPOINT_REST_ACTIVITIES = exports.ENDPOINT_REST_PRODUCTIVITY = exports.ENDPOINT_REST_USER = exports.ENDPOINT_REST_PROJECT_COLLABORATORS = exports.ENDPOINT_REST_PROJECTS_ARCHIVED = exports.ENDPOINT_REST_PROJECTS = exports.ENDPOINT_REST_TASK_MOVE = exports.ENDPOINT_REST_TASK_REOPEN = exports.ENDPOINT_REST_TASK_CLOSE = exports.ENDPOINT_REST_COMMENTS = exports.ENDPOINT_REST_LABELS_SHARED_REMOVE = exports.ENDPOINT_REST_LABELS_SHARED_RENAME = exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS = exports.ENDPOINT_REST_SECTIONS = exports.ENDPOINT_REST_TASKS_COMPLETED_SEARCH = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = exports.ENDPOINT_REST_TASKS_FILTER = exports.ENDPOINT_REST_TASKS = exports.API_BASE_URI = exports.API_VERSION = exports.TODOIST_WEB_URI = void 0;
+exports.ENDPOINT_WORKSPACE_USERS = exports.ENDPOINT_WORKSPACE_PLAN_DETAILS = exports.ENDPOINT_WORKSPACE_LOGO = exports.ENDPOINT_WORKSPACE_JOIN = exports.ENDPOINT_WORKSPACE_INVITATIONS_DELETE = exports.ENDPOINT_WORKSPACE_INVITATIONS_ALL = exports.ENDPOINT_WORKSPACE_INVITATIONS = exports.ENDPOINT_REVOKE = exports.ENDPOINT_REVOKE_TOKEN = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.PROJECT_UNARCHIVE = exports.PROJECT_ARCHIVE = exports.ENDPOINT_REST_UPLOADS = exports.ENDPOINT_REST_ACTIVITIES = exports.ENDPOINT_REST_PRODUCTIVITY = exports.ENDPOINT_REST_USER = exports.ENDPOINT_REST_PROJECT_COLLABORATORS = exports.ENDPOINT_REST_PROJECTS_ARCHIVED = exports.ENDPOINT_REST_PROJECTS_SEARCH = exports.ENDPOINT_REST_PROJECTS = exports.ENDPOINT_REST_TASK_MOVE = exports.ENDPOINT_REST_TASK_REOPEN = exports.ENDPOINT_REST_TASK_CLOSE = exports.ENDPOINT_REST_COMMENTS = exports.ENDPOINT_REST_LABELS_SHARED_REMOVE = exports.ENDPOINT_REST_LABELS_SHARED_RENAME = exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS_SEARCH = exports.ENDPOINT_REST_LABELS = exports.ENDPOINT_REST_SECTIONS_SEARCH = exports.ENDPOINT_REST_SECTIONS = exports.ENDPOINT_REST_TASKS_COMPLETED_SEARCH = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = exports.ENDPOINT_REST_TASKS_FILTER = exports.ENDPOINT_REST_TASKS = exports.API_BASE_URI = exports.API_VERSION = exports.TODOIST_WEB_URI = void 0;
 exports.getSyncBaseUri = getSyncBaseUri;
 exports.getAuthBaseUri = getAuthBaseUri;
 exports.getWorkspaceInvitationAcceptEndpoint = getWorkspaceInvitationAcceptEndpoint;
@@ -27,7 +27,9 @@ exports.ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = exports.ENDPOINT_REST
 exports.ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = exports.ENDPOINT_REST_TASKS + '/completed/by_due_date';
 exports.ENDPOINT_REST_TASKS_COMPLETED_SEARCH = 'completed/search';
 exports.ENDPOINT_REST_SECTIONS = 'sections';
+exports.ENDPOINT_REST_SECTIONS_SEARCH = exports.ENDPOINT_REST_SECTIONS + '/search';
 exports.ENDPOINT_REST_LABELS = 'labels';
+exports.ENDPOINT_REST_LABELS_SEARCH = exports.ENDPOINT_REST_LABELS + '/search';
 exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS + '/shared';
 exports.ENDPOINT_REST_LABELS_SHARED_RENAME = exports.ENDPOINT_REST_LABELS_SHARED + '/rename';
 exports.ENDPOINT_REST_LABELS_SHARED_REMOVE = exports.ENDPOINT_REST_LABELS_SHARED + '/remove';
@@ -36,6 +38,7 @@ exports.ENDPOINT_REST_TASK_CLOSE = 'close';
 exports.ENDPOINT_REST_TASK_REOPEN = 'reopen';
 exports.ENDPOINT_REST_TASK_MOVE = 'move';
 exports.ENDPOINT_REST_PROJECTS = 'projects';
+exports.ENDPOINT_REST_PROJECTS_SEARCH = exports.ENDPOINT_REST_PROJECTS + '/search';
 exports.ENDPOINT_REST_PROJECTS_ARCHIVED = exports.ENDPOINT_REST_PROJECTS + '/archived';
 exports.ENDPOINT_REST_PROJECT_COLLABORATORS = 'collaborators';
 exports.ENDPOINT_REST_USER = 'user';

package/dist/cjs/todoist-api.js

@@ -46,6 +46,36 @@ class TodoistApi {
             this.customFetch = options.customFetch;
         }
     }
+    /**
+     * 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
+     */
+    async requestSync(syncRequest, requestId, hasSyncCommands = false) {
+        const response = await (0, rest_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_SYNC,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: syncRequest,
+            requestId: requestId,
+            hasSyncCommands: hasSyncCommands,
+        });
+        // Check for sync errors and throw if any are found
+        if (response.data.syncStatus) {
+            Object.entries(response.data.syncStatus).forEach(([_, value]) => {
+                if (value === 'ok')
+                    return;
+                throw new types_1.TodoistRequestError(value.error, value.httpCode, value.errorExtra);
+            });
+        }
+        return response.data;
+    }
     /**
      * Retrieves information about the authenticated user.
      *
@@ -265,27 +295,11 @@ class TodoistApi {
             commands,
             resource_types: ['items'],
         };
-        const response = await (0, rest_client_1.request)({
-            httpMethod: 'POST',
-            baseUri: this.syncApiBase,
-            relativePath: endpoints_1.ENDPOINT_SYNC,
-            apiToken: this.authToken,
-            customFetch: this.customFetch,
-            payload: syncRequest,
-            requestId: requestId,
-            hasSyncCommands: true,
-        });
-        if (response.data.syncStatus) {
-            Object.entries(response.data.syncStatus).forEach(([_, value]) => {
-                if (value === 'ok')
-                    return;
-                throw new types_1.TodoistRequestError(value.error, value.httpCode, value.errorExtra);
-            });
-        }
-        if (!((_a = response.data.items) === null || _a === void 0 ? void 0 : _a.length)) {
+        const syncResponse = await this.requestSync(syncRequest, requestId, true);
+        if (!((_a = syncResponse.items) === null || _a === void 0 ? void 0 : _a.length)) {
             throw new types_1.TodoistRequestError('Tasks not found', 404);
         }
-        const syncTasks = response.data.items.filter((task) => ids.includes(task.id));
+        const syncTasks = syncResponse.items.filter((task) => ids.includes(task.id));
         if (!syncTasks.length) {
             throw new types_1.TodoistRequestError('Tasks not found', 404);
         }
@@ -406,6 +420,26 @@ class TodoistApi {
             nextCursor,
         };
     }
+    /**
+     * Searches projects by name.
+     *
+     * @param args - Search parameters including the query string.
+     * @returns A promise that resolves to a paginated response of projects.
+     */
+    async searchProjects(args) {
+        const { data: { results, nextCursor }, } = await (0, rest_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,
+        };
+    }
     /**
      * Retrieves all archived projects with optional filters.
      *
@@ -566,6 +600,26 @@ class TodoistApi {
             nextCursor,
         };
     }
+    /**
+     * Searches sections by name.
+     *
+     * @param args - Search parameters including the query string.
+     * @returns A promise that resolves to a paginated response of sections.
+     */
+    async searchSections(args) {
+        const { data: { results, nextCursor }, } = await (0, rest_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_SECTIONS_SEARCH,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: (0, validators_1.validateSectionArray)(results),
+            nextCursor,
+        };
+    }
     /**
      * Retrieves a single section by its ID.
      *
@@ -679,6 +733,26 @@ class TodoistApi {
             nextCursor,
         };
     }
+    /**
+     * Searches labels by name.
+     *
+     * @param args - Search parameters including the query string.
+     * @returns A promise that resolves to a paginated response of labels.
+     */
+    async searchLabels(args) {
+        const { data: { results, nextCursor }, } = await (0, rest_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,
+        };
+    }
     /**
      * Adds a new label.
      *
@@ -1228,6 +1302,35 @@ class TodoistApi {
             workspaceUsers: (0, validators_1.validateWorkspaceUserArray)(response.data.workspaceUsers || []),
         };
     }
+    /**
+     * 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.
+     *
+     * @example
+     * ```typescript
+     * const workspaces = await api.getWorkspaces()
+     * workspaces.forEach(workspace => {
+     *   console.log(`${workspace.name} (${workspace.plan}) - Role: ${workspace.role}`)
+     * })
+     * ```
+     */
+    async getWorkspaces(requestId) {
+        const syncRequest = {
+            sync_token: '*',
+            resource_types: ['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 (0, validators_1.validateWorkspaceArray)(workspacesArray);
+    }
     /**
      * Gets active projects in a workspace with pagination.
      *

package/dist/cjs/types/entities.js

@@ -11,7 +11,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JoinWorkspaceResultSchema = exports.WorkspacePlanDetailsSchema = exports.FormattedPriceListingSchema = exports.PlanPriceSchema = exports.WorkspaceInvitationSchema = exports.WorkspaceUserSchema = exports.WorkspaceRoleSchema = exports.WORKSPACE_ROLES = exports.ActivityEventSchema = exports.ActivityEventExtraDataSchema = exports.ColorSchema = exports.ProductivityStatsSchema = exports.CurrentUserSchema = exports.TimezoneInfoSchema = exports.UserSchema = exports.CommentSchema = exports.RawCommentSchema = exports.AttachmentSchema = exports.LabelSchema = exports.SectionSchema = exports.WorkspaceProjectSchema = exports.PersonalProjectSchema = exports.BaseProjectSchema = exports.TaskSchema = exports.DeadlineSchema = exports.DurationSchema = exports.DueDateSchema = void 0;
+exports.WorkspaceSchema = exports.WorkspacePropertiesSchema = exports.WorkspaceLimitsSchema = exports.WorkspacePlanSchema = exports.WORKSPACE_PLANS = exports.JoinWorkspaceResultSchema = exports.WorkspacePlanDetailsSchema = exports.FormattedPriceListingSchema = exports.PlanPriceSchema = exports.WorkspaceInvitationSchema = exports.WorkspaceUserSchema = exports.WorkspaceRoleSchema = exports.WORKSPACE_ROLES = exports.ActivityEventSchema = exports.ActivityEventExtraDataSchema = exports.ColorSchema = exports.ProductivityStatsSchema = exports.CurrentUserSchema = exports.TimezoneInfoSchema = exports.UserSchema = exports.CommentSchema = exports.RawCommentSchema = exports.AttachmentSchema = exports.LabelSchema = exports.SectionSchema = exports.WorkspaceProjectSchema = exports.PersonalProjectSchema = exports.BaseProjectSchema = exports.TaskSchema = exports.DeadlineSchema = exports.DurationSchema = exports.DueDateSchema = void 0;
 const zod_1 = require("zod");
 const url_helpers_1 = require("../utils/url-helpers");
 const uncompletable_helpers_1 = require("../utils/uncompletable-helpers");
@@ -377,3 +377,41 @@ exports.JoinWorkspaceResultSchema = zod_1.z.object({
     userId: zod_1.z.string(),
     workspaceId: zod_1.z.string(),
 });
+/**
+ * Available workspace plans.
+ */
+exports.WORKSPACE_PLANS = ['STARTER', 'BUSINESS'];
+exports.WorkspacePlanSchema = zod_1.z.enum(exports.WORKSPACE_PLANS);
+/**
+ * Workspace resource limits.
+ */
+exports.WorkspaceLimitsSchema = zod_1.z
+    .object({
+    current: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).nullable(),
+    next: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).nullable(),
+})
+    .catchall(zod_1.z.any());
+/**
+ * Workspace properties (flexible object for unknown fields).
+ */
+exports.WorkspacePropertiesSchema = zod_1.z.record(zod_1.z.string(), zod_1.z.unknown());
+/**
+ * Represents a workspace in Todoist.
+ */
+exports.WorkspaceSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    name: zod_1.z.string(),
+    plan: exports.WorkspacePlanSchema,
+    role: exports.WorkspaceRoleSchema,
+    inviteCode: zod_1.z.string(),
+    isLinkSharingEnabled: zod_1.z.boolean(),
+    isGuestAllowed: zod_1.z.boolean(),
+    limits: exports.WorkspaceLimitsSchema,
+    logoBig: zod_1.z.string().nullish(),
+    logoMedium: zod_1.z.string().nullish(),
+    logoSmall: zod_1.z.string().nullish(),
+    logoS640: zod_1.z.string().nullish(),
+    createdAt: zod_1.z.string(),
+    creatorId: zod_1.z.string(),
+    properties: exports.WorkspacePropertiesSchema,
+});

package/dist/cjs/types/sync.js

@@ -1,2 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SYNC_RESOURCE_TYPES = void 0;
+/**
+ * All available Sync API resource types.
+ */
+exports.SYNC_RESOURCE_TYPES = [
+    'labels',
+    'projects',
+    'items',
+    'notes',
+    'sections',
+    'filters',
+    'reminders',
+    'reminders_location',
+    'locations',
+    'user',
+    'live_notifications',
+    'collaborators',
+    'user_settings',
+    'notification_settings',
+    'user_plan_limits',
+    'completed_info',
+    'stats',
+    'workspaces',
+    'workspace_users',
+    'workspace_filters',
+    'view_options',
+    'project_view_options_defaults',
+    'role_actions',
+];

package/dist/cjs/utils/validators.js

@@ -25,6 +25,8 @@ exports.validateWorkspaceInvitation = validateWorkspaceInvitation;
 exports.validateWorkspaceInvitationArray = validateWorkspaceInvitationArray;
 exports.validateWorkspacePlanDetails = validateWorkspacePlanDetails;
 exports.validateJoinWorkspaceResult = validateJoinWorkspaceResult;
+exports.validateWorkspace = validateWorkspace;
+exports.validateWorkspaceArray = validateWorkspaceArray;
 const entities_1 = require("../types/entities");
 function validateTask(input) {
     return entities_1.TaskSchema.parse(input);
@@ -122,3 +124,9 @@ function validateWorkspacePlanDetails(input) {
 function validateJoinWorkspaceResult(input) {
     return entities_1.JoinWorkspaceResultSchema.parse(input);
 }
+function validateWorkspace(input) {
+    return entities_1.WorkspaceSchema.parse(input);
+}
+function validateWorkspaceArray(input) {
+    return input.map(validateWorkspace);
+}

package/dist/esm/consts/endpoints.js

@@ -18,7 +18,9 @@ export const ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = ENDPOINT_REST_TA
 export const ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = ENDPOINT_REST_TASKS + '/completed/by_due_date';
 export const ENDPOINT_REST_TASKS_COMPLETED_SEARCH = 'completed/search';
 export const ENDPOINT_REST_SECTIONS = 'sections';
+export const ENDPOINT_REST_SECTIONS_SEARCH = ENDPOINT_REST_SECTIONS + '/search';
 export const ENDPOINT_REST_LABELS = 'labels';
+export const ENDPOINT_REST_LABELS_SEARCH = ENDPOINT_REST_LABELS + '/search';
 export const ENDPOINT_REST_LABELS_SHARED = ENDPOINT_REST_LABELS + '/shared';
 export const ENDPOINT_REST_LABELS_SHARED_RENAME = ENDPOINT_REST_LABELS_SHARED + '/rename';
 export const ENDPOINT_REST_LABELS_SHARED_REMOVE = ENDPOINT_REST_LABELS_SHARED + '/remove';
@@ -27,6 +29,7 @@ export const ENDPOINT_REST_TASK_CLOSE = 'close';
 export const ENDPOINT_REST_TASK_REOPEN = 'reopen';
 export const ENDPOINT_REST_TASK_MOVE = 'move';
 export const ENDPOINT_REST_PROJECTS = 'projects';
+export const ENDPOINT_REST_PROJECTS_SEARCH = ENDPOINT_REST_PROJECTS + '/search';
 export const ENDPOINT_REST_PROJECTS_ARCHIVED = ENDPOINT_REST_PROJECTS + '/archived';
 export const ENDPOINT_REST_PROJECT_COLLABORATORS = 'collaborators';
 export const ENDPOINT_REST_USER = 'user';

package/dist/esm/todoist-api.js

@@ -1,6 +1,6 @@
 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_SYNC_QUICK_ADD, ENDPOINT_REST_TASK_CLOSE, ENDPOINT_REST_TASK_REOPEN, ENDPOINT_REST_TASK_MOVE, ENDPOINT_REST_LABELS, ENDPOINT_REST_PROJECT_COLLABORATORS, ENDPOINT_REST_SECTIONS, 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_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, } from './utils/validators.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_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 { formatDateToYYYYMMDD } from './utils/url-helpers.js';
 import { uploadMultipartFile } from './utils/multipart-upload.js';
 import { normalizeObjectTypeForApi, denormalizeObjectTypeFromApi } from './utils/activity-helpers.js';
@@ -43,6 +43,36 @@ export class TodoistApi {
             this.customFetch = options.customFetch;
         }
     }
+    /**
+     * 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
+     */
+    async requestSync(syncRequest, requestId, hasSyncCommands = false) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_SYNC,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: syncRequest,
+            requestId: requestId,
+            hasSyncCommands: hasSyncCommands,
+        });
+        // Check for sync errors and throw if any are found
+        if (response.data.syncStatus) {
+            Object.entries(response.data.syncStatus).forEach(([_, value]) => {
+                if (value === 'ok')
+                    return;
+                throw new TodoistRequestError(value.error, value.httpCode, value.errorExtra);
+            });
+        }
+        return response.data;
+    }
     /**
      * Retrieves information about the authenticated user.
      *
@@ -262,27 +292,11 @@ export class TodoistApi {
             commands,
             resource_types: ['items'],
         };
-        const response = await request({
-            httpMethod: 'POST',
-            baseUri: this.syncApiBase,
-            relativePath: ENDPOINT_SYNC,
-            apiToken: this.authToken,
-            customFetch: this.customFetch,
-            payload: syncRequest,
-            requestId: requestId,
-            hasSyncCommands: true,
-        });
-        if (response.data.syncStatus) {
-            Object.entries(response.data.syncStatus).forEach(([_, value]) => {
-                if (value === 'ok')
-                    return;
-                throw new TodoistRequestError(value.error, value.httpCode, value.errorExtra);
-            });
-        }
-        if (!((_a = response.data.items) === null || _a === void 0 ? void 0 : _a.length)) {
+        const syncResponse = await this.requestSync(syncRequest, requestId, true);
+        if (!((_a = syncResponse.items) === null || _a === void 0 ? void 0 : _a.length)) {
             throw new TodoistRequestError('Tasks not found', 404);
         }
-        const syncTasks = response.data.items.filter((task) => ids.includes(task.id));
+        const syncTasks = syncResponse.items.filter((task) => ids.includes(task.id));
         if (!syncTasks.length) {
             throw new TodoistRequestError('Tasks not found', 404);
         }
@@ -403,6 +417,26 @@ export class TodoistApi {
             nextCursor,
         };
     }
+    /**
+     * Searches projects by name.
+     *
+     * @param args - Search parameters including the query string.
+     * @returns A promise that resolves to a paginated response of projects.
+     */
+    async searchProjects(args) {
+        const { data: { results, nextCursor }, } = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_PROJECTS_SEARCH,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: validateProjectArray(results),
+            nextCursor,
+        };
+    }
     /**
      * Retrieves all archived projects with optional filters.
      *
@@ -563,6 +597,26 @@ export class TodoistApi {
             nextCursor,
         };
     }
+    /**
+     * Searches sections by name.
+     *
+     * @param args - Search parameters including the query string.
+     * @returns A promise that resolves to a paginated response of sections.
+     */
+    async searchSections(args) {
+        const { data: { results, nextCursor }, } = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_SECTIONS_SEARCH,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: validateSectionArray(results),
+            nextCursor,
+        };
+    }
     /**
      * Retrieves a single section by its ID.
      *
@@ -676,6 +730,26 @@ export class TodoistApi {
             nextCursor,
         };
     }
+    /**
+     * Searches labels by name.
+     *
+     * @param args - Search parameters including the query string.
+     * @returns A promise that resolves to a paginated response of labels.
+     */
+    async searchLabels(args) {
+        const { data: { results, nextCursor }, } = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_LABELS_SEARCH,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: validateLabelArray(results),
+            nextCursor,
+        };
+    }
     /**
      * Adds a new label.
      *
@@ -1225,6 +1299,35 @@ export class TodoistApi {
             workspaceUsers: validateWorkspaceUserArray(response.data.workspaceUsers || []),
         };
     }
+    /**
+     * 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.
+     *
+     * @example
+     * ```typescript
+     * const workspaces = await api.getWorkspaces()
+     * workspaces.forEach(workspace => {
+     *   console.log(`${workspace.name} (${workspace.plan}) - Role: ${workspace.role}`)
+     * })
+     * ```
+     */
+    async getWorkspaces(requestId) {
+        const syncRequest = {
+            sync_token: '*',
+            resource_types: ['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);
+    }
     /**
      * Gets active projects in a workspace with pagination.
      *

package/dist/esm/types/entities.js

@@ -374,3 +374,41 @@ export const JoinWorkspaceResultSchema = z.object({
     userId: z.string(),
     workspaceId: z.string(),
 });
+/**
+ * Available workspace plans.
+ */
+export const WORKSPACE_PLANS = ['STARTER', 'BUSINESS'];
+export const WorkspacePlanSchema = z.enum(WORKSPACE_PLANS);
+/**
+ * Workspace resource limits.
+ */
+export const WorkspaceLimitsSchema = z
+    .object({
+    current: z.record(z.string(), z.any()).nullable(),
+    next: z.record(z.string(), z.any()).nullable(),
+})
+    .catchall(z.any());
+/**
+ * Workspace properties (flexible object for unknown fields).
+ */
+export const WorkspacePropertiesSchema = z.record(z.string(), z.unknown());
+/**
+ * Represents a workspace in Todoist.
+ */
+export const WorkspaceSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    plan: WorkspacePlanSchema,
+    role: WorkspaceRoleSchema,
+    inviteCode: z.string(),
+    isLinkSharingEnabled: z.boolean(),
+    isGuestAllowed: z.boolean(),
+    limits: WorkspaceLimitsSchema,
+    logoBig: z.string().nullish(),
+    logoMedium: z.string().nullish(),
+    logoSmall: z.string().nullish(),
+    logoS640: z.string().nullish(),
+    createdAt: z.string(),
+    creatorId: z.string(),
+    properties: WorkspacePropertiesSchema,
+});

package/dist/esm/types/sync.js

@@ -1 +1,28 @@
-export {};
+/**
+ * All available Sync API resource types.
+ */
+export const SYNC_RESOURCE_TYPES = [
+    'labels',
+    'projects',
+    'items',
+    'notes',
+    'sections',
+    'filters',
+    'reminders',
+    'reminders_location',
+    'locations',
+    'user',
+    'live_notifications',
+    'collaborators',
+    'user_settings',
+    'notification_settings',
+    'user_plan_limits',
+    'completed_info',
+    'stats',
+    'workspaces',
+    'workspace_users',
+    'workspace_filters',
+    'view_options',
+    'project_view_options_defaults',
+    'role_actions',
+];

package/dist/esm/utils/validators.js

@@ -1,4 +1,4 @@
-import { AttachmentSchema, SectionSchema, LabelSchema, CommentSchema, UserSchema, CurrentUserSchema, TaskSchema, PersonalProjectSchema, WorkspaceProjectSchema, ProductivityStatsSchema, ActivityEventSchema, WorkspaceUserSchema, WorkspaceInvitationSchema, WorkspacePlanDetailsSchema, JoinWorkspaceResultSchema, } from '../types/entities.js';
+import { AttachmentSchema, SectionSchema, LabelSchema, CommentSchema, UserSchema, CurrentUserSchema, TaskSchema, PersonalProjectSchema, WorkspaceProjectSchema, ProductivityStatsSchema, ActivityEventSchema, WorkspaceUserSchema, WorkspaceInvitationSchema, WorkspacePlanDetailsSchema, JoinWorkspaceResultSchema, WorkspaceSchema, } from '../types/entities.js';
 export function validateTask(input) {
     return TaskSchema.parse(input);
 }
@@ -95,3 +95,9 @@ export function validateWorkspacePlanDetails(input) {
 export function validateJoinWorkspaceResult(input) {
     return JoinWorkspaceResultSchema.parse(input);
 }
+export function validateWorkspace(input) {
+    return WorkspaceSchema.parse(input);
+}
+export function validateWorkspaceArray(input) {
+    return input.map(validateWorkspace);
+}

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

@@ -9,7 +9,9 @@ export declare const ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE: string;
 export declare const ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE: string;
 export declare const ENDPOINT_REST_TASKS_COMPLETED_SEARCH = "completed/search";
 export declare const ENDPOINT_REST_SECTIONS = "sections";
+export declare const ENDPOINT_REST_SECTIONS_SEARCH: string;
 export declare const ENDPOINT_REST_LABELS = "labels";
+export declare const ENDPOINT_REST_LABELS_SEARCH: string;
 export declare const ENDPOINT_REST_LABELS_SHARED: string;
 export declare const ENDPOINT_REST_LABELS_SHARED_RENAME: string;
 export declare const ENDPOINT_REST_LABELS_SHARED_REMOVE: string;
@@ -18,6 +20,7 @@ export declare const ENDPOINT_REST_TASK_CLOSE = "close";
 export declare const ENDPOINT_REST_TASK_REOPEN = "reopen";
 export declare const ENDPOINT_REST_TASK_MOVE = "move";
 export declare const ENDPOINT_REST_PROJECTS = "projects";
+export declare const ENDPOINT_REST_PROJECTS_SEARCH: string;
 export declare const ENDPOINT_REST_PROJECTS_ARCHIVED: string;
 export declare const ENDPOINT_REST_PROJECT_COLLABORATORS = "collaborators";
 export declare const ENDPOINT_REST_USER = "user";

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

@@ -1,5 +1,5 @@
-import { Attachment, PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser, ProductivityStats, WorkspaceInvitation, WorkspacePlanDetails, JoinWorkspaceResult } from './types/entities.js';
-import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, GetSectionsResponse, GetSharedLabelsResponse, GetCommentsResponse, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse, SearchCompletedTasksArgs, GetActivityLogsArgs, GetActivityLogsResponse, UploadFileArgs, DeleteUploadArgs, GetWorkspaceInvitationsArgs, DeleteWorkspaceInvitationArgs, WorkspaceInvitationActionArgs, JoinWorkspaceArgs, WorkspaceLogoArgs, GetWorkspacePlanDetailsArgs, GetWorkspaceUsersArgs, GetWorkspaceUsersResponse, GetWorkspaceProjectsArgs, WorkspaceInvitationsResponse, AllWorkspaceInvitationsResponse, WorkspaceLogoResponse } from './types/requests.js';
+import { Attachment, PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser, ProductivityStats, WorkspaceInvitation, WorkspacePlanDetails, JoinWorkspaceResult, Workspace } from './types/entities.js';
+import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, SearchProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, SearchLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, SearchSectionsArgs, GetSectionsResponse, GetSharedLabelsResponse, GetCommentsResponse, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse, SearchCompletedTasksArgs, GetActivityLogsArgs, GetActivityLogsResponse, UploadFileArgs, DeleteUploadArgs, GetWorkspaceInvitationsArgs, DeleteWorkspaceInvitationArgs, WorkspaceInvitationActionArgs, JoinWorkspaceArgs, WorkspaceLogoArgs, GetWorkspacePlanDetailsArgs, GetWorkspaceUsersArgs, GetWorkspaceUsersResponse, GetWorkspaceProjectsArgs, WorkspaceInvitationsResponse, AllWorkspaceInvitationsResponse, WorkspaceLogoResponse } from './types/requests.js';
 import { CustomFetch } from './types/http.js';
 /**
  * A client for interacting with the Todoist API v1.
@@ -45,6 +45,16 @@ export declare class TodoistApi {
     constructor(authToken: string, baseUrl: string);
     constructor(authToken: string);
     constructor(authToken: string, 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;
     /**
      * Retrieves information about the authenticated user.
      *
@@ -174,6 +184,13 @@ export declare class TodoistApi {
      * @returns A promise that resolves to an array of projects.
      */
     getProjects(args?: GetProjectsArgs): Promise<GetProjectsResponse>;
+    /**
+     * Searches projects by name.
+     *
+     * @param args - Search parameters including the query string.
+     * @returns A promise that resolves to a paginated response of projects.
+     */
+    searchProjects(args: SearchProjectsArgs): Promise<GetProjectsResponse>;
     /**
      * Retrieves all archived projects with optional filters.
      *
@@ -238,6 +255,13 @@ export declare class TodoistApi {
      * @returns A promise that resolves to an array of sections.
      */
     getSections(args?: GetSectionsArgs): Promise<GetSectionsResponse>;
+    /**
+     * Searches sections by name.
+     *
+     * @param args - Search parameters including the query string.
+     * @returns A promise that resolves to a paginated response of sections.
+     */
+    searchSections(args: SearchSectionsArgs): Promise<GetSectionsResponse>;
     /**
      * Retrieves a single section by its ID.
      *
@@ -284,6 +308,13 @@ export declare class TodoistApi {
      * @returns A promise that resolves to an array of labels.
      */
     getLabels(args?: GetLabelsArgs): Promise<GetLabelsResponse>;
+    /**
+     * Searches labels by name.
+     *
+     * @param args - Search parameters including the query string.
+     * @returns A promise that resolves to a paginated response of labels.
+     */
+    searchLabels(args: SearchLabelsArgs): Promise<GetLabelsResponse>;
     /**
      * Adds a new label.
      *
@@ -508,6 +539,23 @@ export declare class TodoistApi {
      * @returns Paginated list of workspace users.
      */
     getWorkspaceUsers(args?: GetWorkspaceUsersArgs, requestId?: string): Promise<GetWorkspaceUsersResponse>;
+    /**
+     * 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.
+     *
+     * @example
+     * ```typescript
+     * const workspaces = await api.getWorkspaces()
+     * workspaces.forEach(workspace => {
+     *   console.log(`${workspace.name} (${workspace.plan}) - Role: ${workspace.role}`)
+     * })
+     * ```
+     */
+    getWorkspaces(requestId?: string): Promise<Workspace[]>;
     /**
      * Gets active projects in a workspace with pagination.
      *

package/dist/types/types/entities.d.ts

@@ -841,4 +841,60 @@ export declare const JoinWorkspaceResultSchema: z.ZodObject<{
  * Result returned when successfully joining a workspace.
  */
 export type JoinWorkspaceResult = z.infer<typeof JoinWorkspaceResultSchema>;
+/**
+ * Available workspace plans.
+ */
+export declare const WORKSPACE_PLANS: readonly ["STARTER", "BUSINESS"];
+/**
+ * Workspace plan type.
+ */
+export type WorkspacePlan = (typeof WORKSPACE_PLANS)[number];
+export declare const WorkspacePlanSchema: z.ZodEnum<{
+    STARTER: "STARTER";
+    BUSINESS: "BUSINESS";
+}>;
+/**
+ * Workspace resource limits.
+ */
+export declare const WorkspaceLimitsSchema: z.ZodObject<{
+    current: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    next: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$catchall<z.ZodAny>>;
+export type WorkspaceLimits = z.infer<typeof WorkspaceLimitsSchema>;
+/**
+ * Workspace properties (flexible object for unknown fields).
+ */
+export declare const WorkspacePropertiesSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+export type WorkspaceProperties = z.infer<typeof WorkspacePropertiesSchema>;
+/**
+ * Represents a workspace in Todoist.
+ */
+export declare const WorkspaceSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    plan: z.ZodEnum<{
+        STARTER: "STARTER";
+        BUSINESS: "BUSINESS";
+    }>;
+    role: z.ZodEnum<{
+        ADMIN: "ADMIN";
+        MEMBER: "MEMBER";
+        GUEST: "GUEST";
+    }>;
+    inviteCode: z.ZodString;
+    isLinkSharingEnabled: z.ZodBoolean;
+    isGuestAllowed: z.ZodBoolean;
+    limits: z.ZodObject<{
+        current: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        next: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, z.core.$catchall<z.ZodAny>>;
+    logoBig: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    logoMedium: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    logoSmall: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    logoS640: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    createdAt: z.ZodString;
+    creatorId: z.ZodString;
+    properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$strip>;
+export type Workspace = z.infer<typeof WorkspaceSchema>;
 export {};

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

@@ -160,6 +160,15 @@ export type GetProjectsArgs = {
     cursor?: string | null;
     limit?: number;
 };
+/**
+ * Arguments for searching projects.
+ */
+type SearchArgs = {
+    query: string;
+    cursor?: string | null;
+    limit?: number;
+};
+export type SearchProjectsArgs = SearchArgs;
 /**
  * Response from retrieving projects.
  * @see https://todoist.com/api/v1/docs#tag/Projects/operation/get_projects_api_v1_projects_get
@@ -230,6 +239,12 @@ export type GetSectionsArgs = {
     cursor?: string | null;
     limit?: number;
 };
+/**
+ * Arguments for searching sections.
+ */
+export type SearchSectionsArgs = SearchArgs & {
+    projectId?: string | null;
+};
 /**
  * Response from retrieving sections.
  * @see https://todoist.com/api/v1/docs#tag/Sections/operation/get_sections_api_v1_sections_get
@@ -262,6 +277,10 @@ export type GetLabelsArgs = {
     cursor?: string | null;
     limit?: number;
 };
+/**
+ * Arguments for searching labels.
+ */
+export type SearchLabelsArgs = SearchArgs;
 /**
  * Response from retrieving labels.
  * @see https://todoist.com/api/v1/docs#tag/Labels/operation/get_labels_api_v1_labels_get

package/dist/types/types/sync.d.ts

@@ -11,11 +11,20 @@ export type SyncError = {
     errorTag: string;
     httpCode: number;
 };
+/**
+ * All available Sync API resource types.
+ */
+export declare const SYNC_RESOURCE_TYPES: readonly ["labels", "projects", "items", "notes", "sections", "filters", "reminders", "reminders_location", "locations", "user", "live_notifications", "collaborators", "user_settings", "notification_settings", "user_plan_limits", "completed_info", "stats", "workspaces", "workspace_users", "workspace_filters", "view_options", "project_view_options_defaults", "role_actions"];
+export type SyncResourceType = (typeof SYNC_RESOURCE_TYPES)[number];
 export type SyncRequest = {
-    commands: Command[];
-    resource_types?: string[];
+    commands?: Command[];
+    resource_types?: SyncResourceType[];
+    sync_token?: string;
 };
 export type SyncResponse = {
     items?: Task[];
     syncStatus?: Record<string, 'ok' | SyncError>;
+    syncToken?: string;
+    fullSync?: boolean;
+    workspaces?: Record<string, unknown>;
 };

package/dist/types/utils/validators.d.ts

@@ -1,4 +1,4 @@
-import { type Attachment, type Task, type Section, type Label, type Comment, type User, type CurrentUser, type ProductivityStats, type WorkspaceProject, type PersonalProject, type ActivityEvent, type WorkspaceUser, type WorkspaceInvitation, type WorkspacePlanDetails, type JoinWorkspaceResult } from '../types/entities.js';
+import { type Attachment, type Task, type Section, type Label, type Comment, type User, type CurrentUser, type ProductivityStats, type WorkspaceProject, type PersonalProject, type ActivityEvent, type WorkspaceUser, type WorkspaceInvitation, type WorkspacePlanDetails, type JoinWorkspaceResult, type Workspace } from '../types/entities.js';
 export declare function validateTask(input: unknown): Task;
 export declare function validateTaskArray(input: unknown[]): Task[];
 /**
@@ -39,3 +39,5 @@ export declare function validateWorkspaceInvitation(input: unknown): WorkspaceIn
 export declare function validateWorkspaceInvitationArray(input: unknown[]): WorkspaceInvitation[];
 export declare function validateWorkspacePlanDetails(input: unknown): WorkspacePlanDetails;
 export declare function validateJoinWorkspaceResult(input: unknown): JoinWorkspaceResult;
+export declare function validateWorkspace(input: unknown): Workspace;
+export declare function validateWorkspaceArray(input: unknown[]): Workspace[];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-api-typescript",
-    "version": "6.2.1",
+    "version": "6.4.0",
     "description": "A typescript wrapper for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-api-typescript",