@doist/todoist-sdk 10.1.0 → 10.2.0-next.1

package/dist/cjs/utils/validators.js

@@ -1,25 +1,26 @@
 "use strict";
-var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12;
+var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateFolder = exports.validateCollaboratorStateArray = exports.validateCollaboratorState = exports.validateCollaboratorArray = exports.validateCollaborator = exports.validateFilterArray = exports.validateFilter = exports.validateMovedIdArray = exports.validateMovedId = exports.validateIdMappingArray = exports.validateIdMapping = exports.validateBackupArray = exports.validateBackup = exports.validateWorkspaceInsights = exports.validateProjectProgress = exports.validateProjectHealthContext = exports.validateProjectHealth = exports.validateProjectActivityStats = exports.validateWorkspaceUserTaskArray = exports.validateWorkspaceUserTask = exports.validateMemberActivityInfoArray = exports.validateMemberActivityInfo = exports.validateWorkspaceArray = exports.validateWorkspace = exports.validateJoinWorkspaceResult = exports.validateWorkspacePlanDetails = exports.validateWorkspaceInvitationArray = exports.validateWorkspaceInvitation = exports.validateWorkspaceUserArray = exports.validateWorkspaceUser = exports.validateAttachment = exports.validateActivityEventArray = exports.validateActivityEvent = exports.validateCurrentUser = exports.validateProductivityStats = exports.validateUserArray = exports.validateUser = exports.validateCommentArray = exports.validateComment = exports.validateLabelArray = exports.validateLabel = exports.validateSectionArray = exports.validateSection = exports.validateWorkspaceProjectArray = exports.validateWorkspaceProject = exports.validateProjectArray = exports.validateProject = exports.validateTaskArray = exports.validateTask = exports.IdSchema = void 0;
-exports.validateUiExtensionArray = exports.validateUiExtension = exports.validateUserAuthorizationArray = exports.validateUserAuthorization = exports.validateAppInstallationArray = exports.validateAppInstallation = exports.validateAppWebhook = exports.validateAppByDistributionToken = exports.validateAppDistributionToken = exports.validateAppTestToken = exports.validateAppVerificationToken = exports.validateAppSecrets = exports.validateAppWithUserCount = exports.validateAppArray = exports.validateApp = exports.validateSuggestionArray = exports.validateSuggestion = exports.validateUserSettings = exports.validateSyncUser = exports.validateSyncWorkspaceArray = exports.validateSyncWorkspace = exports.validateLiveNotificationArray = exports.validateLiveNotification = exports.validateUserPlanLimits = exports.validateProjectViewOptionsDefaultsArray = exports.validateProjectViewOptionsDefaults = exports.validateViewOptionsArray = exports.validateViewOptions = exports.validateCompletedInfoArray = exports.validateCompletedInfo = exports.validateLocationReminderArray = exports.validateLocationReminder = exports.validateReminderArray = exports.validateReminder = exports.validateCalendarAccountArray = exports.validateCalendarAccount = exports.validateCalendarArray = exports.validateCalendar = exports.validateWorkspaceGoalArray = exports.validateWorkspaceGoal = exports.validateWorkspaceFilterArray = exports.validateWorkspaceFilter = exports.validateTooltips = exports.validateNoteArray = exports.validateNote = exports.validateFolderArray = void 0;
+exports.validateUiExtensionArray = exports.validateUiExtension = exports.validateUserAuthorizationArray = exports.validateUserAuthorization = exports.validateAppInstallationArray = exports.validateAppInstallation = exports.validateAppWebhook = exports.validateAppByDistributionToken = exports.validateAppDistributionToken = exports.validateAppTestToken = exports.validateAppVerificationToken = exports.validateAppSecrets = exports.validateAppWithUserCount = exports.validateAppArray = exports.validateApp = exports.validateSuggestionArray = exports.validateSuggestion = exports.validateUserSettings = exports.validateSyncUser = exports.validateSyncWorkspaceArray = exports.validateSyncWorkspace = exports.validateLiveNotificationArray = exports.validateLiveNotification = exports.validateUserPlanLimits = exports.validateProjectViewOptionsDefaultsArray = exports.validateProjectViewOptionsDefaults = exports.validateViewOptionsArray = exports.validateViewOptions = exports.validateCompletedInfoArray = exports.validateCompletedInfo = exports.validateLocationReminderArray = exports.validateLocationReminder = exports.validateReminderArray = exports.validateReminder = exports.validateCalendarAccountArray = exports.validateCalendarAccount = exports.validateCalendarArray = exports.validateCalendar = exports.validateWorkspaceGoalArray = exports.validateWorkspaceGoal = exports.validateWorkspaceFilterArray = exports.validateWorkspaceFilter = exports.validateTooltips = exports.validateNoteArray = exports.validateNote = exports.validateGoalArray = exports.validateGoal = exports.validateFolderArray = void 0;
 exports.parseSyncResponse = parseSyncResponse;
 const zod_1 = require("zod");
 const types_1 = require("../types/activity/types");
 const types_2 = require("../types/apps/types");
 const types_3 = require("../types/backups/types");
 const types_4 = require("../types/comments/types");
