@doist/todoist-sdk 9.0.0 → 9.1.0-next.2

package/dist/esm/transport/sync-request.js

@@ -0,0 +1,72 @@
+import { ENDPOINT_SYNC } from '../consts/endpoints.js';
+import { TodoistRequestError } from '../types/index.js';
+import { DATE_FORMAT_TO_API, TIME_FORMAT_TO_API, DAY_OF_WEEK_TO_API, } from '../types/sync/index.js';
+import { spreadIfDefined } from '../utils/request-helpers.js';
+import { parseSyncResponse } from '../utils/validators.js';
+import { request } from './http-client.js';
+function serializeUserUpdateArgs(args) {
+    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, args), spreadIfDefined(args.dateFormat, (v) => ({
+        dateFormat: DATE_FORMAT_TO_API[v],
+    }))), spreadIfDefined(args.timeFormat, (v) => ({
+        timeFormat: TIME_FORMAT_TO_API[v],
+    }))), spreadIfDefined(args.startDay, (v) => ({
+        startDay: DAY_OF_WEEK_TO_API[v],
+    }))), spreadIfDefined(args.nextWeek, (v) => ({
+        nextWeek: DAY_OF_WEEK_TO_API[v],
+    })));
+}
+function serializeTaskUpdateDateCompleteArgs(args) {
+    return Object.assign(Object.assign(Object.assign({}, args), { isForward: args.isForward ? 1 : 0 }), spreadIfDefined(args.resetSubtasks, (v) => ({
+        resetSubtasks: v ? 1 : 0,
+    })));
+}
+function serializeUpdateGoalsArgs(args) {
+    return Object.assign(Object.assign(Object.assign({}, args), spreadIfDefined(args.vacationMode, (v) => ({ vacationMode: v ? 1 : 0 }))), spreadIfDefined(args.karmaDisabled, (v) => ({
+        karmaDisabled: v ? 1 : 0,
+    })));
+}
+function preprocessSyncCommands(commands) {
+    return commands.map((cmd) => {
+        if (cmd.type === 'user_update')
+            return Object.assign(Object.assign({}, cmd), { args: serializeUserUpdateArgs(cmd.args) });
+        if (cmd.type === 'item_update_date_complete')
+            return Object.assign(Object.assign({}, cmd), { args: serializeTaskUpdateDateCompleteArgs(cmd.args) });
+        if (cmd.type === 'update_goals')
+            return Object.assign(Object.assign({}, cmd), { args: serializeUpdateGoalsArgs(cmd.args) });
+        return cmd;
+    });
+}
+/**
+ * Makes a request to the Sync API and handles error checking.
+ *
+ * @param ctx - HTTP identity (auth token, sync API base URI, optional custom fetch).
+ * @param syncRequest - The sync request payload.
+ * @param options - Optional request identifier and commands flag.
+ * @returns The sync response data.
+ * @throws TodoistRequestError if sync status contains errors.
+ */
+export async function performSyncRequest(ctx, syncRequest, options = {}) {
+    var _a;
+    const { requestId, hasSyncCommands = false } = options;
+    const processedRequest = ((_a = syncRequest.commands) === null || _a === void 0 ? void 0 : _a.length)
+        ? Object.assign(Object.assign({}, syncRequest), { commands: preprocessSyncCommands(syncRequest.commands) }) : syncRequest;
+    const response = await request({
+        httpMethod: 'POST',
+        baseUri: ctx.syncApiBase,
+        relativePath: ENDPOINT_SYNC,
+        apiToken: ctx.authToken,
+        customFetch: ctx.customFetch,
+        payload: processedRequest,
+        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 parseSyncResponse(response.data);
+}

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

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

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

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

package/dist/esm/types/goals/types.js

@@ -0,0 +1,53 @@
+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';
+/** Available goal owner types. */
+export const GOAL_OWNER_TYPES = ['USER', 'WORKSPACE'];
+/**
+ * Progress of a {@link Goal}.
+ *
+ * The REST API returns these counts under `total_item_count` / `completed_item_count`,
+ * reflecting the backend's generic "item" terminology. The SDK normalizes them to
+ * `totalTaskCount` / `completedTaskCount` so the public surface consistently speaks
+ * in "tasks" (matching the rest of the SDK). The `preprocess` step below performs
+ * that rename after the transport layer's snake_case → camelCase conversion — do not
+ * remove it without also changing the downstream field names.
+ */
+export const GoalProgressSchema = z.preprocess((raw) => {
+    if (raw === null || raw === undefined || typeof raw !== 'object' || Array.isArray(raw)) {
+        return raw;
+    }
+    const _a = raw, { totalItemCount, completedItemCount, totalTaskCount, completedTaskCount } = _a, rest = __rest(_a, ["totalItemCount", "completedItemCount", "totalTaskCount", "completedTaskCount"]);
+    return Object.assign(Object.assign({}, rest), { totalTaskCount: totalTaskCount !== null && totalTaskCount !== void 0 ? totalTaskCount : totalItemCount, completedTaskCount: completedTaskCount !== null && completedTaskCount !== void 0 ? completedTaskCount : completedItemCount });
+}, z.looseObject({
+    totalTaskCount: z.number().int(),
+    completedTaskCount: z.number().int(),
+    percentage: z.number(),
+}));
+export const GoalSchema = z.looseObject({
+    id: z.string(),
+    ownerType: z.enum(GOAL_OWNER_TYPES),
+    ownerId: z.string(),
+    name: z.string(),
+    description: z.string().nullable(),
+    deadline: z.string().nullable(),
+    parentGoalId: z.string().nullable(),
+    childOrder: z.number().int(),
+    isCompleted: z.boolean(),
+    completedAt: z.coerce.date().nullable(),
+    responsibleUid: z.string().nullable(),
+    isDeleted: z.boolean(),
+    progress: GoalProgressSchema.optional(),
+    creatorUid: z.string(),
+    createdAt: z.coerce.date(),
+    updatedAt: z.coerce.date(),
+});

package/dist/esm/types/index.js

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

package/dist/esm/types/sync/commands/goals.js

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

package/dist/esm/types/sync/commands/index.js

@@ -11,6 +11,7 @@ export * from './workspaces.js';
 export * from './folders.js';
 export * from './workspace-filters.js';
 export * from './workspace-goals.js';
+export * from './goals.js';
 export * from './notifications.js';
 export * from './sharing.js';
 export * from './view-options.js';

package/dist/esm/types/sync/resource-types.js

@@ -29,6 +29,7 @@ export const SYNC_RESOURCE_TYPES = [
     'role_actions',
     'folders',
     'workspace_goals',
+    'goals',
     'day_orders',
     'calendars',
     'calendar_accounts',

package/dist/esm/types/sync/response.js

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { GoalSchema } from '../goals/types.js';
 import { LabelSchema } from '../labels/types.js';
 import { ProjectSchema } from '../projects/types.js';
 import { SectionSchema } from '../sections/types.js';
@@ -43,6 +44,7 @@ export const SyncResponseSchema = z.looseObject({
     projectViewOptionsDefaults: z.array(ProjectViewOptionsDefaultsSchema).optional(),
     roleActions: z.array(z.record(z.string(), z.unknown())).optional(),
     folders: z.array(FolderSchema).optional(),
+    goals: z.array(GoalSchema).optional(),
     workspaceGoals: z.array(WorkspaceGoalSchema).optional(),
     dayOrders: z.record(z.string(), z.number()).optional(),
     calendars: z.array(CalendarSchema).optional(),

package/dist/esm/utils/headers.js

@@ -0,0 +1,13 @@
+/**
+ * Converts a native Fetch `Headers` object into a plain `Record<string, string>`.
+ * Used when wrapping a native `fetch` response into the SDK's `FileResponse`
+ * shape (which expects headers as a plain record for symmetry with
+ * `CustomFetchResponse`).
+ */
+export function headersToRecord(headers) {
+    const result = {};
+    headers.forEach((value, key) => {
+        result[key] = value;
+    });
+    return result;
+}

package/dist/esm/utils/request-helpers.js

@@ -0,0 +1,17 @@
+/**
+ * Joins path segments using `/` separator.
+ * @param segments A list of **valid** path segments.
+ * @returns A joined path.
+ */
+export function generatePath(...segments) {
+    return segments.join('/');
+}
+/**
+ * Returns `fn(value)` spread into an object if `value` is defined, otherwise an empty object.
+ *
+ * Used to conditionally include a property on a payload object without
+ * resorting to mutation or ternary-built object literals.
+ */
+export function spreadIfDefined(value, fn) {
+    return value !== undefined ? fn(value) : {};
+}

package/dist/esm/utils/validators.js

@@ -2,6 +2,7 @@ import { z } from 'zod';
 import { ActivityEventSchema } from '../types/activity/types.js';
 import { BackupSchema } from '../types/backups/types.js';
 import { AttachmentSchema, CommentSchema } from '../types/comments/types.js';
+import { GoalSchema } from '../types/goals/types.js';
 import { IdMappingSchema, MovedIdSchema } from '../types/id-mappings/types.js';
 import { ProjectActivityStatsSchema, ProjectHealthSchema, ProjectHealthContextSchema, ProjectProgressSchema, WorkspaceInsightsSchema, } from '../types/insights/types.js';
 import { LabelSchema } from '../types/labels/types.js';
@@ -56,6 +57,7 @@ export const { validate: validateFilter, validateArray: validateFilterArray } =
 export const { validate: validateCollaborator, validateArray: validateCollaboratorArray } = createValidator(CollaboratorSchema);
 export const { validate: validateCollaboratorState, validateArray: validateCollaboratorStateArray, } = createValidator(CollaboratorStateSchema);
 export const { validate: validateFolder, validateArray: validateFolderArray } = createValidator(FolderSchema);
+export const { validate: validateGoal, validateArray: validateGoalArray } = createValidator(GoalSchema);
 export const { validate: validateNote, validateArray: validateNoteArray } = createValidator(NoteSchema);
 export const { validate: validateTooltips } = createValidator(TooltipsSchema);
 export const { validate: validateWorkspaceFilter, validateArray: validateWorkspaceFilterArray } = createValidator(WorkspaceFilterSchema);

package/dist/types/clients/activity-client.d.ts

@@ -0,0 +1,12 @@
+import type { GetActivityLogsArgs, GetActivityLogsResponse } from '../types/activity/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling the activity-log endpoint.
+ *
+ * Instantiated by `TodoistApi`; the public `getActivityLogs` method on
+ * `TodoistApi` delegates here. See `todoist-api.ts` for user-facing
+ * JSDoc.
+ */
+export declare class ActivityClient extends BaseClient {
+    getActivityLogs(args?: GetActivityLogsArgs): Promise<GetActivityLogsResponse>;
+}

package/dist/types/clients/backup-client.d.ts

@@ -0,0 +1,14 @@
+import type { Backup, DownloadBackupArgs, GetBackupsArgs } from '../types/backups/index.js';
+import type { FileResponse } from '../types/http.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling backup-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public backup method on
+ * `TodoistApi` delegates here. See `todoist-api.ts` for user-facing
+ * JSDoc.
+ */
+export declare class BackupClient extends BaseClient {
+    getBackups(args?: GetBackupsArgs): Promise<Backup[]>;
+    downloadBackup(args: DownloadBackupArgs): Promise<FileResponse>;
+}

package/dist/types/clients/base-client.d.ts

@@ -0,0 +1,21 @@
+import type { SyncRequestContext } from '../transport/sync-request.js';
+import type { CustomFetch } from '../types/http.js';
+/**
+ * Internal base class for every domain sub-client (tasks, projects, …).
+ *
+ * Not exported from the package — sub-clients are an implementation detail
+ * of `TodoistApi`. Holds the three pieces of HTTP identity every sub-client
+ * needs and exposes a typed accessor to feed the Sync API helper.
+ *
+ * The constructor takes a {@link SyncRequestContext} — the same record
+ * shape used by `performSyncRequest` — so there is a single type describing
+ * "the HTTP identity an SDK component needs", not two types that must stay
+ * in sync.
+ */
+export declare abstract class BaseClient {
+    protected readonly authToken: string;
+    protected readonly syncApiBase: string;
+    protected readonly customFetch?: CustomFetch;
+    constructor(context: SyncRequestContext);
+    protected get syncContext(): SyncRequestContext;
+}

package/dist/types/clients/comment-client.d.ts

@@ -0,0 +1,15 @@
+import type { AddCommentArgs, Comment, GetCommentsResponse, GetProjectCommentsArgs, GetTaskCommentsArgs, UpdateCommentArgs } from '../types/comments/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all comment-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public comment method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+export declare class CommentClient extends BaseClient {
+    getComments(args: GetTaskCommentsArgs | GetProjectCommentsArgs): Promise<GetCommentsResponse>;
+    getComment(id: string): Promise<Comment>;
+    addComment(args: AddCommentArgs, requestId?: string): Promise<Comment>;
+    updateComment(id: string, args: UpdateCommentArgs, requestId?: string): Promise<Comment>;
+    deleteComment(id: string, requestId?: string): Promise<boolean>;
+}

package/dist/types/clients/email-client.d.ts

@@ -0,0 +1,13 @@
+import type { DisableEmailArgs, GetOrCreateEmailArgs, GetOrCreateEmailResponse } from '../types/emails/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling email-forwarding endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public email-forwarding method on
+ * `TodoistApi` delegates here. See `todoist-api.ts` for user-facing
+ * JSDoc.
+ */
+export declare class EmailClient extends BaseClient {
+    getOrCreateEmailForwarding(args: GetOrCreateEmailArgs, requestId?: string): Promise<GetOrCreateEmailResponse>;
+    disableEmailForwarding(args: DisableEmailArgs, requestId?: string): Promise<boolean>;
+}

package/dist/types/clients/folder-client.d.ts

@@ -0,0 +1,16 @@
+import type { AddFolderArgs, GetFoldersArgs, GetFoldersResponse, UpdateFolderArgs } from '../types/folders/index.js';
+import type { Folder } from '../types/sync/resources/folders.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all folder-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public folder method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+export declare class FolderClient extends BaseClient {
+    getFolders(args: GetFoldersArgs): Promise<GetFoldersResponse>;
+    getFolder(id: string): Promise<Folder>;
+    addFolder(args: AddFolderArgs, requestId?: string): Promise<Folder>;
+    updateFolder(id: string, args: UpdateFolderArgs, requestId?: string): Promise<Folder>;
+    deleteFolder(id: string, requestId?: string): Promise<boolean>;
+}

package/dist/types/clients/goals-client.d.ts

@@ -0,0 +1,20 @@
+import type { AddGoalArgs, GetGoalsArgs, GetGoalsResponse, Goal, SearchGoalsArgs, TaskLinkingArgs, UpdateGoalArgs } from '../types/goals/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all goal-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public goal method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+export declare class GoalsClient extends BaseClient {
+    getGoals(args?: GetGoalsArgs): Promise<GetGoalsResponse>;
+    searchGoals(args: SearchGoalsArgs): Promise<GetGoalsResponse>;
+    getGoal(id: string): Promise<Goal>;
+    addGoal(args: AddGoalArgs, requestId?: string): Promise<Goal>;
+    updateGoal(id: string, args: UpdateGoalArgs, requestId?: string): Promise<Goal>;
+    deleteGoal(id: string, requestId?: string): Promise<boolean>;
+    completeGoal(id: string, requestId?: string): Promise<Goal>;
+    uncompleteGoal(id: string, requestId?: string): Promise<Goal>;
+    linkTaskToGoal({ goalId, taskId }: TaskLinkingArgs, requestId?: string): Promise<Goal>;
+    unlinkTaskFromGoal({ goalId, taskId }: TaskLinkingArgs, requestId?: string): Promise<boolean>;
+}

package/dist/types/clients/id-mapping-client.d.ts

@@ -0,0 +1,13 @@
+import type { GetIdMappingsArgs, GetMovedIdsArgs, IdMapping, MovedId } from '../types/id-mappings/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling ID-mapping endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public id-mapping method on
+ * `TodoistApi` delegates here. See `todoist-api.ts` for user-facing
+ * JSDoc.
+ */
+export declare class IdMappingClient extends BaseClient {
+    getIdMappings(args: GetIdMappingsArgs): Promise<IdMapping[]>;
+    getMovedIds(args: GetMovedIdsArgs): Promise<MovedId[]>;
+}

package/dist/types/clients/insights-client.d.ts

@@ -0,0 +1,18 @@
+import type { GetProjectActivityStatsArgs, GetWorkspaceInsightsArgs, ProjectActivityStats, ProjectHealth, ProjectHealthContext, ProjectProgress, WorkspaceInsights } from '../types/insights/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all insights-domain endpoints
+ * (project activity stats, health, progress, workspace insights).
+ *
+ * Instantiated by `TodoistApi`; every public insights method on
+ * `TodoistApi` delegates here. See `todoist-api.ts` for user-facing
+ * JSDoc.
+ */
+export declare class InsightsClient extends BaseClient {
+    getProjectActivityStats(projectId: string, args?: GetProjectActivityStatsArgs): Promise<ProjectActivityStats>;
+    getProjectHealth(projectId: string): Promise<ProjectHealth>;
+    getProjectHealthContext(projectId: string): Promise<ProjectHealthContext>;
+    getProjectProgress(projectId: string): Promise<ProjectProgress>;
+    getWorkspaceInsights(workspaceId: string, args?: GetWorkspaceInsightsArgs): Promise<WorkspaceInsights>;
+    analyzeProjectHealth(projectId: string, requestId?: string): Promise<ProjectHealth>;
+}

package/dist/types/clients/label-client.d.ts

@@ -0,0 +1,19 @@
+import type { AddLabelArgs, GetLabelsArgs, GetLabelsResponse, GetSharedLabelsArgs, GetSharedLabelsResponse, Label, RemoveSharedLabelArgs, RenameSharedLabelArgs, SearchLabelsArgs, UpdateLabelArgs } from '../types/labels/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all label-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public label method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+export declare class LabelClient extends BaseClient {
+    getLabel(id: string): Promise<Label>;
+    getLabels(args?: GetLabelsArgs): Promise<GetLabelsResponse>;
+    searchLabels(args: SearchLabelsArgs): Promise<GetLabelsResponse>;
+    addLabel(args: AddLabelArgs, requestId?: string): Promise<Label>;
+    updateLabel(id: string, args: UpdateLabelArgs, requestId?: string): Promise<Label>;
+    deleteLabel(id: string, requestId?: string): Promise<boolean>;
+    getSharedLabels(args?: GetSharedLabelsArgs): Promise<GetSharedLabelsResponse>;
+    renameSharedLabel(args: RenameSharedLabelArgs): Promise<boolean>;
+    removeSharedLabel(args: RemoveSharedLabelArgs): Promise<boolean>;
+}

package/dist/types/clients/productivity-client.d.ts

@@ -0,0 +1,12 @@
+import type { ProductivityStats } from '../types/productivity/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling the productivity-stats endpoint.
+ *
+ * Instantiated by `TodoistApi`; the public `getProductivityStats` method
+ * on `TodoistApi` delegates here. See `todoist-api.ts` for user-facing
+ * JSDoc.
+ */
+export declare class ProductivityClient extends BaseClient {
+    getProductivityStats(): Promise<ProductivityStats>;
+}

package/dist/types/clients/project-client.d.ts

@@ -0,0 +1,26 @@
+import type { AddProjectArgs, GetArchivedProjectsArgs, GetArchivedProjectsCountArgs, GetArchivedProjectsCountResponse, GetArchivedProjectsResponse, GetFullProjectArgs, GetFullProjectResponse, GetProjectCollaboratorsArgs, GetProjectCollaboratorsResponse, GetProjectPermissionsResponse, GetProjectsArgs, GetProjectsResponse, JoinProjectResponse, MoveProjectToPersonalArgs, MoveProjectToWorkspaceArgs, PersonalProject, SearchProjectsArgs, UpdateProjectArgs, WorkspaceProject } from '../types/projects/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all project-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public project method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+export declare class ProjectClient extends BaseClient {
+    getProject(id: string): Promise<PersonalProject | WorkspaceProject>;
+    getProjects(args?: GetProjectsArgs): Promise<GetProjectsResponse>;
+    searchProjects(args: SearchProjectsArgs): Promise<GetProjectsResponse>;
+    getArchivedProjects(args?: GetArchivedProjectsArgs): Promise<GetArchivedProjectsResponse>;
+    addProject(args: AddProjectArgs, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
+    updateProject(id: string, args: UpdateProjectArgs, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
+    deleteProject(id: string, requestId?: string): Promise<boolean>;
+    archiveProject(id: string, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
+    unarchiveProject(id: string, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
+    moveProjectToWorkspace(args: MoveProjectToWorkspaceArgs, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
+    moveProjectToPersonal(args: MoveProjectToPersonalArgs, requestId?: string): Promise<PersonalProject | WorkspaceProject>;
+    getArchivedProjectsCount(args?: GetArchivedProjectsCountArgs): Promise<GetArchivedProjectsCountResponse>;
+    getProjectPermissions(): Promise<GetProjectPermissionsResponse>;
+    getFullProject(id: string, args?: GetFullProjectArgs): Promise<GetFullProjectResponse>;
+    joinProject(id: string, requestId?: string): Promise<JoinProjectResponse>;
+    getProjectCollaborators(projectId: string, args?: GetProjectCollaboratorsArgs): Promise<GetProjectCollaboratorsResponse>;
+}

package/dist/types/clients/reminder-client.d.ts

@@ -0,0 +1,25 @@
+import type { Reminder } from '../types/index.js';
+import type { AddLocationReminderArgs, AddReminderArgs, GetLocationRemindersArgs, GetLocationRemindersResponse, GetRemindersArgs, GetRemindersResponse, UpdateLocationReminderArgs, UpdateReminderArgs } from '../types/reminders/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all reminder-domain endpoints
+ * (both time-based and location-based reminders).
+ *
+ * Instantiated by `TodoistApi`; every public reminder method on
+ * `TodoistApi` delegates here. See `todoist-api.ts` for user-facing
+ * JSDoc. The time-vs-location 404 translation is preserved here so a
+ * caller who used the wrong endpoint gets a TodoistArgumentError
+ * pointing at the correct method, rather than a bare 404.
+ */
+export declare class ReminderClient extends BaseClient {
+    getReminders(args?: GetRemindersArgs): Promise<GetRemindersResponse>;
+    getLocationReminders(args?: GetLocationRemindersArgs): Promise<GetLocationRemindersResponse>;
+    getReminder(id: string): Promise<Reminder>;
+    getLocationReminder(id: string): Promise<Reminder>;
+    addReminder(args: AddReminderArgs, requestId?: string): Promise<Reminder>;
+    addLocationReminder(args: AddLocationReminderArgs, requestId?: string): Promise<Reminder>;
+    updateReminder(id: string, args: UpdateReminderArgs, requestId?: string): Promise<Reminder>;
+    updateLocationReminder(id: string, args: UpdateLocationReminderArgs, requestId?: string): Promise<Reminder>;
+    deleteReminder(id: string, requestId?: string): Promise<boolean>;
+    deleteLocationReminder(id: string, requestId?: string): Promise<boolean>;
+}

package/dist/types/clients/section-client.d.ts

@@ -0,0 +1,18 @@
+import type { AddSectionArgs, GetSectionsArgs, GetSectionsResponse, SearchSectionsArgs, Section, UpdateSectionArgs } from '../types/sections/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all section-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public section method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+export declare class SectionClient extends BaseClient {
+    getSections(args?: GetSectionsArgs): Promise<GetSectionsResponse>;
+    searchSections(args: SearchSectionsArgs): Promise<GetSectionsResponse>;
+    getSection(id: string): Promise<Section>;
+    addSection(args: AddSectionArgs, requestId?: string): Promise<Section>;
+    updateSection(id: string, args: UpdateSectionArgs, requestId?: string): Promise<Section>;
+    deleteSection(id: string, requestId?: string): Promise<boolean>;
+    archiveSection(id: string, requestId?: string): Promise<Section>;
+    unarchiveSection(id: string, requestId?: string): Promise<Section>;
+}

package/dist/types/clients/task-client.d.ts

@@ -0,0 +1,25 @@
+import type { AddTaskArgs, GetAllCompletedTasksArgs, GetAllCompletedTasksResponse, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, GetTasksArgs, GetTasksByFilterArgs, GetTasksResponse, MoveTaskArgs, QuickAddTaskArgs, SearchCompletedTasksArgs, Task, UpdateTaskArgs } from '../types/tasks/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all task-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public task method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+export declare class TaskClient extends BaseClient {
+    getTask(id: string): Promise<Task>;
+    getTasks(args?: GetTasksArgs): Promise<GetTasksResponse>;
+    getTasksByFilter(args: GetTasksByFilterArgs): Promise<GetTasksResponse>;
+    getCompletedTasksByCompletionDate(args: GetCompletedTasksByCompletionDateArgs): Promise<GetCompletedTasksResponse>;
+    getCompletedTasksByDueDate(args: GetCompletedTasksByDueDateArgs): Promise<GetCompletedTasksResponse>;
+    searchCompletedTasks(args: SearchCompletedTasksArgs): Promise<GetCompletedTasksResponse>;
+    getAllCompletedTasks(args?: GetAllCompletedTasksArgs): Promise<GetAllCompletedTasksResponse>;
+    addTask(args: AddTaskArgs, requestId?: string): Promise<Task>;
+    quickAddTask(args: QuickAddTaskArgs): Promise<Task>;
+    updateTask(id: string, args: UpdateTaskArgs, requestId?: string): Promise<Task>;
+    moveTasks(ids: string[], args: MoveTaskArgs, requestId?: string): Promise<Task[]>;
+    moveTask(id: string, args: MoveTaskArgs, requestId?: string): Promise<Task>;
+    closeTask(id: string, requestId?: string): Promise<boolean>;
+    reopenTask(id: string, requestId?: string): Promise<boolean>;
+    deleteTask(id: string, requestId?: string): Promise<boolean>;
+}

package/dist/types/clients/template-client.d.ts

@@ -0,0 +1,17 @@
+import type { CreateProjectFromTemplateArgs, CreateProjectFromTemplateResponse, ExportTemplateFileArgs, ExportTemplateUrlArgs, ExportTemplateUrlResponse, ImportTemplateFromIdArgs, ImportTemplateIntoProjectArgs, ImportTemplateResponse } from '../types/templates/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling all template-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public template method on
+ * `TodoistApi` delegates here. See `todoist-api.ts` for user-facing
+ * JSDoc.
+ */
+export declare class TemplateClient extends BaseClient {
+    exportTemplateAsFile(args: ExportTemplateFileArgs): Promise<string>;
+    exportTemplateAsUrl(args: ExportTemplateUrlArgs): Promise<ExportTemplateUrlResponse>;
+    createProjectFromTemplate(args: CreateProjectFromTemplateArgs, requestId?: string): Promise<CreateProjectFromTemplateResponse>;
+    importTemplateIntoProject(args: ImportTemplateIntoProjectArgs, requestId?: string): Promise<ImportTemplateResponse>;
+    importTemplateFromId(args: ImportTemplateFromIdArgs, requestId?: string): Promise<ImportTemplateResponse>;
+    private validateTemplateResponse;
+}

package/dist/types/clients/upload-client.d.ts

@@ -0,0 +1,17 @@
+import type { Attachment, Comment } from '../types/comments/index.js';
+import type { FileResponse } from '../types/http.js';
+import type { DeleteUploadArgs, UploadFileArgs } from '../types/uploads/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * Internal sub-client handling upload + attachment endpoints
+ * (file upload, upload delete, attachment view).
+ *
+ * Instantiated by `TodoistApi`; every public upload method on
+ * `TodoistApi` delegates here. See `todoist-api.ts` for user-facing
+ * JSDoc.
+ */
+export declare class UploadClient extends BaseClient {
+    uploadFile(args: UploadFileArgs, requestId?: string): Promise<Attachment>;
+    deleteUpload(args: DeleteUploadArgs, requestId?: string): Promise<boolean>;
+    viewAttachment(commentOrUrl: Comment | string): Promise<FileResponse>;
+}

package/dist/types/clients/workspace-client.d.ts

@@ -0,0 +1,43 @@
+import type { GetProjectsResponse } from '../types/projects/index.js';
+import type { AddWorkspaceArgs, AllWorkspaceInvitationsResponse, DeleteWorkspaceInvitationArgs, GetWorkspaceMembersActivityArgs, GetWorkspaceMembersActivityResponse, GetWorkspaceProjectsArgs, GetWorkspaceUserTasksArgs, GetWorkspaceUserTasksResponse, GetWorkspaceUsersArgs, GetWorkspaceUsersResponse, InviteWorkspaceUsersArgs, InviteWorkspaceUsersResponse, JoinWorkspaceArgs, JoinWorkspaceResult, RemoveWorkspaceUserArgs, UpdateWorkspaceArgs, UpdateWorkspaceUserArgs, Workspace, WorkspaceInvitation, WorkspaceInvitationActionArgs, WorkspaceInvitationsResponse, WorkspaceLogoArgs, WorkspaceLogoResponse, WorkspacePlanDetails } from '../types/workspaces/index.js';
+import { BaseClient } from './base-client.js';
+type GetAllWorkspaceInvitationsArgs = {
+    workspaceId?: string;
+};
+/**
+ * Internal sub-client handling all workspace-domain endpoints —
+ * workspaces, invitations, users, plans, logos, and workspace project
+ * pagination.
+ *
+ * Instantiated by `TodoistApi`; every public workspace method on
+ * `TodoistApi` delegates here. See `todoist-api.ts` for user-facing
+ * JSDoc.
+ */
+export declare class WorkspaceClient extends BaseClient {
+    getWorkspaceInvitations(args: {
+        workspaceId: string;
+    }, requestId?: string): Promise<WorkspaceInvitationsResponse>;
+    getAllWorkspaceInvitations(args?: GetAllWorkspaceInvitationsArgs, requestId?: string): Promise<AllWorkspaceInvitationsResponse>;
+    deleteWorkspaceInvitation(args: DeleteWorkspaceInvitationArgs, requestId?: string): Promise<WorkspaceInvitation>;
+    acceptWorkspaceInvitation(args: WorkspaceInvitationActionArgs, requestId?: string): Promise<WorkspaceInvitation>;
+    rejectWorkspaceInvitation(args: WorkspaceInvitationActionArgs, requestId?: string): Promise<WorkspaceInvitation>;
+    joinWorkspace(args: JoinWorkspaceArgs, requestId?: string): Promise<JoinWorkspaceResult>;
+    uploadWorkspaceLogo(args: WorkspaceLogoArgs, requestId?: string): Promise<WorkspaceLogoResponse>;
+    getWorkspacePlanDetails(args: {
+        workspaceId: string;
+    }, requestId?: string): Promise<WorkspacePlanDetails>;
+    getWorkspaceUsers(args?: GetWorkspaceUsersArgs, requestId?: string): Promise<GetWorkspaceUsersResponse>;
+    getWorkspaces(requestId?: string): Promise<Workspace[]>;
+    getWorkspace(id: string, requestId?: string): Promise<Workspace>;
+    addWorkspace(args: AddWorkspaceArgs, requestId?: string): Promise<Workspace>;
+    updateWorkspace(id: string, args: UpdateWorkspaceArgs, requestId?: string): Promise<Workspace>;
+    deleteWorkspace(id: string, requestId?: string): Promise<boolean>;
+    getWorkspaceMembersActivity(args: GetWorkspaceMembersActivityArgs, requestId?: string): Promise<GetWorkspaceMembersActivityResponse>;
+    getWorkspaceUserTasks(args: GetWorkspaceUserTasksArgs, requestId?: string): Promise<GetWorkspaceUserTasksResponse>;
+    inviteWorkspaceUsers(args: InviteWorkspaceUsersArgs, requestId?: string): Promise<InviteWorkspaceUsersResponse>;
+    updateWorkspaceUser(args: UpdateWorkspaceUserArgs, requestId?: string): Promise<JoinWorkspaceResult>;
+    removeWorkspaceUser(args: RemoveWorkspaceUserArgs, requestId?: string): Promise<boolean>;
+    getWorkspaceActiveProjects(args: GetWorkspaceProjectsArgs, requestId?: string): Promise<GetProjectsResponse>;
+    getWorkspaceArchivedProjects(args: GetWorkspaceProjectsArgs, requestId?: string): Promise<GetProjectsResponse>;
+}
+export {};

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

@@ -58,6 +58,11 @@ export declare const ENDPOINT_GET_TOKEN = "access_token";
 export declare const ENDPOINT_REVOKE = "revoke";
 export declare const ENDPOINT_REGISTER = "register";
 export declare const ENDPOINT_REST_FOLDERS = "folders";
+export declare const ENDPOINT_REST_GOALS = "goals";
+export declare const ENDPOINT_REST_GOALS_SEARCH: string;
+export declare const GOAL_COMPLETE = "complete";
+export declare const GOAL_UNCOMPLETE = "uncomplete";
+export declare const GOAL_TASKS = "items";
 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, WorkspaceProject, Reminder, Folder } from '../types/index.js';
+import { Label, Section, Task, User, Attachment, Duration, Deadline, RawComment, PersonalProject, WorkspaceProject, Reminder, Folder, Goal } 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";
@@ -264,4 +264,7 @@ export declare const COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT: {
 export declare const DEFAULT_FOLDER: Folder;
 export declare const DEFAULT_COLLABORATOR: Collaborator;
 export declare const DEFAULT_COLLABORATOR_STATE: CollaboratorState;
+export declare const DEFAULT_GOAL_ID = "550e8400-e29b-41d4-a716-446655440000";
+export declare const DEFAULT_GOAL: Goal;
+export declare const DEFAULT_GOAL_NO_PROGRESS: Goal;
 export declare const DEFAULT_NOTE: Note;