@workwae/sdk 0.1.0-alpha.1 → 0.1.0-alpha.3

package/contract/events/models.d.ts

@@ -17,7 +17,6 @@ export declare const AccountConnectedData: z.ZodObject<{
     reauthorized: z.ZodBoolean;
 }, z.core.$strip>;
 export type AccountConnectedData = z.infer<typeof AccountConnectedData>;
-/** imap and dav: the account's IMAP or DAV connection settings; credentials: its password. */
 export declare const AccountUpdatedField: z.ZodEnum<{
     imap: "imap";
     dav: "dav";
@@ -79,13 +78,13 @@ export declare const MailboxData: z.ZodObject<{
         parentId: z.ZodNullable<z.ZodUUID>;
         role: z.ZodEnum<{
             custom: "custom";
+            all: "all";
             inbox: "inbox";
             sent: "sent";
             drafts: "drafts";
             trash: "trash";
             junk: "junk";
             archive: "archive";
-            all: "all";
             important: "important";
         }>;
         kind: z.ZodEnum<{
@@ -105,13 +104,13 @@ export declare const MailboxUpdatedData: z.ZodObject<{
         parentId: z.ZodNullable<z.ZodUUID>;
         role: z.ZodEnum<{
             custom: "custom";
+            all: "all";
             inbox: "inbox";
             sent: "sent";
             drafts: "drafts";
             trash: "trash";
             junk: "junk";
             archive: "archive";
-            all: "all";
             important: "important";
         }>;
         kind: z.ZodEnum<{
@@ -130,19 +129,18 @@ export declare const MailboxUpdatedData: z.ZodObject<{
     }>>;
 }, z.core.$strip>;
 export type MailboxUpdatedData = z.infer<typeof MailboxUpdatedData>;
-/** A mailbox a message is in, as events name it: roles tell inbound mail from sent and drafts. */
 export declare const MailboxRef: z.ZodObject<{
     id: z.ZodUUID;
     name: z.ZodString;
     role: z.ZodEnum<{
         custom: "custom";
+        all: "all";
         inbox: "inbox";
         sent: "sent";
         drafts: "drafts";
         trash: "trash";
         junk: "junk";
         archive: "archive";
-        all: "all";
         important: "important";
     }>;
 }, z.core.$strip>;
@@ -191,13 +189,13 @@ export declare const MessageData: z.ZodObject<{
         name: z.ZodString;
         role: z.ZodEnum<{
             custom: "custom";
+            all: "all";
             inbox: "inbox";
             sent: "sent";
             drafts: "drafts";
             trash: "trash";
             junk: "junk";
             archive: "archive";
-            all: "all";
             important: "important";
         }>;
     }, z.core.$strip>>;
@@ -247,13 +245,13 @@ export declare const MessageUpdatedData: z.ZodObject<{
         name: z.ZodString;
         role: z.ZodEnum<{
             custom: "custom";
+            all: "all";
             inbox: "inbox";
             sent: "sent";
             drafts: "drafts";
             trash: "trash";
             junk: "junk";
             archive: "archive";
-            all: "all";
             important: "important";
         }>;
     }, z.core.$strip>>;
@@ -325,13 +323,13 @@ export declare const MessageDeletedData: z.ZodObject<{
         name: z.ZodString;
         role: z.ZodEnum<{
             custom: "custom";
+            all: "all";
             inbox: "inbox";
             sent: "sent";
             drafts: "drafts";
             trash: "trash";
             junk: "junk";
             archive: "archive";
-            all: "all";
             important: "important";
         }>;
     }, z.core.$strip>>;
@@ -383,13 +381,13 @@ export declare const MessageClassifiedData: z.ZodObject<{
         name: z.ZodString;
         role: z.ZodEnum<{
             custom: "custom";
+            all: "all";
             inbox: "inbox";
             sent: "sent";
             drafts: "drafts";
             trash: "trash";
             junk: "junk";
             archive: "archive";
-            all: "all";
             important: "important";
         }>;
     }, z.core.$strip>>;
@@ -523,11 +521,22 @@ export declare const SendError: z.ZodObject<{
     message: z.ZodString;
 }, z.core.$strip>;
 export type SendError = z.infer<typeof SendError>;
+export declare const RejectedRecipient: z.ZodObject<{
+    address: z.ZodString;
+    status: z.ZodNullable<z.ZodString>;
+    diagnostic: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type RejectedRecipient = z.infer<typeof RejectedRecipient>;
 export declare const SendSentData: z.ZodObject<{
     attempt: z.ZodNumber;
     providerMessageId: z.ZodNullable<z.ZodString>;
     internetMessageId: z.ZodNullable<z.ZodString>;
     sentAt: z.ZodPreprocess<z.ZodDate, Date>;
+    rejectedRecipients: z.ZodArray<z.ZodObject<{
+        address: z.ZodString;
+        status: z.ZodNullable<z.ZodString>;
+        diagnostic: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
     outboxId: z.ZodUUID;
     reference: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
@@ -560,11 +569,18 @@ export declare const SendRescheduledData: z.ZodObject<{
     reference: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
 export type SendRescheduledData = z.infer<typeof SendRescheduledData>;
+export declare const SendCancelledData: z.ZodObject<{
+    mailMergeId: z.ZodNullable<z.ZodUUID>;
+    outboxId: z.ZodUUID;
+    reference: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type SendCancelledData = z.infer<typeof SendCancelledData>;
 export declare const SuppressionCreatedData: z.ZodObject<{
     listId: z.ZodString;
     address: z.ZodString;
     source: z.ZodEnum<{
         api: "api";
+        invalid: "invalid";
         bounce: "bounce";
         unsubscribe: "unsubscribe";
         reply: "reply";
@@ -984,12 +1000,16 @@ export declare const MeetingConnectionReauthRequiredData: z.ZodObject<{
     reason: z.ZodString;
 }, z.core.$strip>;
 export type MeetingConnectionReauthRequiredData = z.infer<typeof MeetingConnectionReauthRequiredData>;
-/**
- * Which accounts an event's envelope names. account: always the account it concerns; tenant:
- * never (accountId is null); either: an account, or null for the whole tenant.
- */
+export declare const BookingEventData: z.ZodObject<{
+    bookingId: z.ZodUUID;
+    linkId: z.ZodUUID;
+    eventId: z.ZodNullable<z.ZodUUID>;
+    start: z.ZodPreprocess<z.ZodDate, Date>;
+    end: z.ZodPreprocess<z.ZodDate, Date>;
+    invitee: z.ZodString;
+}, z.core.$strip>;
+export type BookingEventData = z.infer<typeof BookingEventData>;
 export type EventScope = "account" | "tenant" | "either";
-/** Every event type: its scope, its `data` and what it announces. */
 export declare const EVENTS: {
     "account.connected": {
         scope: "account";
@@ -1080,13 +1100,13 @@ export declare const EVENTS: {
                 parentId: z.ZodNullable<z.ZodUUID>;
                 role: z.ZodEnum<{
                     custom: "custom";
+                    all: "all";
                     inbox: "inbox";
                     sent: "sent";
                     drafts: "drafts";
                     trash: "trash";
                     junk: "junk";
                     archive: "archive";
-                    all: "all";
                     important: "important";
                 }>;
                 kind: z.ZodEnum<{
@@ -1109,13 +1129,13 @@ export declare const EVENTS: {
                 parentId: z.ZodNullable<z.ZodUUID>;
                 role: z.ZodEnum<{
                     custom: "custom";
+                    all: "all";
                     inbox: "inbox";
                     sent: "sent";
                     drafts: "drafts";
                     trash: "trash";
                     junk: "junk";
                     archive: "archive";
-                    all: "all";
                     important: "important";
                 }>;
                 kind: z.ZodEnum<{
@@ -1145,13 +1165,13 @@ export declare const EVENTS: {
                 parentId: z.ZodNullable<z.ZodUUID>;
                 role: z.ZodEnum<{
                     custom: "custom";
+                    all: "all";
                     inbox: "inbox";
                     sent: "sent";
                     drafts: "drafts";
                     trash: "trash";
                     junk: "junk";
                     archive: "archive";
-                    all: "all";
                     important: "important";
                 }>;
                 kind: z.ZodEnum<{
@@ -1210,13 +1230,13 @@ export declare const EVENTS: {
                 name: z.ZodString;
                 role: z.ZodEnum<{
                     custom: "custom";
+                    all: "all";
                     inbox: "inbox";
                     sent: "sent";
                     drafts: "drafts";
                     trash: "trash";
                     junk: "junk";
                     archive: "archive";
-                    all: "all";
                     important: "important";
                 }>;
             }, z.core.$strip>>;
@@ -1269,13 +1289,13 @@ export declare const EVENTS: {
                 name: z.ZodString;
                 role: z.ZodEnum<{
                     custom: "custom";
+                    all: "all";
                     inbox: "inbox";
                     sent: "sent";
                     drafts: "drafts";
                     trash: "trash";
                     junk: "junk";
                     archive: "archive";
-                    all: "all";
                     important: "important";
                 }>;
             }, z.core.$strip>>;
@@ -1350,13 +1370,13 @@ export declare const EVENTS: {
                 name: z.ZodString;
                 role: z.ZodEnum<{
                     custom: "custom";
+                    all: "all";
                     inbox: "inbox";
                     sent: "sent";
                     drafts: "drafts";
                     trash: "trash";
                     junk: "junk";
                     archive: "archive";
-                    all: "all";
                     important: "important";
                 }>;
             }, z.core.$strip>>;
@@ -1426,13 +1446,13 @@ export declare const EVENTS: {
                 name: z.ZodString;
                 role: z.ZodEnum<{
                     custom: "custom";
+                    all: "all";
                     inbox: "inbox";
                     sent: "sent";
                     drafts: "drafts";
                     trash: "trash";
                     junk: "junk";
                     archive: "archive";
-                    all: "all";
                     important: "important";
                 }>;
             }, z.core.$strip>>;
@@ -1639,6 +1659,11 @@ export declare const EVENTS: {
             providerMessageId: z.ZodNullable<z.ZodString>;
             internetMessageId: z.ZodNullable<z.ZodString>;
             sentAt: z.ZodPreprocess<z.ZodDate, Date>;
+            rejectedRecipients: z.ZodArray<z.ZodObject<{
+                address: z.ZodString;
+                status: z.ZodNullable<z.ZodString>;
+                diagnostic: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>>;
             outboxId: z.ZodUUID;
             reference: z.ZodNullable<z.ZodString>;
         }, z.core.$strip>;
@@ -1681,6 +1706,15 @@ export declare const EVENTS: {
         }, z.core.$strip>;
         description: string;
     };
+    "send.cancelled": {
+        scope: "account";
+        data: z.ZodObject<{
+            mailMergeId: z.ZodNullable<z.ZodUUID>;
+            outboxId: z.ZodUUID;
+            reference: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>;
+        description: string;
+    };
     "suppression.created": {
         scope: "account";
         data: z.ZodObject<{
@@ -1688,6 +1722,7 @@ export declare const EVENTS: {
             address: z.ZodString;
             source: z.ZodEnum<{
                 api: "api";
+                invalid: "invalid";
                 bounce: "bounce";
                 unsubscribe: "unsubscribe";
                 reply: "reply";
@@ -2172,6 +2207,30 @@ export declare const EVENTS: {
         }, z.core.$strip>;
         description: string;
     };
+    "booking.created": {
+        scope: "account";
+        data: z.ZodObject<{
+            bookingId: z.ZodUUID;
+            linkId: z.ZodUUID;
+            eventId: z.ZodNullable<z.ZodUUID>;
+            start: z.ZodPreprocess<z.ZodDate, Date>;
+            end: z.ZodPreprocess<z.ZodDate, Date>;
+            invitee: z.ZodString;
+        }, z.core.$strip>;
+        description: string;
+    };
+    "booking.cancelled": {
+        scope: "account";
+        data: z.ZodObject<{
+            bookingId: z.ZodUUID;
+            linkId: z.ZodUUID;
+            eventId: z.ZodNullable<z.ZodUUID>;
+            start: z.ZodPreprocess<z.ZodDate, Date>;
+            end: z.ZodPreprocess<z.ZodDate, Date>;
+            invitee: z.ZodString;
+        }, z.core.$strip>;
+        description: string;
+    };
     "webhook.test": {
         scope: "tenant";
         data: z.ZodObject<{
@@ -2182,7 +2241,6 @@ export declare const EVENTS: {
 };
 export type EventType = keyof typeof EVENTS;
 type EventDefinition<T extends EventType> = (typeof EVENTS)[T];
-/** Every event type, in the registry's order. */
 export declare const EVENT_TYPES: EventType[];
 export declare const EventType: z.ZodEnum<{
     "account.connected": "account.connected";
@@ -2205,6 +2263,7 @@ export declare const EventType: z.ZodEnum<{
     "send.retrying": "send.retrying";
     "send.failed": "send.failed";
     "send.rescheduled": "send.rescheduled";
+    "send.cancelled": "send.cancelled";
     "suppression.created": "suppression.created";
     "calendar.initialized": "calendar.initialized";
     "calendar.created": "calendar.created";
@@ -2221,34 +2280,29 @@ export declare const EventType: z.ZodEnum<{
     "export.failed": "export.failed";
     "meeting_connection.connected": "meeting_connection.connected";
     "meeting_connection.reauth_required": "meeting_connection.reauth_required";
+    "booking.created": "booking.created";
+    "booking.cancelled": "booking.cancelled";
     "webhook.test": "webhook.test";
 }>;
-/** The type the test action sends when it is given none. */
 export declare const TEST_EVENT_TYPE = "webhook.test";
-/** The `data` of an event of type T. */
 export type EventData<T extends EventType = EventType> = {
     [K in T]: z.infer<EventDefinition<K>["data"]>;
 }[T];
-/** What an emitter passes as the `data` of an event of type T. */
 export type EventDataInput<T extends EventType = EventType> = {
     [K in T]: z.input<EventDefinition<K>["data"]>;
 }[T];
-/** The envelope accountId of an event of type T. */
 export type EventAccountId<T extends EventType> = {
     account: string;
     tenant: null;
     either: string | null;
 }[EventDefinition<T>["scope"]];
-/** Whether `type` is announced without an account (the envelope's accountId is always null). */
 export declare function isAccountlessEventType(type: EventType): boolean;
-/** `data` checked against the schema of `type`; throws a ZodError when it does not match. */
 export declare function parseEventData<T extends EventType>(type: T, data: unknown): EventData<T>;
 declare const ENVELOPE_ACCOUNT_ID: {
     readonly account: z.ZodUUID;
     readonly tenant: z.ZodNull;
     readonly either: z.ZodNullable<z.ZodUUID>;
 };
-/** The envelope schema of events of type T. */
 export type EventEnvelope<T extends EventType> = z.ZodObject<{
     id: typeof EventId;
     type: z.ZodLiteral<T>;
@@ -2260,58 +2314,62 @@ export type EventEnvelope<T extends EventType> = z.ZodObject<{
 type EventVariant = {
     [T in EventType]: EventEnvelope<T>;
 }[EventType];
-/**
- * One event: an item of the change feed, and the JSON body POSTed to webhook endpoints. `type`
- * says what `data` holds.
- */
-export declare const Event: z.ZodDiscriminatedUnion<[EventVariant, ...EventVariant[]], "type">;
+export declare const Event: z.ZodDiscriminatedUnion<[
+    EventVariant,
+    ...EventVariant[]
+], "type">;
 export type Event = z.infer<typeof Event>;
-/** An event of one type. */
 export type EventOf<T extends EventType> = Extract<Event, {
     type: T;
 }>;
 export declare const ListChangesQuery: z.ZodObject<{
     cursor: z.ZodOptional<z.ZodString>;
     limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
-    types: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodEnum<{
-        "account.connected": "account.connected";
-        "account.updated": "account.updated";
-        "account.deleted": "account.deleted";
-        "account.reauth_required": "account.reauth_required";
-        "account.initialized": "account.initialized";
-        "account.purged": "account.purged";
-        "mailbox.created": "mailbox.created";
-        "mailbox.updated": "mailbox.updated";
-        "mailbox.deleted": "mailbox.deleted";
-        "message.created": "message.created";
-        "message.updated": "message.updated";
-        "message.deleted": "message.deleted";
-        "message.bounced": "message.bounced";
-        "message.classified": "message.classified";
-        "message.opened": "message.opened";
-        "message.clicked": "message.clicked";
-        "send.sent": "send.sent";
-        "send.retrying": "send.retrying";
-        "send.failed": "send.failed";
-        "send.rescheduled": "send.rescheduled";
-        "suppression.created": "suppression.created";
-        "calendar.initialized": "calendar.initialized";
-        "calendar.created": "calendar.created";
-        "calendar.updated": "calendar.updated";
-        "calendar.deleted": "calendar.deleted";
-        "calendar_event.created": "calendar_event.created";
-        "calendar_event.updated": "calendar_event.updated";
-        "calendar_event.deleted": "calendar_event.deleted";
-        "contacts.initialized": "contacts.initialized";
-        "contact.created": "contact.created";
-        "contact.updated": "contact.updated";
-        "contact.deleted": "contact.deleted";
-        "export.completed": "export.completed";
-        "export.failed": "export.failed";
-        "meeting_connection.connected": "meeting_connection.connected";
-        "meeting_connection.reauth_required": "meeting_connection.reauth_required";
-        "webhook.test": "webhook.test";
-    }>>]>, z.ZodTransform<string[], string | ("account.connected" | "account.updated" | "account.deleted" | "account.reauth_required" | "account.initialized" | "account.purged" | "mailbox.created" | "mailbox.updated" | "mailbox.deleted" | "message.created" | "message.updated" | "message.deleted" | "message.bounced" | "message.classified" | "message.opened" | "message.clicked" | "send.sent" | "send.retrying" | "send.failed" | "send.rescheduled" | "suppression.created" | "calendar.initialized" | "calendar.created" | "calendar.updated" | "calendar.deleted" | "calendar_event.created" | "calendar_event.updated" | "calendar_event.deleted" | "contacts.initialized" | "contact.created" | "contact.updated" | "contact.deleted" | "export.completed" | "export.failed" | "meeting_connection.connected" | "meeting_connection.reauth_required" | "webhook.test")[]>>, z.ZodArray<z.ZodEnum<{
+    types: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [
+        z.ZodString,
+        z.ZodArray<z.ZodEnum<{
+            "account.connected": "account.connected";
+            "account.updated": "account.updated";
+            "account.deleted": "account.deleted";
+            "account.reauth_required": "account.reauth_required";
+            "account.initialized": "account.initialized";
+            "account.purged": "account.purged";
+            "mailbox.created": "mailbox.created";
+            "mailbox.updated": "mailbox.updated";
+            "mailbox.deleted": "mailbox.deleted";
+            "message.created": "message.created";
+            "message.updated": "message.updated";
+            "message.deleted": "message.deleted";
+            "message.bounced": "message.bounced";
+            "message.classified": "message.classified";
+            "message.opened": "message.opened";
+            "message.clicked": "message.clicked";
+            "send.sent": "send.sent";
+            "send.retrying": "send.retrying";
+            "send.failed": "send.failed";
+            "send.rescheduled": "send.rescheduled";
+            "send.cancelled": "send.cancelled";
+            "suppression.created": "suppression.created";
+            "calendar.initialized": "calendar.initialized";
+            "calendar.created": "calendar.created";
+            "calendar.updated": "calendar.updated";
+            "calendar.deleted": "calendar.deleted";
+            "calendar_event.created": "calendar_event.created";
+            "calendar_event.updated": "calendar_event.updated";
+            "calendar_event.deleted": "calendar_event.deleted";
+            "contacts.initialized": "contacts.initialized";
+            "contact.created": "contact.created";
+            "contact.updated": "contact.updated";
+            "contact.deleted": "contact.deleted";
+            "export.completed": "export.completed";
+            "export.failed": "export.failed";
+            "meeting_connection.connected": "meeting_connection.connected";
+            "meeting_connection.reauth_required": "meeting_connection.reauth_required";
+            "booking.created": "booking.created";
+            "booking.cancelled": "booking.cancelled";
+            "webhook.test": "webhook.test";
+        }>>
+    ]>, z.ZodTransform<string[], string | ("account.connected" | "account.updated" | "account.deleted" | "account.reauth_required" | "account.initialized" | "account.purged" | "mailbox.created" | "mailbox.updated" | "mailbox.deleted" | "message.created" | "message.updated" | "message.deleted" | "message.bounced" | "message.classified" | "message.opened" | "message.clicked" | "send.sent" | "send.retrying" | "send.failed" | "send.rescheduled" | "send.cancelled" | "suppression.created" | "calendar.initialized" | "calendar.created" | "calendar.updated" | "calendar.deleted" | "calendar_event.created" | "calendar_event.updated" | "calendar_event.deleted" | "contacts.initialized" | "contact.created" | "contact.updated" | "contact.deleted" | "export.completed" | "export.failed" | "meeting_connection.connected" | "meeting_connection.reauth_required" | "booking.created" | "booking.cancelled" | "webhook.test")[]>>, z.ZodArray<z.ZodEnum<{
         "account.connected": "account.connected";
         "account.updated": "account.updated";
         "account.deleted": "account.deleted";
@@ -2332,6 +2390,7 @@ export declare const ListChangesQuery: z.ZodObject<{
         "send.retrying": "send.retrying";
         "send.failed": "send.failed";
         "send.rescheduled": "send.rescheduled";
+        "send.cancelled": "send.cancelled";
         "suppression.created": "suppression.created";
         "calendar.initialized": "calendar.initialized";
         "calendar.created": "calendar.created";
@@ -2348,16 +2407,17 @@ export declare const ListChangesQuery: z.ZodObject<{
         "export.failed": "export.failed";
         "meeting_connection.connected": "meeting_connection.connected";
         "meeting_connection.reauth_required": "meeting_connection.reauth_required";
+        "booking.created": "booking.created";
+        "booking.cancelled": "booking.cancelled";
         "webhook.test": "webhook.test";
     }>>>>;
 }, z.core.$strip>;
 export type ListChangesQuery = z.infer<typeof ListChangesQuery>;
-/**
- * A page of the change feed: pass nextCursor back to continue; an empty page means caught up. The
- * feed has no end, only a present, so nextCursor is never null: keep polling from it.
- */
 export declare const EventFeedPage: z.ZodObject<{
-    items: z.ZodArray<z.ZodDiscriminatedUnion<[EventVariant, ...EventVariant[]], "type">>;
+    items: z.ZodArray<z.ZodDiscriminatedUnion<[
+        EventVariant,
+        ...EventVariant[]
+    ], "type">>;
     nextCursor: z.ZodString;
 }, z.core.$strip>;
 export type EventFeedPage = z.infer<typeof EventFeedPage>;