@doist/todoist-sdk 9.4.0 → 9.6.0

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

@@ -0,0 +1,335 @@
+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. 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;
+    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>>;
+}, 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;
+}, {
+    id: string;
+    userId: string;
+    projectId: string;
+    addedAt: Date;
+    archivedAt: Date | null;
+    name: string;
+    sectionOrder: number;
+    isArchived: boolean;
+    isDeleted: boolean;
+    isCollapsed: boolean;
+    updatedAt: Date | null;
+}>>;
+/** 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;
+        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>>;
+    }, 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;
+    }, {
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+    }>>;
+    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;
+        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>>;
+    }, 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;
+    }, {
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+    }>>;
+    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;
+        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>>;
+    }, 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;
+    }, {
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+    }>>;
+    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;
+        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>>;
+    }, 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;
+    }, {
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+    }>>;
+    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;
+        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>>;
+    }, 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;
+    }, {
+        id: string;
+        userId: string;
+        projectId: string;
+        addedAt: Date;
+        archivedAt: Date | null;
+        name: string;
+        sectionOrder: number;
+        isArchived: boolean;
+        isDeleted: boolean;
+        isCollapsed: boolean;
+        updatedAt: Date | null;
+    }>>;
+    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>;