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

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

@@ -4,7 +4,8 @@ import { Backup, GetBackupsArgs, DownloadBackupArgs } from './types/backups/inde
 import { Attachment, Comment, AddCommentArgs, UpdateCommentArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetCommentsResponse } from './types/comments/index.js';
 import { GetOrCreateEmailArgs, GetOrCreateEmailResponse, DisableEmailArgs } from './types/emails/index.js';
 import { GetFoldersArgs, GetFoldersResponse, AddFolderArgs, UpdateFolderArgs } from './types/folders/index.js';
-import { CustomFetch, CustomFetchResponse } from './types/http.js';
+import type { AddGoalArgs, GetGoalsArgs, GetGoalsResponse, Goal, SearchGoalsArgs, TaskLinkingArgs, UpdateGoalArgs } from './types/goals/index.js';
+import { CustomFetch, FileResponse } from './types/http.js';
 import { IdMapping, MovedId, GetIdMappingsArgs, GetMovedIdsArgs } from './types/id-mappings/index.js';
 import { ProjectActivityStats, ProjectHealth, ProjectHealthContext, ProjectProgress, WorkspaceInsights, GetProjectActivityStatsArgs, GetWorkspaceInsightsArgs } from './types/insights/index.js';
 import { Label, AddLabelArgs, UpdateLabelArgs, GetLabelsArgs, SearchLabelsArgs, GetLabelsResponse, GetSharedLabelsArgs, GetSharedLabelsResponse, RenameSharedLabelArgs, RemoveSharedLabelArgs } from './types/labels/index.js';
@@ -20,12 +21,26 @@ import { CurrentUser } from './types/users/index.js';
 import { WorkspaceInvitation, WorkspacePlanDetails, JoinWorkspaceResult, Workspace, AddWorkspaceArgs, UpdateWorkspaceArgs, GetWorkspaceMembersActivityArgs, GetWorkspaceMembersActivityResponse, GetWorkspaceUserTasksArgs, GetWorkspaceUserTasksResponse, InviteWorkspaceUsersArgs, InviteWorkspaceUsersResponse, UpdateWorkspaceUserArgs, RemoveWorkspaceUserArgs, GetWorkspaceInvitationsArgs, DeleteWorkspaceInvitationArgs, WorkspaceInvitationActionArgs, JoinWorkspaceArgs, WorkspaceLogoArgs, GetWorkspacePlanDetailsArgs, GetWorkspaceUsersArgs, GetWorkspaceUsersResponse, GetWorkspaceProjectsArgs, WorkspaceInvitationsResponse, AllWorkspaceInvitationsResponse, WorkspaceLogoResponse } from './types/workspaces/index.js';
 import { type SyncResponse, type SyncRequest } from './types/sync/index.js';
 /**
- * Response from viewAttachment, extending CustomFetchResponse with
- * arrayBuffer() support for binary file content.
+ * A client for interacting with the Todoist API v1.
+ * This class provides methods to manage tasks, projects, sections, labels, and comments in Todoist.
+ *
+ * @example
+ * ```typescript
+ * const api = new TodoistApi('your-api-token');
+ *
+ * // Get all tasks
+ * const tasks = await api.getTasks();
+ *
+ * // Create a new task
+ * const newTask = await api.addTask({
+ *   content: 'My new task',
+ *   projectId: '12345'
+ * });
+ * ```
+ *
+ * For more information about the Todoist API v1, see the [official documentation](https://todoist.com/api/v1).
+ * If you're migrating from v9, please refer to the [migration guide](https://todoist.com/api/v1/docs#tag/Migrating-from-v9).
  */
-export type FileResponse = CustomFetchResponse & {
-    arrayBuffer(): Promise<ArrayBuffer>;
-};
 /**
  * Configuration options for the TodoistApi constructor
  */
