@doist/todoist-sdk 8.0.0 → 8.0.1

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.DEFAULT_NOTE = exports.DEFAULT_COLLABORATOR_STATE = exports.DEFAULT_COLLABORATOR = 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.DEFAULT_WORKSPACE_PROJECT = 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';
@@ -131,6 +131,32 @@ exports.DEFAULT_PROJECT = {
 };
 exports.INVALID_PROJECT = Object.assign(Object.assign({}, exports.DEFAULT_PROJECT), { name: 123 });
 exports.PROJECT_WITH_OPTIONALS_AS_NULL = Object.assign(Object.assign({}, exports.DEFAULT_PROJECT), { parentId: null });
+exports.DEFAULT_WORKSPACE_PROJECT = {
+    id: exports.DEFAULT_PROJECT_ID,
+    name: exports.DEFAULT_PROJECT_NAME,
+    color: DEFAULT_ENTITY_COLOR,
+    childOrder: exports.DEFAULT_ORDER,
+    isFavorite: false,
+    isShared: true,
+    viewStyle: exports.DEFAULT_PROJECT_VIEW_STYLE,
+    canAssignTasks: DEFAULT_CAN_ASSIGN_TASKS,
+    isArchived: DEFAULT_IS_ARCHIVED,
+    isDeleted: DEFAULT_IS_DELETED,
+    isFrozen: DEFAULT_IS_FROZEN,
+    createdAt: DEFAULT_DATE,
+    updatedAt: DEFAULT_DATE,
+    defaultOrder: exports.DEFAULT_ORDER,
+    description: '',
+    isCollapsed: DEFAULT_IS_COLLAPSED,
+    url: DEFAULT_PROJECT_URL,
+    workspaceId: '100',
+    folderId: null,
+    collaboratorRoleDefault: 'READ_WRITE',
+    isInviteOnly: false,
+    isLinkSharingEnabled: true,
+    role: 'ADMIN',
+    status: 'ACTIVE',
+};
 exports.DEFAULT_SECTION = {
     id: DEFAULT_SECTION_ID,
     userId: DEFAULT_USER_ID,
@@ -238,3 +264,27 @@ exports.DEFAULT_FOLDER = {
     childOrder: 3,
     isDeleted: false,
 };
+exports.DEFAULT_COLLABORATOR = {
+    id: DEFAULT_USER_ID,
+    email: DEFAULT_USER_EMAIL,
+    fullName: DEFAULT_USER_NAME,
+    timezone: 'UTC',
+    imageId: null,
+};
+exports.DEFAULT_COLLABORATOR_STATE = {
+    userId: DEFAULT_USER_ID,
+    projectId: exports.DEFAULT_PROJECT_ID,
+    state: 'active',
+    isDeleted: false,
+};
+exports.DEFAULT_NOTE = {
+    id: DEFAULT_COMMENT_ID,
+    projectId: exports.DEFAULT_PROJECT_ID,
+    content: DEFAULT_COMMENT_CONTENT,
+    postedAt: DEFAULT_DATE,
+    fileAttachment: exports.DEFAULT_ATTACHMENT,
+    postedUid: DEFAULT_USER_ID,
+    uidsToNotify: null,
+    reactions: DEFAULT_COMMENT_REACTIONS,
+    isDeleted: false,
+};

package/dist/cjs/todoist-api.js

@@ -12,6 +12,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TodoistApi = void 0;
+const projects_1 = require("./types/projects");
 const reminders_1 = require("./types/reminders");
 const http_client_1 = require("./transport/http-client");
 const endpoints_1 = require("./consts/endpoints");
@@ -771,15 +772,18 @@ class TodoistApi {
         };
     }
     /**
-     * Joins a shared project by its ID.
+     * Joins a workspace project.
      *
-     * @param id - The unique identifier of the project to join.
+     * Only used for workspaces — this endpoint is used to join a workspace project
+     * by a workspace user.
+     *
+     * @param id - The unique identifier of the workspace project to join.
      * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the joined project.
+     * @returns A promise that resolves to the full project data after joining.
      */
     async joinProject(id, requestId) {
         zod_1.z.string().parse(id);
-        const response = await (0, http_client_1.request)({
+        const { data } = await (0, http_client_1.request)({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
             relativePath: generatePath(endpoints_1.ENDPOINT_REST_PROJECTS, id, endpoints_1.ENDPOINT_REST_PROJECT_JOIN),
@@ -787,7 +791,16 @@ class TodoistApi {
             customFetch: this.customFetch,
             requestId: requestId,
         });
-        return (0, validators_1.validateProject)(response.data);
+        return {
+            project: projects_1.WorkspaceProjectSchema.parse(data.project),
+            tasks: (0, validators_1.validateTaskArray)(data.tasks),
+            sections: (0, validators_1.validateSectionArray)(data.sections),
+            comments: (0, validators_1.validateNoteArray)(data.comments),
+            collaborators: (0, validators_1.validateCollaboratorArray)(data.collaborators),
+            collaboratorStates: (0, validators_1.validateCollaboratorStateArray)(data.collaboratorStates),
+            folder: data.folder ? (0, validators_1.validateFolder)(data.folder) : null,
+            subprojects: data.subprojects.map((p) => projects_1.WorkspaceProjectSchema.parse(p)),
+        };
     }
     /**
      * Retrieves a list of collaborators for a specific project.

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

@@ -128,6 +128,32 @@ export const DEFAULT_PROJECT = {
 };
 export const INVALID_PROJECT = Object.assign(Object.assign({}, DEFAULT_PROJECT), { name: 123 });
 export const PROJECT_WITH_OPTIONALS_AS_NULL = Object.assign(Object.assign({}, DEFAULT_PROJECT), { parentId: null });
+export const DEFAULT_WORKSPACE_PROJECT = {
+    id: DEFAULT_PROJECT_ID,
+    name: DEFAULT_PROJECT_NAME,
+    color: DEFAULT_ENTITY_COLOR,
+    childOrder: DEFAULT_ORDER,
+    isFavorite: false,
+    isShared: true,
+    viewStyle: DEFAULT_PROJECT_VIEW_STYLE,
+    canAssignTasks: DEFAULT_CAN_ASSIGN_TASKS,
+    isArchived: DEFAULT_IS_ARCHIVED,
+    isDeleted: DEFAULT_IS_DELETED,
+    isFrozen: DEFAULT_IS_FROZEN,
+    createdAt: DEFAULT_DATE,
+    updatedAt: DEFAULT_DATE,
+    defaultOrder: DEFAULT_ORDER,
+    description: '',
+    isCollapsed: DEFAULT_IS_COLLAPSED,
+    url: DEFAULT_PROJECT_URL,
+    workspaceId: '100',
+    folderId: null,
+    collaboratorRoleDefault: 'READ_WRITE',
+    isInviteOnly: false,
+    isLinkSharingEnabled: true,
+    role: 'ADMIN',
+    status: 'ACTIVE',
+};
 export const DEFAULT_SECTION = {
     id: DEFAULT_SECTION_ID,
     userId: DEFAULT_USER_ID,
@@ -235,3 +261,27 @@ export const DEFAULT_FOLDER = {
     childOrder: 3,
     isDeleted: false,
 };
+export const DEFAULT_COLLABORATOR = {
+    id: DEFAULT_USER_ID,
+    email: DEFAULT_USER_EMAIL,
+    fullName: DEFAULT_USER_NAME,
+    timezone: 'UTC',
+    imageId: null,
+};
+export const DEFAULT_COLLABORATOR_STATE = {
+    userId: DEFAULT_USER_ID,
+    projectId: DEFAULT_PROJECT_ID,
+    state: 'active',
+    isDeleted: false,
+};
+export const DEFAULT_NOTE = {
+    id: DEFAULT_COMMENT_ID,
+    projectId: DEFAULT_PROJECT_ID,
+    content: DEFAULT_COMMENT_CONTENT,
+    postedAt: DEFAULT_DATE,
+    fileAttachment: DEFAULT_ATTACHMENT,
+    postedUid: DEFAULT_USER_ID,
+    uidsToNotify: null,
+    reactions: DEFAULT_COMMENT_REACTIONS,
+    isDeleted: false,
+};

package/dist/esm/todoist-api.js

@@ -9,10 +9,11 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
+import { WorkspaceProjectSchema, } from './types/projects/index.js';
 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, 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 { 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, validateCollaboratorArray, validateCollaboratorStateArray, validateNoteArray, } 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';
@@ -768,15 +769,18 @@ export class TodoistApi {
         };
     }
     /**
-     * Joins a shared project by its ID.
+     * Joins a workspace project.
      *
-     * @param id - The unique identifier of the project to join.
+     * Only used for workspaces — this endpoint is used to join a workspace project
+     * by a workspace user.
+     *
+     * @param id - The unique identifier of the workspace project to join.
      * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the joined project.
+     * @returns A promise that resolves to the full project data after joining.
      */
     async joinProject(id, requestId) {
         z.string().parse(id);
-        const response = await request({
+        const { data } = await request({
             httpMethod: 'POST',
             baseUri: this.syncApiBase,
             relativePath: generatePath(ENDPOINT_REST_PROJECTS, id, ENDPOINT_REST_PROJECT_JOIN),
@@ -784,7 +788,16 @@ export class TodoistApi {
             customFetch: this.customFetch,
             requestId: requestId,
         });
-        return validateProject(response.data);
+        return {
+            project: WorkspaceProjectSchema.parse(data.project),
+            tasks: validateTaskArray(data.tasks),
+            sections: validateSectionArray(data.sections),
+            comments: validateNoteArray(data.comments),
+            collaborators: validateCollaboratorArray(data.collaborators),
+            collaboratorStates: validateCollaboratorStateArray(data.collaboratorStates),
+            folder: data.folder ? validateFolder(data.folder) : null,
+            subprojects: data.subprojects.map((p) => WorkspaceProjectSchema.parse(p)),
+        };
     }
     /**
      * Retrieves a list of collaborators for a specific project.

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

@@ -1,4 +1,6 @@
-import { Label, Section, Task, User, Attachment, Duration, Deadline, RawComment, PersonalProject, Reminder, Folder } from '../types/index.js';
+import { Label, Section, Task, User, Attachment, Duration, Deadline, RawComment, PersonalProject, WorkspaceProject, Reminder, Folder } from '../types/index.js';
+import type { Collaborator, CollaboratorState } from '../types/sync/resources/collaborators.js';
+import type { Note } from '../types/sync/resources/notes.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";
@@ -77,6 +79,7 @@ export declare const INVALID_PROJECT: {
     inboxProject: boolean;
 };
 export declare const PROJECT_WITH_OPTIONALS_AS_NULL: PersonalProject;
+export declare const DEFAULT_WORKSPACE_PROJECT: WorkspaceProject;
 export declare const DEFAULT_SECTION: Section;
 export declare const INVALID_SECTION: {
     projectId: undefined;
@@ -259,3 +262,6 @@ export declare const COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT: {
     projectId?: string | undefined;
 };
 export declare const DEFAULT_FOLDER: Folder;
+export declare const DEFAULT_COLLABORATOR: Collaborator;
+export declare const DEFAULT_COLLABORATOR_STATE: CollaboratorState;
+export declare const DEFAULT_NOTE: Note;

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

@@ -1,5 +1,5 @@
 import { Task, AddTaskArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateTaskArgs, QuickAddTaskArgs, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, SearchCompletedTasksArgs, GetTasksResponse, GetAllCompletedTasksArgs, GetAllCompletedTasksResponse } from './types/tasks/index.js';
-import { PersonalProject, WorkspaceProject, AddProjectArgs, UpdateProjectArgs, GetProjectsArgs, SearchProjectsArgs, GetProjectCollaboratorsArgs, GetProjectsResponse, GetProjectCollaboratorsResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse, MoveProjectToWorkspaceArgs, MoveProjectToPersonalArgs, GetArchivedProjectsCountArgs, GetArchivedProjectsCountResponse, GetProjectPermissionsResponse, GetFullProjectArgs, GetFullProjectResponse } from './types/projects/index.js';
+import { PersonalProject, WorkspaceProject, AddProjectArgs, UpdateProjectArgs, GetProjectsArgs, SearchProjectsArgs, GetProjectCollaboratorsArgs, GetProjectsResponse, GetProjectCollaboratorsResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse, MoveProjectToWorkspaceArgs, MoveProjectToPersonalArgs, GetArchivedProjectsCountArgs, GetArchivedProjectsCountResponse, GetProjectPermissionsResponse, GetFullProjectArgs, GetFullProjectResponse, JoinProjectResponse } from './types/projects/index.js';
 import { Section, AddSectionArgs, UpdateSectionArgs, GetSectionsArgs, SearchSectionsArgs, GetSectionsResponse } from './types/sections/index.js';
 import { Label, AddLabelArgs, UpdateLabelArgs, GetLabelsArgs, SearchLabelsArgs, GetLabelsResponse, GetSharedLabelsArgs, GetSharedLabelsResponse, RenameSharedLabelArgs, RemoveSharedLabelArgs } from './types/labels/index.js';
 import { Attachment, Comment, AddCommentArgs, UpdateCommentArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetCommentsResponse } from './types/comments/index.js';
@@ -318,13 +318,16 @@ export declare class TodoistApi {
      */
     getFullProject(id: string, args?: GetFullProjectArgs): Promise<GetFullProjectResponse>;
     /**
-     * Joins a shared project by its ID.
+     * Joins a workspace project.
      *
-     * @param id - The unique identifier of the project to join.
+     * Only used for workspaces — this endpoint is used to join a workspace project
+     * by a workspace user.
+     *
+     * @param id - The unique identifier of the workspace project to join.
      * @param requestId - Optional custom identifier for the request.
-     * @returns A promise that resolves to the joined project.
+     * @returns A promise that resolves to the full project data after joining.
      */
-    joinProject(id: string, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
+    joinProject(id: string, requestId?: string): Promise<JoinProjectResponse>;
     /**
      * Retrieves a list of collaborators for a specific project.
      *

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

@@ -2,6 +2,9 @@ import type { ColorKey } from '../../utils/colors.js';
 import type { SearchArgs } from '../common.js';
 import type { Comment } from '../comments/types.js';
 import type { Section } from '../sections/types.js';
+import type { Collaborator, CollaboratorState } from '../sync/resources/collaborators.js';
+import type { Folder } from '../sync/resources/folders.js';
+import type { Note } from '../sync/resources/notes.js';
 import type { Task } from '../tasks/types.js';
 import type { User } from '../users/types.js';
 import type { CollaboratorRole, WorkspaceRole } from '../workspaces/types.js';
@@ -167,3 +170,21 @@ export type GetFullProjectResponse = {
     collaborators: User[];
     notes: Comment[];
 };
+/**
+ * Response from joining a workspace project.
+ *
+ * Only used for workspaces — this endpoint is used to join a workspace project
+ * by a workspace user.
+ *
+ * @see https://developer.todoist.com/api/v1/#tag/Projects/operation/join_project_api_v1_projects__project_id__join_post
+ */
+export type JoinProjectResponse = {
+    project: WorkspaceProject;
+    tasks: Task[];
+    sections: Section[];
+    comments: Note[];
+    collaborators: Collaborator[];
+    collaboratorStates: CollaboratorState[];
+    folder: Folder | null;
+    subprojects: WorkspaceProject[];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/todoist-sdk",
-    "version": "8.0.0",
+    "version": "8.0.1",
     "description": "The official TypeScript SDK for the Todoist REST API.",
     "author": "Doist developers",
     "repository": "https://github.com/Doist/todoist-sdk-typescript",