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

package/contract/send/models.d.ts

@@ -45,7 +45,6 @@ export declare const Compose: z.ZodObject<{
     }>>;
 }, z.core.$strip>;
 export type Compose = z.infer<typeof Compose>;
-/** What composing with templates adds to a draft or a send. */
 export declare const ComposeWithTemplate: z.ZodObject<{
     to: z.ZodDefault<z.ZodArray<z.ZodObject<{
         name: z.ZodOptional<z.ZodString>;
@@ -129,9 +128,9 @@ export declare const OutboxEntry: z.ZodObject<{
     machineClickCount: z.ZodNumber;
     firstOpenedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
     lastOpenedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    mailMergeId: z.ZodNullable<z.ZodUUID>;
 }, z.core.$strip>;
 export type OutboxEntry = z.infer<typeof OutboxEntry>;
-/** What queueing a send answers: the entry, and until when cancelling it undoes the send. */
 export declare const QueuedSend: z.ZodObject<{
     id: z.ZodUUID;
     accountId: z.ZodUUID;
@@ -159,18 +158,16 @@ export declare const QueuedSend: z.ZodObject<{
     machineClickCount: z.ZodNumber;
     firstOpenedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
     lastOpenedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    mailMergeId: z.ZodNullable<z.ZodUUID>;
     undoUntil: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
 }, z.core.$strip>;
 export type QueuedSend = z.infer<typeof QueuedSend>;
-/** Per-send tracking; an omitted key follows the account's trackOpens / trackClicks /
- * trackingHoneypot. `honeypot` only comes with click tracking: true with clicks off is refused. */
 export declare const SendTracking: z.ZodObject<{
     opens: z.ZodOptional<z.ZodBoolean>;
     clicks: z.ZodOptional<z.ZodBoolean>;
     honeypot: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 export type SendTracking = z.infer<typeof SendTracking>;
-/** How and when a send or draft-send goes out. */
 export declare const SendOptions: z.ZodObject<{
     sendAt: z.ZodOptional<z.ZodPreprocess<z.ZodDate, string | Date>>;
     reference: z.ZodOptional<z.ZodString>;
@@ -181,8 +178,6 @@ export declare const SendOptions: z.ZodObject<{
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type SendOptions = z.infer<typeof SendOptions>;
-/** One recipient of a mail merge. Checked one by one, so a bad entry fails alone (see
- * MailMergeResult); `to.address` and `messageId` are therefore not refused by the schema. */
 export declare const MailMergeEntry: z.ZodObject<{
     to: z.ZodObject<{
         name: z.ZodOptional<z.ZodString>;
@@ -249,7 +244,6 @@ export declare const SendMessageRequest: z.ZodObject<{
     listId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type SendMessageRequest = z.infer<typeof SendMessageRequest>;
-/** The send body without to, cc, bcc and render: an unknown field is refused. */
 export declare const MailMergeRequest: z.ZodObject<{
     format: z.ZodOptional<z.ZodEnum<{
         markdown: "markdown";
@@ -323,30 +317,8 @@ export declare const MailMergeFailure: z.ZodObject<{
     status: z.ZodNumber;
 }, z.core.$strip>;
 export type MailMergeFailure = z.infer<typeof MailMergeFailure>;
-export declare const MailMergeResult: z.ZodDiscriminatedUnion<[z.ZodObject<{
-    success: z.ZodLiteral<true>;
-    to: z.ZodObject<{
-        name: z.ZodNullable<z.ZodString>;
-        address: z.ZodString;
-    }, z.core.$strip>;
-    outboxId: z.ZodUUID;
-    messageId: z.ZodString;
-    sendAt: z.ZodPreprocess<z.ZodDate, Date>;
-    undoUntil: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
-}, z.core.$strip>, z.ZodObject<{
-    success: z.ZodLiteral<false>;
-    to: z.ZodObject<{
-        name: z.ZodNullable<z.ZodString>;
-        address: z.ZodString;
-    }, z.core.$strip>;
-    reason: z.ZodString;
-    error: z.ZodString;
-    status: z.ZodNumber;
-}, z.core.$strip>], "success">;
-export type MailMergeResult = z.infer<typeof MailMergeResult>;
-/** What a mail merge answers: one result per entry, in the order given. */
-export declare const MailMergeResultList: z.ZodObject<{
-    items: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+export declare const MailMergeResult: z.ZodDiscriminatedUnion<[
+    z.ZodObject<{
         success: z.ZodLiteral<true>;
         to: z.ZodObject<{
             name: z.ZodNullable<z.ZodString>;
@@ -356,7 +328,8 @@ export declare const MailMergeResultList: z.ZodObject<{
         messageId: z.ZodString;
         sendAt: z.ZodPreprocess<z.ZodDate, Date>;
         undoUntil: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
-    }, z.core.$strip>, z.ZodObject<{
+    }, z.core.$strip>,
+    z.ZodObject<{
         success: z.ZodLiteral<false>;
         to: z.ZodObject<{
             name: z.ZodNullable<z.ZodString>;
@@ -365,9 +338,83 @@ export declare const MailMergeResultList: z.ZodObject<{
         reason: z.ZodString;
         error: z.ZodString;
         status: z.ZodNumber;
-    }, z.core.$strip>], "success">>;
+    }, z.core.$strip>
+], "success">;
+export type MailMergeResult = z.infer<typeof MailMergeResult>;
+export declare const MailMergeResultList: z.ZodObject<{
+    items: z.ZodArray<z.ZodDiscriminatedUnion<[
+        z.ZodObject<{
+            success: z.ZodLiteral<true>;
+            to: z.ZodObject<{
+                name: z.ZodNullable<z.ZodString>;
+                address: z.ZodString;
+            }, z.core.$strip>;
+            outboxId: z.ZodUUID;
+            messageId: z.ZodString;
+            sendAt: z.ZodPreprocess<z.ZodDate, Date>;
+            undoUntil: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+        }, z.core.$strip>,
+        z.ZodObject<{
+            success: z.ZodLiteral<false>;
+            to: z.ZodObject<{
+                name: z.ZodNullable<z.ZodString>;
+                address: z.ZodString;
+            }, z.core.$strip>;
+            reason: z.ZodString;
+            error: z.ZodString;
+            status: z.ZodNumber;
+        }, z.core.$strip>
+    ], "success">>;
+    id: z.ZodNullable<z.ZodUUID>;
 }, z.core.$strip>;
 export type MailMergeResultList = z.infer<typeof MailMergeResultList>;
+export declare const MailMerge: z.ZodObject<{
+    id: z.ZodUUID;
+    accountId: z.ZodUUID;
+    reference: z.ZodNullable<z.ZodString>;
+    entryCount: z.ZodNumber;
+    createdAt: z.ZodPreprocess<z.ZodDate, Date>;
+    counts: z.ZodObject<{
+        queued: z.ZodNumber;
+        sending: z.ZodNumber;
+        sent: z.ZodNumber;
+        failed: z.ZodNumber;
+        cancelled: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type MailMerge = z.infer<typeof MailMerge>;
+export declare const MailMergeIdInput: z.ZodObject<{
+    accountId: z.ZodUUID;
+    mailMergeId: z.ZodUUID;
+}, z.core.$strip>;
+export type MailMergeIdInput = z.infer<typeof MailMergeIdInput>;
+export declare const MailMergePage: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        accountId: z.ZodUUID;
+        reference: z.ZodNullable<z.ZodString>;
+        entryCount: z.ZodNumber;
+        createdAt: z.ZodPreprocess<z.ZodDate, Date>;
+        counts: z.ZodObject<{
+            queued: z.ZodNumber;
+            sending: z.ZodNumber;
+            sent: z.ZodNumber;
+            failed: z.ZodNumber;
+            cancelled: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type MailMergePage = z.infer<typeof MailMergePage>;
+export declare const ListMailMergesQuery: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    cursor: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type ListMailMergesQuery = z.infer<typeof ListMailMergesQuery>;
+export declare const MailMergeCancelled: z.ZodObject<{
+    cancelled: z.ZodNumber;
+}, z.core.$strip>;
+export type MailMergeCancelled = z.infer<typeof MailMergeCancelled>;
 export declare const OutboxIdInput: z.ZodObject<{
     accountId: z.ZodUUID;
     outboxId: z.ZodUUID;
@@ -401,6 +448,7 @@ export declare const OutboxEntryPage: z.ZodObject<{
         machineClickCount: z.ZodNumber;
         firstOpenedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
         lastOpenedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+        mailMergeId: z.ZodNullable<z.ZodUUID>;
     }, z.core.$strip>>;
     nextCursor: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
@@ -431,9 +479,6 @@ export declare const TrackingEventKind: z.ZodEnum<{
     click: "click";
 }>;
 export type TrackingEventKind = z.infer<typeof TrackingEventKind>;
-/** Who is behind a hit. proxy: fetches for a person who opened the message (Gmail's image
- * proxy); prefetch: fetches whether or not anyone reads it (Apple Mail Privacy Protection);
- * scanner: a security gateway or bot; unknown: some signal against a person, not enough to say. */
 export declare const TrackingActor: z.ZodEnum<{
     unknown: "unknown";
     human: "human";
@@ -442,10 +487,6 @@ export declare const TrackingActor: z.ZodEnum<{
     scanner: "scanner";
 }>;
 export type TrackingActor = z.infer<typeof TrackingActor>;
-/** The mail client behind a hit, from its user agent, the Referer / Origin host it came from and
- * the fingerprint rules it matched. gmail_proxy: Gmail's image proxy (the reader's own device is
- * hidden); apple_mail_privacy: Apple Mail loading through Mail Privacy Protection's relay;
- * webmail: a self-hosted webmail (Roundcube, SOGo, Horde, a webmail.* host). */
 export declare const TrackingClient: z.ZodEnum<{
     unknown: "unknown";
     gmail_proxy: "gmail_proxy";
@@ -493,7 +534,6 @@ export declare const TrackingBrowser: z.ZodEnum<{
     samsung: "samsung";
 }>;
 export type TrackingBrowser = z.infer<typeof TrackingBrowser>;
-/** Fetch metadata the browser sent (sec-fetch-*), lower-cased; null where absent. */
 export declare const TrackingSecFetch: z.ZodObject<{
     dest: z.ZodNullable<z.ZodString>;
     mode: z.ZodNullable<z.ZodString>;
@@ -501,8 +541,6 @@ export declare const TrackingSecFetch: z.ZodObject<{
     user: z.ZodNullable<z.ZodBoolean>;
 }, z.core.$strip>;
 export type TrackingSecFetch = z.infer<typeof TrackingSecFetch>;
-/** What a hit's request showed, derived when it was recorded; carried by the list API and by
- * message.opened / message.clicked. */
 export declare const TrackingSignals: z.ZodObject<{
     method: z.ZodString;
     refererHost: z.ZodNullable<z.ZodString>;
@@ -570,7 +608,6 @@ export declare const TrackingSignals: z.ZodObject<{
     }, z.core.$strip>;
 }, z.core.$strip>;
 export type TrackingSignals = z.infer<typeof TrackingSignals>;
-/** One pixel load or link follow of a tracked send. */
 export declare const TrackingEvent: z.ZodObject<{
     headers: z.ZodRecord<z.ZodString, z.ZodString>;
     method: z.ZodString;