@doist/todoist-api-typescript 5.7.1 → 5.9.0

package/README.md

@@ -51,7 +51,7 @@ Example scratch.ts file:
 
 ```
 /* eslint-disable no-console */
-import { TodoistApi } from './TodoistApi'
+import { TodoistApi } from './todoist-api'
 
 const token = 'YOURTOKEN'
 const api = new TodoistApi(token)

package/dist/authentication.d.ts

@@ -29,6 +29,15 @@ export type RevokeAuthTokenRequestArgs = {
     clientSecret: string;
     accessToken: string;
 };
+/**
+ * Parameters required to revoke a token using RFC 7009 compliant endpoint.
+ * @see https://todoist.com/api/v1/docs#tag/Authorization
+ */
+export type RevokeTokenRequestArgs = {
+    clientId: string;
+    clientSecret: string;
+    token: string;
+};
 /**
  * Generates a random state parameter for OAuth2 authorization.
  * The state parameter helps prevent CSRF attacks.
@@ -88,7 +97,28 @@ export declare function getAuthToken(args: AuthTokenRequestArgs, baseUrl?: strin
  * })
  * ```
  *
+ * @deprecated Use {@link revokeToken} instead. This function uses a legacy endpoint that will be removed in a future version. The new function uses the RFC 7009 compliant endpoint.
  * @returns True if revocation was successful
  * @see https://todoist.com/api/v1/docs#tag/Authorization/operation/revoke_access_token_api_api_v1_access_tokens_delete
  */
 export declare function revokeAuthToken(args: RevokeAuthTokenRequestArgs, baseUrl?: string): Promise<boolean>;
+/**
+ * Revokes a token using the RFC 7009 OAuth 2.0 Token Revocation standard.
+ *
+ * This function uses HTTP Basic Authentication with client credentials and follows
+ * the RFC 7009 specification for token revocation.
+ *
+ * @example
+ * ```typescript
+ * await revokeToken({
+ *   clientId: 'your-client-id',
+ *   clientSecret: 'your-client-secret',
+ *   token: 'access-token-to-revoke'
+ * })
+ * ```
+ *
+ * @returns True if revocation was successful
+ * @see https://datatracker.ietf.org/doc/html/rfc7009
+ * @see https://todoist.com/api/v1/docs#tag/Authorization
+ */
+export declare function revokeToken(args: RevokeTokenRequestArgs, baseUrl?: string): Promise<boolean>;

package/dist/authentication.js

@@ -40,10 +40,21 @@ exports.getAuthStateParameter = getAuthStateParameter;
 exports.getAuthorizationUrl = getAuthorizationUrl;
 exports.getAuthToken = getAuthToken;
 exports.revokeAuthToken = revokeAuthToken;
-var restClient_1 = require("./restClient");
+exports.revokeToken = revokeToken;
+var rest_client_1 = require("./rest-client");
 var uuid_1 = require("uuid");
 var types_1 = require("./types");
 var endpoints_1 = require("./consts/endpoints");