@@ -43,6 +58,23 @@ export declare class TodoistApi {
     private authToken;
     private syncApiBase;
     private customFetch?;
+    private readonly taskClient;
+    private readonly projectClient;
+    private readonly sectionClient;
+    private readonly labelClient;
+    private readonly commentClient;
+    private readonly reminderClient;
+    private readonly insightsClient;
+    private readonly folderClient;
+    private readonly templateClient;
+    private readonly uploadClient;
+    private readonly backupClient;
+    private readonly emailClient;
+    private readonly idMappingClient;
+    private readonly activityClient;
+    private readonly productivityClient;
+    private readonly workspaceClient;
+    private readonly goalsClient;
     constructor(
     /**
      * Your Todoist API token.
@@ -52,16 +84,6 @@ export declare class TodoistApi {
      * Optional configuration options
      */
     options?: TodoistApiOptions);
-    /**
-     * Makes a request to the Sync API and handles error checking.
-     *
-     * @param syncRequest - The sync request payload
-     * @param requestId - Optional request identifier
-     * @param hasSyncCommands - Whether this request contains sync commands (write operations)
-     * @returns The sync response data
-     * @throws TodoistRequestError if sync status contains errors
-     */
-    private requestSync;
     /**
      * Executes a raw Sync API request.
      *
@@ -763,6 +785,16 @@ export declare class TodoistApi {
      * @returns A promise that resolves to `true` if successful.
      */
     deleteFolder(id: string, requestId?: string): Promise<boolean>;
+    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(args: TaskLinkingArgs, requestId?: string): Promise<Goal>;
+    unlinkTaskFromGoal(args: TaskLinkingArgs, requestId?: string): Promise<boolean>;
     /**
      * Retrieves a list of available backups.
      *
@@ -845,7 +877,6 @@ export declare class TodoistApi {
      * @returns A promise that resolves to the import result.
      */
     importTemplateFromId(args: ImportTemplateFromIdArgs, requestId?: string): Promise<ImportTemplateResponse>;
-    private validateTemplateResponse;
     /**
      * Gets pending invitations for a workspace.
      *

package/dist/types/transport/sync-request.d.ts

@@ -0,0 +1,27 @@
+import type { CustomFetch } from '../types/http.js';
+import { type SyncRequest, type SyncResponse } from '../types/sync/index.js';
+/**
+ * Shared context needed to issue Sync API requests.
+ *
+ * Constructed by {@link TodoistApi} and each {@link BaseClient} subclass so
+ * that sub-clients can delegate to {@link performSyncRequest} without
+ * rebuilding the HTTP identity on every call.
+ */
+export type SyncRequestContext = {
+    authToken: string;
+    syncApiBase: string;
+    customFetch?: CustomFetch;
+};
+/**
+ * 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 declare function performSyncRequest(ctx: SyncRequestContext, syncRequest: SyncRequest, options?: {
+    requestId?: string;
+    hasSyncCommands?: boolean;
+}): Promise<SyncResponse>;

package/dist/types/types/goals/index.d.ts

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

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

@@ -0,0 +1,33 @@
+import type { SearchArgs } from '../common.js';
+import type { Workspace } from '../workspaces/index.js';
+import type { Goal, GoalOwnerType } from './types.js';
+export type GetGoalsArgs = {
+    ownerType?: GoalOwnerType;
+    workspaceId?: Workspace['id'];
+    cursor?: string | null;
+    limit?: number;
+};
+export type SearchGoalsArgs = SearchArgs & {
+    ownerType?: GoalOwnerType;
+};
+export type GetGoalsResponse = {
+    results: Goal[];
+    nextCursor: string | null;
+};
+export type AddGoalArgs = {
+    name: string;
+    workspaceId?: string;
+    description?: string | null;
+    deadline?: string | null;
+    responsibleUid?: string | null;
+};
+export type UpdateGoalArgs = {
+    name?: string;
+    description?: string | null;
+    deadline?: string | null;
+    responsibleUid?: string | null;
+};
+export type TaskLinkingArgs = {
+    goalId: string;
+    taskId: string;
+};

package/dist/types/types/goals/types.d.ts

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+/** Available goal owner types. */
+export declare const GOAL_OWNER_TYPES: readonly ["USER", "WORKSPACE"];
+/** Goal owner type. */
+export type GoalOwnerType = (typeof GOAL_OWNER_TYPES)[number];
+/**
+ * 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 declare const GoalProgressSchema: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
+    totalTaskCount: z.ZodNumber;
+    completedTaskCount: z.ZodNumber;
+    percentage: z.ZodNumber;
+}, z.core.$loose>>;
+export type GoalProgress = z.infer<typeof GoalProgressSchema>;
+export declare const GoalSchema: z.ZodObject<{
+    id: z.ZodString;
+    ownerType: z.ZodEnum<{
+        USER: "USER";
+        WORKSPACE: "WORKSPACE";
+    }>;
+    ownerId: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    deadline: z.ZodNullable<z.ZodString>;
+    parentGoalId: z.ZodNullable<z.ZodString>;
+    childOrder: z.ZodNumber;
+    isCompleted: z.ZodBoolean;
+    completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    responsibleUid: z.ZodNullable<z.ZodString>;
+    isDeleted: z.ZodBoolean;
+    progress: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
+        totalTaskCount: z.ZodNumber;
+        completedTaskCount: z.ZodNumber;
+        percentage: z.ZodNumber;
+    }, z.core.$loose>>>;
+    creatorUid: z.ZodString;
+    createdAt: z.ZodCoercedDate<unknown>;
+    updatedAt: z.ZodCoercedDate<unknown>;
+}, z.core.$loose>;
+/**
+ * Represents a goal in Todoist.
+ * Goals support dual ownership: personal (ownerType=USER) and workspace (ownerType=WORKSPACE).
+ */
+export type Goal = z.infer<typeof GoalSchema>;

package/dist/types/types/http.d.ts

@@ -83,3 +83,10 @@ export type CustomFetchResponse = {
 export type CustomFetch = (url: string, options?: RequestInit & {
     timeout?: number;
 }) => Promise<CustomFetchResponse>;
+/**
+ * Response from a binary file endpoint (e.g. attachment view, backup download),
+ * extending CustomFetchResponse with `arrayBuffer()` support for binary content.
+ */
+export type FileResponse = CustomFetchResponse & {
+    arrayBuffer(): Promise<ArrayBuffer>;
+};

package/dist/types/types/index.d.ts

@@ -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/types/types/sync/commands/goals.d.ts

@@ -0,0 +1,33 @@
+import type { GoalOwnerType } from '../../goals/types.js';
+export type GoalAddArgs = {
+    ownerType: GoalOwnerType;
+    ownerId: string;
+    name: string;
+    description?: string | null;
+    deadline?: string | null;
+    responsibleUid?: string | null;
+};
+export type GoalUpdateArgs = {
+    id: string;
+    name?: string;
+    description?: string | null;
+    deadline?: string | null;
+    responsibleUid?: string | null;
+};
+export type GoalCompleteArgs = {
+    id: string;
+};
+export type GoalUncompleteArgs = {
+    id: string;
+};
+export type GoalDeleteArgs = {
+    id: string;
+};
+export type GoalLinkItemArgs = {
+    goalId: string;
+    itemId: string;
+};
+export type GoalUnlinkItemArgs = {
+    goalId: string;
+    itemId: string;
+};

package/dist/types/types/sync/commands/index.d.ts

@@ -1,6 +1,7 @@
 import type { CalendarUpdateArgs, CalendarAccountUpdateArgs, CalendarAccountRestoreTaskCalendarArgs } from './calendars.js';
 import type { FilterAddArgs, FilterUpdateArgs, FilterUpdateOrdersArgs, FilterDeleteArgs } from './filters.js';
 import type { FolderAddArgs, FolderUpdateArgs, FolderDeleteArgs } from './folders.js';
+import type { GoalAddArgs, GoalUpdateArgs, GoalCompleteArgs, GoalUncompleteArgs, GoalDeleteArgs, GoalLinkItemArgs, GoalUnlinkItemArgs } from './goals.js';
 import type { LabelAddArgs, LabelRenameArgs, LabelUpdateArgs, LabelUpdateOrdersArgs, LabelDeleteArgs, LabelDeleteOccurrencesArgs } from './labels.js';
 import type { NoteAddArgs, NoteUpdateArgs, NoteDeleteArgs, NoteReactionAddArgs, NoteReactionRemoveArgs } from './notes.js';
 import type { LiveNotificationsMarkUnreadArgs, LiveNotificationsMarkReadArgs, LiveNotificationsMarkReadAllArgs, LiveNotificationsSetLastReadArgs } from './notifications.js';
@@ -96,6 +97,13 @@ export type SyncCommandsMap = {
     workspace_goal_delete: WorkspaceGoalDeleteArgs;
     workspace_goal_project_add: WorkspaceGoalProjectAddArgs;
     workspace_goal_project_remove: WorkspaceGoalProjectRemoveArgs;
+    goal_add: GoalAddArgs;
+    goal_update: GoalUpdateArgs;
+    goal_complete: GoalCompleteArgs;
+    goal_uncomplete: GoalUncompleteArgs;
+    goal_delete: GoalDeleteArgs;
+    goal_link_item: GoalLinkItemArgs;
+    goal_unlink_item: GoalUnlinkItemArgs;
     live_notifications_mark_unread: LiveNotificationsMarkUnreadArgs;
     live_notifications_mark_read: LiveNotificationsMarkReadArgs;
     live_notifications_mark_read_all: LiveNotificationsMarkReadAllArgs;
@@ -163,6 +171,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/types/types/sync/resource-types.d.ts

@@ -1,5 +1,5 @@
 /**
  * All available Sync API resource types.
  */
-export declare const SYNC_RESOURCE_TYPES: readonly ["labels", "projects", "items", "notes", "project_notes", "sections", "filters", "reminders", "reminders_location", "locations", "user", "live_notifications", "collaborators", "collaborator_states", "user_settings", "notification_settings", "user_plan_limits", "completed_info", "stats", "workspaces", "workspace_users", "workspace_filters", "view_options", "project_view_options_defaults", "role_actions", "folders", "workspace_goals", "day_orders", "calendars", "calendar_accounts", "suggestions", "tooltips"];
+export declare const SYNC_RESOURCE_TYPES: readonly ["labels", "projects", "items", "notes", "project_notes", "sections", "filters", "reminders", "reminders_location", "locations", "user", "live_notifications", "collaborators", "collaborator_states", "user_settings", "notification_settings", "user_plan_limits", "completed_info", "stats", "workspaces", "workspace_users", "workspace_filters", "view_options", "project_view_options_defaults", "role_actions", "folders", "workspace_goals", "goals", "day_orders", "calendars", "calendar_accounts", "suggestions", "tooltips"];
 export type SyncResourceType = (typeof SYNC_RESOURCE_TYPES)[number];

package/dist/types/types/sync/resources/view-options.d.ts

@@ -32,6 +32,7 @@ export declare const GROUPED_BY_OPTIONS: readonly ["ASSIGNEE", "ADDED_DATE", "DU
 /** Field to group tasks by. */
 export type GroupedBy = (typeof GROUPED_BY_OPTIONS)[number];
 export declare const GroupedBySchema: z.ZodNullable<z.ZodEnum<{
+    WORKSPACE: "WORKSPACE";
     PROJECT: "PROJECT";
     LABEL: "LABEL";
     ASSIGNEE: "ASSIGNEE";
@@ -39,20 +40,19 @@ export declare const GroupedBySchema: z.ZodNullable<z.ZodEnum<{
     DUE_DATE: "DUE_DATE";
     DEADLINE: "DEADLINE";
     PRIORITY: "PRIORITY";
-    WORKSPACE: "WORKSPACE";
 }>>;
 /** Available sorting options. */
 export declare const SORTED_BY_OPTIONS: readonly ["MANUAL", "ALPHABETICALLY", "ASSIGNEE", "DUE_DATE", "DEADLINE", "ADDED_DATE", "PRIORITY", "PROJECT", "WORKSPACE"];
 /** Field to sort tasks by. */
 export type SortedBy = (typeof SORTED_BY_OPTIONS)[number];
 export declare const SortedBySchema: z.ZodNullable<z.ZodEnum<{
+    WORKSPACE: "WORKSPACE";
     PROJECT: "PROJECT";
     ASSIGNEE: "ASSIGNEE";
     ADDED_DATE: "ADDED_DATE";
     DUE_DATE: "DUE_DATE";
     DEADLINE: "DEADLINE";
     PRIORITY: "PRIORITY";
-    WORKSPACE: "WORKSPACE";
     MANUAL: "MANUAL";
     ALPHABETICALLY: "ALPHABETICALLY";
 }>>;
@@ -92,6 +92,7 @@ export declare const ViewOptionsSchema: z.ZodObject<{
     }>;
     objectId: z.ZodOptional<z.ZodString>;
     groupedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        WORKSPACE: "WORKSPACE";
         PROJECT: "PROJECT";
         LABEL: "LABEL";
         ASSIGNEE: "ASSIGNEE";
@@ -99,7 +100,6 @@ export declare const ViewOptionsSchema: z.ZodObject<{
         DUE_DATE: "DUE_DATE";
         DEADLINE: "DEADLINE";
         PRIORITY: "PRIORITY";
-        WORKSPACE: "WORKSPACE";
     }>>>;
     filteredBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     viewMode: z.ZodOptional<z.ZodEnum<{
@@ -109,13 +109,13 @@ export declare const ViewOptionsSchema: z.ZodObject<{
     }>>;
     showCompletedTasks: z.ZodOptional<z.ZodBoolean>;
     sortedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        WORKSPACE: "WORKSPACE";
         PROJECT: "PROJECT";
         ASSIGNEE: "ASSIGNEE";
         ADDED_DATE: "ADDED_DATE";
         DUE_DATE: "DUE_DATE";
         DEADLINE: "DEADLINE";
         PRIORITY: "PRIORITY";
-        WORKSPACE: "WORKSPACE";
         MANUAL: "MANUAL";
         ALPHABETICALLY: "ALPHABETICALLY";
     }>>>;
@@ -133,6 +133,7 @@ export declare const ProjectViewOptionsDefaultsSchema: z.ZodObject<{
         CALENDAR: "CALENDAR";
     }>>>;
     groupedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        WORKSPACE: "WORKSPACE";
         PROJECT: "PROJECT";
         LABEL: "LABEL";
         ASSIGNEE: "ASSIGNEE";
@@ -140,16 +141,15 @@ export declare const ProjectViewOptionsDefaultsSchema: z.ZodObject<{
         DUE_DATE: "DUE_DATE";
         DEADLINE: "DEADLINE";
         PRIORITY: "PRIORITY";
-        WORKSPACE: "WORKSPACE";
     }>>>;
     sortedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        WORKSPACE: "WORKSPACE";
         PROJECT: "PROJECT";
         ASSIGNEE: "ASSIGNEE";
         ADDED_DATE: "ADDED_DATE";
         DUE_DATE: "DUE_DATE";
         DEADLINE: "DEADLINE";
         PRIORITY: "PRIORITY";
-        WORKSPACE: "WORKSPACE";
         MANUAL: "MANUAL";
         ALPHABETICALLY: "ALPHABETICALLY";
     }>>>;

package/dist/types/types/sync/response.d.ts

@@ -750,6 +750,7 @@ export declare const SyncResponseSchema: z.ZodObject<{
         }>;
         objectId: z.ZodOptional<z.ZodString>;
         groupedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            WORKSPACE: "WORKSPACE";
             PROJECT: "PROJECT";
             LABEL: "LABEL";
             ASSIGNEE: "ASSIGNEE";
@@ -757,7 +758,6 @@ export declare const SyncResponseSchema: z.ZodObject<{
             DUE_DATE: "DUE_DATE";
             DEADLINE: "DEADLINE";
             PRIORITY: "PRIORITY";
-            WORKSPACE: "WORKSPACE";
         }>>>;
         filteredBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         viewMode: z.ZodOptional<z.ZodEnum<{
@@ -767,13 +767,13 @@ export declare const SyncResponseSchema: z.ZodObject<{
         }>>;
         showCompletedTasks: z.ZodOptional<z.ZodBoolean>;
         sortedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            WORKSPACE: "WORKSPACE";
             PROJECT: "PROJECT";
             ASSIGNEE: "ASSIGNEE";
             ADDED_DATE: "ADDED_DATE";
             DUE_DATE: "DUE_DATE";
             DEADLINE: "DEADLINE";
             PRIORITY: "PRIORITY";
-            WORKSPACE: "WORKSPACE";
             MANUAL: "MANUAL";
             ALPHABETICALLY: "ALPHABETICALLY";
         }>>>;
@@ -790,6 +790,7 @@ export declare const SyncResponseSchema: z.ZodObject<{
             CALENDAR: "CALENDAR";
         }>>>;
         groupedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            WORKSPACE: "WORKSPACE";
             PROJECT: "PROJECT";
             LABEL: "LABEL";
             ASSIGNEE: "ASSIGNEE";
@@ -797,16 +798,15 @@ export declare const SyncResponseSchema: z.ZodObject<{
             DUE_DATE: "DUE_DATE";
             DEADLINE: "DEADLINE";
             PRIORITY: "PRIORITY";
-            WORKSPACE: "WORKSPACE";
         }>>>;
         sortedBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            WORKSPACE: "WORKSPACE";
             PROJECT: "PROJECT";
             ASSIGNEE: "ASSIGNEE";
             ADDED_DATE: "ADDED_DATE";
             DUE_DATE: "DUE_DATE";
             DEADLINE: "DEADLINE";
             PRIORITY: "PRIORITY";
-            WORKSPACE: "WORKSPACE";
             MANUAL: "MANUAL";
             ALPHABETICALLY: "ALPHABETICALLY";
         }>>>;
@@ -832,6 +832,31 @@ export declare const SyncResponseSchema: z.ZodObject<{
         defaultOrder: z.ZodNumber;
         childOrder: z.ZodNumber;
     }, z.core.$loose>>>;
+    goals: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        ownerType: z.ZodEnum<{
+            USER: "USER";
+            WORKSPACE: "WORKSPACE";
+        }>;
+        ownerId: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        deadline: z.ZodNullable<z.ZodString>;
+        parentGoalId: z.ZodNullable<z.ZodString>;
+        childOrder: z.ZodNumber;
+        isCompleted: z.ZodBoolean;
+        completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+        responsibleUid: z.ZodNullable<z.ZodString>;
+        isDeleted: z.ZodBoolean;
+        progress: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
+            totalTaskCount: z.ZodNumber;
+            completedTaskCount: z.ZodNumber;
+            percentage: z.ZodNumber;
+        }, z.core.$loose>>>;
+        creatorUid: z.ZodString;
+        createdAt: z.ZodCoercedDate<unknown>;
+        updatedAt: z.ZodCoercedDate<unknown>;
+    }, z.core.$loose>>>;
     workspaceGoals: z.ZodOptional<z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         workspaceId: z.ZodString;

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

@@ -36,6 +36,7 @@ export type GetTasksArgs = {
     parentId?: string;
     label?: string;
     ids?: string[];
+    goalId?: string;
     cursor?: string | null;
     limit?: number;
 };

package/dist/types/utils/headers.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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 declare function headersToRecord(headers: Headers): Record<string, string>;

package/dist/types/utils/request-helpers.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Joins path segments using `/` separator.
+ * @param segments A list of **valid** path segments.
+ * @returns A joined path.
+ */
+export declare function generatePath(...segments: string[]): string;
+/**
+ * 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 declare function spreadIfDefined<T, V extends Record<string, unknown>>(value: T | undefined, fn: (v: T) => V): V | Record<string, never>;

package/dist/types/utils/validators.d.ts

@@ -816,6 +816,53 @@ export declare const validateFolder: (input: unknown) => {
     defaultOrder: number;
     childOrder: number;
 }[];
+export declare const validateGoal: (input: unknown) => {
+    [x: string]: unknown;
+    id: string;
+    ownerType: "USER" | "WORKSPACE";
+    ownerId: string;
+    name: string;
+    description: string | null;
+    deadline: string | null;
+    parentGoalId: string | null;
+    childOrder: number;
+    isCompleted: boolean;
+    completedAt: Date | null;
+    responsibleUid: string | null;
+    isDeleted: boolean;
+    creatorUid: string;
+    createdAt: Date;
+    updatedAt: Date;
+    progress?: {
+        [x: string]: unknown;
+        totalTaskCount: number;
+        completedTaskCount: number;
+        percentage: number;
+    } | undefined;
+}, validateGoalArray: (input: unknown) => {
+    [x: string]: unknown;
+    id: string;
+    ownerType: "USER" | "WORKSPACE";
+    ownerId: string;
+    name: string;
+    description: string | null;
+    deadline: string | null;
+    parentGoalId: string | null;
+    childOrder: number;
+    isCompleted: boolean;
+    completedAt: Date | null;
+    responsibleUid: string | null;
+    isDeleted: boolean;
+    creatorUid: string;
+    createdAt: Date;
+    updatedAt: Date;
+    progress?: {
+        [x: string]: unknown;
+        totalTaskCount: number;
+        completedTaskCount: number;
+        percentage: number;
+    } | undefined;
+}[];
 export declare const validateNote: (input: unknown) => {
     [x: string]: unknown;
     id: string;
@@ -1137,29 +1184,29 @@ export declare const validateViewOptions: (input: unknown) => {
     [x: string]: unknown;
     viewType: "PROJECT" | "TODAY" | "UPCOMING" | "LABEL" | "FILTER" | "WORKSPACE_FILTER" | "SEARCH" | "TEMPLATE_PREVIEW" | "TASK_DETAIL" | "AUTOMATION" | "ASSIGNED" | "OVERDUE" | "WORKSPACE_OVERVIEW";
     objectId?: string | undefined;
-    groupedBy?: "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | null | undefined;
+    groupedBy?: "WORKSPACE" | "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | null | undefined;
     filteredBy?: string | null | undefined;
     viewMode?: "LIST" | "BOARD" | "CALENDAR" | undefined;
     showCompletedTasks?: boolean | undefined;
-    sortedBy?: "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
+    sortedBy?: "WORKSPACE" | "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
     sortOrder?: "ASC" | "DESC" | null | undefined;
 }, validateViewOptionsArray: (input: unknown) => {
     [x: string]: unknown;
     viewType: "PROJECT" | "TODAY" | "UPCOMING" | "LABEL" | "FILTER" | "WORKSPACE_FILTER" | "SEARCH" | "TEMPLATE_PREVIEW" | "TASK_DETAIL" | "AUTOMATION" | "ASSIGNED" | "OVERDUE" | "WORKSPACE_OVERVIEW";
     objectId?: string | undefined;
-    groupedBy?: "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | null | undefined;
+    groupedBy?: "WORKSPACE" | "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | null | undefined;
     filteredBy?: string | null | undefined;
     viewMode?: "LIST" | "BOARD" | "CALENDAR" | undefined;
     showCompletedTasks?: boolean | undefined;
-    sortedBy?: "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
+    sortedBy?: "WORKSPACE" | "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
     sortOrder?: "ASC" | "DESC" | null | undefined;
 }[];
 export declare const validateProjectViewOptionsDefaults: (input: unknown) => {
     [x: string]: unknown;
     projectId: string;
     viewMode?: "LIST" | "BOARD" | "CALENDAR" | null | undefined;
-    groupedBy?: "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | null | undefined;
-    sortedBy?: "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
+    groupedBy?: "WORKSPACE" | "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | null | undefined;
+    sortedBy?: "WORKSPACE" | "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
     sortOrder?: "ASC" | "DESC" | null | undefined;
     showCompletedTasks?: boolean | undefined;
     filteredBy?: string | null | undefined;
@@ -1171,8 +1218,8 @@ export declare const validateProjectViewOptionsDefaults: (input: unknown) => {
     [x: string]: unknown;
     projectId: string;
     viewMode?: "LIST" | "BOARD" | "CALENDAR" | null | undefined;
-    groupedBy?: "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | null | undefined;
-    sortedBy?: "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "WORKSPACE" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
+    groupedBy?: "WORKSPACE" | "PROJECT" | "LABEL" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | null | undefined;
+    sortedBy?: "WORKSPACE" | "PROJECT" | "ASSIGNEE" | "ADDED_DATE" | "DUE_DATE" | "DEADLINE" | "PRIORITY" | "MANUAL" | "ALPHABETICALLY" | null | undefined;
     sortOrder?: "ASC" | "DESC" | null | undefined;
     showCompletedTasks?: boolean | undefined;
     filteredBy?: string | null | undefined;

package/package.json

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