@todoist/sdk 0.0.0-stage → 18.0.0

package/dist/types/types/webhooks/envelope.d.ts

@@ -0,0 +1,34 @@
+import { z } from 'zod';
+/**
+ * Collaborator info for the user that triggered a webhook event.
+ * @see https://developer.todoist.com/sync/v1/#webhooks
+ */
+export declare const WebhookInitiatorSchema: z.ZodObject<{
+    id: z.ZodString;
+    fullName: z.ZodString;
+    email: z.ZodString;
+    imageId: z.ZodNullable<z.ZodString>;
+    isPremium: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Collaborator info for the user that triggered a webhook event.
+ */
+export type WebhookInitiator = z.infer<typeof WebhookInitiatorSchema>;
+/**
+ * Fields common to every webhook payload, regardless of `eventName`.
+ * Meant to be spread into per-event variant schemas.
+ */
+export declare const BaseWebhookEnvelopeShape: {
+    readonly version: z.ZodEnum<{
+        1: "1";
+    }>;
+    readonly userId: z.ZodString;
+    readonly initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    readonly triggeredAt: z.ZodCoercedDate<unknown>;
+};

package/dist/types/types/webhooks/filters.d.ts

@@ -0,0 +1,99 @@
+import { z } from 'zod';
+/**
+ * Enum-like object of filter (`filter:*`) webhook event names. Single
+ * source of truth for the discriminator values — `FILTER_WEBHOOK_EVENTS`
+ * and every `z.literal()` below derive from it.
+ */
+export declare const FilterWebhookEventEnum: {
+    readonly Added: "filter:added";
+    readonly Updated: "filter:updated";
+    readonly Deleted: "filter:deleted";
+};
+/** Webhook events that carry a filter as their `eventData`. */
+export declare const FILTER_WEBHOOK_EVENTS: readonly ["filter:added", "filter:updated", "filter:deleted"];
+/**
+ * Webhook filter payloads match the shared {@link Filter} resource shape,
+ * so `eventData` reuses `FilterSchema` directly — no webhook-specific
+ * schema is needed.
+ */
+export declare const FilterAddedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"filter:added">;
+    eventData: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        query: z.ZodString;
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        color: z.ZodString;
+        isDeleted: z.ZodBoolean;
+        isFavorite: z.ZodBoolean;
+        isFrozen: z.ZodBoolean;
+        itemOrder: z.ZodNumber;
+    }, z.core.$loose>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type FilterAddedPayload = z.infer<typeof FilterAddedPayloadSchema>;
+export declare const FilterUpdatedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"filter:updated">;
+    eventData: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        query: z.ZodString;
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        color: z.ZodString;
+        isDeleted: z.ZodBoolean;
+        isFavorite: z.ZodBoolean;
+        isFrozen: z.ZodBoolean;
+        itemOrder: z.ZodNumber;
+    }, z.core.$loose>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type FilterUpdatedPayload = z.infer<typeof FilterUpdatedPayloadSchema>;
+export declare const FilterDeletedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"filter:deleted">;
+    eventData: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        query: z.ZodString;
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        color: z.ZodString;
+        isDeleted: z.ZodBoolean;
+        isFavorite: z.ZodBoolean;
+        isFrozen: z.ZodBoolean;
+        itemOrder: z.ZodNumber;
+    }, z.core.$loose>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type FilterDeletedPayload = z.infer<typeof FilterDeletedPayloadSchema>;

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

@@ -0,0 +1,9 @@
+export * from './comments.js';
+export * from './envelope.js';
+export * from './filters.js';
+export * from './labels.js';
+export * from './projects.js';
+export * from './reminders.js';
+export * from './sections.js';
+export * from './tasks.js';
+export * from './types.js';

package/dist/types/types/webhooks/labels.d.ts

