@doist/todoist-sdk 9.5.0 → 9.7.0

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

@@ -0,0 +1,345 @@
+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;
+    } | {
+        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;
+        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;
+    } | {
+        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;
+        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;
+    } | {
+        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;
+        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;
+    } | {
+        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;
+        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;
+    } | {
+        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;
+        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>;

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

@@ -0,0 +1,82 @@
+import { z } from 'zod';
+/**
+ * Enum-like object of reminder (`reminder:*`) webhook event names. Single
+ * source of truth for the discriminator values — `REMINDER_WEBHOOK_EVENTS`
+ * and every `z.literal()` below derive from it.
+ */
+export declare const ReminderWebhookEventEnum: {
+    readonly Fired: "reminder:fired";
+};
+/** Webhook events that carry a fired-reminder as their `eventData`. */
+export declare const REMINDER_WEBHOOK_EVENTS: readonly ["reminder:fired"];
+/**
+ * A fired-reminder notification as delivered in a webhook payload.
+ *
+ * `reminder:fired` carries a subset of the full Reminder record (closer
+ * to a fired-notification projection), so it doesn't line up with any of
+ * the {@link Reminder} discriminated variants directly. This schema
+ * reuses {@link ReminderBaseSchema} for the common identity fields and
+ * adds the fields always present on a fired notification.
+ */
+export declare const WebhookFiredReminderSchema: z.ZodObject<{
+    id: z.ZodString;
+    notifyUid: z.ZodString;
+    itemId: z.ZodString;
+    projectId: z.ZodOptional<z.ZodString>;
+    isDeleted: z.ZodBoolean;
+    type: z.ZodEnum<{
+        relative: "relative";
+        absolute: "absolute";
+        location: "location";
+    }>;
+    isUrgent: z.ZodBoolean;
+    minuteOffset: z.ZodNullable<z.ZodNumber>;
+    due: z.ZodNullable<z.ZodObject<{
+        isRecurring: z.ZodBoolean;
+        string: z.ZodString;
+        date: z.ZodString;
+        datetime: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        lang: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$loose>;
+/** A fired-reminder notification delivered in a webhook payload. */
+export type WebhookFiredReminder = z.infer<typeof WebhookFiredReminderSchema>;
+export declare const ReminderFiredPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"reminder:fired">;
+    eventData: z.ZodObject<{
+        id: z.ZodString;
+        notifyUid: z.ZodString;
+        itemId: z.ZodString;
+        projectId: z.ZodOptional<z.ZodString>;
+        isDeleted: z.ZodBoolean;
+        type: z.ZodEnum<{
+            relative: "relative";
+            absolute: "absolute";
+            location: "location";
+        }>;
+        isUrgent: z.ZodBoolean;
+        minuteOffset: z.ZodNullable<z.ZodNumber>;
+        due: z.ZodNullable<z.ZodObject<{
+            isRecurring: z.ZodBoolean;
+            string: z.ZodString;
+            date: z.ZodString;
+            datetime: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            lang: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$strip>>;
+    }, 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 ReminderFiredPayload = z.infer<typeof ReminderFiredPayloadSchema>;