@todoist/sdk 0.0.0-stage → 18.0.0

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>;

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

@@ -0,0 +1,372 @@
+import { z } from 'zod';
+/**
+ * Enum-like object of section (`section:*`) webhook event names. Single
+ * source of truth for the discriminator values — `SECTION_WEBHOOK_EVENTS`
+ * and every `z.literal()` below derive from it.
+ */
+export declare const SectionWebhookEventEnum: {
+    readonly Added: "section:added";
+    readonly Updated: "section:updated";
+    readonly Deleted: "section:deleted";
+    readonly Archived: "section:archived";
+    readonly Unarchived: "section:unarchived";
+};
+/** Webhook events that carry a section as their `eventData`. */
+export declare const SECTION_WEBHOOK_EVENTS: readonly ["section:added", "section:updated", "section:deleted", "section:archived", "section:unarchived"];
+/**
+ * A section as delivered in a webhook payload.
+ *
+ * Reuses {@link SectionBaseSchema} and overrides `updatedAt` to tolerate
+ * payloads that deliver it as `null` or omit the key entirely — tombstones
+ * and never-updated sections come through without an `updated_at` value.
+ * The result is normalised to `Date | null` so consumers don't have to
+ * handle three shapes. `description` is similarly tolerated (older webhook
+ * payloads may omit it) and normalised to `string | null`. Surfaces the
+ * computed `url` so the exposed shape matches {@link Section}.
+ */
+export declare const WebhookSectionSchema: z.ZodPipe<z.ZodObject<{
+    id: z.ZodString;
+    userId: z.ZodString;
+    projectId: z.ZodString;
+    addedAt: z.ZodCoercedDate<unknown>;
+    archivedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    name: z.ZodString;
+    sectionOrder: z.ZodNumber;
+    orderKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    isArchived: z.ZodBoolean;
+    isDeleted: z.ZodBoolean;
+    isCollapsed: z.ZodBoolean;
+    updatedAt: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>, z.ZodTransform<Date | null, Date | null | undefined>>;
+    description: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+}, z.core.$strip>, z.ZodTransform<{
+    url: string;
+    id: string;
+    userId: string;
+    projectId: string;
+    addedAt: Date;
+    archivedAt: Date | null;
+    name: string;
+    sectionOrder: number;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isCollapsed: boolean;
+    updatedAt: Date | null;
+    description: string | null;
+    orderKey?: string | null | undefined;
+}, {
+    id: string;
+    userId: string;
+    projectId: string;
+    addedAt: Date;
+    archivedAt: Date | null;
+    name: string;
+    sectionOrder: number;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isCollapsed: boolean;
+    updatedAt: Date | null;
+    description: string | null;
+    orderKey?: string | null | undefined;
+}>>;
+/** A section delivered in a webhook payload. */
+export type WebhookSection = z.infer<typeof WebhookSectionSchema>;
+export declare const SectionAddedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"section:added">;
+    eventData: z.ZodPipe<z.ZodObject<{
+        id: z.ZodString;
+        userId: z.ZodString;
+        projectId: z.ZodString;
+        addedAt: z.ZodCoercedDate<unknown>;
+        archivedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+        name: z.ZodString;
+        sectionOrder: z.ZodNumber;
+        orderKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        isArchived: z.ZodBoolean;
+        isDeleted: z.ZodBoolean;
+        isCollapsed: z.ZodBoolean;
+        updatedAt: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>, z.ZodTransform<Date | null, Date | null | undefined>>;
+        description: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+    }, z.core.$strip>, z.ZodTransform<{
+        url: string;
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+        description: string | null;
+        orderKey?: string | null | undefined;
+    }, {
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+        description: string | null;
+        orderKey?: string | null | undefined;
+    }>>;
+    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 SectionAddedPayload = z.infer<typeof SectionAddedPayloadSchema>;
+export declare const SectionUpdatedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"section:updated">;
+    eventData: z.ZodPipe<z.ZodObject<{
+        id: z.ZodString;
+        userId: z.ZodString;
+        projectId: z.ZodString;
+        addedAt: z.ZodCoercedDate<unknown>;
+        archivedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+        name: z.ZodString;
+        sectionOrder: z.ZodNumber;
+        orderKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        isArchived: z.ZodBoolean;
+        isDeleted: z.ZodBoolean;
+        isCollapsed: z.ZodBoolean;
+        updatedAt: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>, z.ZodTransform<Date | null, Date | null | undefined>>;
+        description: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+    }, z.core.$strip>, z.ZodTransform<{
+        url: string;
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+        description: string | null;
+        orderKey?: string | null | undefined;
+    }, {
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+        description: string | null;
+        orderKey?: string | null | undefined;
+    }>>;
+    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 SectionUpdatedPayload = z.infer<typeof SectionUpdatedPayloadSchema>;
+export declare const SectionDeletedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"section:deleted">;
+    eventData: z.ZodPipe<z.ZodObject<{
+        id: z.ZodString;
+        userId: z.ZodString;
+        projectId: z.ZodString;
+        addedAt: z.ZodCoercedDate<unknown>;
+        archivedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+        name: z.ZodString;
+        sectionOrder: z.ZodNumber;
+        orderKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        isArchived: z.ZodBoolean;
+        isDeleted: z.ZodBoolean;
+        isCollapsed: z.ZodBoolean;
+        updatedAt: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>, z.ZodTransform<Date | null, Date | null | undefined>>;
+        description: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+    }, z.core.$strip>, z.ZodTransform<{
+        url: string;
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+        description: string | null;
+        orderKey?: string | null | undefined;
+    }, {
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+        description: string | null;
+        orderKey?: string | null | undefined;
+    }>>;
+    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 SectionDeletedPayload = z.infer<typeof SectionDeletedPayloadSchema>;
+export declare const SectionArchivedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"section:archived">;
+    eventData: z.ZodPipe<z.ZodObject<{
+        id: z.ZodString;
+        userId: z.ZodString;
+        projectId: z.ZodString;
+        addedAt: z.ZodCoercedDate<unknown>;
+        archivedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+        name: z.ZodString;
+        sectionOrder: z.ZodNumber;
+        orderKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        isArchived: z.ZodBoolean;
+        isDeleted: z.ZodBoolean;
+        isCollapsed: z.ZodBoolean;
+        updatedAt: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>, z.ZodTransform<Date | null, Date | null | undefined>>;
+        description: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+    }, z.core.$strip>, z.ZodTransform<{
+        url: string;
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+        description: string | null;
+        orderKey?: string | null | undefined;
+    }, {
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+        description: string | null;
+        orderKey?: string | null | undefined;
+    }>>;
+    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 SectionArchivedPayload = z.infer<typeof SectionArchivedPayloadSchema>;
+export declare const SectionUnarchivedPayloadSchema: z.ZodObject<{
+    eventName: z.ZodLiteral<"section:unarchived">;
+    eventData: z.ZodPipe<z.ZodObject<{
+        id: z.ZodString;
+        userId: z.ZodString;
+        projectId: z.ZodString;
+        addedAt: z.ZodCoercedDate<unknown>;
+        archivedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+        name: z.ZodString;
+        sectionOrder: z.ZodNumber;
+        orderKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        isArchived: z.ZodBoolean;
+        isDeleted: z.ZodBoolean;
+        isCollapsed: z.ZodBoolean;
+        updatedAt: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>, z.ZodTransform<Date | null, Date | null | undefined>>;
+        description: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+    }, z.core.$strip>, z.ZodTransform<{
+        url: string;
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+        description: string | null;
+        orderKey?: string | null | undefined;
+    }, {
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+        description: string | null;
+        orderKey?: string | null | undefined;
+    }>>;
+    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 SectionUnarchivedPayload = z.infer<typeof SectionUnarchivedPayloadSchema>;