@doist/todoist-api-typescript 7.8.0 → 7.9.1

package/dist/cjs/consts/endpoints.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ENDPOINT_REST_ID_MAPPINGS = exports.ENDPOINT_REST_EMAILS = exports.ENDPOINT_REST_BACKUPS_DOWNLOAD = exports.ENDPOINT_REST_BACKUPS = exports.ENDPOINT_REST_ACCESS_TOKENS_MIGRATE = exports.ENDPOINT_REST_TEMPLATES_IMPORT_FROM_ID = exports.ENDPOINT_REST_TEMPLATES_IMPORT_FROM_FILE = exports.ENDPOINT_REST_TEMPLATES_CREATE_FROM_FILE = exports.ENDPOINT_REST_TEMPLATES_URL = exports.ENDPOINT_REST_TEMPLATES_FILE = exports.ENDPOINT_REST_TASKS_COMPLETED = exports.ENDPOINT_REST_PROJECTS_MOVE_TO_PERSONAL = exports.ENDPOINT_REST_PROJECTS_MOVE_TO_WORKSPACE = exports.SECTION_UNARCHIVE = exports.SECTION_ARCHIVE = exports.ENDPOINT_REST_PROJECT_JOIN = exports.ENDPOINT_REST_PROJECT_FULL = exports.ENDPOINT_REST_PROJECTS_PERMISSIONS = exports.ENDPOINT_REST_PROJECTS_ARCHIVED_COUNT = 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_LOCATION_REMINDERS = exports.ENDPOINT_REST_REMINDERS = 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.ENDPOINT_WORKSPACE_MEMBERS = 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_REST_WORKSPACES = exports.ENDPOINT_REVOKE = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_MOVED_IDS = void 0;
+exports.ENDPOINT_WORKSPACE_MEMBERS = 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_REST_WORKSPACES = exports.ENDPOINT_REST_FOLDERS = exports.ENDPOINT_REVOKE = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_MOVED_IDS = void 0;
 exports.getSyncBaseUri = getSyncBaseUri;
 exports.getAuthBaseUri = getAuthBaseUri;
 exports.getWorkspaceInvitationAcceptEndpoint = getWorkspaceInvitationAcceptEndpoint;
@@ -84,6 +84,7 @@ exports.ENDPOINT_SYNC = 'sync';
 exports.ENDPOINT_AUTHORIZATION = 'authorize';
 exports.ENDPOINT_GET_TOKEN = 'access_token';
 exports.ENDPOINT_REVOKE = 'revoke';
+exports.ENDPOINT_REST_FOLDERS = 'folders';
 // Workspace endpoints
 exports.ENDPOINT_REST_WORKSPACES = 'workspaces';
 exports.ENDPOINT_WORKSPACE_INVITATIONS = 'workspaces/invitations';

package/dist/cjs/test-utils/test-defaults.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = exports.COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = exports.RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = exports.COMMENT_WITH_OPTIONALS_AS_NULL_TASK = exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_TASK = exports.INVALID_COMMENT = exports.DEFAULT_LOCATION_REMINDER = exports.DEFAULT_ABSOLUTE_REMINDER = exports.DEFAULT_RELATIVE_REMINDER = exports.DEFAULT_REMINDER_ID = exports.DEFAULT_COMMENT = exports.DEFAULT_RAW_COMMENT = exports.INVALID_ATTACHMENT = exports.DEFAULT_ATTACHMENT = exports.INVALID_USER = exports.DEFAULT_USER = exports.INVALID_LABEL = exports.DEFAULT_LABEL = exports.INVALID_SECTION = exports.DEFAULT_SECTION = exports.PROJECT_WITH_OPTIONALS_AS_NULL = exports.INVALID_PROJECT = exports.DEFAULT_PROJECT = exports.TASK_WITH_OPTIONALS_AS_NULL = exports.INVALID_TASK = exports.DEFAULT_TASK = exports.DEFAULT_DEADLINE = exports.DEFAULT_DURATION = exports.DEFAULT_DUE_DATE = exports.INVALID_ENTITY_ID = exports.DEFAULT_REQUEST_ID = exports.DEFAULT_AUTH_TOKEN = exports.DEFAULT_PROJECT_VIEW_STYLE = exports.DEFAULT_PROJECT_NAME = exports.DEFAULT_PROJECT_ID = exports.DEFAULT_ORDER = exports.DEFAULT_TASK_PRIORITY = exports.DEFAULT_TASK_DESCRIPTION = exports.DEFAULT_TASK_CONTENT = exports.DEFAULT_TASK_ID = void 0;
+exports.DEFAULT_FOLDER = exports.COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = exports.COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = exports.RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = exports.COMMENT_WITH_OPTIONALS_AS_NULL_TASK = exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_TASK = exports.INVALID_COMMENT = exports.DEFAULT_LOCATION_REMINDER = exports.DEFAULT_ABSOLUTE_REMINDER = exports.DEFAULT_RELATIVE_REMINDER = exports.DEFAULT_REMINDER_ID = exports.DEFAULT_COMMENT = exports.DEFAULT_RAW_COMMENT = exports.INVALID_ATTACHMENT = exports.DEFAULT_ATTACHMENT = exports.INVALID_USER = exports.DEFAULT_USER = exports.INVALID_LABEL = exports.DEFAULT_LABEL = exports.INVALID_SECTION = exports.DEFAULT_SECTION = exports.PROJECT_WITH_OPTIONALS_AS_NULL = exports.INVALID_PROJECT = exports.DEFAULT_PROJECT = exports.TASK_WITH_OPTIONALS_AS_NULL = exports.INVALID_TASK = exports.DEFAULT_TASK = exports.DEFAULT_DEADLINE = exports.DEFAULT_DURATION = exports.DEFAULT_DUE_DATE = exports.INVALID_ENTITY_ID = exports.DEFAULT_REQUEST_ID = exports.DEFAULT_AUTH_TOKEN = exports.DEFAULT_PROJECT_VIEW_STYLE = exports.DEFAULT_PROJECT_NAME = exports.DEFAULT_PROJECT_ID = exports.DEFAULT_ORDER = exports.DEFAULT_TASK_PRIORITY = exports.DEFAULT_TASK_DESCRIPTION = exports.DEFAULT_TASK_CONTENT = exports.DEFAULT_TASK_ID = void 0;
 const url_helpers_1 = require("../utils/url-helpers");
 exports.DEFAULT_TASK_ID = '1234';
 exports.DEFAULT_TASK_CONTENT = 'This is a task';