+/**
+ * Creates a Basic Authentication header value from client credentials.
+ * @param clientId - The OAuth client ID
+ * @param clientSecret - The OAuth client secret
+ * @returns The Basic Auth header value (without the 'Basic ' prefix)
+ */
+function createBasicAuthHeader(clientId, clientSecret) {
+    var credentials = "".concat(clientId, ":").concat(clientSecret);
+    return Buffer.from(credentials).toString('base64');
+}
 /**
  * Generates a random state parameter for OAuth2 authorization.
  * The state parameter helps prevent CSRF attacks.
@@ -104,7 +115,13 @@ function getAuthToken(args, baseUrl) {
         var _a;
         return __generator(this, function (_b) {
             switch (_b.label) {
-                case 0: return [4 /*yield*/, (0, restClient_1.request)('POST', (0, endpoints_1.getAuthBaseUri)(baseUrl), endpoints_1.ENDPOINT_GET_TOKEN, undefined, args)];
+                case 0: return [4 /*yield*/, (0, rest_client_1.request)({
+                        httpMethod: 'POST',
+                        baseUri: (0, endpoints_1.getAuthBaseUri)(baseUrl),
+                        relativePath: endpoints_1.ENDPOINT_GET_TOKEN,
+                        apiToken: undefined,
+                        payload: args,
+                    })];
                 case 1:
                     response = _b.sent();
                     if (response.status !== 200 || !((_a = response.data) === null || _a === void 0 ? void 0 : _a.accessToken)) {
@@ -127,6 +144,7 @@ function getAuthToken(args, baseUrl) {
  * })
  * ```
  *
+ * @deprecated Use {@link revokeToken} instead. This function uses a legacy endpoint that will be removed in a future version. The new function uses the RFC 7009 compliant endpoint.
  * @returns True if revocation was successful
  * @see https://todoist.com/api/v1/docs#tag/Authorization/operation/revoke_access_token_api_api_v1_access_tokens_delete
  */
@@ -135,10 +153,67 @@ function revokeAuthToken(args, baseUrl) {
         var response;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0: return [4 /*yield*/, (0, restClient_1.request)('POST', (0, endpoints_1.getSyncBaseUri)(baseUrl), endpoints_1.ENDPOINT_REVOKE_TOKEN, undefined, args)];
+                case 0: return [4 /*yield*/, (0, rest_client_1.request)({
+                        httpMethod: 'POST',
+                        baseUri: (0, endpoints_1.getSyncBaseUri)(baseUrl),
+                        relativePath: endpoints_1.ENDPOINT_REVOKE_TOKEN,
+                        apiToken: undefined,
+                        payload: args,
+                    })];
+                case 1:
+                    response = _a.sent();
+                    return [2 /*return*/, (0, rest_client_1.isSuccess)(response)];
+            }
+        });
+    });
+}
+/**
+ * Revokes a token using the RFC 7009 OAuth 2.0 Token Revocation standard.
+ *
+ * This function uses HTTP Basic Authentication with client credentials and follows
+ * the RFC 7009 specification for token revocation.
+ *
+ * @example
+ * ```typescript
+ * await revokeToken({
+ *   clientId: 'your-client-id',
+ *   clientSecret: 'your-client-secret',
+ *   token: 'access-token-to-revoke'
+ * })
+ * ```
+ *
+ * @returns True if revocation was successful
+ * @see https://datatracker.ietf.org/doc/html/rfc7009
+ * @see https://todoist.com/api/v1/docs#tag/Authorization
+ */
+function revokeToken(args, baseUrl) {
+    return __awaiter(this, void 0, void 0, function () {
+        var clientId, clientSecret, token, basicAuth, customHeaders, requestBody, response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    clientId = args.clientId, clientSecret = args.clientSecret, token = args.token;
+                    basicAuth = createBasicAuthHeader(clientId, clientSecret);
+                    customHeaders = {
+                        Authorization: "Basic ".concat(basicAuth),
+                    };
+                    requestBody = {
+                        token: token,
+                        token_type_hint: 'access_token',
+                    };
+                    return [4 /*yield*/, (0, rest_client_1.request)({
+                            httpMethod: 'POST',
+                            baseUri: (0, endpoints_1.getSyncBaseUri)(baseUrl),
+                            relativePath: endpoints_1.ENDPOINT_REVOKE,
+                            apiToken: undefined,
+                            payload: requestBody,
+                            requestId: undefined,
+                            hasSyncCommands: false,
+                            customHeaders: customHeaders,
+                        })];
                 case 1:
                     response = _a.sent();
-                    return [2 /*return*/, (0, restClient_1.isSuccess)(response)];
+                    return [2 /*return*/, (0, rest_client_1.isSuccess)(response)];
             }
         });
     });

package/dist/consts/endpoints.d.ts

@@ -23,6 +23,7 @@ export declare const ENDPOINT_REST_PROJECT_COLLABORATORS = "collaborators";
 export declare const ENDPOINT_REST_USER = "user";
 export declare const ENDPOINT_REST_PRODUCTIVITY: string;
 export declare const ENDPOINT_REST_ACTIVITIES = "activities";
+export declare const ENDPOINT_REST_UPLOADS = "uploads";
 export declare const PROJECT_ARCHIVE = "archive";
 export declare const PROJECT_UNARCHIVE = "unarchive";
 export declare const ENDPOINT_SYNC_QUICK_ADD: string;
@@ -30,3 +31,15 @@ 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_TOKEN = "access_tokens/revoke";
+export declare const ENDPOINT_REVOKE = "revoke";
+export declare const ENDPOINT_WORKSPACE_INVITATIONS = "workspaces/invitations";
+export declare const ENDPOINT_WORKSPACE_INVITATIONS_ALL = "workspaces/invitations/all";
+export declare const ENDPOINT_WORKSPACE_INVITATIONS_DELETE = "workspaces/invitations/delete";
+export declare const ENDPOINT_WORKSPACE_JOIN = "workspaces/join";
+export declare const ENDPOINT_WORKSPACE_LOGO = "workspaces/logo";
+export declare const ENDPOINT_WORKSPACE_PLAN_DETAILS = "workspaces/plan_details";
+export declare const ENDPOINT_WORKSPACE_USERS = "workspaces/users";
+export declare function getWorkspaceInvitationAcceptEndpoint(inviteCode: string): string;
+export declare function getWorkspaceInvitationRejectEndpoint(inviteCode: string): string;
+export declare function getWorkspaceActiveProjectsEndpoint(workspaceId: number): string;
+export declare function getWorkspaceArchivedProjectsEndpoint(workspaceId: number): string;

package/dist/consts/endpoints.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ENDPOINT_REVOKE_TOKEN = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.PROJECT_UNARCHIVE = exports.PROJECT_ARCHIVE = exports.ENDPOINT_REST_ACTIVITIES = exports.ENDPOINT_REST_PRODUCTIVITY = exports.ENDPOINT_REST_USER = exports.ENDPOINT_REST_PROJECT_COLLABORATORS = exports.ENDPOINT_REST_PROJECTS_ARCHIVED = exports.ENDPOINT_REST_PROJECTS = exports.ENDPOINT_REST_TASK_MOVE = exports.ENDPOINT_REST_TASK_REOPEN = exports.ENDPOINT_REST_TASK_CLOSE = exports.ENDPOINT_REST_COMMENTS = exports.ENDPOINT_REST_LABELS_SHARED_REMOVE = exports.ENDPOINT_REST_LABELS_SHARED_RENAME = exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS = exports.ENDPOINT_REST_SECTIONS = exports.ENDPOINT_REST_TASKS_COMPLETED_SEARCH = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = exports.ENDPOINT_REST_TASKS_FILTER = exports.ENDPOINT_REST_TASKS = exports.API_BASE_URI = exports.API_VERSION = exports.TODOIST_WEB_URI = void 0;
+exports.ENDPOINT_WORKSPACE_USERS = exports.ENDPOINT_WORKSPACE_PLAN_DETAILS = exports.ENDPOINT_WORKSPACE_LOGO = exports.ENDPOINT_WORKSPACE_JOIN = exports.ENDPOINT_WORKSPACE_INVITATIONS_DELETE = exports.ENDPOINT_WORKSPACE_INVITATIONS_ALL = exports.ENDPOINT_WORKSPACE_INVITATIONS = exports.ENDPOINT_REVOKE = exports.ENDPOINT_REVOKE_TOKEN = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.PROJECT_UNARCHIVE = exports.PROJECT_ARCHIVE = exports.ENDPOINT_REST_UPLOADS = exports.ENDPOINT_REST_ACTIVITIES = exports.ENDPOINT_REST_PRODUCTIVITY = exports.ENDPOINT_REST_USER = exports.ENDPOINT_REST_PROJECT_COLLABORATORS = exports.ENDPOINT_REST_PROJECTS_ARCHIVED = exports.ENDPOINT_REST_PROJECTS = exports.ENDPOINT_REST_TASK_MOVE = exports.ENDPOINT_REST_TASK_REOPEN = exports.ENDPOINT_REST_TASK_CLOSE = exports.ENDPOINT_REST_COMMENTS = exports.ENDPOINT_REST_LABELS_SHARED_REMOVE = exports.ENDPOINT_REST_LABELS_SHARED_RENAME = exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS = exports.ENDPOINT_REST_SECTIONS = exports.ENDPOINT_REST_TASKS_COMPLETED_SEARCH = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = exports.ENDPOINT_REST_TASKS_FILTER = exports.ENDPOINT_REST_TASKS = exports.API_BASE_URI = exports.API_VERSION = exports.TODOIST_WEB_URI = void 0;
 exports.getSyncBaseUri = getSyncBaseUri;
 exports.getAuthBaseUri = getAuthBaseUri;
+exports.getWorkspaceInvitationAcceptEndpoint = getWorkspaceInvitationAcceptEndpoint;
+exports.getWorkspaceInvitationRejectEndpoint = getWorkspaceInvitationRejectEndpoint;
+exports.getWorkspaceActiveProjectsEndpoint = getWorkspaceActiveProjectsEndpoint;
+exports.getWorkspaceArchivedProjectsEndpoint = getWorkspaceArchivedProjectsEndpoint;
 var BASE_URI = 'https://api.todoist.com';
 var TODOIST_URI = 'https://todoist.com';
 exports.TODOIST_WEB_URI = 'https://app.todoist.com/app';
@@ -39,6 +43,7 @@ exports.ENDPOINT_REST_PROJECT_COLLABORATORS = 'collaborators';
 exports.ENDPOINT_REST_USER = 'user';
 exports.ENDPOINT_REST_PRODUCTIVITY = exports.ENDPOINT_REST_TASKS + '/completed/stats';
 exports.ENDPOINT_REST_ACTIVITIES = 'activities';
+exports.ENDPOINT_REST_UPLOADS = 'uploads';
 exports.PROJECT_ARCHIVE = 'archive';
 exports.PROJECT_UNARCHIVE = 'unarchive';
 exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_TASKS + '/quick';
@@ -46,3 +51,26 @@ exports.ENDPOINT_SYNC = 'sync';
 exports.ENDPOINT_AUTHORIZATION = 'authorize';
 exports.ENDPOINT_GET_TOKEN = 'access_token';
 exports.ENDPOINT_REVOKE_TOKEN = 'access_tokens/revoke';
+exports.ENDPOINT_REVOKE = 'revoke';
+// Workspace endpoints
+exports.ENDPOINT_WORKSPACE_INVITATIONS = 'workspaces/invitations';
+exports.ENDPOINT_WORKSPACE_INVITATIONS_ALL = 'workspaces/invitations/all';
+exports.ENDPOINT_WORKSPACE_INVITATIONS_DELETE = 'workspaces/invitations/delete';
+exports.ENDPOINT_WORKSPACE_JOIN = 'workspaces/join';
+exports.ENDPOINT_WORKSPACE_LOGO = 'workspaces/logo';
+exports.ENDPOINT_WORKSPACE_PLAN_DETAILS = 'workspaces/plan_details';
+exports.ENDPOINT_WORKSPACE_USERS = 'workspaces/users';
+// Workspace invitation actions (require invite_code parameter)
+function getWorkspaceInvitationAcceptEndpoint(inviteCode) {
+    return "workspaces/invitations/".concat(inviteCode, "/accept");
+}
+function getWorkspaceInvitationRejectEndpoint(inviteCode) {
+    return "workspaces/invitations/".concat(inviteCode, "/reject");
+}
+// Workspace projects (require workspace_id parameter)
+function getWorkspaceActiveProjectsEndpoint(workspaceId) {
+    return "workspaces/".concat(workspaceId, "/projects/active");
+}
+function getWorkspaceArchivedProjectsEndpoint(workspaceId) {
+    return "workspaces/".concat(workspaceId, "/projects/archived");
+}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export * from './TodoistApi';
+export * from './todoist-api';
 export * from './authentication';
 export * from './types';
 export * from './utils';

package/dist/index.js

@@ -14,7 +14,7 @@ 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("./TodoistApi"), exports);
+__exportStar(require("./todoist-api"), exports);
 __exportStar(require("./authentication"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./utils"), exports);

package/dist/rest-client.d.ts

@@ -0,0 +1,16 @@
+import { AxiosResponse } from 'axios';
+import { HttpMethod } from './types/http';
+type RequestArgs = {
+    httpMethod: HttpMethod;
+    baseUri: string;
+    relativePath: string;
+    apiToken?: string;
+    payload?: Record<string, unknown>;
+    requestId?: string;
+    hasSyncCommands?: boolean;
+    customHeaders?: Record<string, string>;
+};
+export declare function paramsSerializer(params: Record<string, unknown>): string;
+export declare function isSuccess(response: AxiosResponse): boolean;
+export declare function request<T>(args: RequestArgs): Promise<AxiosResponse<T>>;
+export {};

package/dist/{restClient.js → rest-client.js}

@@ -91,7 +91,8 @@ function getRetryDelay(retryCount) {
 function isAxiosError(error) {
     return Boolean(error === null || error === void 0 ? void 0 : error.isAxiosError);
 }
-function getTodoistRequestError(error, originalStack) {
+function getTodoistRequestError(args) {
+    var error = args.error, originalStack = args.originalStack;
     var requestError = new errors_1.TodoistRequestError(error.message);
     requestError.stack = isAxiosError(error) && originalStack ? originalStack.stack : error.stack;
     if (isAxiosError(error) && error.response) {
@@ -100,14 +101,16 @@ function getTodoistRequestError(error, originalStack) {
     }
     return requestError;
 }
-function getRequestConfiguration(baseURL, apiToken, requestId) {
+function getRequestConfiguration(args) {
+    var baseURL = args.baseURL, apiToken = args.apiToken, requestId = args.requestId, customHeaders = args.customHeaders;
     var authHeader = apiToken ? { Authorization: getAuthHeader(apiToken) } : undefined;
     var requestIdHeader = requestId ? { 'X-Request-Id': requestId } : undefined;
-    var headers = __assign(__assign(__assign({}, defaultHeaders), authHeader), requestIdHeader);
+    var headers = __assign(__assign(__assign(__assign({}, defaultHeaders), authHeader), requestIdHeader), customHeaders);
     return { baseURL: baseURL, headers: headers };
 }
-function getAxiosClient(baseURL, apiToken, requestId) {
-    var configuration = getRequestConfiguration(baseURL, apiToken, requestId);
+function getAxiosClient(args) {
+    var baseURL = args.baseURL, apiToken = args.apiToken, requestId = args.requestId, customHeaders = args.customHeaders;
+    var configuration = getRequestConfiguration({ baseURL: baseURL, apiToken: apiToken, requestId: requestId, customHeaders: customHeaders });
     var client = (0, axios_case_converter_1.default)(axios_1.default.create(configuration), {
         caseFunctions: {
             camel: processing_helpers_1.customCamelCase,
@@ -123,28 +126,31 @@ function getAxiosClient(baseURL, apiToken, requestId) {
 function isSuccess(response) {
     return response.status >= 200 && response.status < 300;
 }
-function request(httpMethod, baseUri, relativePath, apiToken, payload, requestId, hasSyncCommands) {
+function request(args) {
     return __awaiter(this, void 0, void 0, function () {
-        var originalStack, axiosClient, _a, error_1;
+        var httpMethod, baseUri, relativePath, apiToken, payload, initialRequestId, hasSyncCommands, customHeaders, originalStack, requestId, axiosClient, _a, error_1;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
+                    httpMethod = args.httpMethod, baseUri = args.baseUri, relativePath = args.relativePath, apiToken = args.apiToken, payload = args.payload, initialRequestId = args.requestId, hasSyncCommands = args.hasSyncCommands, customHeaders = args.customHeaders;
                     originalStack = new Error();
                     _b.label = 1;
                 case 1:
-                    _b.trys.push([1, 9, , 10]);
+                    _b.trys.push([1, 11, , 12]);
+                    requestId = initialRequestId;
                     // Sync api don't allow a request id in the CORS
                     if (httpMethod === 'POST' && !requestId && !baseUri.includes(endpoints_1.API_BASE_URI)) {
                         requestId = (0, uuid_1.v4)();
                     }
-                    axiosClient = getAxiosClient(baseUri, apiToken, requestId);
+                    axiosClient = getAxiosClient({ baseURL: baseUri, apiToken: apiToken, requestId: requestId, customHeaders: customHeaders });
                     _a = httpMethod;
                     switch (_a) {
                         case 'GET': return [3 /*break*/, 2];
                         case 'POST': return [3 /*break*/, 4];
-                        case 'DELETE': return [3 /*break*/, 6];
+                        case 'PUT': return [3 /*break*/, 6];
+                        case 'DELETE': return [3 /*break*/, 8];
                     }
-                    return [3 /*break*/, 8];
+                    return [3 /*break*/, 10];
                 case 2: return [4 /*yield*/, axiosClient.get(relativePath, {
                         params: payload,
                         paramsSerializer: {
@@ -154,16 +160,18 @@ function request(httpMethod, baseUri, relativePath, apiToken, payload, requestId
                 case 3: return [2 /*return*/, _b.sent()];
                 case 4: return [4 /*yield*/, axiosClient.post(relativePath, hasSyncCommands ? JSON.stringify(payload) : payload)];
                 case 5: return [2 /*return*/, _b.sent()];
-                case 6: return [4 /*yield*/, axiosClient.delete(relativePath)];
+                case 6: return [4 /*yield*/, axiosClient.put(relativePath, hasSyncCommands ? JSON.stringify(payload) : payload)];
                 case 7: return [2 /*return*/, _b.sent()];
-                case 8: return [3 /*break*/, 10];
-                case 9:
+                case 8: return [4 /*yield*/, axiosClient.delete(relativePath)];
+                case 9: return [2 /*return*/, _b.sent()];
+                case 10: return [3 /*break*/, 12];
+                case 11:
                     error_1 = _b.sent();
                     if (!isAxiosError(error_1) && !(error_1 instanceof Error)) {
                         throw new Error('An unknown error occurred during the request');
                     }
-                    throw getTodoistRequestError(error_1, originalStack);
-                case 10: return [2 /*return*/];
+                    throw getTodoistRequestError({ error: error_1, originalStack: originalStack });
+                case 12: return [2 /*return*/];
             }
         });
     });

package/dist/{testUtils → test-utils}/mocks.js

@@ -34,7 +34,7 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setupRestClientMock = setupRestClientMock;
-var restClient = __importStar(require("../restClient"));
+var restClient = __importStar(require("../rest-client"));
 function setupRestClientMock(responseData, status) {
     if (status === void 0) { status = 200; }
     var response = { status: status, data: responseData };

package/dist/{testUtils/testDefaults.js → test-utils/test-defaults.js}

@@ -12,7 +12,7 @@ var __assign = (this && this.__assign) || function () {
 };
 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_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;
-var urlHelpers_1 = require("../utils/urlHelpers");
+var url_helpers_1 = require("../utils/url-helpers");
 exports.DEFAULT_TASK_ID = '1234';
 exports.DEFAULT_TASK_CONTENT = 'This is a task';
 exports.DEFAULT_TASK_DESCRIPTION = 'A description';
@@ -44,9 +44,9 @@ var DEFAULT_IS_DELETED = false;
 var DEFAULT_IS_FROZEN = false;
 var DEFAULT_IS_COLLAPSED = false;
 // URL constants using the helper functions
-var DEFAULT_TASK_URL = (0, urlHelpers_1.getTaskUrl)(exports.DEFAULT_TASK_ID, exports.DEFAULT_TASK_CONTENT);
-var DEFAULT_PROJECT_URL = (0, urlHelpers_1.getProjectUrl)(exports.DEFAULT_PROJECT_ID, exports.DEFAULT_PROJECT_NAME);
-var DEFAULT_SECTION_URL = (0, urlHelpers_1.getSectionUrl)(DEFAULT_SECTION_ID, DEFAULT_SECTION_NAME);
+var DEFAULT_TASK_URL = (0, url_helpers_1.getTaskUrl)(exports.DEFAULT_TASK_ID, exports.DEFAULT_TASK_CONTENT);
+var DEFAULT_PROJECT_URL = (0, url_helpers_1.getProjectUrl)(exports.DEFAULT_PROJECT_ID, exports.DEFAULT_PROJECT_NAME);
+var DEFAULT_SECTION_URL = (0, url_helpers_1.getSectionUrl)(DEFAULT_SECTION_ID, DEFAULT_SECTION_NAME);
 exports.DEFAULT_AUTH_TOKEN = 'AToken';
 exports.DEFAULT_REQUEST_ID = 'ARequestID';
 exports.INVALID_ENTITY_ID = 1234;

package/dist/{TodoistApi.d.ts → todoist-api.d.ts}

@@ -1,5 +1,5 @@
-import { PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser, ProductivityStats } from './types/entities';
-import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, GetSectionsResponse, GetSharedLabelsResponse, GetCommentsResponse, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse, SearchCompletedTasksArgs, GetActivityLogsArgs, GetActivityLogsResponse } from './types/requests';
+import { Attachment, PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser, ProductivityStats, WorkspaceInvitation, WorkspacePlanDetails, JoinWorkspaceResult } from './types/entities';
+import { AddCommentArgs, AddLabelArgs, AddProjectArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateProjectArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, GetSectionsResponse, GetSharedLabelsResponse, GetCommentsResponse, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse, SearchCompletedTasksArgs, GetActivityLogsArgs, GetActivityLogsResponse, UploadFileArgs, DeleteUploadArgs, GetWorkspaceInvitationsArgs, DeleteWorkspaceInvitationArgs, WorkspaceInvitationActionArgs, JoinWorkspaceArgs, WorkspaceLogoArgs, GetWorkspacePlanDetailsArgs, GetWorkspaceUsersArgs, GetWorkspaceUsersResponse, GetWorkspaceProjectsArgs, WorkspaceInvitationsResponse, AllWorkspaceInvitationsResponse, WorkspaceLogoResponse } from './types/requests';
 /**
  * A client for interacting with the Todoist API v1.
  * This class provides methods to manage tasks, projects, sections, labels, and comments in Todoist.
@@ -369,4 +369,146 @@ export declare class TodoistApi {
      * @returns A promise that resolves to a paginated response of activity events.
      */
     getActivityLogs(args?: GetActivityLogsArgs): Promise<GetActivityLogsResponse>;
+    /**
+     * Uploads a file and returns attachment metadata.
+     * This creates an upload record that can be referenced in tasks or comments.
+     *
+     * @param args - Upload parameters including file content, filename, and optional project ID.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the uploaded file's attachment metadata.
+     *
+     * @example
+     * ```typescript
+     * // Upload from a file path
+     * const upload = await api.uploadFile({
+     *   file: '/path/to/document.pdf',
+     *   projectId: '12345'
+     * })
+     *
+     * // Upload from a Buffer
+     * const buffer = fs.readFileSync('/path/to/document.pdf')
+     * const upload = await api.uploadFile({
+     *   file: buffer,
+     *   fileName: 'document.pdf',  // Required for Buffer/Stream
+     *   projectId: '12345'
+     * })
+     *
+     * // Use the returned fileUrl in a comment
+     * await api.addComment({
+     *   content: 'See attached document',
+     *   taskId: '67890',
+     *   attachment: {
+     *     fileUrl: upload.fileUrl,
+     *     fileName: upload.fileName,
+     *     fileType: upload.fileType,
+     *     resourceType: upload.resourceType
+     *   }
+     * })
+     * ```
+     */
+    uploadFile(args: UploadFileArgs, requestId?: string): Promise<Attachment>;
+    /**
+     * Deletes an uploaded file by its URL.
+     *
+     * @param args - The file URL to delete.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to `true` if deletion was successful.
+     *
+     * @example
+     * ```typescript
+     * await api.deleteUpload({
+     *   fileUrl: 'https://cdn.todoist.com/...'
+     * })
+     * ```
+     */
+    deleteUpload(args: DeleteUploadArgs, requestId?: string): Promise<boolean>;
+    /**
+     * Gets pending invitations for a workspace.
+     *
+     * @param args - Arguments including workspace ID.
+     * @param requestId - Optional request ID for idempotency.
+     * @returns Array of email addresses with pending invitations.
+     */
+    getWorkspaceInvitations(args: GetWorkspaceInvitationsArgs, requestId?: string): Promise<WorkspaceInvitationsResponse>;
+    /**
+     * Gets all workspace invitations (admin only).
+     *
+     * @param requestId - Optional request ID for idempotency.
+     * @returns Array of email addresses with pending invitations.
+     */
+    getAllWorkspaceInvitations(args?: {
+        workspaceId?: number;
+    }, requestId?: string): Promise<AllWorkspaceInvitationsResponse>;
+    /**
+     * Deletes a workspace invitation (admin only).
+     *
+     * @param args - Arguments including workspace ID and user email.
+     * @param requestId - Optional request ID for idempotency.
+     * @returns The deleted invitation.
+     */
+    deleteWorkspaceInvitation(args: DeleteWorkspaceInvitationArgs, requestId?: string): Promise<WorkspaceInvitation>;
+    /**
+     * Accepts a workspace invitation.
+     *
+     * @param args - Arguments including invite code.
+     * @param requestId - Optional request ID for idempotency.
+     * @returns The accepted invitation.
+     */
+    acceptWorkspaceInvitation(args: WorkspaceInvitationActionArgs, requestId?: string): Promise<WorkspaceInvitation>;
+    /**
+     * Rejects a workspace invitation.
+     *
+     * @param args - Arguments including invite code.
+     * @param requestId - Optional request ID for idempotency.
+     * @returns The rejected invitation.
+     */
+    rejectWorkspaceInvitation(args: WorkspaceInvitationActionArgs, requestId?: string): Promise<WorkspaceInvitation>;
+    /**
+     * Joins a workspace via invitation link or domain auto-join.
+     *
+     * @param args - Arguments including invite code or workspace ID.
+     * @param requestId - Optional request ID for idempotency.
+     * @returns Workspace user information.
+     */
+    joinWorkspace(args: JoinWorkspaceArgs, requestId?: string): Promise<JoinWorkspaceResult>;
+    /**
+     * Uploads or updates a workspace logo.
+     *
+     * @param args - Arguments including workspace ID, file, and options.
+     * @param requestId - Optional request ID for idempotency.
+     * @returns Logo information or null if deleted.
+     */
+    uploadWorkspaceLogo(args: WorkspaceLogoArgs, requestId?: string): Promise<WorkspaceLogoResponse>;
+    /**
+     * Gets workspace plan and billing details.
+     *
+     * @param args - Arguments including workspace ID.
+     * @param requestId - Optional request ID for idempotency.
+     * @returns Workspace plan details.
+     */
+    getWorkspacePlanDetails(args: GetWorkspacePlanDetailsArgs, requestId?: string): Promise<WorkspacePlanDetails>;
+    /**
+     * Gets workspace users with pagination.
+     *
+     * @param args - Arguments including optional workspace ID, cursor, and limit.
+     * @param requestId - Optional request ID for idempotency.
+     * @returns Paginated list of workspace users.
+     */
+    getWorkspaceUsers(args?: GetWorkspaceUsersArgs, requestId?: string): Promise<GetWorkspaceUsersResponse>;
+    /**
+     * Gets active projects in a workspace with pagination.
+     *
+     * @param args - Arguments including workspace ID, cursor, and limit.
+     * @param requestId - Optional request ID for idempotency.
+     * @returns Paginated list of active workspace projects.
+     */
+    getWorkspaceActiveProjects(args: GetWorkspaceProjectsArgs, requestId?: string): Promise<GetProjectsResponse>;
+    /**
+     * Gets archived projects in a workspace with pagination.
+     *
+     * @param args - Arguments including workspace ID, cursor, and limit.
+     * @param requestId - Optional request ID for idempotency.
+     * @returns Paginated list of archived workspace projects.
+     */
+    getWorkspaceArchivedProjects(args: GetWorkspaceProjectsArgs, requestId?: string): Promise<GetProjectsResponse>;
 }