@doist/todoist-api-typescript 7.6.0 → 7.6.1

package/dist/esm/types/workspaces/types.js

@@ -0,0 +1,134 @@
+import { z } from 'zod';
+import { DueDateSchema, DeadlineSchema } from '../tasks/types.js';
+/** Available project collaborator roles. */
+export const COLLABORATOR_ROLES = [
+    'CREATOR',
+    'ADMIN',
+    'READ_WRITE',
+    'EDIT_ONLY',
+    'COMPLETE_ONLY',
+];
+/**
+ * Available workspace roles.
+ */
+export const WORKSPACE_ROLES = ['ADMIN', 'MEMBER', 'GUEST'];
+export const WorkspaceRoleSchema = z.enum(WORKSPACE_ROLES);
+export const WorkspaceUserSchema = z.object({
+    userId: z.string(),
+    workspaceId: z.string(),
+    userEmail: z.string(),
+    fullName: z.string(),
+    timezone: z.string(),
+    role: WorkspaceRoleSchema,
+    imageId: z.string().nullable(),
+    isDeleted: z.boolean().default(false),
+});
+export const WorkspaceInvitationSchema = z.object({
+    id: z.string().default('0'),
+    inviterId: z.string(),
+    userEmail: z.string(),
+    workspaceId: z.string(),
+    role: WorkspaceRoleSchema,
+    isExistingUser: z.boolean(),
+});
+export const PlanPriceSchema = z.object({
+    currency: z.string(),
+    amount: z.union([z.number(), z.string()]),
+    interval: z.string().optional(),
+});
+export const FormattedPriceListingSchema = z.object({
+    currency: z.string().optional(),
+    amount: z.number().optional(),
+    interval: z.string().optional(),
+    formatted: z.string().optional(),
+});
+/** Available workspace plan names. */
+export const WORKSPACE_CURRENT_PLANS = ['Business', 'Starter'];
+/** Available workspace plan statuses. */
+export const WORKSPACE_PLAN_STATUSES = [
+    'Active',
+    'Downgraded',
+    'Cancelled',
+    'NeverSubscribed',
+];
+export const WorkspacePlanDetailsSchema = z.object({
+    currentMemberCount: z.number(),
+    currentPlan: z.enum(WORKSPACE_CURRENT_PLANS),
+    currentPlanStatus: z.enum(WORKSPACE_PLAN_STATUSES),
+    downgradeAt: z.string().nullable(),
+    currentActiveProjects: z.number(),
+    maximumActiveProjects: z.number(),
+    priceList: z.array(FormattedPriceListingSchema),
+    workspaceId: z.number(),
+    isTrialing: z.boolean(),
+    trialEndsAt: z.string().nullable(),
+    cancelAtPeriodEnd: z.boolean(),
+    hasTrialed: z.boolean(),
+    planPrice: PlanPriceSchema.nullable(),
+    hasBillingPortal: z.boolean(),
+    hasBillingPortalSwitchToAnnual: z.boolean(),
+});
+export const JoinWorkspaceResultSchema = z.object({
+    customSortingApplied: z.boolean(),
+    projectSortPreference: z.string(),
+    role: WorkspaceRoleSchema,
+    userId: z.string(),
+    workspaceId: z.string(),
+});
+/**
+ * Available workspace plans.
+ */
+export const WORKSPACE_PLANS = ['STARTER', 'BUSINESS'];
+export const WorkspacePlanSchema = z.enum(WORKSPACE_PLANS);
+/**
+ * Workspace resource limits.
+ */
+export const WorkspaceLimitsSchema = z
+    .object({
+    current: z.record(z.string(), z.any()).nullable(),
+    next: z.record(z.string(), z.any()).nullable(),
+})
+    .catchall(z.any());
+/**
+ * Workspace properties (flexible object for unknown fields).
+ */
+export const WorkspacePropertiesSchema = z.record(z.string(), z.unknown());
+/**
+ * Represents a workspace in Todoist.
+ */
+export const WorkspaceSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    plan: WorkspacePlanSchema,
+    role: WorkspaceRoleSchema,
+    inviteCode: z.string(),
+    isLinkSharingEnabled: z.boolean(),
+    isGuestAllowed: z.boolean(),
+    limits: WorkspaceLimitsSchema,
+    logoBig: z.string().nullish(),
+    logoMedium: z.string().nullish(),
+    logoSmall: z.string().nullish(),
+    logoS640: z.string().nullish(),
+    createdAt: z.string(),
+    creatorId: z.string(),
+    properties: WorkspacePropertiesSchema,
+});
+export const MemberActivityInfoSchema = z.object({
+    userId: z.string(),
+    tasksAssigned: z.number().int(),
+    tasksOverdue: z.number().int(),
+});
+export const WorkspaceUserTaskSchema = z.object({
+    id: z.string(),
+    content: z.string(),
+    responsibleUid: z.string().nullable(),
+    due: DueDateSchema.nullable(),
+    deadline: DeadlineSchema.nullable(),
+    labels: z.array(z.string()),
+    notesCount: z.number().int(),
+    projectId: z.string(),
+    projectName: z.string(),
+    priority: z.number().int(),
+    description: z.string(),
+    isOverdue: z.boolean(),
+});