@@ -0,0 +1,160 @@
+import { z } from 'zod';
+/**
+ * Enum-like object of label (`label:*`) webhook event names. Single source
+ * of truth for the discriminator values — `LABEL_WEBHOOK_EVENTS` and every
+ * `z.literal()` below derive from it.
+ */
+export declare const LabelWebhookEventEnum: {
+    readonly Added: "label:added";
+    readonly Updated: "label:updated";
+    readonly Deleted: "label:deleted";
+};
+/** Webhook events that carry a label as their `eventData`. */
+export declare const LABEL_WEBHOOK_EVENTS: readonly ["label:added", "label:updated", "label:deleted"];
+/**
+ * A label as delivered in a webhook payload.
+ *
+ * Webhook label payloads differ from the REST label shape in two ways:
+ * they use `item_order` (not `order`) and always include `is_deleted`. This
+ * schema reuses {@link LabelSchema}, swapping `order` for `itemOrder` on
+ * the input side and renaming it back after validation, and surfaces
+ * `isDeleted` for downstream filtering.
+ */
+export declare const WebhookLabelSchema: z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    color: z.ZodString;
+    isFavorite: z.ZodBoolean;
+    name: z.ZodString;
+    itemOrder: z.ZodNullable<z.ZodNumber>;
+    isDeleted: z.ZodBoolean;
+}, z.core.$strip>, z.ZodTransform<{
+    order: number | null;
+    id: string;
+    color: string;
+    isFavorite: boolean;
+    name: string;
+    isDeleted: boolean;
+}, {
+    id: string;
+    color: string;
+    isFavorite: boolean;
+    name: string;
+    itemOrder: number | null;
+    isDeleted: boolean;
+}>>;
+/** A label as delivered in a webhook payload. */
+export type WebhookLabel = z.infer<typeof WebhookLabelSchema>;
+export declare const LabelAddedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"label:added">;
+    eventData: z.ZodPipe<z.ZodObject<{
+        id: z.ZodString;
+        color: z.ZodString;
+        isFavorite: z.ZodBoolean;
+        name: z.ZodString;
+        itemOrder: z.ZodNullable<z.ZodNumber>;
+        isDeleted: z.ZodBoolean;
+    }, z.core.$strip>, z.ZodTransform<{
+        order: number | null;
+        id: string;
+        color: string;
+        isFavorite: boolean;
+        name: string;
+        isDeleted: boolean;
+    }, {
+        id: string;
+        color: string;
+        isFavorite: boolean;
+        name: string;
+        itemOrder: number | null;
+        isDeleted: boolean;
+    }>>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type LabelAddedPayload = z.infer<typeof LabelAddedPayloadSchema>;
+export declare const LabelUpdatedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"label:updated">;
+    eventData: z.ZodPipe<z.ZodObject<{
+        id: z.ZodString;
+        color: z.ZodString;
+        isFavorite: z.ZodBoolean;
+        name: z.ZodString;
+        itemOrder: z.ZodNullable<z.ZodNumber>;
+        isDeleted: z.ZodBoolean;
+    }, z.core.$strip>, z.ZodTransform<{
+        order: number | null;
+        id: string;
+        color: string;
+        isFavorite: boolean;
+        name: string;
+        isDeleted: boolean;
+    }, {
+        id: string;
+        color: string;
+        isFavorite: boolean;
+        name: string;
+        itemOrder: number | null;
+        isDeleted: boolean;
+    }>>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type LabelUpdatedPayload = z.infer<typeof LabelUpdatedPayloadSchema>;
+export declare const LabelDeletedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"label:deleted">;
+    eventData: z.ZodPipe<z.ZodObject<{
+        id: z.ZodString;
+        color: z.ZodString;
+        isFavorite: z.ZodBoolean;
+        name: z.ZodString;
+        itemOrder: z.ZodNullable<z.ZodNumber>;
+        isDeleted: z.ZodBoolean;
+    }, z.core.$strip>, z.ZodTransform<{
+        order: number | null;
+        id: string;
+        color: string;
+        isFavorite: boolean;
+        name: string;
+        isDeleted: boolean;
+    }, {
+        id: string;
+        color: string;
+        isFavorite: boolean;
+        name: string;
+        itemOrder: number | null;
+        isDeleted: boolean;
+    }>>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type LabelDeletedPayload = z.infer<typeof LabelDeletedPayloadSchema>;

package/dist/types/types/webhooks/projects.d.ts

