@automate.ax/integration-contracts 0.147.1 → 0.148.0

package/dist/kit/events.d.ts

@@ -0,0 +1,437 @@
+import { type Encodable } from "@automate.ax/codec";
+import * as z from "zod";
+/** Kit webhook event types currently available for endpoint subscriptions. */
+export declare const KIT_WEBHOOK_EVENT_TYPES: readonly ["subscriber.created", "subscriber.activated", "subscriber.unsubscribed", "subscriber.bounced", "subscriber.complained", "subscriber.subscribed_to_form", "subscriber.added_to_sequence", "subscriber.sequence_completed", "subscriber.tag_added", "subscriber.tag_removed", "subscriber.custom_field_value_updated", "tag.created", "tag.deleted", "custom_field.created", "custom_field.deleted", "sequence.created", "sequence.deleted", "sequence.published", "sequence.disabled", "broadcast.created", "broadcast.sent", "broadcast.deleted", "post.published"];
+export type KitWebhookEventType = (typeof KIT_WEBHOOK_EVENT_TYPES)[number];
+declare const KIT_EVENT_DATA_SCHEMAS: {
+    readonly "broadcast.created": z.ZodObject<{
+        broadcast: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            description: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            previewText: z.ZodNullable<z.ZodString>;
+            public: z.ZodBoolean;
+            publicationId: z.ZodNumber;
+            publishedAt: z.ZodNullable<z.ZodISODateTime>;
+            sendAt: z.ZodNullable<z.ZodISODateTime>;
+            status: z.ZodString;
+            subject: z.ZodString;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$loose>;
+    readonly "broadcast.deleted": z.ZodObject<{
+        broadcast: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            description: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            previewText: z.ZodNullable<z.ZodString>;
+            public: z.ZodBoolean;
+            publicationId: z.ZodNumber;
+            publishedAt: z.ZodNullable<z.ZodISODateTime>;
+            sendAt: z.ZodNullable<z.ZodISODateTime>;
+            status: z.ZodString;
+            subject: z.ZodString;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$loose>;
+    readonly "broadcast.sent": z.ZodObject<{
+        broadcast: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            description: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            previewText: z.ZodNullable<z.ZodString>;
+            public: z.ZodBoolean;
+            publicationId: z.ZodNumber;
+            publishedAt: z.ZodNullable<z.ZodISODateTime>;
+            sendAt: z.ZodNullable<z.ZodISODateTime>;
+            status: z.ZodString;
+            subject: z.ZodString;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$loose>;
+    readonly "custom_field.created": z.ZodObject<{
+        customField: z.ZodObject<{
+            id: z.ZodNumber;
+            key: z.ZodString;
+            label: z.ZodString;
+            name: z.ZodString;
+            value: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$loose>;
+    readonly "custom_field.deleted": z.ZodObject<{
+        customField: z.ZodObject<{
+            id: z.ZodNumber;
+            key: z.ZodString;
+            label: z.ZodString;
+            name: z.ZodString;
+            value: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$loose>;
+    readonly "post.published": z.ZodObject<{
+        post: z.ZodObject<{
+            id: z.ZodNumber;
+            isPaid: z.ZodBoolean;
+            publicUrl: z.ZodURL;
+            publicationId: z.ZodNumber;
+            publishedAt: z.ZodISODateTime;
+            slug: z.ZodString;
+            title: z.ZodString;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$loose>;
+    readonly "sequence.created": z.ZodObject<{
+        sequence: z.ZodObject<{
+            active: z.ZodBoolean;
+            createdAt: z.ZodISODateTime;
+            emailTemplateId: z.ZodNullable<z.ZodNumber>;
+            hold: z.ZodBoolean;
+            id: z.ZodNumber;
+            name: z.ZodString;
+            repeat: z.ZodBoolean;
+            updatedAt: z.ZodISODateTime;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$loose>;
+    readonly "sequence.deleted": z.ZodObject<{
+        sequence: z.ZodObject<{
+            active: z.ZodBoolean;
+            createdAt: z.ZodISODateTime;
+            emailTemplateId: z.ZodNullable<z.ZodNumber>;
+            hold: z.ZodBoolean;
+            id: z.ZodNumber;
+            name: z.ZodString;
+            repeat: z.ZodBoolean;
+            updatedAt: z.ZodISODateTime;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$loose>;
+    readonly "sequence.disabled": z.ZodObject<{
+        sequence: z.ZodObject<{
+            active: z.ZodBoolean;
+            createdAt: z.ZodISODateTime;
+            emailTemplateId: z.ZodNullable<z.ZodNumber>;
+            hold: z.ZodBoolean;
+            id: z.ZodNumber;
+            name: z.ZodString;
+            repeat: z.ZodBoolean;
+            updatedAt: z.ZodISODateTime;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$loose>;
+    readonly "sequence.published": z.ZodObject<{
+        sequence: z.ZodObject<{
+            active: z.ZodBoolean;
+            createdAt: z.ZodISODateTime;
+            emailTemplateId: z.ZodNullable<z.ZodNumber>;
+            hold: z.ZodBoolean;
+            id: z.ZodNumber;
+            name: z.ZodString;
+            repeat: z.ZodBoolean;
+            updatedAt: z.ZodISODateTime;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$loose>;
+    readonly "subscriber.activated": z.ZodObject<{
+        subscriber: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            emailAddress: z.ZodEmail;
+            fields: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
+            firstName: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            state: z.ZodEnum<{
+                cancelled: "cancelled";
+                active: "active";
+                inactive: "inactive";
+                bounced: "bounced";
+                complained: "complained";
+            }>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    readonly "subscriber.added_to_sequence": z.ZodObject<{
+        subscriber: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            emailAddress: z.ZodEmail;
+            fields: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
+            firstName: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            state: z.ZodEnum<{
+                cancelled: "cancelled";
+                active: "active";
+                inactive: "inactive";
+                bounced: "bounced";
+                complained: "complained";
+            }>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+        sequence: z.ZodObject<{
+            active: z.ZodBoolean;
+            createdAt: z.ZodISODateTime;
+            emailTemplateId: z.ZodNullable<z.ZodNumber>;
+            hold: z.ZodBoolean;
+            id: z.ZodNumber;
+            name: z.ZodString;
+            repeat: z.ZodBoolean;
+            updatedAt: z.ZodISODateTime;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    readonly "subscriber.bounced": z.ZodObject<{
+        subscriber: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            emailAddress: z.ZodEmail;
+            fields: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
+            firstName: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            state: z.ZodEnum<{
+                cancelled: "cancelled";
+                active: "active";
+                inactive: "inactive";
+                bounced: "bounced";
+                complained: "complained";
+            }>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    readonly "subscriber.complained": z.ZodObject<{
+        subscriber: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            emailAddress: z.ZodEmail;
+            fields: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
+            firstName: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            state: z.ZodEnum<{
+                cancelled: "cancelled";
+                active: "active";
+                inactive: "inactive";
+                bounced: "bounced";
+                complained: "complained";
+            }>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    readonly "subscriber.created": z.ZodObject<{
+        subscriber: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            emailAddress: z.ZodEmail;
+            fields: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
+            firstName: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            state: z.ZodEnum<{
+                cancelled: "cancelled";
+                active: "active";
+                inactive: "inactive";
+                bounced: "bounced";
+                complained: "complained";
+            }>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    readonly "subscriber.custom_field_value_updated": z.ZodObject<{
+        subscriber: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            emailAddress: z.ZodEmail;
+            fields: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
+            firstName: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            state: z.ZodEnum<{
+                cancelled: "cancelled";
+                active: "active";
+                inactive: "inactive";
+                bounced: "bounced";
+                complained: "complained";
+            }>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+        customField: z.ZodObject<{
+            id: z.ZodNumber;
+            key: z.ZodString;
+            label: z.ZodString;
+            name: z.ZodString;
+            value: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    readonly "subscriber.sequence_completed": z.ZodObject<{
+        subscriber: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            emailAddress: z.ZodEmail;
+            fields: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
+            firstName: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            state: z.ZodEnum<{
+                cancelled: "cancelled";
+                active: "active";
+                inactive: "inactive";
+                bounced: "bounced";
+                complained: "complained";
+            }>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+        sequence: z.ZodObject<{
+            active: z.ZodBoolean;
+            createdAt: z.ZodISODateTime;
+            emailTemplateId: z.ZodNullable<z.ZodNumber>;
+            hold: z.ZodBoolean;
+            id: z.ZodNumber;
+            name: z.ZodString;
+            repeat: z.ZodBoolean;
+            updatedAt: z.ZodISODateTime;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    readonly "subscriber.subscribed_to_form": z.ZodObject<{
+        subscriber: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            emailAddress: z.ZodEmail;
+            fields: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
+            firstName: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            state: z.ZodEnum<{
+                cancelled: "cancelled";
+                active: "active";
+                inactive: "inactive";
+                bounced: "bounced";
+                complained: "complained";
+            }>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+        form: z.ZodObject<{
+            archived: z.ZodBoolean;
+            createdAt: z.ZodISODateTime;
+            format: z.ZodString;
+            id: z.ZodNumber;
+            name: z.ZodString;
+            type: z.ZodEnum<{
+                embed: "embed";
+                hosted: "hosted";
+            }>;
+            uid: z.ZodString;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    readonly "subscriber.tag_added": z.ZodObject<{
+        subscriber: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            emailAddress: z.ZodEmail;
+            fields: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
+            firstName: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            state: z.ZodEnum<{
+                cancelled: "cancelled";
+                active: "active";
+                inactive: "inactive";
+                bounced: "bounced";
+                complained: "complained";
+            }>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+        tag: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            id: z.ZodNumber;
+            name: z.ZodString;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    readonly "subscriber.tag_removed": z.ZodObject<{
+        subscriber: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            emailAddress: z.ZodEmail;
+            fields: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
+            firstName: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            state: z.ZodEnum<{
+                cancelled: "cancelled";
+                active: "active";
+                inactive: "inactive";
+                bounced: "bounced";
+                complained: "complained";
+            }>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+        tag: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            id: z.ZodNumber;
+            name: z.ZodString;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    readonly "subscriber.unsubscribed": z.ZodObject<{
+        subscriber: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            emailAddress: z.ZodEmail;
+            fields: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
+            firstName: z.ZodNullable<z.ZodString>;
+            id: z.ZodNumber;
+            state: z.ZodEnum<{
+                cancelled: "cancelled";
+                active: "active";
+                inactive: "inactive";
+                bounced: "bounced";
+                complained: "complained";
+            }>;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    readonly "tag.created": z.ZodObject<{
+        tag: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            id: z.ZodNumber;
+            name: z.ZodString;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$loose>;
+    readonly "tag.deleted": z.ZodObject<{
+        tag: z.ZodObject<{
+            createdAt: z.ZodISODateTime;
+            id: z.ZodNumber;
+            name: z.ZodString;
+        }, z.core.$catchall<z.ZodOptional<z.ZodCustom<Encodable, Encodable>>>>;
+    }, z.core.$loose>;
+};
+/** One normalized Kit webhook event narrowed by provider type. */
+export type KitEvent<TType extends KitWebhookEventType = KitWebhookEventType> = TType extends KitWebhookEventType ? {
+    readonly [key: string]: Encodable;
+    created: string;
+    data: z.output<(typeof KIT_EVENT_DATA_SCHEMAS)[TType]> & {
+        readonly [key: string]: Encodable;
+    };
+    id: string;
+    type: TType;
+} : never;
+/** One parsed Kit webhook delivery containing one to 100 same-type events. */
+export interface KitWebhookEnvelope {
+    readonly [key: string]: Encodable;
+    deliveryId: number;
+    events: KitEvent[];
+}
+export declare const KIT_TRIGGER_CONFIG_SCHEMA: z.ZodObject<{}, z.core.$strip>;
+/** Validates any currently available normalized Kit event. */
+export declare const KIT_EVENT_SCHEMA: z.ZodType<KitEvent>;
+/** Parses and normalizes Kit's provider-native delivery envelope. */
+export declare const KIT_WEBHOOK_ENVELOPE_SCHEMA: z.ZodType<KitWebhookEnvelope>;
+/** Platform event type emitted for each exact Kit provider event. */
+export declare const KIT_EVENT_TYPE_MAP: {
+    readonly "broadcast.created": "kit.broadcast.created";
+    readonly "broadcast.deleted": "kit.broadcast.deleted";
+    readonly "broadcast.sent": "kit.broadcast.sent";
+    readonly "custom_field.created": "kit.customField.created";
+    readonly "custom_field.deleted": "kit.customField.deleted";
+    readonly "post.published": "kit.post.published";
+    readonly "sequence.created": "kit.sequence.created";
+    readonly "sequence.deleted": "kit.sequence.deleted";
+    readonly "sequence.disabled": "kit.sequence.disabled";
+    readonly "sequence.published": "kit.sequence.published";
+    readonly "subscriber.activated": "kit.subscriber.activated";
+    readonly "subscriber.added_to_sequence": "kit.subscriber.addedToSequence";
+    readonly "subscriber.bounced": "kit.subscriber.bounced";
+    readonly "subscriber.complained": "kit.subscriber.complained";
+    readonly "subscriber.created": "kit.subscriber.created";
+    readonly "subscriber.custom_field_value_updated": "kit.subscriber.customFieldValueUpdated";
+    readonly "subscriber.sequence_completed": "kit.subscriber.sequenceCompleted";
+    readonly "subscriber.subscribed_to_form": "kit.subscriber.subscribedToForm";
+    readonly "subscriber.tag_added": "kit.subscriber.tagAdded";
+    readonly "subscriber.tag_removed": "kit.subscriber.tagRemoved";
+    readonly "subscriber.unsubscribed": "kit.subscriber.unsubscribed";
+    readonly "tag.created": "kit.tag.created";
+    readonly "tag.deleted": "kit.tag.deleted";
+};
+type KitTriggerContract<TEvent> = {
+    readonly configSchema: typeof KIT_TRIGGER_CONFIG_SCHEMA;
+    readonly eventSchema: z.ZodType<TEvent>;
+};
+/** Semantic contracts keyed by every public Kit platform event type. */
+type KitSemanticContracts = {
+    readonly [TType in KitWebhookEventType as (typeof KIT_EVENT_TYPE_MAP)[TType]]: KitTriggerContract<KitEvent<TType>>;
+} & {
+    readonly "kit.event": KitTriggerContract<KitEvent>;
+};
+/** Exact provider-to-platform Kit trigger contract map. */
+export declare const kitTriggerContracts: KitSemanticContracts;
+/**
+ * Builds a schema narrowed to one exact Kit webhook event.
+ *
+ * @param type Provider event type.
+ */
+export declare function kitSemanticEventSchema<TType extends KitWebhookEventType>(type: TType): z.ZodType<KitEvent<TType>>;
+/**
+ * Returns the broad and exact platform types for one Kit event.
+ *
+ * @param type Provider event type.
+ */
+export declare function getKitEventTypes(type: KitWebhookEventType): readonly ["kit.event", "kit.broadcast.created" | "kit.broadcast.deleted" | "kit.broadcast.sent" | "kit.customField.created" | "kit.customField.deleted" | "kit.post.published" | "kit.sequence.created" | "kit.sequence.deleted" | "kit.sequence.disabled" | "kit.sequence.published" | "kit.subscriber.activated" | "kit.subscriber.addedToSequence" | "kit.subscriber.bounced" | "kit.subscriber.complained" | "kit.subscriber.created" | "kit.subscriber.customFieldValueUpdated" | "kit.subscriber.sequenceCompleted" | "kit.subscriber.subscribedToForm" | "kit.subscriber.tagAdded" | "kit.subscriber.tagRemoved" | "kit.subscriber.unsubscribed" | "kit.tag.created" | "kit.tag.deleted"];
+export {};