-const types_5 = require("../types/id-mappings/types");
-const types_6 = require("../types/insights/types");
-const types_7 = require("../types/labels/types");
-const types_8 = require("../types/productivity/types");
-const types_9 = require("../types/projects/types");
-const types_10 = require("../types/sections/types");
+const types_5 = require("../types/goals/types");
+const types_6 = require("../types/id-mappings/types");
+const types_7 = require("../types/insights/types");
+const types_8 = require("../types/labels/types");
+const types_9 = require("../types/productivity/types");
+const types_10 = require("../types/projects/types");
+const types_11 = require("../types/sections/types");
 const response_1 = require("../types/sync/response");
-const types_11 = require("../types/tasks/types");
-const types_12 = require("../types/ui-extensions/types");
-const types_13 = require("../types/users/types");
-const types_14 = require("../types/workspaces/types");
+const types_12 = require("../types/tasks/types");
+const types_13 = require("../types/ui-extensions/types");
+const types_14 = require("../types/users/types");
+const types_15 = require("../types/workspaces/types");
 const resources_1 = require("../types/sync/resources");
 function createValidator(schema) {
     return {
@@ -33,64 +34,65 @@ exports.IdSchema = zod_1.z
     .min(1)
     .refine((id) => !id.startsWith('tmp-'), { message: TMP_ID_MESSAGE });
 // Entity validators
-_a = createValidator(types_11.TaskSchema), exports.validateTask = _a.validate, exports.validateTaskArray = _a.validateArray;
+_a = createValidator(types_12.TaskSchema), exports.validateTask = _a.validate, exports.validateTaskArray = _a.validateArray;
 /**
  * Validates and parses a project input.
  * @param input The input to validate
  * @returns A validated project (either PersonalProject or WorkspaceProject)
  */
-_b = createValidator(types_9.ProjectSchema), exports.validateProject = _b.validate, exports.validateProjectArray = _b.validateArray;
-_c = createValidator(types_9.WorkspaceProjectSchema), exports.validateWorkspaceProject = _c.validate, exports.validateWorkspaceProjectArray = _c.validateArray;
-_d = createValidator(types_10.SectionSchema), exports.validateSection = _d.validate, exports.validateSectionArray = _d.validateArray;
-_e = createValidator(types_7.LabelSchema), exports.validateLabel = _e.validate, exports.validateLabelArray = _e.validateArray;
+_b = createValidator(types_10.ProjectSchema), exports.validateProject = _b.validate, exports.validateProjectArray = _b.validateArray;
+_c = createValidator(types_10.WorkspaceProjectSchema), exports.validateWorkspaceProject = _c.validate, exports.validateWorkspaceProjectArray = _c.validateArray;
+_d = createValidator(types_11.SectionSchema), exports.validateSection = _d.validate, exports.validateSectionArray = _d.validateArray;
+_e = createValidator(types_8.LabelSchema), exports.validateLabel = _e.validate, exports.validateLabelArray = _e.validateArray;
 _f = createValidator(types_4.CommentSchema), exports.validateComment = _f.validate, exports.validateCommentArray = _f.validateArray;
-_g = createValidator(types_13.UserSchema), exports.validateUser = _g.validate, exports.validateUserArray = _g.validateArray;
-exports.validateProductivityStats = createValidator(types_8.ProductivityStatsSchema).validate;
-exports.validateCurrentUser = createValidator(types_13.CurrentUserSchema).validate;
+_g = createValidator(types_14.UserSchema), exports.validateUser = _g.validate, exports.validateUserArray = _g.validateArray;
+exports.validateProductivityStats = createValidator(types_9.ProductivityStatsSchema).validate;
+exports.validateCurrentUser = createValidator(types_14.CurrentUserSchema).validate;
 _h = createValidator(types_1.ActivityEventSchema), exports.validateActivityEvent = _h.validate, exports.validateActivityEventArray = _h.validateArray;
 exports.validateAttachment = createValidator(types_4.AttachmentSchema).validate;
-_j = createValidator(types_14.WorkspaceUserSchema), exports.validateWorkspaceUser = _j.validate, exports.validateWorkspaceUserArray = _j.validateArray;
-_k = createValidator(types_14.WorkspaceInvitationSchema), exports.validateWorkspaceInvitation = _k.validate, exports.validateWorkspaceInvitationArray = _k.validateArray;
-exports.validateWorkspacePlanDetails = createValidator(types_14.WorkspacePlanDetailsSchema).validate;
-exports.validateJoinWorkspaceResult = createValidator(types_14.JoinWorkspaceResultSchema).validate;
-_l = createValidator(types_14.WorkspaceSchema), exports.validateWorkspace = _l.validate, exports.validateWorkspaceArray = _l.validateArray;
-_m = createValidator(types_14.MemberActivityInfoSchema), exports.validateMemberActivityInfo = _m.validate, exports.validateMemberActivityInfoArray = _m.validateArray;
-_o = createValidator(types_14.WorkspaceUserTaskSchema), exports.validateWorkspaceUserTask = _o.validate, exports.validateWorkspaceUserTaskArray = _o.validateArray;
-exports.validateProjectActivityStats = createValidator(types_6.ProjectActivityStatsSchema).validate;
-exports.validateProjectHealth = createValidator(types_6.ProjectHealthSchema).validate;
-exports.validateProjectHealthContext = createValidator(types_6.ProjectHealthContextSchema).validate;
-exports.validateProjectProgress = createValidator(types_6.ProjectProgressSchema).validate;
-exports.validateWorkspaceInsights = createValidator(types_6.WorkspaceInsightsSchema).validate;
+_j = createValidator(types_15.WorkspaceUserSchema), exports.validateWorkspaceUser = _j.validate, exports.validateWorkspaceUserArray = _j.validateArray;
+_k = createValidator(types_15.WorkspaceInvitationSchema), exports.validateWorkspaceInvitation = _k.validate, exports.validateWorkspaceInvitationArray = _k.validateArray;
+exports.validateWorkspacePlanDetails = createValidator(types_15.WorkspacePlanDetailsSchema).validate;
+exports.validateJoinWorkspaceResult = createValidator(types_15.JoinWorkspaceResultSchema).validate;
+_l = createValidator(types_15.WorkspaceSchema), exports.validateWorkspace = _l.validate, exports.validateWorkspaceArray = _l.validateArray;
+_m = createValidator(types_15.MemberActivityInfoSchema), exports.validateMemberActivityInfo = _m.validate, exports.validateMemberActivityInfoArray = _m.validateArray;
+_o = createValidator(types_15.WorkspaceUserTaskSchema), exports.validateWorkspaceUserTask = _o.validate, exports.validateWorkspaceUserTaskArray = _o.validateArray;
+exports.validateProjectActivityStats = createValidator(types_7.ProjectActivityStatsSchema).validate;
+exports.validateProjectHealth = createValidator(types_7.ProjectHealthSchema).validate;
+exports.validateProjectHealthContext = createValidator(types_7.ProjectHealthContextSchema).validate;
+exports.validateProjectProgress = createValidator(types_7.ProjectProgressSchema).validate;
+exports.validateWorkspaceInsights = createValidator(types_7.WorkspaceInsightsSchema).validate;
 _p = createValidator(types_3.BackupSchema), exports.validateBackup = _p.validate, exports.validateBackupArray = _p.validateArray;
-_q = createValidator(types_5.IdMappingSchema), exports.validateIdMapping = _q.validate, exports.validateIdMappingArray = _q.validateArray;
-_r = createValidator(types_5.MovedIdSchema), exports.validateMovedId = _r.validate, exports.validateMovedIdArray = _r.validateArray;
+_q = createValidator(types_6.IdMappingSchema), exports.validateIdMapping = _q.validate, exports.validateIdMappingArray = _q.validateArray;
+_r = createValidator(types_6.MovedIdSchema), exports.validateMovedId = _r.validate, exports.validateMovedIdArray = _r.validateArray;
 // Sync resource validators
 _s = createValidator(resources_1.FilterSchema), exports.validateFilter = _s.validate, exports.validateFilterArray = _s.validateArray;
 _t = createValidator(resources_1.CollaboratorSchema), exports.validateCollaborator = _t.validate, exports.validateCollaboratorArray = _t.validateArray;
 _u = createValidator(resources_1.CollaboratorStateSchema), exports.validateCollaboratorState = _u.validate, exports.validateCollaboratorStateArray = _u.validateArray;
 _v = createValidator(resources_1.FolderSchema), exports.validateFolder = _v.validate, exports.validateFolderArray = _v.validateArray;
-_w = createValidator(resources_1.NoteSchema), exports.validateNote = _w.validate, exports.validateNoteArray = _w.validateArray;
+_w = createValidator(types_5.GoalSchema), exports.validateGoal = _w.validate, exports.validateGoalArray = _w.validateArray;
+_x = createValidator(resources_1.NoteSchema), exports.validateNote = _x.validate, exports.validateNoteArray = _x.validateArray;
 exports.validateTooltips = createValidator(resources_1.TooltipsSchema).validate;
-_x = createValidator(resources_1.WorkspaceFilterSchema), exports.validateWorkspaceFilter = _x.validate, exports.validateWorkspaceFilterArray = _x.validateArray;
-_y = createValidator(resources_1.WorkspaceGoalSchema), exports.validateWorkspaceGoal = _y.validate, exports.validateWorkspaceGoalArray = _y.validateArray;
-_z = createValidator(resources_1.CalendarSchema), exports.validateCalendar = _z.validate, exports.validateCalendarArray = _z.validateArray;
-_0 = createValidator(resources_1.CalendarAccountSchema), exports.validateCalendarAccount = _0.validate, exports.validateCalendarAccountArray = _0.validateArray;
-_1 = createValidator(resources_1.ReminderSchema), exports.validateReminder = _1.validate, exports.validateReminderArray = _1.validateArray;
-_2 = createValidator(resources_1.LocationReminderSchema), exports.validateLocationReminder = _2.validate, exports.validateLocationReminderArray = _2.validateArray;
-_3 = createValidator(resources_1.CompletedInfoSchema), exports.validateCompletedInfo = _3.validate, exports.validateCompletedInfoArray = _3.validateArray;
-_4 = createValidator(resources_1.ViewOptionsSchema), exports.validateViewOptions = _4.validate, exports.validateViewOptionsArray = _4.validateArray;
-_5 = createValidator(resources_1.ProjectViewOptionsDefaultsSchema), exports.validateProjectViewOptionsDefaults = _5.validate, exports.validateProjectViewOptionsDefaultsArray = _5.validateArray;
+_y = createValidator(resources_1.WorkspaceFilterSchema), exports.validateWorkspaceFilter = _y.validate, exports.validateWorkspaceFilterArray = _y.validateArray;
+_z = createValidator(resources_1.WorkspaceGoalSchema), exports.validateWorkspaceGoal = _z.validate, exports.validateWorkspaceGoalArray = _z.validateArray;
+_0 = createValidator(resources_1.CalendarSchema), exports.validateCalendar = _0.validate, exports.validateCalendarArray = _0.validateArray;
+_1 = createValidator(resources_1.CalendarAccountSchema), exports.validateCalendarAccount = _1.validate, exports.validateCalendarAccountArray = _1.validateArray;
+_2 = createValidator(resources_1.ReminderSchema), exports.validateReminder = _2.validate, exports.validateReminderArray = _2.validateArray;
+_3 = createValidator(resources_1.LocationReminderSchema), exports.validateLocationReminder = _3.validate, exports.validateLocationReminderArray = _3.validateArray;
+_4 = createValidator(resources_1.CompletedInfoSchema), exports.validateCompletedInfo = _4.validate, exports.validateCompletedInfoArray = _4.validateArray;
+_5 = createValidator(resources_1.ViewOptionsSchema), exports.validateViewOptions = _5.validate, exports.validateViewOptionsArray = _5.validateArray;
+_6 = createValidator(resources_1.ProjectViewOptionsDefaultsSchema), exports.validateProjectViewOptionsDefaults = _6.validate, exports.validateProjectViewOptionsDefaultsArray = _6.validateArray;
 exports.validateUserPlanLimits = createValidator(resources_1.UserPlanLimitsSchema).validate;
-_6 = createValidator(resources_1.LiveNotificationSchema), exports.validateLiveNotification = _6.validate, exports.validateLiveNotificationArray = _6.validateArray;
-_7 = createValidator(resources_1.SyncWorkspaceSchema), exports.validateSyncWorkspace = _7.validate, exports.validateSyncWorkspaceArray = _7.validateArray;
+_7 = createValidator(resources_1.LiveNotificationSchema), exports.validateLiveNotification = _7.validate, exports.validateLiveNotificationArray = _7.validateArray;
+_8 = createValidator(resources_1.SyncWorkspaceSchema), exports.validateSyncWorkspace = _8.validate, exports.validateSyncWorkspaceArray = _8.validateArray;
 exports.validateSyncUser = createValidator(resources_1.SyncUserSchema).validate;
 exports.validateUserSettings = createValidator(resources_1.UserSettingsSchema).validate;
-_8 = createValidator(resources_1.SuggestionSchema), exports.validateSuggestion = _8.validate, exports.validateSuggestionArray = _8.validateArray;
+_9 = createValidator(resources_1.SuggestionSchema), exports.validateSuggestion = _9.validate, exports.validateSuggestionArray = _9.validateArray;
 function parseSyncResponse(raw) {
     return response_1.SyncResponseSchema.parse(raw);
 }
 // App management validators
-_9 = createValidator(types_2.AppSchema), exports.validateApp = _9.validate, exports.validateAppArray = _9.validateArray;
+_10 = createValidator(types_2.AppSchema), exports.validateApp = _10.validate, exports.validateAppArray = _10.validateArray;
 exports.validateAppWithUserCount = createValidator(types_2.AppWithUserCountSchema).validate;
 exports.validateAppSecrets = createValidator(types_2.AppSecretsSchema).validate;
 exports.validateAppVerificationToken = createValidator(types_2.AppVerificationTokenSchema).validate;
@@ -98,6 +100,6 @@ exports.validateAppTestToken = createValidator(types_2.AppTestTokenSchema).valid
 exports.validateAppDistributionToken = createValidator(types_2.AppDistributionTokenSchema).validate;
 exports.validateAppByDistributionToken = createValidator(types_2.AppByDistributionTokenSchema).validate;
 exports.validateAppWebhook = createValidator(types_2.AppWebhookSchema).validate;
-_10 = createValidator(types_2.AppInstallationSchema), exports.validateAppInstallation = _10.validate, exports.validateAppInstallationArray = _10.validateArray;
-_11 = createValidator(types_2.UserAuthorizationSchema), exports.validateUserAuthorization = _11.validate, exports.validateUserAuthorizationArray = _11.validateArray;
-_12 = createValidator(types_12.UiExtensionSchema), exports.validateUiExtension = _12.validate, exports.validateUiExtensionArray = _12.validateArray;
+_11 = createValidator(types_2.AppInstallationSchema), exports.validateAppInstallation = _11.validate, exports.validateAppInstallationArray = _11.validateArray;
+_12 = createValidator(types_2.UserAuthorizationSchema), exports.validateUserAuthorization = _12.validate, exports.validateUserAuthorizationArray = _12.validateArray;
+_13 = createValidator(types_13.UiExtensionSchema), exports.validateUiExtension = _13.validate, exports.validateUiExtensionArray = _13.validateArray;

package/dist/esm/clients/goals-client.js

@@ -0,0 +1,141 @@
+import { z } from 'zod';
+import { ENDPOINT_REST_GOALS, ENDPOINT_REST_GOALS_SEARCH, GOAL_COMPLETE, GOAL_TASKS, GOAL_UNCOMPLETE, } from '../consts/endpoints.js';
+import { isSuccess, request } from '../transport/http-client.js';
+import { generatePath } from '../utils/request-helpers.js';
+import { validateGoal, validateGoalArray } from '../utils/validators.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 class GoalsClient extends BaseClient {
+    async getGoals(args) {
+        const { data: { results, nextCursor }, } = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_GOALS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: validateGoalArray(results),
+            nextCursor,
+        };
+    }
+    async searchGoals(args) {
+        const { data: { results, nextCursor }, } = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_GOALS_SEARCH,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return {
+            results: validateGoalArray(results),
+            nextCursor,
+        };
+    }
+    async getGoal(id) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return validateGoal(response.data);
+    }
+    async addGoal(args, requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_REST_GOALS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return validateGoal(response.data);
+    }
+    async updateGoal(id, args, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return validateGoal(response.data);
+    }
+    async deleteGoal(id, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'DELETE',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, id),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return isSuccess(response);
+    }
+    async completeGoal(id, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, id, GOAL_COMPLETE),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return validateGoal(response.data);
+    }
+    async uncompleteGoal(id, requestId) {
+        z.string().parse(id);
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, id, GOAL_UNCOMPLETE),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return validateGoal(response.data);
+    }
+    async linkTaskToGoal({ goalId, taskId }, requestId) {
+        z.string().parse(goalId);
+        z.string().parse(taskId);
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, goalId, GOAL_TASKS),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: { itemId: taskId },
+            requestId: requestId,
+        });
+        return validateGoal(response.data);
+    }
+    async unlinkTaskFromGoal({ goalId, taskId }, requestId) {
+        z.string().parse(goalId);
+        z.string().parse(taskId);
+        const response = await request({
+            httpMethod: 'DELETE',
+            baseUri: this.syncApiBase,
+            relativePath: generatePath(ENDPOINT_REST_GOALS, goalId, GOAL_TASKS, taskId),
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return isSuccess(response);
+    }
+}

package/dist/esm/consts/endpoints.js

@@ -70,6 +70,11 @@ export const ENDPOINT_GET_TOKEN = 'access_token';
 export const ENDPOINT_REVOKE = 'revoke';
 export const ENDPOINT_REGISTER = 'register';
 export const ENDPOINT_REST_FOLDERS = 'folders';
+export const ENDPOINT_REST_GOALS = 'goals';
+export const ENDPOINT_REST_GOALS_SEARCH = ENDPOINT_REST_GOALS + '/search';
+export const GOAL_COMPLETE = 'complete';
+export const GOAL_UNCOMPLETE = 'uncomplete';
+export const GOAL_TASKS = 'items';
 // Workspace endpoints
 export const ENDPOINT_REST_WORKSPACES = 'workspaces';
 export const ENDPOINT_WORKSPACE_INVITATIONS = 'workspaces/invitations';

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

@@ -277,6 +277,30 @@ export const DEFAULT_COLLABORATOR_STATE = {
     state: 'active',
     isDeleted: false,
 };
+export const DEFAULT_GOAL_ID = '550e8400-e29b-41d4-a716-446655440000';
+export const DEFAULT_GOAL = {
+    id: DEFAULT_GOAL_ID,
+    ownerType: 'USER',
+    ownerId: DEFAULT_USER_ID,
+    name: 'Ship v2',
+    description: 'Launch the new version',
+    deadline: '2026-04-03',
+    parentGoalId: null,
+    childOrder: 0,
+    isCompleted: false,
+    completedAt: null,
+    responsibleUid: null,
+    isDeleted: false,
+    progress: {
+        totalTaskCount: 5,
+        completedTaskCount: 2,
+        percentage: 40,
+    },
+    creatorUid: DEFAULT_USER_ID,
+    createdAt: defaultDate(),
+    updatedAt: defaultDate(),
+};
+export const DEFAULT_GOAL_NO_PROGRESS = Object.assign(Object.assign({}, DEFAULT_GOAL), { id: 'e5f6g7h8-e29b-41d4-a716-446655440001', progress: undefined });
 export const DEFAULT_APP_ID = '42';
 export const DEFAULT_INSTALLATION_ID = '1001';
 export const DEFAULT_UI_EXTENSION_ID = '2002';

package/dist/esm/todoist-api.js

@@ -4,6 +4,7 @@ import { BackupClient } from './clients/backup-client.js';
 import { CommentClient } from './clients/comment-client.js';
 import { EmailClient } from './clients/email-client.js';
 import { FolderClient } from './clients/folder-client.js';
+import { GoalsClient } from './clients/goals-client.js';
 import { IdMappingClient } from './clients/id-mapping-client.js';
 import { InsightsClient } from './clients/insights-client.js';
 import { LabelClient } from './clients/label-client.js';
@@ -58,6 +59,7 @@ export class TodoistApi {
         this.activityClient = new ActivityClient(clientDeps);
         this.productivityClient = new ProductivityClient(clientDeps);
         this.workspaceClient = new WorkspaceClient(clientDeps);
+        this.goalsClient = new GoalsClient(clientDeps);
         this.appClient = new AppClient(clientDeps);
         this.uiExtensionClient = new UiExtensionClient(clientDeps);
     }
@@ -939,6 +941,37 @@ export class TodoistApi {
     async deleteFolder(id, requestId) {
         return this.folderClient.deleteFolder(id, requestId);
     }
+    // ── Goals ──
+    async getGoals(args) {
+        return this.goalsClient.getGoals(args);
+    }
+    async searchGoals(args) {
+        return this.goalsClient.searchGoals(args);
+    }
+    async getGoal(id) {
+        return this.goalsClient.getGoal(id);
+    }
+    async addGoal(args, requestId) {
+        return this.goalsClient.addGoal(args, requestId);
+    }
+    async updateGoal(id, args, requestId) {
+        return this.goalsClient.updateGoal(id, args, requestId);
+    }
+    async deleteGoal(id, requestId) {
+        return this.goalsClient.deleteGoal(id, requestId);
+    }
+    async completeGoal(id, requestId) {
+        return this.goalsClient.completeGoal(id, requestId);
+    }
+    async uncompleteGoal(id, requestId) {
+        return this.goalsClient.uncompleteGoal(id, requestId);
+    }
+    async linkTaskToGoal(args, requestId) {
+        return this.goalsClient.linkTaskToGoal(args, requestId);
+    }
+    async unlinkTaskFromGoal(args, requestId) {
+        return this.goalsClient.unlinkTaskFromGoal(args, requestId);
+    }
     // ── Backups ──
     /**
      * Retrieves a list of available backups.

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/resources/user-settings.js

@@ -13,8 +13,8 @@ export const QuickAddFeatureSchema = z.object({
 export const UserSettingsSchema = z.looseObject({
     completedSoundDesktop: z.boolean(),
     completedSoundMobile: z.boolean(),
-    debugLogSendingEnabledUntil: z.string().nullable(),
-    legacyPricing: z.boolean(),
+    debugLogSendingEnabledUntil: z.string().nullish(),
+    legacyPricing: z.union([z.boolean(), z.literal(0), z.literal(1)]).transform(Boolean),
     navigation: z
         .object({
         countsShown: z.boolean(),

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

@@ -50,7 +50,7 @@ export const SyncUserSchema = z.looseObject({
     businessAccountId: z.string().nullable(),
     dailyGoal: z.number().int(),
     dateFormat: DateFormatSchema,
-    dateistLang: z.string().nullable(),
+    dateistLang: z.string().nullish(),
     daysOff: z.array(z.number().int()),
     featureIdentifier: z.string(),
     features: FeaturesSchema,
@@ -69,8 +69,8 @@ export const SyncUserSchema = z.looseObject({
     karmaTrend: z.string(),
     lang: z.string(),
     mfaEnabled: z.boolean().optional(),
-    mobileHost: z.string().nullable(),
-    mobileNumber: z.string().nullable(),
+    mobileHost: z.string().nullish(),
+    mobileNumber: z.string().nullish(),
     nextWeek: DayOfWeekSchema,
     onboardingLevel: z.string().nullable().optional(),
     onboardingRole: z.string().nullable().optional(),
@@ -97,7 +97,7 @@ export const SyncUserSchema = z.looseObject({
     startPage: z.string(),
     themeId: z.string(),
     timeFormat: TimeFormatSchema,
-    token: z.string(),
+    token: z.string().optional(),
     tzInfo: TzInfoSchema,
     uniquePrefix: z.number().int(),
     verificationStatus: z.string(),

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/validators.js

@@ -3,6 +3,7 @@ import { ActivityEventSchema } from '../types/activity/types.js';
 import { AppSchema, AppWithUserCountSchema, AppSecretsSchema, AppVerificationTokenSchema, AppTestTokenSchema, AppDistributionTokenSchema, AppByDistributionTokenSchema, AppWebhookSchema, AppInstallationSchema, UserAuthorizationSchema, } from '../types/apps/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';
@@ -63,6 +64,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/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/consts/endpoints.d.ts

@@ -59,6 +59,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, App, AppWithUserCount, AppSecrets, AppVerificationToken, AppTestToken, AppDistributionToken, AppWebhook, AppInstallation, UserAuthorization, UiExtension } from '../types/index.js';
+import { Label, Section, Task, User, Attachment, Duration, Deadline, RawComment, PersonalProject, WorkspaceProject, Reminder, Folder, Goal, App, AppWithUserCount, AppSecrets, AppVerificationToken, AppTestToken, AppDistributionToken, AppWebhook, AppInstallation, UserAuthorization, UiExtension } 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,6 +264,9 @@ 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_APP_ID = "42";
 export declare const DEFAULT_INSTALLATION_ID = "1001";
 export declare const DEFAULT_UI_EXTENSION_ID = "2002";