@@ -0,0 +1,365 @@
+import { z } from 'zod';
+/**
+ * Enum-like object of project (`project:*`) webhook event names. Single
+ * source of truth for the discriminator values — `PROJECT_WEBHOOK_EVENTS`
+ * and every `z.literal()` below derive from it.
+ */
+export declare const ProjectWebhookEventEnum: {
+    readonly Added: "project:added";
+    readonly Updated: "project:updated";
+    readonly Deleted: "project:deleted";
+    readonly Archived: "project:archived";
+    readonly Unarchived: "project:unarchived";
+};
+/** Webhook events that carry a project as their `eventData`. */
+export declare const PROJECT_WEBHOOK_EVENTS: readonly ["project:added", "project:updated", "project:deleted", "project:archived", "project:unarchived"];
+/**
+ * Webhook project payloads match the shape of the shared {@link Project}
+ * resource — either a personal or a workspace project. No webhook-specific
+ * schema is needed; `ProjectSchema` already dispatches on `workspaceId`.
+ */
+export declare const ProjectAddedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"project:added">;
+    eventData: z.ZodPipe<z.ZodUnknown, z.ZodTransform<{
+        url: string;
+        id: string;
+        canAssignTasks: boolean;
+        childOrder: number;
+        color: string;
+        createdAt: Date | null;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isFavorite: boolean;
+        isFrozen: boolean;
+        name: string;
+        updatedAt: Date | null;
+        viewStyle: string;
+        defaultOrder: number;
+        description: string;
+        isCollapsed: boolean;
+        isShared: boolean;
+        parentId: string | null;
+        inboxProject: boolean;
+        orderKey?: string | null | undefined;
+        defaultOrderKey?: string | null | undefined;
+    } | {
+        url: string;
+        id: string;
+        canAssignTasks: boolean;
+        childOrder: number;
+        color: string;
+        createdAt: Date | null;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isFavorite: boolean;
+        isFrozen: boolean;
+        name: string;
+        updatedAt: Date | null;
+        viewStyle: string;
+        defaultOrder: number;
+        description: string;
+        isCollapsed: boolean;
+        isShared: boolean;
+        collaboratorRoleDefault: string;
+        folderId: string | null;
+        isInviteOnly: boolean | null;
+        isLinkSharingEnabled: boolean;
+        role: string | null;
+        status: string;
+        workspaceId: string;
+        orderKey?: string | null | undefined;
+        defaultOrderKey?: string | null | undefined;
+        access?: {
+            visibility: "restricted" | "team" | "public";
+        } | undefined;
+    }, unknown>>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type ProjectAddedPayload = z.infer<typeof ProjectAddedPayloadSchema>;
+export declare const ProjectUpdatedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"project:updated">;
+    eventData: z.ZodPipe<z.ZodUnknown, z.ZodTransform<{
+        url: string;
+        id: string;
+        canAssignTasks: boolean;
+        childOrder: number;
+        color: string;
+        createdAt: Date | null;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isFavorite: boolean;
+        isFrozen: boolean;
+        name: string;
+        updatedAt: Date | null;
+        viewStyle: string;
+        defaultOrder: number;
+        description: string;
+        isCollapsed: boolean;
+        isShared: boolean;
+        parentId: string | null;
+        inboxProject: boolean;
+        orderKey?: string | null | undefined;
+        defaultOrderKey?: string | null | undefined;
+    } | {
+        url: string;
+        id: string;
+        canAssignTasks: boolean;
+        childOrder: number;
+        color: string;
+        createdAt: Date | null;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isFavorite: boolean;
+        isFrozen: boolean;
+        name: string;
+        updatedAt: Date | null;
+        viewStyle: string;
+        defaultOrder: number;
+        description: string;
+        isCollapsed: boolean;
+        isShared: boolean;
+        collaboratorRoleDefault: string;
+        folderId: string | null;
+        isInviteOnly: boolean | null;
+        isLinkSharingEnabled: boolean;
+        role: string | null;
+        status: string;
+        workspaceId: string;
+        orderKey?: string | null | undefined;
+        defaultOrderKey?: string | null | undefined;
+        access?: {
+            visibility: "restricted" | "team" | "public";
+        } | undefined;
+    }, unknown>>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type ProjectUpdatedPayload = z.infer<typeof ProjectUpdatedPayloadSchema>;
+export declare const ProjectDeletedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"project:deleted">;
+    eventData: z.ZodPipe<z.ZodUnknown, z.ZodTransform<{
+        url: string;
+        id: string;
+        canAssignTasks: boolean;
+        childOrder: number;
+        color: string;
+        createdAt: Date | null;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isFavorite: boolean;
+        isFrozen: boolean;
+        name: string;
+        updatedAt: Date | null;
+        viewStyle: string;
+        defaultOrder: number;
+        description: string;
+        isCollapsed: boolean;
+        isShared: boolean;
+        parentId: string | null;
+        inboxProject: boolean;
+        orderKey?: string | null | undefined;
+        defaultOrderKey?: string | null | undefined;
+    } | {
+        url: string;
+        id: string;
+        canAssignTasks: boolean;
+        childOrder: number;
+        color: string;
+        createdAt: Date | null;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isFavorite: boolean;
+        isFrozen: boolean;
+        name: string;
+        updatedAt: Date | null;
+        viewStyle: string;
+        defaultOrder: number;
+        description: string;
+        isCollapsed: boolean;
+        isShared: boolean;
+        collaboratorRoleDefault: string;
+        folderId: string | null;
+        isInviteOnly: boolean | null;
+        isLinkSharingEnabled: boolean;
+        role: string | null;
+        status: string;
+        workspaceId: string;
+        orderKey?: string | null | undefined;
+        defaultOrderKey?: string | null | undefined;
+        access?: {
+            visibility: "restricted" | "team" | "public";
+        } | undefined;
+    }, unknown>>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type ProjectDeletedPayload = z.infer<typeof ProjectDeletedPayloadSchema>;
+export declare const ProjectArchivedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"project:archived">;
+    eventData: z.ZodPipe<z.ZodUnknown, z.ZodTransform<{
+        url: string;
+        id: string;
+        canAssignTasks: boolean;
+        childOrder: number;
+        color: string;
+        createdAt: Date | null;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isFavorite: boolean;
+        isFrozen: boolean;
+        name: string;
+        updatedAt: Date | null;
+        viewStyle: string;
+        defaultOrder: number;
+        description: string;
+        isCollapsed: boolean;
+        isShared: boolean;
+        parentId: string | null;
+        inboxProject: boolean;
+        orderKey?: string | null | undefined;
+        defaultOrderKey?: string | null | undefined;
+    } | {
+        url: string;
+        id: string;
+        canAssignTasks: boolean;
+        childOrder: number;
+        color: string;
+        createdAt: Date | null;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isFavorite: boolean;
+        isFrozen: boolean;
+        name: string;
+        updatedAt: Date | null;
+        viewStyle: string;
+        defaultOrder: number;
+        description: string;
+        isCollapsed: boolean;
+        isShared: boolean;
+        collaboratorRoleDefault: string;
+        folderId: string | null;
+        isInviteOnly: boolean | null;
+        isLinkSharingEnabled: boolean;
+        role: string | null;
+        status: string;
+        workspaceId: string;
+        orderKey?: string | null | undefined;
+        defaultOrderKey?: string | null | undefined;
+        access?: {
+            visibility: "restricted" | "team" | "public";
+        } | undefined;
+    }, unknown>>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type ProjectArchivedPayload = z.infer<typeof ProjectArchivedPayloadSchema>;
+export declare const ProjectUnarchivedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"project:unarchived">;
+    eventData: z.ZodPipe<z.ZodUnknown, z.ZodTransform<{
+        url: string;
+        id: string;
+        canAssignTasks: boolean;
+        childOrder: number;
+        color: string;
+        createdAt: Date | null;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isFavorite: boolean;
+        isFrozen: boolean;
+        name: string;
+        updatedAt: Date | null;
+        viewStyle: string;
+        defaultOrder: number;
+        description: string;
+        isCollapsed: boolean;
+        isShared: boolean;
+        parentId: string | null;
+        inboxProject: boolean;
+        orderKey?: string | null | undefined;
+        defaultOrderKey?: string | null | undefined;
+    } | {
+        url: string;
+        id: string;
+        canAssignTasks: boolean;
+        childOrder: number;
+        color: string;
+        createdAt: Date | null;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isFavorite: boolean;
+        isFrozen: boolean;
+        name: string;
+        updatedAt: Date | null;
+        viewStyle: string;
+        defaultOrder: number;
+        description: string;
+        isCollapsed: boolean;
+        isShared: boolean;
+        collaboratorRoleDefault: string;
+        folderId: string | null;
+        isInviteOnly: boolean | null;
+        isLinkSharingEnabled: boolean;
+        role: string | null;
+        status: string;
+        workspaceId: string;
+        orderKey?: string | null | undefined;
+        defaultOrderKey?: string | null | undefined;
+        access?: {
+            visibility: "restricted" | "team" | "public";
+        } | undefined;
+    }, unknown>>;
+    version: z.ZodEnum<{
+        1: "1";
+    }>;
+    userId: z.ZodString;
+    initiator: z.ZodObject<{
+        id: z.ZodString;
+        fullName: z.ZodString;
+        email: z.ZodString;
+        imageId: z.ZodNullable<z.ZodString>;
+        isPremium: z.ZodBoolean;
+    }, z.core.$strip>;
+    triggeredAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export type ProjectUnarchivedPayload = z.infer<typeof ProjectUnarchivedPayloadSchema>;