package/dist/esm/utils/validators.js

@@ -1,4 +1,15 @@
-import { AttachmentSchema, SectionSchema, LabelSchema, CommentSchema, UserSchema, CurrentUserSchema, TaskSchema, PersonalProjectSchema, WorkspaceProjectSchema, ProductivityStatsSchema, ActivityEventSchema, WorkspaceUserSchema, WorkspaceInvitationSchema, WorkspacePlanDetailsSchema, JoinWorkspaceResultSchema, WorkspaceSchema, MemberActivityInfoSchema, WorkspaceUserTaskSchema, ProjectActivityStatsSchema, ProjectHealthSchema, ProjectHealthContextSchema, ProjectProgressSchema, WorkspaceInsightsSchema, BackupSchema, IdMappingSchema, MovedIdSchema, } from '../types/entities.js';
+import { TaskSchema } from '../types/tasks/types.js';
+import { PersonalProjectSchema, WorkspaceProjectSchema, } from '../types/projects/types.js';
+import { SectionSchema } from '../types/sections/types.js';
+import { LabelSchema } from '../types/labels/types.js';
+import { AttachmentSchema, CommentSchema } from '../types/comments/types.js';
+import { UserSchema, CurrentUserSchema } from '../types/users/types.js';
+import { ProductivityStatsSchema } from '../types/productivity/types.js';
+import { ActivityEventSchema } from '../types/activity/types.js';
+import { WorkspaceUserSchema, WorkspaceInvitationSchema, WorkspacePlanDetailsSchema, JoinWorkspaceResultSchema, WorkspaceSchema, MemberActivityInfoSchema, WorkspaceUserTaskSchema, } from '../types/workspaces/types.js';
+import { ProjectActivityStatsSchema, ProjectHealthSchema, ProjectHealthContextSchema, ProjectProgressSchema, WorkspaceInsightsSchema, } from '../types/insights/types.js';
+import { BackupSchema } from '../types/backups/types.js';
+import { IdMappingSchema, MovedIdSchema } from '../types/id-mappings/types.js';
 import { FilterSchema, CollaboratorSchema, CollaboratorStateSchema, FolderSchema, NoteSchema, TooltipsSchema, WorkspaceFilterSchema, WorkspaceGoalSchema, CalendarSchema, CalendarAccountSchema, ReminderSchema, LocationReminderSchema, CompletedInfoSchema, ViewOptionsSchema, ProjectViewOptionsDefaultsSchema, UserPlanLimitsSchema, LiveNotificationSchema, SyncWorkspaceSchema, SyncUserSchema, UserSettingsSchema, SuggestionSchema, } from '../types/sync/resources/index.js';
 function createValidator(schema) {
     return (input) => schema.parse(input);

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

@@ -135,7 +135,7 @@ export declare const DEFAULT_COMMENT: {
         fileType?: string | null | undefined;
         fileUrl?: string | null | undefined;
         fileDuration?: number | null | undefined;
-        uploadState?: "pending" | "completed" | null | undefined;
+        uploadState?: "completed" | "pending" | null | undefined;
         image?: string | null | undefined;
         imageWidth?: number | null | undefined;
         imageHeight?: number | null | undefined;
@@ -164,7 +164,7 @@ export declare const INVALID_COMMENT: {
         fileType?: string | null | undefined;
         fileUrl?: string | null | undefined;
         fileDuration?: number | null | undefined;
-        uploadState?: "pending" | "completed" | null | undefined;
+        uploadState?: "completed" | "pending" | null | undefined;
         image?: string | null | undefined;
         imageWidth?: number | null | undefined;
         imageHeight?: number | null | undefined;
@@ -191,7 +191,7 @@ export declare const COMMENT_WITH_OPTIONALS_AS_NULL_TASK: {
         fileType?: string | null | undefined;
         fileUrl?: string | null | undefined;
         fileDuration?: number | null | undefined;
-        uploadState?: "pending" | "completed" | null | undefined;
+        uploadState?: "completed" | "pending" | null | undefined;
         image?: string | null | undefined;
         imageWidth?: number | null | undefined;
         imageHeight?: number | null | undefined;
@@ -218,7 +218,7 @@ export declare const COMMENT_WITH_ATTACHMENT_WITH_OPTIONALS_AS_NULL: {
         fileType?: string | null | undefined;
         fileUrl?: string | null | undefined;
         fileDuration?: number | null | undefined;
-        uploadState?: "pending" | "completed" | null | undefined;
+        uploadState?: "completed" | "pending" | null | undefined;
         image?: string | null | undefined;
         imageWidth?: number | null | undefined;
         imageHeight?: number | null | undefined;
@@ -244,7 +244,7 @@ export declare const COMMENT_WITH_OPTIONALS_AS_NULL_PROJECT: {
         fileType?: string | null | undefined;
         fileUrl?: string | null | undefined;
         fileDuration?: number | null | undefined;
-        uploadState?: "pending" | "completed" | null | undefined;
+        uploadState?: "completed" | "pending" | null | undefined;
         image?: string | null | undefined;
         imageWidth?: number | null | undefined;
         imageHeight?: number | null | undefined;

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

@@ -1,5 +1,19 @@
-import { Attachment, PersonalProject, WorkspaceProject, Label, Section, Comment, Task, CurrentUser, ProductivityStats, WorkspaceInvitation, WorkspacePlanDetails, JoinWorkspaceResult, Workspace, Backup, IdMapping, MovedId, ProjectActivityStats, ProjectHealth, ProjectHealthContext, ProjectProgress, WorkspaceInsights } from './types/entities.js';
-import { AddCommentArgs, AddLabelArgs, AddLocationReminderArgs, AddProjectArgs, AddReminderArgs, AddSectionArgs, AddTaskArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateCommentArgs, UpdateLabelArgs, UpdateLocationReminderArgs, UpdateProjectArgs, UpdateReminderArgs, UpdateSectionArgs, UpdateTaskArgs, QuickAddTaskArgs, GetSharedLabelsArgs, RenameSharedLabelArgs, RemoveSharedLabelArgs, GetProjectsArgs, SearchProjectsArgs, GetProjectCollaboratorsArgs, GetLabelsArgs, SearchLabelsArgs, GetLabelsResponse, GetTasksResponse, GetProjectsResponse, GetProjectCollaboratorsResponse, GetSectionsArgs, SearchSectionsArgs, GetSectionsResponse, GetSharedLabelsResponse, GetCommentsResponse, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse, SearchCompletedTasksArgs, GetActivityLogsArgs, GetActivityLogsResponse, UploadFileArgs, DeleteUploadArgs, GetWorkspaceInvitationsArgs, DeleteWorkspaceInvitationArgs, WorkspaceInvitationActionArgs, JoinWorkspaceArgs, WorkspaceLogoArgs, GetWorkspacePlanDetailsArgs, GetWorkspaceUsersArgs, GetWorkspaceUsersResponse, GetWorkspaceProjectsArgs, WorkspaceInvitationsResponse, AllWorkspaceInvitationsResponse, WorkspaceLogoResponse, MoveProjectToWorkspaceArgs, MoveProjectToPersonalArgs, GetArchivedProjectsCountArgs, GetArchivedProjectsCountResponse, GetProjectPermissionsResponse, GetFullProjectArgs, GetFullProjectResponse, AddWorkspaceArgs, UpdateWorkspaceArgs, GetWorkspaceMembersActivityArgs, GetWorkspaceMembersActivityResponse, GetWorkspaceUserTasksArgs, GetWorkspaceUserTasksResponse, InviteWorkspaceUsersArgs, InviteWorkspaceUsersResponse, UpdateWorkspaceUserArgs, RemoveWorkspaceUserArgs, GetProjectActivityStatsArgs, GetWorkspaceInsightsArgs, GetRemindersArgs, GetRemindersResponse, GetLocationRemindersArgs, GetLocationRemindersResponse, GetAllCompletedTasksArgs, GetAllCompletedTasksResponse, ExportTemplateFileArgs, ExportTemplateUrlArgs, ExportTemplateUrlResponse, CreateProjectFromTemplateArgs, CreateProjectFromTemplateResponse, ImportTemplateIntoProjectArgs, ImportTemplateFromIdArgs, ImportTemplateResponse, GetBackupsArgs, DownloadBackupArgs, GetOrCreateEmailArgs, GetOrCreateEmailResponse, DisableEmailArgs, GetIdMappingsArgs, GetMovedIdsArgs } from './types/requests.js';
+import { Task, AddTaskArgs, GetTasksArgs, GetTasksByFilterArgs, UpdateTaskArgs, QuickAddTaskArgs, type MoveTaskArgs, GetCompletedTasksByCompletionDateArgs, GetCompletedTasksByDueDateArgs, GetCompletedTasksResponse, SearchCompletedTasksArgs, GetTasksResponse, GetAllCompletedTasksArgs, GetAllCompletedTasksResponse } from './types/tasks/index.js';
+import { PersonalProject, WorkspaceProject, AddProjectArgs, UpdateProjectArgs, GetProjectsArgs, SearchProjectsArgs, GetProjectCollaboratorsArgs, GetProjectsResponse, GetProjectCollaboratorsResponse, GetArchivedProjectsArgs, GetArchivedProjectsResponse, MoveProjectToWorkspaceArgs, MoveProjectToPersonalArgs, GetArchivedProjectsCountArgs, GetArchivedProjectsCountResponse, GetProjectPermissionsResponse, GetFullProjectArgs, GetFullProjectResponse } from './types/projects/index.js';
+import { Section, AddSectionArgs, UpdateSectionArgs, GetSectionsArgs, SearchSectionsArgs, GetSectionsResponse } from './types/sections/index.js';
+import { Label, AddLabelArgs, UpdateLabelArgs, GetLabelsArgs, SearchLabelsArgs, GetLabelsResponse, GetSharedLabelsArgs, GetSharedLabelsResponse, RenameSharedLabelArgs, RemoveSharedLabelArgs } from './types/labels/index.js';
+import { Attachment, Comment, AddCommentArgs, UpdateCommentArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetCommentsResponse } from './types/comments/index.js';
+import { AddReminderArgs, UpdateReminderArgs, AddLocationReminderArgs, UpdateLocationReminderArgs, GetRemindersArgs, GetRemindersResponse, GetLocationRemindersArgs, GetLocationRemindersResponse } from './types/reminders/index.js';
+import { CurrentUser } from './types/users/index.js';
+import { ProductivityStats } from './types/productivity/index.js';
+import { GetActivityLogsArgs, GetActivityLogsResponse } from './types/activity/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 { ProjectActivityStats, ProjectHealth, ProjectHealthContext, ProjectProgress, WorkspaceInsights, GetProjectActivityStatsArgs, GetWorkspaceInsightsArgs } from './types/insights/index.js';
+import { Backup, GetBackupsArgs, DownloadBackupArgs } from './types/backups/index.js';
+import { IdMapping, MovedId, GetIdMappingsArgs, GetMovedIdsArgs } from './types/id-mappings/index.js';
+import { GetOrCreateEmailArgs, GetOrCreateEmailResponse, DisableEmailArgs } from './types/emails/index.js';
+import { UploadFileArgs, DeleteUploadArgs } from './types/uploads/index.js';
+import { ExportTemplateFileArgs, ExportTemplateUrlArgs, ExportTemplateUrlResponse, CreateProjectFromTemplateArgs, CreateProjectFromTemplateResponse, ImportTemplateIntoProjectArgs, ImportTemplateFromIdArgs, ImportTemplateResponse } from './types/templates/index.js';
 import { CustomFetch, CustomFetchResponse } from './types/http.js';
 import type { Reminder } from './types/index.js';
 import { type SyncResponse, type SyncRequest } from './types/sync/index.js';

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

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

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

@@ -0,0 +1,85 @@
+import type { ActivityEvent, ActivityObjectEventType } from './types.js';
+/**
+ * Common arguments for retrieving activity logs (excluding filter-type params).
+ */
+type GetActivityLogsArgsCommon = {
+    /**
+     * Filter by the ID of a specific object.
+     */
+    objectId?: string;
+    /**
+     * Filter events by parent project ID.
+     */
+    parentProjectId?: string;
+    /**
+     * Filter events by parent task ID.
+     */
+    parentItemId?: string;
+    /**
+     * When true, includes the parent object data in the response.
+     */
+    includeParentObject?: boolean;
+    /**
+     * When true, includes child object data in the response.
+     */
+    includeChildObjects?: boolean;
+    /**
+     * Filter by the user ID who initiated the event.
+     */
+    initiatorId?: string;
+    /**
+     * When true, filters for events with no initiator (system-generated events).
+     * When false, filters for events with an initiator.
+     * When null or undefined, no filtering on initiator is applied.
+     */
+    initiatorIdNull?: boolean | null;
+    /**
+     * When true, ensures the last state of objects is included in the response.
+     */
+    ensureLastState?: boolean;
+    /**
+     * When true, includes comment annotations in the response.
+     */
+    annotateNotes?: boolean;
+    /**
+     * When true, includes parent object annotations in the response.
+     */
+    annotateParents?: boolean;
+    /**
+     * Pagination cursor for retrieving the next page of results.
+     */
+    cursor?: string | null;
+    /**
+     * Maximum number of results to return per page.
+     */
+    limit?: number;
+    /**
+     * Start date for filtering events (inclusive). Replaces deprecated `since`.
+     * Accepts a Date object or YYYY-MM-DD string.
+     */
+    dateFrom?: Date | string;
+    /**
+     * End date for filtering events (inclusive). Replaces deprecated `until`.
+     * Accepts a Date object or YYYY-MM-DD string.
+     */
+    dateTo?: Date | string;
+};
+export type GetActivityLogsArgs = GetActivityLogsArgsCommon & {
+    objectEventTypes?: ActivityObjectEventType | ActivityObjectEventType[];
+    /** @removed Use `objectEventTypes` instead. */
+    objectType?: never;
+    /** @removed Use `objectEventTypes` instead. */
+    eventType?: never;
+    /** @removed Use `dateFrom` instead. */
+    since?: never;
+    /** @removed Use `dateTo` instead. */
+    until?: never;
+};
+/**
+ * Response from retrieving activity logs.
+ */
+export type GetActivityLogsResponse = {
+    results: ActivityEvent[];
+    nextCursor: string | null;
+};
+export {};

package/dist/types/types/activity/types.d.ts

@@ -0,0 +1,49 @@
+import { z } from 'zod';
+/**
+ * Type hints for known object types. Accepts any string for forward compatibility.
+ */
+export type ActivityObjectType = 'task' | 'comment' | 'project' | (string & Record<string, never>);
+/**
+ * Type hints for known event types. Accepts any string for forward compatibility.
+ */
+export type ActivityEventType = 'added' | 'updated' | 'deleted' | 'completed' | 'uncompleted' | 'archived' | 'unarchived' | 'shared' | 'left' | (string & Record<string, never>);
+type ModernActivityObjectType = 'task' | 'comment' | 'project' | (string & Record<string, never>);
+/**
+ * Combined object:event filter string for the `objectEventTypes` parameter of `getActivityLogs`.
+ *
+ * Uses modern object type names (`task`, `comment`) rather than legacy API names (`item`, `note`).
+ * Either part may be omitted:
+ * - `'task:added'` — task additions only
+ * - `'task:'` — all events for tasks
+ * - `':deleted'` — all deleted events across all object types
+ *
+ * The final `string & Record<string, never>` member allows any arbitrary string
+ * to be passed for forward compatibility, while still providing autocomplete for
+ * the known combinations above.
+ */
+export type ActivityObjectEventType = `${ModernActivityObjectType}:${ActivityEventType}` | `${ModernActivityObjectType}:` | `:${ActivityEventType}` | (string & Record<string, never>);
+/**
+ * Flexible object containing event-specific data.
+ * Uses z.record to accept any properties for forward compatibility.
+ */
+export declare const ActivityEventExtraDataSchema: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+export type ActivityEventExtraData = z.infer<typeof ActivityEventExtraDataSchema>;
+/**
+ * Activity log event schema. Accepts unknown fields for forward compatibility.
+ */
+export declare const ActivityEventSchema: z.ZodObject<{
+    objectType: z.ZodString;
+    objectId: z.ZodString;
+    eventType: z.ZodString;
+    eventDate: z.ZodString;
+    id: z.ZodNullable<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<string, string | number>>>;
+    parentProjectId: z.ZodNullable<z.ZodString>;
+    parentItemId: z.ZodNullable<z.ZodString>;
+    initiatorId: z.ZodNullable<z.ZodString>;
+    extraData: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$catchall<z.ZodAny>>;
+/**
+ * Represents an activity log event in Todoist.
+ */
+export type ActivityEvent = z.infer<typeof ActivityEventSchema>;
+export {};

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * Arguments for listing backups.
+ * @see https://developer.todoist.com/api/v1/#tag/Backups/operation/get_backups_api_v1_backups_get
+ */
+export type GetBackupsArgs = {
+    /** MFA token if required. Not needed when using an OAuth token with the `backups:read` scope. */
+    mfaToken?: string | null;
+};
+/**
+ * Arguments for downloading a backup.
+ * @see https://developer.todoist.com/api/v1/#tag/Backups/operation/download_backup_api_v1_backups_download_get
+ */
+export type DownloadBackupArgs = {
+    /** The backup file URL. */
+    file: string;
+};

package/dist/types/types/backups/types.d.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+export declare const BackupSchema: z.ZodObject<{
+    version: z.ZodString;
+    url: z.ZodString;
+}, z.core.$strip>;
+/** Represents a backup snapshot. */
+export type Backup = z.infer<typeof BackupSchema>;

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

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

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

@@ -0,0 +1,63 @@
+import type { RequireExactlyOne } from 'type-fest';
+import type { Comment } from './types.js';
+/**
+ * Arguments for retrieving comments.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments/operation/get_comments_api_v1_comments_get
+ */
+export type GetCommentsArgs = {
+    taskId: string;
+    projectId?: never;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for retrieving task comments.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments/operation/get_comments_api_v1_comments_get
+ */
+export type GetTaskCommentsArgs = {
+    taskId: string;
+    projectId?: never;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Arguments for retrieving project comments.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments/operation/get_comments_api_v1_comments_get
+ */
+export type GetProjectCommentsArgs = {
+    projectId: string;
+    taskId?: never;
+    cursor?: string | null;
+    limit?: number;
+};
+/**
+ * Response from retrieving comments.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments/operation/get_comments_api_v1_comments_get
+ */
+export type GetCommentsResponse = {
+    results: Comment[];
+    nextCursor: string | null;
+};
+/**
+ * Arguments for creating a new comment.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments/operation/create_comment_api_v1_comments_post
+ */
+export type AddCommentArgs = {
+    content: string;
+    attachment?: {
+        fileName?: string;
+        fileUrl: string;
+        fileType?: string;
+        resourceType?: string;
+    } | null;
+} & RequireExactlyOne<{
+    taskId?: string;
+    projectId?: string;
+}>;
+/**
+ * Arguments for updating a comment.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments/operation/update_comment_api_v1_comments__comment_id__post
+ */
+export type UpdateCommentArgs = {
+    content: string;
+};

package/dist/types/types/comments/types.d.ts

@@ -0,0 +1,141 @@
+import { z } from 'zod';
+/** Available file attachment upload states. */
+export declare const UPLOAD_STATES: readonly ["pending", "completed"];
+/** Upload state of a file attachment. */
+export type UploadState = (typeof UPLOAD_STATES)[number];
+export declare const AttachmentSchema: z.ZodObject<{
+    resourceType: z.ZodString;
+    fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    fileType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fileUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fileDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    uploadState: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        completed: "completed";
+        pending: "pending";
+    }>>>;
+    image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Represents a file attachment in a comment.
+ * @see https://developer.todoist.com/api/v1/#tag/Sync/Comments/File-Attachments
+ */
+export type Attachment = z.infer<typeof AttachmentSchema>;
+export declare const RawCommentSchema: z.ZodObject<{
+    id: z.ZodString;
+    itemId: z.ZodOptional<z.ZodString>;
+    projectId: z.ZodOptional<z.ZodString>;
+    content: z.ZodString;
+    postedAt: z.ZodString;
+    fileAttachment: z.ZodNullable<z.ZodObject<{
+        resourceType: z.ZodString;
+        fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        fileType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        uploadState: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            completed: "completed";
+            pending: "pending";
+        }>>>;
+        image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>;
+    postedUid: z.ZodString;
+    uidsToNotify: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    reactions: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>;
+    isDeleted: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Represents a raw comment response from the API.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments
+ */
+export type RawComment = z.infer<typeof RawCommentSchema>;
+export declare const CommentSchema: z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    itemId: z.ZodOptional<z.ZodString>;
+    projectId: z.ZodOptional<z.ZodString>;
+    content: z.ZodString;
+    postedAt: z.ZodString;
+    fileAttachment: z.ZodNullable<z.ZodObject<{
+        resourceType: z.ZodString;
+        fileName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileSize: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        fileType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fileDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        uploadState: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            completed: "completed";
+            pending: "pending";
+        }>>>;
+        image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        imageWidth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        imageHeight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>;
+    postedUid: z.ZodString;
+    uidsToNotify: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    reactions: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>;
+    isDeleted: z.ZodBoolean;
+}, z.core.$strip>, z.ZodTransform<{
+    taskId: string | undefined;
+    id: string;
+    content: string;
+    postedAt: string;
+    fileAttachment: {
+        resourceType: string;
+        fileName?: string | null | undefined;
+        fileSize?: number | null | undefined;
+        fileType?: string | null | undefined;
+        fileUrl?: string | null | undefined;
+        fileDuration?: number | null | undefined;
+        uploadState?: "completed" | "pending" | null | undefined;
+        image?: string | null | undefined;
+        imageWidth?: number | null | undefined;
+        imageHeight?: number | null | undefined;
+        url?: string | null | undefined;
+        title?: string | null | undefined;
+    } | null;
+    postedUid: string;
+    uidsToNotify: string[] | null;
+    reactions: Record<string, string[]> | null;
+    isDeleted: boolean;
+    projectId?: string | undefined;
+}, {
+    id: string;
+    content: string;
+    postedAt: string;
+    fileAttachment: {
+        resourceType: string;
+        fileName?: string | null | undefined;
+        fileSize?: number | null | undefined;
+        fileType?: string | null | undefined;
+        fileUrl?: string | null | undefined;
+        fileDuration?: number | null | undefined;
+        uploadState?: "completed" | "pending" | null | undefined;
+        image?: string | null | undefined;
+        imageWidth?: number | null | undefined;
+        imageHeight?: number | null | undefined;
+        url?: string | null | undefined;
+        title?: string | null | undefined;
+    } | null;
+    postedUid: string;
+    uidsToNotify: string[] | null;
+    reactions: Record<string, string[]> | null;
+    isDeleted: boolean;
+    itemId?: string | undefined;
+    projectId?: string | undefined;
+}>>;
+/**
+ * Represents a comment in Todoist.
+ * @see https://developer.todoist.com/api/v1/#tag/Comments
+ */
+export type Comment = z.infer<typeof CommentSchema>;

package/dist/types/types/common.d.ts

@@ -0,0 +1,6 @@
+type SearchArgs = {
+    query: string;
+    cursor?: string | null;
+    limit?: number;
+};
+export type { SearchArgs };

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

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

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

@@ -0,0 +1,30 @@
+/** Object types that support email forwarding. */
+export declare const EMAIL_OBJECT_TYPES: readonly ["project", "project_comments", "task"];
+/** Object type that supports email forwarding. */
+export type EmailObjectType = (typeof EMAIL_OBJECT_TYPES)[number];
+/**
+ * Arguments for getting or creating an email forwarding address.
+ * @see https://developer.todoist.com/api/v1/#tag/Emails/operation/email_get_or_create_api_v1_emails_put
+ */
+export type GetOrCreateEmailArgs = {
+    /** The type of object to forward emails to. */
+    objType: EmailObjectType;
+    /** The ID of the object. */
+    objId: string;
+};
+/**
+ * Response from getting or creating an email forwarding address.
+ */
+export type GetOrCreateEmailResponse = {
+    email: string;
+};
+/**
+ * Arguments for disabling email forwarding.
+ * @see https://developer.todoist.com/api/v1/#tag/Emails/operation/email_disable_api_v1_emails_delete
+ */
+export type DisableEmailArgs = {
+    /** The type of object to disable forwarding for. */
+    objType: EmailObjectType;
+    /** The ID of the object. */
+    objId: string;
+};

package/dist/types/types/id-mappings/index.d.ts

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