@workwae/sdk 0.0.0-stage → 0.1.0-alpha.1

package/contract/send/models.d.ts

@@ -0,0 +1,750 @@
+import * as z from "zod";
+export declare const AttachmentInput: z.ZodObject<{
+    filename: z.ZodString;
+    contentType: z.ZodString;
+    content: z.ZodBase64;
+    contentId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type AttachmentInput = z.infer<typeof AttachmentInput>;
+export declare const Compose: z.ZodObject<{
+    to: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>>;
+    cc: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>>;
+    bcc: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>>;
+    replyTo: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>>;
+    subject: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    html: z.ZodOptional<z.ZodString>;
+    attachments: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        filename: z.ZodString;
+        contentType: z.ZodString;
+        content: z.ZodBase64;
+        contentId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    inReplyToMessageId: z.ZodOptional<z.ZodUUID>;
+    from: z.ZodOptional<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>;
+    signature: z.ZodOptional<z.ZodBoolean>;
+    priority: z.ZodDefault<z.ZodEnum<{
+        normal: "normal";
+        high: "high";
+        low: "low";
+    }>>;
+}, 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>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>>;
+    cc: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>>;
+    bcc: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>>;
+    replyTo: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>>;
+    subject: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    html: z.ZodOptional<z.ZodString>;
+    attachments: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        filename: z.ZodString;
+        contentType: z.ZodString;
+        content: z.ZodBase64;
+        contentId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    inReplyToMessageId: z.ZodOptional<z.ZodUUID>;
+    from: z.ZodOptional<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>;
+    signature: z.ZodOptional<z.ZodBoolean>;
+    priority: z.ZodDefault<z.ZodEnum<{
+        normal: "normal";
+        high: "high";
+        low: "low";
+    }>>;
+    template: z.ZodOptional<z.ZodUUID>;
+    render: z.ZodOptional<z.ZodObject<{
+        params: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>>;
+    previewText: z.ZodOptional<z.ZodString>;
+    format: z.ZodOptional<z.ZodEnum<{
+        markdown: "markdown";
+        html: "html";
+    }>>;
+}, z.core.$strip>;
+export type ComposeWithTemplate = z.infer<typeof ComposeWithTemplate>;
+export declare const OutboxStatus: z.ZodEnum<{
+    failed: "failed";
+    cancelled: "cancelled";
+    sent: "sent";
+    queued: "queued";
+    sending: "sending";
+}>;
+export type OutboxStatus = z.infer<typeof OutboxStatus>;
+export declare const OutboxEntry: z.ZodObject<{
+    id: z.ZodUUID;
+    accountId: z.ZodUUID;
+    status: z.ZodEnum<{
+        failed: "failed";
+        cancelled: "cancelled";
+        sent: "sent";
+        queued: "queued";
+        sending: "sending";
+    }>;
+    reference: z.ZodNullable<z.ZodString>;
+    sendAt: z.ZodPreprocess<z.ZodDate, Date>;
+    attempt: z.ZodNumber;
+    lastError: z.ZodNullable<z.ZodString>;
+    providerMessageId: z.ZodNullable<z.ZodString>;
+    internetMessageId: z.ZodNullable<z.ZodString>;
+    sentAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    createdAt: z.ZodPreprocess<z.ZodDate, Date>;
+    trackOpens: z.ZodBoolean;
+    trackClicks: z.ZodBoolean;
+    trackHoneypot: z.ZodBoolean;
+    humanOpenCount: z.ZodNumber;
+    machineOpenCount: z.ZodNumber;
+    humanClickCount: z.ZodNumber;
+    machineClickCount: z.ZodNumber;
+    firstOpenedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    lastOpenedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+}, 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;
+    status: z.ZodEnum<{
+        failed: "failed";
+        cancelled: "cancelled";
+        sent: "sent";
+        queued: "queued";
+        sending: "sending";
+    }>;
+    reference: z.ZodNullable<z.ZodString>;
+    sendAt: z.ZodPreprocess<z.ZodDate, Date>;
+    attempt: z.ZodNumber;
+    lastError: z.ZodNullable<z.ZodString>;
+    providerMessageId: z.ZodNullable<z.ZodString>;
+    internetMessageId: z.ZodNullable<z.ZodString>;
+    sentAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    createdAt: z.ZodPreprocess<z.ZodDate, Date>;
+    trackOpens: z.ZodBoolean;
+    trackClicks: z.ZodBoolean;
+    trackHoneypot: z.ZodBoolean;
+    humanOpenCount: z.ZodNumber;
+    machineOpenCount: z.ZodNumber;
+    humanClickCount: z.ZodNumber;
+    machineClickCount: z.ZodNumber;
+    firstOpenedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    lastOpenedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    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>;
+    tracking: z.ZodOptional<z.ZodObject<{
+        opens: z.ZodOptional<z.ZodBoolean>;
+        clicks: z.ZodOptional<z.ZodBoolean>;
+        honeypot: z.ZodOptional<z.ZodBoolean>;
+    }, 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>;
+        address: z.ZodString;
+    }, z.core.$strip>;
+    params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    messageId: z.ZodOptional<z.ZodString>;
+    sendAt: z.ZodOptional<z.ZodPreprocess<z.ZodDate, string | Date>>;
+}, z.core.$strip>;
+export type MailMergeEntry = z.infer<typeof MailMergeEntry>;
+export declare const SendMessageRequest: z.ZodObject<{
+    to: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>>;
+    cc: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>>;
+    bcc: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>>;
+    replyTo: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>>;
+    subject: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    html: z.ZodOptional<z.ZodString>;
+    attachments: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        filename: z.ZodString;
+        contentType: z.ZodString;
+        content: z.ZodBase64;
+        contentId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    inReplyToMessageId: z.ZodOptional<z.ZodUUID>;
+    from: z.ZodOptional<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>;
+    signature: z.ZodOptional<z.ZodBoolean>;
+    priority: z.ZodDefault<z.ZodEnum<{
+        normal: "normal";
+        high: "high";
+        low: "low";
+    }>>;
+    template: z.ZodOptional<z.ZodUUID>;
+    render: z.ZodOptional<z.ZodObject<{
+        params: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>>;
+    previewText: z.ZodOptional<z.ZodString>;
+    format: z.ZodOptional<z.ZodEnum<{
+        markdown: "markdown";
+        html: "html";
+    }>>;
+    sendAt: z.ZodOptional<z.ZodPreprocess<z.ZodDate, string | Date>>;
+    reference: z.ZodOptional<z.ZodString>;
+    tracking: z.ZodOptional<z.ZodObject<{
+        opens: z.ZodOptional<z.ZodBoolean>;
+        clicks: z.ZodOptional<z.ZodBoolean>;
+        honeypot: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    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";
+        html: "html";
+    }>>;
+    text: z.ZodOptional<z.ZodString>;
+    from: z.ZodOptional<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>;
+    subject: z.ZodOptional<z.ZodString>;
+    html: z.ZodOptional<z.ZodString>;
+    previewText: z.ZodOptional<z.ZodString>;
+    replyTo: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        address: z.ZodEmail;
+    }, z.core.$strip>>>;
+    attachments: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        filename: z.ZodString;
+        contentType: z.ZodString;
+        content: z.ZodBase64;
+        contentId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    inReplyToMessageId: z.ZodOptional<z.ZodUUID>;
+    signature: z.ZodOptional<z.ZodBoolean>;
+    priority: z.ZodDefault<z.ZodEnum<{
+        normal: "normal";
+        high: "high";
+        low: "low";
+    }>>;
+    template: z.ZodOptional<z.ZodUUID>;
+    sendAt: z.ZodOptional<z.ZodPreprocess<z.ZodDate, string | Date>>;
+    reference: z.ZodOptional<z.ZodString>;
+    tracking: z.ZodOptional<z.ZodObject<{
+        opens: z.ZodOptional<z.ZodBoolean>;
+        clicks: z.ZodOptional<z.ZodBoolean>;
+        honeypot: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    entries: z.ZodArray<z.ZodObject<{
+        to: z.ZodObject<{
+            name: z.ZodOptional<z.ZodString>;
+            address: z.ZodString;
+        }, z.core.$strip>;
+        params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        messageId: z.ZodOptional<z.ZodString>;
+        sendAt: z.ZodOptional<z.ZodPreprocess<z.ZodDate, string | Date>>;
+    }, z.core.$strip>>;
+    listId: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type MailMergeRequest = z.infer<typeof MailMergeRequest>;
+export declare const MailMergeSuccess: 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>;
+export type MailMergeSuccess = z.infer<typeof MailMergeSuccess>;
+export declare const MailMergeFailure: 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>;
+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<{
+        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">>;
+}, z.core.$strip>;
+export type MailMergeResultList = z.infer<typeof MailMergeResultList>;
+export declare const OutboxIdInput: z.ZodObject<{
+    accountId: z.ZodUUID;
+    outboxId: z.ZodUUID;
+}, z.core.$strip>;
+export type OutboxIdInput = z.infer<typeof OutboxIdInput>;
+export declare const OutboxEntryPage: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        accountId: z.ZodUUID;
+        status: z.ZodEnum<{
+            failed: "failed";
+            cancelled: "cancelled";
+            sent: "sent";
+            queued: "queued";
+            sending: "sending";
+        }>;
+        reference: z.ZodNullable<z.ZodString>;
+        sendAt: z.ZodPreprocess<z.ZodDate, Date>;
+        attempt: z.ZodNumber;
+        lastError: z.ZodNullable<z.ZodString>;
+        providerMessageId: z.ZodNullable<z.ZodString>;
+        internetMessageId: z.ZodNullable<z.ZodString>;
+        sentAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+        createdAt: z.ZodPreprocess<z.ZodDate, Date>;
+        trackOpens: z.ZodBoolean;
+        trackClicks: z.ZodBoolean;
+        trackHoneypot: z.ZodBoolean;
+        humanOpenCount: z.ZodNumber;
+        machineOpenCount: z.ZodNumber;
+        humanClickCount: z.ZodNumber;
+        machineClickCount: z.ZodNumber;
+        firstOpenedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+        lastOpenedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type OutboxEntryPage = z.infer<typeof OutboxEntryPage>;
+export declare const ListOutboxQuery: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    cursor: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodEnum<{
+        failed: "failed";
+        cancelled: "cancelled";
+        sent: "sent";
+        queued: "queued";
+        sending: "sending";
+    }>>;
+}, z.core.$strip>;
+export type ListOutboxQuery = z.infer<typeof ListOutboxQuery>;
+export declare const RescheduleSendRequest: z.ZodObject<{
+    sendAt: z.ZodPreprocess<z.ZodDate, string | Date>;
+}, z.core.$strip>;
+export type RescheduleSendRequest = z.infer<typeof RescheduleSendRequest>;
+export declare const ListTrackingEventsQuery: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    cursor: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type ListTrackingEventsQuery = z.infer<typeof ListTrackingEventsQuery>;
+export declare const TrackingEventKind: z.ZodEnum<{
+    open: "open";
+    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";
+    proxy: "proxy";
+    prefetch: "prefetch";
+    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";
+    gmail_web: "gmail_web";
+    gmail_app: "gmail_app";
+    outlook_web: "outlook_web";
+    outlook_desktop: "outlook_desktop";
+    outlook_mobile: "outlook_mobile";
+    apple_mail: "apple_mail";
+    apple_mail_privacy: "apple_mail_privacy";
+    yahoo: "yahoo";
+    aol: "aol";
+    thunderbird: "thunderbird";
+    proton: "proton";
+    fastmail: "fastmail";
+    zoho: "zoho";
+    icloud_web: "icloud_web";
+    webmail: "webmail";
+}>;
+export type TrackingClient = z.infer<typeof TrackingClient>;
+export declare const TrackingDevice: z.ZodEnum<{
+    unknown: "unknown";
+    mobile: "mobile";
+    desktop: "desktop";
+    tablet: "tablet";
+    bot: "bot";
+}>;
+export type TrackingDevice = z.infer<typeof TrackingDevice>;
+export declare const TrackingOs: z.ZodEnum<{
+    windows: "windows";
+    macos: "macos";
+    ios: "ios";
+    ipados: "ipados";
+    android: "android";
+    linux: "linux";
+    chromeos: "chromeos";
+}>;
+export type TrackingOs = z.infer<typeof TrackingOs>;
+export declare const TrackingBrowser: z.ZodEnum<{
+    chrome: "chrome";
+    edge: "edge";
+    firefox: "firefox";
+    safari: "safari";
+    opera: "opera";
+    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>;
+    site: z.ZodNullable<z.ZodString>;
+    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>;
+    originHost: z.ZodNullable<z.ZodString>;
+    client: z.ZodEnum<{
+        unknown: "unknown";
+        gmail_proxy: "gmail_proxy";
+        gmail_web: "gmail_web";
+        gmail_app: "gmail_app";
+        outlook_web: "outlook_web";
+        outlook_desktop: "outlook_desktop";
+        outlook_mobile: "outlook_mobile";
+        apple_mail: "apple_mail";
+        apple_mail_privacy: "apple_mail_privacy";
+        yahoo: "yahoo";
+        aol: "aol";
+        thunderbird: "thunderbird";
+        proton: "proton";
+        fastmail: "fastmail";
+        zoho: "zoho";
+        icloud_web: "icloud_web";
+        webmail: "webmail";
+    }>;
+    device: z.ZodEnum<{
+        unknown: "unknown";
+        mobile: "mobile";
+        desktop: "desktop";
+        tablet: "tablet";
+        bot: "bot";
+    }>;
+    os: z.ZodNullable<z.ZodEnum<{
+        windows: "windows";
+        macos: "macos";
+        ios: "ios";
+        ipados: "ipados";
+        android: "android";
+        linux: "linux";
+        chromeos: "chromeos";
+    }>>;
+    browser: z.ZodNullable<z.ZodEnum<{
+        chrome: "chrome";
+        edge: "edge";
+        firefox: "firefox";
+        safari: "safari";
+        opera: "opera";
+        samsung: "samsung";
+    }>>;
+    country: z.ZodNullable<z.ZodString>;
+    region: z.ZodNullable<z.ZodString>;
+    city: z.ZodNullable<z.ZodString>;
+    timezone: z.ZodNullable<z.ZodString>;
+    latitude: z.ZodNullable<z.ZodNumber>;
+    longitude: z.ZodNullable<z.ZodNumber>;
+    secondsAfterSend: z.ZodNullable<z.ZodNumber>;
+    secondsSincePrevious: z.ZodNullable<z.ZodNumber>;
+    sequence: z.ZodNumber;
+    isConditional: z.ZodBoolean;
+    isRange: z.ZodBoolean;
+    isPrefetch: z.ZodBoolean;
+    secFetch: z.ZodObject<{
+        dest: z.ZodNullable<z.ZodString>;
+        mode: z.ZodNullable<z.ZodString>;
+        site: z.ZodNullable<z.ZodString>;
+        user: z.ZodNullable<z.ZodBoolean>;
+    }, 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;
+    refererHost: z.ZodNullable<z.ZodString>;
+    originHost: z.ZodNullable<z.ZodString>;
+    client: z.ZodEnum<{
+        unknown: "unknown";
+        gmail_proxy: "gmail_proxy";
+        gmail_web: "gmail_web";
+        gmail_app: "gmail_app";
+        outlook_web: "outlook_web";
+        outlook_desktop: "outlook_desktop";
+        outlook_mobile: "outlook_mobile";
+        apple_mail: "apple_mail";
+        apple_mail_privacy: "apple_mail_privacy";
+        yahoo: "yahoo";
+        aol: "aol";
+        thunderbird: "thunderbird";
+        proton: "proton";
+        fastmail: "fastmail";
+        zoho: "zoho";
+        icloud_web: "icloud_web";
+        webmail: "webmail";
+    }>;
+    device: z.ZodEnum<{
+        unknown: "unknown";
+        mobile: "mobile";
+        desktop: "desktop";
+        tablet: "tablet";
+        bot: "bot";
+    }>;
+    os: z.ZodNullable<z.ZodEnum<{
+        windows: "windows";
+        macos: "macos";
+        ios: "ios";
+        ipados: "ipados";
+        android: "android";
+        linux: "linux";
+        chromeos: "chromeos";
+    }>>;
+    browser: z.ZodNullable<z.ZodEnum<{
+        chrome: "chrome";
+        edge: "edge";
+        firefox: "firefox";
+        safari: "safari";
+        opera: "opera";
+        samsung: "samsung";
+    }>>;
+    country: z.ZodNullable<z.ZodString>;
+    region: z.ZodNullable<z.ZodString>;
+    city: z.ZodNullable<z.ZodString>;
+    timezone: z.ZodNullable<z.ZodString>;
+    latitude: z.ZodNullable<z.ZodNumber>;
+    longitude: z.ZodNullable<z.ZodNumber>;
+    secondsAfterSend: z.ZodNullable<z.ZodNumber>;
+    secondsSincePrevious: z.ZodNullable<z.ZodNumber>;
+    sequence: z.ZodNumber;
+    isConditional: z.ZodBoolean;
+    isRange: z.ZodBoolean;
+    isPrefetch: z.ZodBoolean;
+    secFetch: z.ZodObject<{
+        dest: z.ZodNullable<z.ZodString>;
+        mode: z.ZodNullable<z.ZodString>;
+        site: z.ZodNullable<z.ZodString>;
+        user: z.ZodNullable<z.ZodBoolean>;
+    }, z.core.$strip>;
+    id: z.ZodUUID;
+    kind: z.ZodEnum<{
+        open: "open";
+        click: "click";
+    }>;
+    linkIndex: z.ZodNullable<z.ZodNumber>;
+    url: z.ZodNullable<z.ZodString>;
+    occurredAt: z.ZodPreprocess<z.ZodDate, Date>;
+    userAgent: z.ZodNullable<z.ZodString>;
+    ip: z.ZodNullable<z.ZodString>;
+    actor: z.ZodEnum<{
+        unknown: "unknown";
+        human: "human";
+        proxy: "proxy";
+        prefetch: "prefetch";
+        scanner: "scanner";
+    }>;
+    reasons: z.ZodArray<z.ZodString>;
+    isMachine: z.ZodBoolean;
+}, z.core.$strip>;
+export type TrackingEvent = z.infer<typeof TrackingEvent>;
+export declare const TrackingEventPage: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        headers: z.ZodRecord<z.ZodString, z.ZodString>;
+        method: z.ZodString;
+        refererHost: z.ZodNullable<z.ZodString>;
+        originHost: z.ZodNullable<z.ZodString>;
+        client: z.ZodEnum<{
+            unknown: "unknown";
+            gmail_proxy: "gmail_proxy";
+            gmail_web: "gmail_web";
+            gmail_app: "gmail_app";
+            outlook_web: "outlook_web";
+            outlook_desktop: "outlook_desktop";
+            outlook_mobile: "outlook_mobile";
+            apple_mail: "apple_mail";
+            apple_mail_privacy: "apple_mail_privacy";
+            yahoo: "yahoo";
+            aol: "aol";
+            thunderbird: "thunderbird";
+            proton: "proton";
+            fastmail: "fastmail";
+            zoho: "zoho";
+            icloud_web: "icloud_web";
+            webmail: "webmail";
+        }>;
+        device: z.ZodEnum<{
+            unknown: "unknown";
+            mobile: "mobile";
+            desktop: "desktop";
+            tablet: "tablet";
+            bot: "bot";
+        }>;
+        os: z.ZodNullable<z.ZodEnum<{
+            windows: "windows";
+            macos: "macos";
+            ios: "ios";
+            ipados: "ipados";
+            android: "android";
+            linux: "linux";
+            chromeos: "chromeos";
+        }>>;
+        browser: z.ZodNullable<z.ZodEnum<{
+            chrome: "chrome";
+            edge: "edge";
+            firefox: "firefox";
+            safari: "safari";
+            opera: "opera";
+            samsung: "samsung";
+        }>>;
+        country: z.ZodNullable<z.ZodString>;
+        region: z.ZodNullable<z.ZodString>;
+        city: z.ZodNullable<z.ZodString>;
+        timezone: z.ZodNullable<z.ZodString>;
+        latitude: z.ZodNullable<z.ZodNumber>;
+        longitude: z.ZodNullable<z.ZodNumber>;
+        secondsAfterSend: z.ZodNullable<z.ZodNumber>;
+        secondsSincePrevious: z.ZodNullable<z.ZodNumber>;
+        sequence: z.ZodNumber;
+        isConditional: z.ZodBoolean;
+        isRange: z.ZodBoolean;
+        isPrefetch: z.ZodBoolean;
+        secFetch: z.ZodObject<{
+            dest: z.ZodNullable<z.ZodString>;
+            mode: z.ZodNullable<z.ZodString>;
+            site: z.ZodNullable<z.ZodString>;
+            user: z.ZodNullable<z.ZodBoolean>;
+        }, z.core.$strip>;
+        id: z.ZodUUID;
+        kind: z.ZodEnum<{
+            open: "open";
+            click: "click";
+        }>;
+        linkIndex: z.ZodNullable<z.ZodNumber>;
+        url: z.ZodNullable<z.ZodString>;
+        occurredAt: z.ZodPreprocess<z.ZodDate, Date>;
+        userAgent: z.ZodNullable<z.ZodString>;
+        ip: z.ZodNullable<z.ZodString>;
+        actor: z.ZodEnum<{
+            unknown: "unknown";
+            human: "human";
+            proxy: "proxy";
+            prefetch: "prefetch";
+            scanner: "scanner";
+        }>;
+        reasons: z.ZodArray<z.ZodString>;
+        isMachine: z.ZodBoolean;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type TrackingEventPage = z.infer<typeof TrackingEventPage>;