@doist/todoist-api-typescript 6.3.0 → 6.4.0

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);
         }
@@ -1288,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/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_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, } from './utils/validators.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);
         }
@@ -1285,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/todoist-api.d.ts

@@ -1,4 +1,4 @@
-import { Attachment, PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser, ProductivityStats, WorkspaceInvitation, WorkspacePlanDetails, JoinWorkspaceResult } from './types/entities.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';
 /**
@@ -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.
      *
@@ -529,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/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.3.0",
+    "version": "6.4.0",
     "description": "A typescript wrapper for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-api-typescript",