@@ -230,3 +230,11 @@ exports.RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = Object.assign(Objec
 exports.COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = Object.assign(Object.assign({}, exports.RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL), { taskId: exports.RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL.itemId, itemId: undefined });
 exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = Object.assign(Object.assign({}, exports.DEFAULT_RAW_COMMENT), { itemId: undefined, projectId: exports.DEFAULT_PROJECT_ID });
 exports.COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = Object.assign(Object.assign({}, exports.RAW_COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT), { taskId: undefined });
+exports.DEFAULT_FOLDER = {
+    id: '789',
+    name: 'This is a folder',
+    workspaceId: '100',
+    defaultOrder: 3,
+    childOrder: 3,
+    isDeleted: false,
+};

package/dist/cjs/todoist-api.js

@@ -1793,6 +1793,103 @@ class TodoistApi {
             arrayBuffer: () => response.arrayBuffer(),
         };
     }
+    // ── Folders ──
+    /**
+     * Retrieves a paginated list of folders.
+     *
+     * @param args - Filter parameters such as workspace ID.
+     * @returns A promise that resolves to a paginated response of folders.
+     */
+    async getFolders(args) {
+        const { data: { results, nextCursor }, } = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_FOLDERS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: (0, validators_1.validateFolderArray)(results),
+            nextCursor,
+        };
+    }
+    /**
+     * Retrieves a single folder by its ID.
+     *
+     * @param id - The unique identifier of the folder.
+     * @returns A promise that resolves to the requested folder.
+     */
+    async getFolder(id) {
+        zod_1.z.string().parse(id);
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(endpoints_1.ENDPOINT_REST_FOLDERS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return (0, validators_1.validateFolder)(response.data);
+    }
+    /**
+     * Creates a new folder.
+     *
+     * @param args - Folder creation parameters including name and workspace ID.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the created folder.
+     */
+    async addFolder(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_REST_FOLDERS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return (0, validators_1.validateFolder)(response.data);
+    }
+    /**
+     * Updates an existing folder by its ID.
+     *
+     * @param id - The unique identifier of the folder to update.
+     * @param args - Update parameters such as name or default order.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated folder.
+     */
+    async updateFolder(id, args, requestId) {
+        zod_1.z.string().parse(id);
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(endpoints_1.ENDPOINT_REST_FOLDERS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return (0, validators_1.validateFolder)(response.data);
+    }
+    /**
+     * Deletes a folder by its ID.
+     *
+     * @param id - The unique identifier of the folder to delete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
+    async deleteFolder(id, requestId) {
+        zod_1.z.string().parse(id);
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'DELETE',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(endpoints_1.ENDPOINT_REST_FOLDERS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return (0, http_client_1.isSuccess)(response);
+    }
     // ── Backups ──
     /**
      * Retrieves a list of available backups.

package/dist/cjs/types/common.js

@@ -1,2 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringOrNumberSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Zod schema that accepts both string and number values and coerces to string.
+ * The REST API returns numeric IDs while the Sync API returns string IDs.
+ */
+const StringOrNumberSchema = zod_1.z.union([zod_1.z.string(), zod_1.z.number()]).transform((val) => String(val));
+exports.StringOrNumberSchema = StringOrNumberSchema;

package/dist/cjs/types/folders/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests"), exports);

package/dist/cjs/types/folders/requests.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./users"), exports);
 __exportStar(require("./productivity"), exports);
 __exportStar(require("./activity"), exports);
 __exportStar(require("./workspaces"), exports);
+__exportStar(require("./folders"), exports);
 __exportStar(require("./insights"), exports);
 __exportStar(require("./backups"), exports);
 __exportStar(require("./id-mappings"), exports);

package/dist/cjs/types/sync/resources/workspaces.js

@@ -1,7 +1,19 @@
 "use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SyncWorkspaceSchema = void 0;
 const zod_1 = require("zod");
+const common_1 = require("../../common");
 const types_1 = require("../../workspaces/types");
 /**
  * Sync API workspace resource.
@@ -12,20 +24,21 @@ const types_1 = require("../../workspaces/types");
  */
 exports.SyncWorkspaceSchema = zod_1.z
     .object({
-    id: zod_1.z.string(),
+    id: common_1.StringOrNumberSchema,
     name: zod_1.z.string(),
     description: zod_1.z.string(),
     logoBig: zod_1.z.string().optional(),
     logoMedium: zod_1.z.string().optional(),
     logoSmall: zod_1.z.string().optional(),
     logoS640: zod_1.z.string().optional(),
-    creatorId: zod_1.z.string(),
-    createdAt: zod_1.z.string(),
+    creatorId: common_1.StringOrNumberSchema,
+    createdAt: zod_1.z.string().optional(),
+    dateCreated: zod_1.z.string().optional(),
     isDeleted: zod_1.z.boolean(),
     isCollapsed: zod_1.z.boolean(),
-    role: types_1.WorkspaceRoleSchema,
+    role: types_1.WorkspaceRoleSchema.optional(),
     plan: types_1.WorkspacePlanSchema,
-    limits: types_1.WorkspaceLimitsSchema,
+    limits: types_1.WorkspaceLimitsSchema.optional(),
     inviteCode: zod_1.z.string().nullable().optional(),
     isLinkSharingEnabled: zod_1.z.boolean().nullable().optional(),
     isGuestAllowed: zod_1.z.boolean().nullable().optional(),
@@ -53,4 +66,8 @@ exports.SyncWorkspaceSchema = zod_1.z
         .optional(),
     properties: types_1.WorkspacePropertiesSchema.optional(),
 })
-    .passthrough();
+    .passthrough()
+    .transform((_a) => {
+    var { dateCreated, createdAt } = _a, rest = __rest(_a, ["dateCreated", "createdAt"]);
+    return (Object.assign(Object.assign({}, rest), { createdAt: createdAt !== null && createdAt !== void 0 ? createdAt : dateCreated }));
+});

package/dist/cjs/types/workspaces/types.js

@@ -1,7 +1,19 @@
 "use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkspaceUserTaskSchema = exports.MemberActivityInfoSchema = exports.WorkspaceSchema = exports.WorkspacePropertiesSchema = exports.WorkspaceLimitsSchema = exports.WorkspacePlanSchema = exports.WORKSPACE_PLANS = exports.JoinWorkspaceResultSchema = exports.WorkspacePlanDetailsSchema = exports.WORKSPACE_PLAN_STATUSES = exports.WORKSPACE_CURRENT_PLANS = exports.FormattedPriceListingSchema = exports.PlanPriceSchema = exports.WorkspaceInvitationSchema = exports.WorkspaceUserSchema = exports.WorkspaceRoleSchema = exports.WORKSPACE_ROLES = exports.COLLABORATOR_ROLES = void 0;
 const zod_1 = require("zod");
+const common_1 = require("../common");
 const types_1 = require("../tasks/types");
 /** Available project collaborator roles. */
 exports.COLLABORATOR_ROLES = [
@@ -99,22 +111,28 @@ exports.WorkspacePropertiesSchema = zod_1.z.record(zod_1.z.string(), zod_1.z.unk
 /**
  * Represents a workspace in Todoist.
  */
-exports.WorkspaceSchema = zod_1.z.object({
-    id: zod_1.z.string(),
+exports.WorkspaceSchema = zod_1.z
+    .object({
+    id: common_1.StringOrNumberSchema,
     name: zod_1.z.string(),
     plan: exports.WorkspacePlanSchema,
-    role: exports.WorkspaceRoleSchema,
+    role: exports.WorkspaceRoleSchema.optional(),
     inviteCode: zod_1.z.string(),
     isLinkSharingEnabled: zod_1.z.boolean(),
     isGuestAllowed: zod_1.z.boolean(),
-    limits: exports.WorkspaceLimitsSchema,
+    limits: exports.WorkspaceLimitsSchema.optional(),
     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(),
+    createdAt: zod_1.z.string().optional(),
+    dateCreated: zod_1.z.string().optional(),
+    creatorId: common_1.StringOrNumberSchema,
     properties: exports.WorkspacePropertiesSchema,
+})
+    .transform((_a) => {
+    var { dateCreated, createdAt } = _a, rest = __rest(_a, ["dateCreated", "createdAt"]);
+    return (Object.assign(Object.assign({}, rest), { createdAt: createdAt !== null && createdAt !== void 0 ? createdAt : dateCreated }));
 });
 exports.MemberActivityInfoSchema = zod_1.z.object({
     userId: zod_1.z.string(),

package/dist/esm/consts/endpoints.js

@@ -65,6 +65,7 @@ export const ENDPOINT_SYNC = 'sync';
 export const ENDPOINT_AUTHORIZATION = 'authorize';
 export const ENDPOINT_GET_TOKEN = 'access_token';
 export const ENDPOINT_REVOKE = 'revoke';
+export const ENDPOINT_REST_FOLDERS = 'folders';
 // Workspace endpoints
 export const ENDPOINT_REST_WORKSPACES = 'workspaces';
 export const ENDPOINT_WORKSPACE_INVITATIONS = 'workspaces/invitations';

package/dist/esm/test-utils/test-defaults.js

@@ -227,3 +227,11 @@ export const RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = Object.assign(
 export const COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL = Object.assign(Object.assign({}, RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL), { taskId: RAW_COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL.itemId, itemId: undefined });
 export const RAW_COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = Object.assign(Object.assign({}, DEFAULT_RAW_COMMENT), { itemId: undefined, projectId: DEFAULT_PROJECT_ID });
 export const COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT = Object.assign(Object.assign({}, RAW_COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT), { taskId: undefined });
+export const DEFAULT_FOLDER = {
+    id: '789',
+    name: 'This is a folder',
+    workspaceId: '100',
+    defaultOrder: 3,
+    childOrder: 3,
+    isDeleted: false,
+};

package/dist/esm/todoist-api.js

@@ -11,8 +11,8 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 import { UpdateReminderArgsSchema, UpdateLocationReminderArgsSchema, ReminderIdSchema, } from './types/reminders/index.js';
 import { request, isSuccess } from './transport/http-client.js';
-import { getSyncBaseUri, ENDPOINT_REST_TASKS, ENDPOINT_REST_TASKS_FILTER, ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE, ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE, ENDPOINT_REST_TASKS_COMPLETED_SEARCH, ENDPOINT_REST_TASKS_COMPLETED, ENDPOINT_REST_TEMPLATES_FILE, ENDPOINT_REST_TEMPLATES_URL, ENDPOINT_REST_TEMPLATES_CREATE_FROM_FILE, ENDPOINT_REST_TEMPLATES_IMPORT_FROM_FILE, ENDPOINT_REST_TEMPLATES_IMPORT_FROM_ID, ENDPOINT_REST_PROJECTS, ENDPOINT_REST_PROJECTS_SEARCH, ENDPOINT_SYNC_QUICK_ADD, ENDPOINT_REST_TASK_CLOSE, ENDPOINT_REST_TASK_REOPEN, ENDPOINT_REST_TASK_MOVE, ENDPOINT_REST_LABELS, ENDPOINT_REST_LABELS_SEARCH, ENDPOINT_REST_PROJECT_COLLABORATORS, ENDPOINT_REST_SECTIONS, ENDPOINT_REST_SECTIONS_SEARCH, ENDPOINT_REST_COMMENTS, ENDPOINT_REST_LOCATION_REMINDERS, ENDPOINT_REST_REMINDERS, ENDPOINT_REST_LABELS_SHARED, ENDPOINT_REST_LABELS_SHARED_RENAME, ENDPOINT_REST_LABELS_SHARED_REMOVE, ENDPOINT_SYNC, PROJECT_ARCHIVE, PROJECT_UNARCHIVE, ENDPOINT_REST_PROJECTS_MOVE_TO_WORKSPACE, ENDPOINT_REST_PROJECTS_MOVE_TO_PERSONAL, ENDPOINT_REST_PROJECTS_ARCHIVED, ENDPOINT_REST_PROJECTS_ARCHIVED_COUNT, ENDPOINT_REST_PROJECTS_PERMISSIONS, ENDPOINT_REST_PROJECT_FULL, ENDPOINT_REST_PROJECT_JOIN, SECTION_ARCHIVE, SECTION_UNARCHIVE, ENDPOINT_REST_USER, ENDPOINT_REST_PRODUCTIVITY, ENDPOINT_REST_ACTIVITIES, ENDPOINT_REST_UPLOADS, getProjectInsightsActivityStatsEndpoint, getProjectInsightsHealthEndpoint, getProjectInsightsHealthContextEndpoint, getProjectInsightsProgressEndpoint, getProjectInsightsHealthAnalyzeEndpoint, getWorkspaceInsightsEndpoint, ENDPOINT_REST_BACKUPS, ENDPOINT_REST_BACKUPS_DOWNLOAD, ENDPOINT_REST_EMAILS, ENDPOINT_REST_ID_MAPPINGS, ENDPOINT_REST_MOVED_IDS, ENDPOINT_REST_WORKSPACES, ENDPOINT_WORKSPACE_MEMBERS, getWorkspaceUserTasksEndpoint, getWorkspaceInviteUsersEndpoint, getWorkspaceUserEndpoint, ENDPOINT_WORKSPACE_INVITATIONS, ENDPOINT_WORKSPACE_INVITATIONS_ALL, ENDPOINT_WORKSPACE_INVITATIONS_DELETE, getWorkspaceInvitationAcceptEndpoint, getWorkspaceInvitationRejectEndpoint, ENDPOINT_WORKSPACE_JOIN, ENDPOINT_WORKSPACE_LOGO, ENDPOINT_WORKSPACE_PLAN_DETAILS, ENDPOINT_WORKSPACE_USERS, getWorkspaceActiveProjectsEndpoint, getWorkspaceArchivedProjectsEndpoint, } from './consts/endpoints.js';
-import { validateAttachment, validateComment, validateCommentArray, validateCurrentUser, validateLabel, validateLabelArray, validateProject, validateProjectArray, validateSection, validateSectionArray, validateTask, validateTaskArray, validateUserArray, validateProductivityStats, validateReminder, validateReminderArray, validateLocationReminderArray, validateActivityEventArray, validateWorkspaceUserArray, validateWorkspaceInvitation, validateWorkspaceInvitationArray, validateWorkspacePlanDetails, validateJoinWorkspaceResult, validateWorkspace, validateWorkspaceArray, validateMemberActivityInfoArray, validateWorkspaceUserTaskArray, validateProjectActivityStats, validateProjectHealth, validateProjectHealthContext, validateProjectProgress, validateWorkspaceInsights, validateBackupArray, validateIdMappingArray, validateMovedIdArray, } 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_TASKS_COMPLETED, ENDPOINT_REST_TEMPLATES_FILE, ENDPOINT_REST_TEMPLATES_URL, ENDPOINT_REST_TEMPLATES_CREATE_FROM_FILE, ENDPOINT_REST_TEMPLATES_IMPORT_FROM_FILE, ENDPOINT_REST_TEMPLATES_IMPORT_FROM_ID, ENDPOINT_REST_PROJECTS, ENDPOINT_REST_PROJECTS_SEARCH, ENDPOINT_SYNC_QUICK_ADD, ENDPOINT_REST_TASK_CLOSE, ENDPOINT_REST_TASK_REOPEN, ENDPOINT_REST_TASK_MOVE, ENDPOINT_REST_LABELS, ENDPOINT_REST_LABELS_SEARCH, ENDPOINT_REST_PROJECT_COLLABORATORS, ENDPOINT_REST_SECTIONS, ENDPOINT_REST_SECTIONS_SEARCH, ENDPOINT_REST_COMMENTS, ENDPOINT_REST_LOCATION_REMINDERS, ENDPOINT_REST_REMINDERS, ENDPOINT_REST_LABELS_SHARED, ENDPOINT_REST_LABELS_SHARED_RENAME, ENDPOINT_REST_LABELS_SHARED_REMOVE, ENDPOINT_SYNC, PROJECT_ARCHIVE, PROJECT_UNARCHIVE, ENDPOINT_REST_PROJECTS_MOVE_TO_WORKSPACE, ENDPOINT_REST_PROJECTS_MOVE_TO_PERSONAL, ENDPOINT_REST_PROJECTS_ARCHIVED, ENDPOINT_REST_PROJECTS_ARCHIVED_COUNT, ENDPOINT_REST_PROJECTS_PERMISSIONS, ENDPOINT_REST_PROJECT_FULL, ENDPOINT_REST_PROJECT_JOIN, SECTION_ARCHIVE, SECTION_UNARCHIVE, ENDPOINT_REST_USER, ENDPOINT_REST_PRODUCTIVITY, ENDPOINT_REST_ACTIVITIES, ENDPOINT_REST_UPLOADS, getProjectInsightsActivityStatsEndpoint, getProjectInsightsHealthEndpoint, getProjectInsightsHealthContextEndpoint, getProjectInsightsProgressEndpoint, getProjectInsightsHealthAnalyzeEndpoint, getWorkspaceInsightsEndpoint, ENDPOINT_REST_BACKUPS, ENDPOINT_REST_BACKUPS_DOWNLOAD, ENDPOINT_REST_EMAILS, ENDPOINT_REST_ID_MAPPINGS, ENDPOINT_REST_MOVED_IDS, ENDPOINT_REST_WORKSPACES, ENDPOINT_WORKSPACE_MEMBERS, getWorkspaceUserTasksEndpoint, getWorkspaceInviteUsersEndpoint, getWorkspaceUserEndpoint, 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, ENDPOINT_REST_FOLDERS, } from './consts/endpoints.js';
+import { validateAttachment, validateComment, validateCommentArray, validateCurrentUser, validateLabel, validateLabelArray, validateProject, validateProjectArray, validateSection, validateSectionArray, validateTask, validateTaskArray, validateUserArray, validateProductivityStats, validateReminder, validateReminderArray, validateLocationReminderArray, validateActivityEventArray, validateWorkspaceUserArray, validateWorkspaceInvitation, validateWorkspaceInvitationArray, validateWorkspacePlanDetails, validateJoinWorkspaceResult, validateWorkspace, validateWorkspaceArray, validateMemberActivityInfoArray, validateWorkspaceUserTaskArray, validateProjectActivityStats, validateProjectHealth, validateProjectHealthContext, validateProjectProgress, validateWorkspaceInsights, validateBackupArray, validateIdMappingArray, validateMovedIdArray, validateFolder, validateFolderArray, } from './utils/validators.js';
 import { formatDateToYYYYMMDD } from './utils/url-helpers.js';
 import { uploadMultipartFile } from './utils/multipart-upload.js';
 import { camelCaseKeys } from './utils/case-conversion.js';
@@ -1790,6 +1790,103 @@ export class TodoistApi {
             arrayBuffer: () => response.arrayBuffer(),
         };
     }
+    // ── Folders ──
+    /**
+     * Retrieves a paginated list of folders.
+     *
+     * @param args - Filter parameters such as workspace ID.
+     * @returns A promise that resolves to a paginated response of folders.
+     */
+    async getFolders(args) {
+        const { data: { results, nextCursor }, } = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_FOLDERS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: validateFolderArray(results),
+            nextCursor,
+        };
+    }
+    /**
+     * Retrieves a single folder by its ID.
+     *
+     * @param id - The unique identifier of the folder.
+     * @returns A promise that resolves to the requested folder.
+     */
+    async getFolder(id) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_FOLDERS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return validateFolder(response.data);
+    }
+    /**
+     * Creates a new folder.
+     *
+     * @param args - Folder creation parameters including name and workspace ID.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the created folder.
+     */
+    async addFolder(args, requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_FOLDERS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return validateFolder(response.data);
+    }
+    /**
+     * Updates an existing folder by its ID.
+     *
+     * @param id - The unique identifier of the folder to update.
+     * @param args - Update parameters such as name or default order.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated folder.
+     */
+    async updateFolder(id, args, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_FOLDERS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return validateFolder(response.data);
+    }
+    /**
+     * Deletes a folder by its ID.
+     *
+     * @param id - The unique identifier of the folder to delete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
+    async deleteFolder(id, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'DELETE',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_FOLDERS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return isSuccess(response);
+    }
     // ── Backups ──
     /**
      * Retrieves a list of available backups.

package/dist/esm/types/common.js

@@ -1 +1,7 @@
-export {};
+import { z } from 'zod';
+/**
+ * Zod schema that accepts both string and number values and coerces to string.
+ * The REST API returns numeric IDs while the Sync API returns string IDs.
+ */
+const StringOrNumberSchema = z.union([z.string(), z.number()]).transform((val) => String(val));
+export { StringOrNumberSchema };

package/dist/esm/types/folders/index.js

@@ -0,0 +1 @@
+export * from './requests.js';

package/dist/esm/types/folders/requests.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/index.js

@@ -8,6 +8,7 @@ export * from './users/index.js';
 export * from './productivity/index.js';
 export * from './activity/index.js';
 export * from './workspaces/index.js';
+export * from './folders/index.js';
 export * from './insights/index.js';
 export * from './backups/index.js';
 export * from './id-mappings/index.js';

package/dist/esm/types/sync/resources/workspaces.js

@@ -1,4 +1,16 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 import { z } from 'zod';
+import { StringOrNumberSchema } from '../../common.js';
 import { WorkspaceRoleSchema, WorkspacePlanSchema, WorkspaceLimitsSchema, WorkspacePropertiesSchema, } from '../../workspaces/types.js';
 /**
  * Sync API workspace resource.
@@ -9,20 +21,21 @@ import { WorkspaceRoleSchema, WorkspacePlanSchema, WorkspaceLimitsSchema, Worksp
  */
 export const SyncWorkspaceSchema = z
     .object({
-    id: z.string(),
+    id: StringOrNumberSchema,
     name: z.string(),
     description: z.string(),
     logoBig: z.string().optional(),
     logoMedium: z.string().optional(),
     logoSmall: z.string().optional(),
     logoS640: z.string().optional(),
-    creatorId: z.string(),
-    createdAt: z.string(),
+    creatorId: StringOrNumberSchema,
+    createdAt: z.string().optional(),
+    dateCreated: z.string().optional(),
     isDeleted: z.boolean(),
     isCollapsed: z.boolean(),
-    role: WorkspaceRoleSchema,
+    role: WorkspaceRoleSchema.optional(),
     plan: WorkspacePlanSchema,
-    limits: WorkspaceLimitsSchema,
+    limits: WorkspaceLimitsSchema.optional(),
     inviteCode: z.string().nullable().optional(),
     isLinkSharingEnabled: z.boolean().nullable().optional(),
     isGuestAllowed: z.boolean().nullable().optional(),
@@ -50,4 +63,8 @@ export const SyncWorkspaceSchema = z
         .optional(),
     properties: WorkspacePropertiesSchema.optional(),
 })
-    .passthrough();
+    .passthrough()
+    .transform((_a) => {
+    var { dateCreated, createdAt } = _a, rest = __rest(_a, ["dateCreated", "createdAt"]);
+    return (Object.assign(Object.assign({}, rest), { createdAt: createdAt !== null && createdAt !== void 0 ? createdAt : dateCreated }));
+});

package/dist/esm/types/workspaces/types.js

@@ -1,4 +1,16 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 import { z } from 'zod';
+import { StringOrNumberSchema } from '../common.js';
 import { DueDateSchema, DeadlineSchema } from '../tasks/types.js';
 /** Available project collaborator roles. */
 export const COLLABORATOR_ROLES = [
@@ -96,22 +108,28 @@ export const WorkspacePropertiesSchema = z.record(z.string(), z.unknown());
 /**
  * Represents a workspace in Todoist.
  */
-export const WorkspaceSchema = z.object({
-    id: z.string(),
+export const WorkspaceSchema = z
+    .object({
+    id: StringOrNumberSchema,
     name: z.string(),
     plan: WorkspacePlanSchema,
-    role: WorkspaceRoleSchema,
+    role: WorkspaceRoleSchema.optional(),
     inviteCode: z.string(),
     isLinkSharingEnabled: z.boolean(),
     isGuestAllowed: z.boolean(),
-    limits: WorkspaceLimitsSchema,
+    limits: WorkspaceLimitsSchema.optional(),
     logoBig: z.string().nullish(),
     logoMedium: z.string().nullish(),
     logoSmall: z.string().nullish(),
     logoS640: z.string().nullish(),
-    createdAt: z.string(),
-    creatorId: z.string(),
+    createdAt: z.string().optional(),
+    dateCreated: z.string().optional(),
+    creatorId: StringOrNumberSchema,
     properties: WorkspacePropertiesSchema,
+})
+    .transform((_a) => {
+    var { dateCreated, createdAt } = _a, rest = __rest(_a, ["dateCreated", "createdAt"]);
+    return (Object.assign(Object.assign({}, rest), { createdAt: createdAt !== null && createdAt !== void 0 ? createdAt : dateCreated }));
 });
 export const MemberActivityInfoSchema = z.object({
     userId: z.string(),

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

@@ -56,6 +56,7 @@ export declare const ENDPOINT_SYNC = "sync";
 export declare const ENDPOINT_AUTHORIZATION = "authorize";
 export declare const ENDPOINT_GET_TOKEN = "access_token";
 export declare const ENDPOINT_REVOKE = "revoke";
+export declare const ENDPOINT_REST_FOLDERS = "folders";
 export declare const ENDPOINT_REST_WORKSPACES = "workspaces";
 export declare const ENDPOINT_WORKSPACE_INVITATIONS = "workspaces/invitations";
 export declare const ENDPOINT_WORKSPACE_INVITATIONS_ALL = "workspaces/invitations/all";

package/dist/types/test-utils/test-defaults.d.ts

@@ -1,4 +1,4 @@
-import { Label, Section, Task, User, Attachment, Duration, Deadline, RawComment, PersonalProject, Reminder } from '../types/index.js';
+import { Label, Section, Task, User, Attachment, Duration, Deadline, RawComment, PersonalProject, Reminder, Folder } from '../types/index.js';
 export declare const DEFAULT_TASK_ID = "1234";
 export declare const DEFAULT_TASK_CONTENT = "This is a task";
 export declare const DEFAULT_TASK_DESCRIPTION = "A description";
@@ -258,3 +258,4 @@ export declare const COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT: {
     itemId?: string | undefined;
     projectId?: string | undefined;
 };
+export declare const DEFAULT_FOLDER: Folder;

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

@@ -8,6 +8,8 @@ import { CurrentUser } from './types/users/index.js';
 import { ProductivityStats } from './types/productivity/index.js';
 import { GetActivityLogsArgs, GetActivityLogsResponse } from './types/activity/index.js';
 import { WorkspaceInvitation, WorkspacePlanDetails, JoinWorkspaceResult, Workspace, AddWorkspaceArgs, UpdateWorkspaceArgs, GetWorkspaceMembersActivityArgs, GetWorkspaceMembersActivityResponse, GetWorkspaceUserTasksArgs, GetWorkspaceUserTasksResponse, InviteWorkspaceUsersArgs, InviteWorkspaceUsersResponse, UpdateWorkspaceUserArgs, RemoveWorkspaceUserArgs, GetWorkspaceInvitationsArgs, DeleteWorkspaceInvitationArgs, WorkspaceInvitationActionArgs, JoinWorkspaceArgs, WorkspaceLogoArgs, GetWorkspacePlanDetailsArgs, GetWorkspaceUsersArgs, GetWorkspaceUsersResponse, GetWorkspaceProjectsArgs, WorkspaceInvitationsResponse, AllWorkspaceInvitationsResponse, WorkspaceLogoResponse } from './types/workspaces/index.js';
+import { GetFoldersArgs, GetFoldersResponse, AddFolderArgs, UpdateFolderArgs } from './types/folders/index.js';
+import type { Folder } from './types/sync/resources/folders.js';
 import { ProjectActivityStats, ProjectHealth, ProjectHealthContext, ProjectProgress, WorkspaceInsights, GetProjectActivityStatsArgs, GetWorkspaceInsightsArgs } from './types/insights/index.js';
 import { Backup, GetBackupsArgs, DownloadBackupArgs } from './types/backups/index.js';
 import { IdMapping, MovedId, GetIdMappingsArgs, GetMovedIdsArgs } from './types/id-mappings/index.js';
@@ -714,6 +716,45 @@ export declare class TodoistApi {
      * ```
      */
     viewAttachment(commentOrUrl: Comment | string): Promise<FileResponse>;
+    /**
+     * Retrieves a paginated list of folders.
+     *
+     * @param args - Filter parameters such as workspace ID.
+     * @returns A promise that resolves to a paginated response of folders.
+     */
+    getFolders(args: GetFoldersArgs): Promise<GetFoldersResponse>;
+    /**
+     * Retrieves a single folder by its ID.
+     *
+     * @param id - The unique identifier of the folder.
+     * @returns A promise that resolves to the requested folder.
+     */
+    getFolder(id: string): Promise<Folder>;
+    /**
+     * Creates a new folder.
+     *
+     * @param args - Folder creation parameters including name and workspace ID.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the created folder.
+     */
+    addFolder(args: AddFolderArgs, requestId?: string): Promise<Folder>;
+    /**
+     * Updates an existing folder by its ID.
+     *
+     * @param id - The unique identifier of the folder to update.
+     * @param args - Update parameters such as name or default order.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the updated folder.
+     */
+    updateFolder(id: string, args: UpdateFolderArgs, requestId?: string): Promise<Folder>;
+    /**
+     * Deletes a folder by its ID.
+     *
+     * @param id - The unique identifier of the folder to delete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if successful.
+     */
+    deleteFolder(id: string, requestId?: string): Promise<boolean>;
     /**
      * Retrieves a list of available backups.
      *

package/dist/types/types/common.d.ts

@@ -1,6 +1,13 @@
+import { z } from 'zod';
 type SearchArgs = {
     query: string;
     cursor?: string | null;
     limit?: number;
 };
+/**
+ * Zod schema that accepts both string and number values and coerces to string.
+ * The REST API returns numeric IDs while the Sync API returns string IDs.
+ */
+declare const StringOrNumberSchema: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+export { StringOrNumberSchema };
 export type { SearchArgs };

package/dist/types/types/folders/index.d.ts

@@ -0,0 +1 @@
+export * from './requests.js';

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

@@ -0,0 +1,20 @@
+import type { Folder } from '../sync/resources/folders.js';
+export type GetFoldersArgs = {
+    workspaceId: number;
+    cursor?: string | null;
+    limit?: number;
+};
+export type GetFoldersResponse = {
+    results: Folder[];
+    nextCursor: string | null;
+};
+export type AddFolderArgs = {
+    name: string;
+    workspaceId: number;
+    defaultOrder?: number | null;
+    childOrder?: number | null;
+};
+export type UpdateFolderArgs = {
+    name?: string | null;
+    defaultOrder?: number | null;
+};

package/dist/types/types/index.d.ts

@@ -8,6 +8,7 @@ export * from './users/index.js';
 export * from './productivity/index.js';
 export * from './activity/index.js';
 export * from './workspaces/index.js';
+export * from './folders/index.js';
 export * from './insights/index.js';
 export * from './backups/index.js';
 export * from './id-mappings/index.js';

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

@@ -6,31 +6,32 @@ import { z } from 'zod';
  * additional fields like description, isDeleted, isCollapsed, member counts,
  * domain settings, and sorting preferences.
  */
-export declare const SyncWorkspaceSchema: z.ZodObject<{
-    id: z.ZodString;
+export declare const SyncWorkspaceSchema: z.ZodPipe<z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
     name: z.ZodString;
     description: z.ZodString;
     logoBig: z.ZodOptional<z.ZodString>;
     logoMedium: z.ZodOptional<z.ZodString>;
     logoSmall: z.ZodOptional<z.ZodString>;
     logoS640: z.ZodOptional<z.ZodString>;
-    creatorId: z.ZodString;
-    createdAt: z.ZodString;
+    creatorId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
+    createdAt: z.ZodOptional<z.ZodString>;
+    dateCreated: z.ZodOptional<z.ZodString>;
     isDeleted: z.ZodBoolean;
     isCollapsed: z.ZodBoolean;
-    role: z.ZodEnum<{
+    role: z.ZodOptional<z.ZodEnum<{
         ADMIN: "ADMIN";
         MEMBER: "MEMBER";
         GUEST: "GUEST";
-    }>;
+    }>>;
     plan: z.ZodEnum<{
         STARTER: "STARTER";
         BUSINESS: "BUSINESS";
     }>;
-    limits: z.ZodObject<{
+    limits: z.ZodOptional<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>>;
+    }, z.core.$catchall<z.ZodAny>>>;
     inviteCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     isLinkSharingEnabled: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     isGuestAllowed: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
@@ -53,5 +54,89 @@ export declare const SyncWorkspaceSchema: z.ZodObject<{
         userIds: z.ZodArray<z.ZodNumber>;
     }, z.core.$strip>>;
     properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, z.core.$loose>;
+}, z.core.$loose>, z.ZodTransform<{
+    createdAt: string | undefined;
+    id: string;
+    name: string;
+    description: string;
+    creatorId: string;
+    isDeleted: boolean;
+    isCollapsed: boolean;
+    plan: "STARTER" | "BUSINESS";
+    currentActiveProjects: number | null;
+    currentMemberCount: number | null;
+    currentTemplateCount: number | null;
+    adminSortingApplied: boolean;
+    logoBig?: string | undefined;
+    logoMedium?: string | undefined;
+    logoSmall?: string | undefined;
+    logoS640?: string | undefined;
+    role?: "ADMIN" | "MEMBER" | "GUEST" | undefined;
+    limits?: {
+        [x: string]: any;
+        current: Record<string, any> | null;
+        next: Record<string, any> | null;
+    } | undefined;
+    inviteCode?: string | null | undefined;
+    isLinkSharingEnabled?: boolean | null | undefined;
+    isGuestAllowed?: boolean | null | undefined;
+    memberCountByType?: {
+        adminCount: number;
+        guestCount: number;
+        memberCount: number;
+    } | undefined;
+    pendingInvitations?: string[] | null | undefined;
+    domainName?: string | undefined;
+    domainDiscovery?: boolean | undefined;
+    restrictEmailDomains?: boolean | undefined;
+    projectSortPreference?: string | undefined;
+    defaultCollaborators?: {
+        predefinedGroupIds: string[];
+        userIds: number[];
+    } | undefined;
+    properties?: Record<string, unknown> | undefined;
+}, {
+    [x: string]: unknown;
+    id: string;
+    name: string;
+    description: string;
+    creatorId: string;
+    isDeleted: boolean;
+    isCollapsed: boolean;
+    plan: "STARTER" | "BUSINESS";
+    currentActiveProjects: number | null;
+    currentMemberCount: number | null;
+    currentTemplateCount: number | null;
+    adminSortingApplied: boolean;
+    logoBig?: string | undefined;
+    logoMedium?: string | undefined;
+    logoSmall?: string | undefined;
+    logoS640?: string | undefined;
+    createdAt?: string | undefined;
+    dateCreated?: string | undefined;
+    role?: "ADMIN" | "MEMBER" | "GUEST" | undefined;
+    limits?: {
+        [x: string]: any;
+        current: Record<string, any> | null;
+        next: Record<string, any> | null;
+    } | undefined;
+    inviteCode?: string | null | undefined;
+    isLinkSharingEnabled?: boolean | null | undefined;
+    isGuestAllowed?: boolean | null | undefined;
+    memberCountByType?: {
+        adminCount: number;
+        guestCount: number;
+        memberCount: number;
+    } | undefined;
+    pendingInvitations?: string[] | null | undefined;
+    domainName?: string | undefined;
+    domainDiscovery?: boolean | undefined;
+    restrictEmailDomains?: boolean | undefined;
+    projectSortPreference?: string | undefined;
+    defaultCollaborators?: {
+        predefinedGroupIds: string[];
+        userIds: number[];
+    } | undefined;
+    properties?: Record<string, unknown> | undefined;
+}>>;
 export type SyncWorkspace = z.infer<typeof SyncWorkspaceSchema>;

package/dist/types/types/workspaces/types.d.ts

@@ -158,33 +158,75 @@ export type WorkspaceProperties = z.infer<typeof WorkspacePropertiesSchema>;
 /**
  * Represents a workspace in Todoist.
  */
-export declare const WorkspaceSchema: z.ZodObject<{
-    id: z.ZodString;
+export declare const WorkspaceSchema: z.ZodPipe<z.ZodObject<{
+    id: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
     name: z.ZodString;
     plan: z.ZodEnum<{
         STARTER: "STARTER";
         BUSINESS: "BUSINESS";
     }>;
-    role: z.ZodEnum<{
+    role: z.ZodOptional<z.ZodEnum<{
         ADMIN: "ADMIN";
         MEMBER: "MEMBER";
         GUEST: "GUEST";
-    }>;
+    }>>;
     inviteCode: z.ZodString;
     isLinkSharingEnabled: z.ZodBoolean;
     isGuestAllowed: z.ZodBoolean;
-    limits: z.ZodObject<{
+    limits: z.ZodOptional<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>>;
+    }, 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;
+    createdAt: z.ZodOptional<z.ZodString>;
+    dateCreated: z.ZodOptional<z.ZodString>;
+    creatorId: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>;
     properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-}, z.core.$strip>;
+}, z.core.$strip>, z.ZodTransform<{
+    createdAt: string | undefined;
+    id: string;
+    name: string;
+    plan: "STARTER" | "BUSINESS";
+    inviteCode: string;
+    isLinkSharingEnabled: boolean;
+    isGuestAllowed: boolean;
+    creatorId: string;
+    properties: Record<string, unknown>;
+    role?: "ADMIN" | "MEMBER" | "GUEST" | undefined;
+    limits?: {
+        [x: string]: any;
+        current: Record<string, any> | null;
+        next: Record<string, any> | null;
+    } | undefined;
+    logoBig?: string | null | undefined;
+    logoMedium?: string | null | undefined;
+    logoSmall?: string | null | undefined;
+    logoS640?: string | null | undefined;
+}, {
+    id: string;
+    name: string;
+    plan: "STARTER" | "BUSINESS";
+    inviteCode: string;
+    isLinkSharingEnabled: boolean;
+    isGuestAllowed: boolean;
+    creatorId: string;
+    properties: Record<string, unknown>;
+    role?: "ADMIN" | "MEMBER" | "GUEST" | undefined;
+    limits?: {
+        [x: string]: any;
+        current: Record<string, any> | null;
+        next: Record<string, any> | null;
+    } | undefined;
+    logoBig?: string | null | undefined;
+    logoMedium?: string | null | undefined;
+    logoSmall?: string | null | undefined;
+    logoS640?: string | null | undefined;
+    createdAt?: string | undefined;
+    dateCreated?: string | undefined;
+}>>;
 export type Workspace = z.infer<typeof WorkspaceSchema>;
 export declare const MemberActivityInfoSchema: z.ZodObject<{
     userId: z.ZodString;

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

@@ -409,42 +409,42 @@ export declare const validateJoinWorkspaceResult: (input: unknown) => {
     workspaceId: string;
 };
 export declare const validateWorkspace: (input: unknown) => {
+    createdAt: string | undefined;
     id: string;
     name: string;
     plan: "STARTER" | "BUSINESS";
-    role: "ADMIN" | "MEMBER" | "GUEST";
     inviteCode: string;
     isLinkSharingEnabled: boolean;
     isGuestAllowed: boolean;
-    limits: {
+    creatorId: string;
+    properties: Record<string, unknown>;
+    role?: "ADMIN" | "MEMBER" | "GUEST" | undefined;
+    limits?: {
         [x: string]: any;
         current: Record<string, any> | null;
         next: Record<string, any> | null;
-    };
-    createdAt: string;
-    creatorId: string;
-    properties: Record<string, unknown>;
+    } | undefined;
     logoBig?: string | null | undefined;
     logoMedium?: string | null | undefined;
     logoSmall?: string | null | undefined;
     logoS640?: string | null | undefined;
 };
 export declare const validateWorkspaceArray: (input: unknown[]) => {
+    createdAt: string | undefined;
     id: string;
     name: string;
     plan: "STARTER" | "BUSINESS";
-    role: "ADMIN" | "MEMBER" | "GUEST";
     inviteCode: string;
     isLinkSharingEnabled: boolean;
     isGuestAllowed: boolean;
-    limits: {
+    creatorId: string;
+    properties: Record<string, unknown>;
+    role?: "ADMIN" | "MEMBER" | "GUEST" | undefined;
+    limits?: {
         [x: string]: any;
         current: Record<string, any> | null;
         next: Record<string, any> | null;
-    };
-    createdAt: string;
-    creatorId: string;
-    properties: Record<string, unknown>;
+    } | undefined;
     logoBig?: string | null | undefined;
     logoMedium?: string | null | undefined;
     logoSmall?: string | null | undefined;
@@ -1137,21 +1137,14 @@ export declare const validateLiveNotificationArray: (input: unknown[]) => {
     invitationSecret?: string | undefined;
 }[];
 export declare const validateSyncWorkspace: (input: unknown) => {
-    [x: string]: unknown;
+    createdAt: string | undefined;
     id: string;
     name: string;
     description: string;
     creatorId: string;
-    createdAt: string;
     isDeleted: boolean;
     isCollapsed: boolean;
-    role: "ADMIN" | "MEMBER" | "GUEST";
     plan: "STARTER" | "BUSINESS";
-    limits: {
-        [x: string]: any;
-        current: Record<string, any> | null;
-        next: Record<string, any> | null;
-    };
     currentActiveProjects: number | null;
     currentMemberCount: number | null;
     currentTemplateCount: number | null;
@@ -1160,6 +1153,12 @@ export declare const validateSyncWorkspace: (input: unknown) => {
     logoMedium?: string | undefined;
     logoSmall?: string | undefined;
     logoS640?: string | undefined;
+    role?: "ADMIN" | "MEMBER" | "GUEST" | undefined;
+    limits?: {
+        [x: string]: any;
+        current: Record<string, any> | null;
+        next: Record<string, any> | null;
+    } | undefined;
     inviteCode?: string | null | undefined;
     isLinkSharingEnabled?: boolean | null | undefined;
     isGuestAllowed?: boolean | null | undefined;
@@ -1180,21 +1179,14 @@ export declare const validateSyncWorkspace: (input: unknown) => {
     properties?: Record<string, unknown> | undefined;
 };
 export declare const validateSyncWorkspaceArray: (input: unknown[]) => {
-    [x: string]: unknown;
+    createdAt: string | undefined;
     id: string;
     name: string;
     description: string;
     creatorId: string;
-    createdAt: string;
     isDeleted: boolean;
     isCollapsed: boolean;
-    role: "ADMIN" | "MEMBER" | "GUEST";
     plan: "STARTER" | "BUSINESS";
-    limits: {
-        [x: string]: any;
-        current: Record<string, any> | null;
-        next: Record<string, any> | null;
-    };
     currentActiveProjects: number | null;
     currentMemberCount: number | null;
     currentTemplateCount: number | null;
@@ -1203,6 +1195,12 @@ export declare const validateSyncWorkspaceArray: (input: unknown[]) => {
     logoMedium?: string | undefined;
     logoSmall?: string | undefined;
     logoS640?: string | undefined;
+    role?: "ADMIN" | "MEMBER" | "GUEST" | undefined;
+    limits?: {
+        [x: string]: any;
+        current: Record<string, any> | null;
+        next: Record<string, any> | null;
+    } | undefined;
     inviteCode?: string | null | undefined;
     isLinkSharingEnabled?: boolean | null | undefined;
     isGuestAllowed?: boolean | null | undefined;

package/package.json

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