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

package/contract/mail/models.d.ts

@@ -0,0 +1,528 @@
+import * as z from "zod";
+export declare const MailboxRole: z.ZodEnum<{
+    custom: "custom";
+    inbox: "inbox";
+    sent: "sent";
+    drafts: "drafts";
+    trash: "trash";
+    junk: "junk";
+    archive: "archive";
+    all: "all";
+    important: "important";
+}>;
+export type MailboxRole = z.infer<typeof MailboxRole>;
+/** folder: a message is in exactly one (Microsoft). label: a message can carry several (Gmail). */
+export declare const MailboxKind: z.ZodEnum<{
+    label: "label";
+    folder: "folder";
+}>;
+export type MailboxKind = z.infer<typeof MailboxKind>;
+export declare const Mailbox: z.ZodObject<{
+    id: z.ZodUUID;
+    name: z.ZodString;
+    path: z.ZodString;
+    parentId: z.ZodNullable<z.ZodUUID>;
+    role: z.ZodEnum<{
+        custom: "custom";
+        inbox: "inbox";
+        sent: "sent";
+        drafts: "drafts";
+        trash: "trash";
+        junk: "junk";
+        archive: "archive";
+        all: "all";
+        important: "important";
+    }>;
+    kind: z.ZodEnum<{
+        label: "label";
+        folder: "folder";
+    }>;
+    totalCount: z.ZodNullable<z.ZodNumber>;
+    unreadCount: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+export type Mailbox = z.infer<typeof Mailbox>;
+export declare const MailboxList: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        name: z.ZodString;
+        path: z.ZodString;
+        parentId: z.ZodNullable<z.ZodUUID>;
+        role: z.ZodEnum<{
+            custom: "custom";
+            inbox: "inbox";
+            sent: "sent";
+            drafts: "drafts";
+            trash: "trash";
+            junk: "junk";
+            archive: "archive";
+            all: "all";
+            important: "important";
+        }>;
+        kind: z.ZodEnum<{
+            label: "label";
+            folder: "folder";
+        }>;
+        totalCount: z.ZodNullable<z.ZodNumber>;
+        unreadCount: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type MailboxList = z.infer<typeof MailboxList>;
+/** The Mailbox fields mailbox.updated names in `changes` (the counts move without an event). */
+export declare const MailboxChangedField: z.ZodEnum<{
+    path: "path";
+    name: "name";
+    kind: "kind";
+    role: "role";
+    parentId: "parentId";
+}>;
+export type MailboxChangedField = z.infer<typeof MailboxChangedField>;
+/**
+ * outbound: the message is in a mailbox with role `sent`, or its From is the account's own address
+ * or one of its identities (so drafts are outbound too). inbound: everything else.
+ */
+export declare const MessageDirection: z.ZodEnum<{
+    inbound: "inbound";
+    outbound: "outbound";
+}>;
+export type MessageDirection = z.infer<typeof MessageDirection>;
+/**
+ * The priority mail clients mark with "!" (high) or a down arrow (low). Sent as
+ * X-Priority, X-MSMail-Priority, Importance and Priority headers; read from Graph's `importance`
+ * and from those headers on Gmail and IMAP.
+ */
+export declare const MessagePriority: z.ZodEnum<{
+    normal: "normal";
+    high: "high";
+    low: "low";
+}>;
+export type MessagePriority = z.infer<typeof MessagePriority>;
+export declare const MessageSummary: z.ZodObject<{
+    id: z.ZodUUID;
+    threadId: z.ZodNullable<z.ZodString>;
+    internetMessageId: z.ZodNullable<z.ZodString>;
+    mailboxIds: z.ZodArray<z.ZodUUID>;
+    subject: z.ZodNullable<z.ZodString>;
+    from: z.ZodNullable<z.ZodObject<{
+        name: z.ZodNullable<z.ZodString>;
+        address: z.ZodString;
+    }, z.core.$strip>>;
+    to: z.ZodArray<z.ZodObject<{
+        name: z.ZodNullable<z.ZodString>;
+        address: z.ZodString;
+    }, z.core.$strip>>;
+    cc: z.ZodArray<z.ZodObject<{
+        name: z.ZodNullable<z.ZodString>;
+        address: z.ZodString;
+    }, z.core.$strip>>;
+    snippet: z.ZodNullable<z.ZodString>;
+    receivedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    sentAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    isRead: z.ZodBoolean;
+    isFlagged: z.ZodBoolean;
+    isDraft: z.ZodBoolean;
+    hasAttachments: z.ZodBoolean;
+    categories: z.ZodArray<z.ZodString>;
+    direction: z.ZodEnum<{
+        inbound: "inbound";
+        outbound: "outbound";
+    }>;
+    outboxId: z.ZodNullable<z.ZodUUID>;
+    reference: z.ZodNullable<z.ZodString>;
+    importance: z.ZodNullable<z.ZodEnum<{
+        normal: "normal";
+        high: "high";
+        low: "low";
+    }>>;
+}, z.core.$strip>;
+export type MessageSummary = z.infer<typeof MessageSummary>;
+/** The Message fields message.updated names in `changes`. `reference` changes only with
+ * outboxId and is not named on its own. */
+export declare const MessageChangedField: z.ZodEnum<{
+    from: "from";
+    to: "to";
+    subject: "subject";
+    snippet: "snippet";
+    categories: "categories";
+    hasAttachments: "hasAttachments";
+    direction: "direction";
+    threadId: "threadId";
+    internetMessageId: "internetMessageId";
+    mailboxIds: "mailboxIds";
+    cc: "cc";
+    receivedAt: "receivedAt";
+    sentAt: "sentAt";
+    isRead: "isRead";
+    isFlagged: "isFlagged";
+    isDraft: "isDraft";
+    outboxId: "outboxId";
+    importance: "importance";
+    bcc: "bcc";
+    replyTo: "replyTo";
+}>;
+export type MessageChangedField = z.infer<typeof MessageChangedField>;
+export declare const MessageSummaryPage: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        threadId: z.ZodNullable<z.ZodString>;
+        internetMessageId: z.ZodNullable<z.ZodString>;
+        mailboxIds: z.ZodArray<z.ZodUUID>;
+        subject: z.ZodNullable<z.ZodString>;
+        from: z.ZodNullable<z.ZodObject<{
+            name: z.ZodNullable<z.ZodString>;
+            address: z.ZodString;
+        }, z.core.$strip>>;
+        to: z.ZodArray<z.ZodObject<{
+            name: z.ZodNullable<z.ZodString>;
+            address: z.ZodString;
+        }, z.core.$strip>>;
+        cc: z.ZodArray<z.ZodObject<{
+            name: z.ZodNullable<z.ZodString>;
+            address: z.ZodString;
+        }, z.core.$strip>>;
+        snippet: z.ZodNullable<z.ZodString>;
+        receivedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+        sentAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+        isRead: z.ZodBoolean;
+        isFlagged: z.ZodBoolean;
+        isDraft: z.ZodBoolean;
+        hasAttachments: z.ZodBoolean;
+        categories: z.ZodArray<z.ZodString>;
+        direction: z.ZodEnum<{
+            inbound: "inbound";
+            outbound: "outbound";
+        }>;
+        outboxId: z.ZodNullable<z.ZodUUID>;
+        reference: z.ZodNullable<z.ZodString>;
+        importance: z.ZodNullable<z.ZodEnum<{
+            normal: "normal";
+            high: "high";
+            low: "low";
+        }>>;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type MessageSummaryPage = z.infer<typeof MessageSummaryPage>;
+export declare const Attachment: z.ZodObject<{
+    id: z.ZodString;
+    filename: z.ZodNullable<z.ZodString>;
+    contentType: z.ZodString;
+    size: z.ZodNullable<z.ZodNumber>;
+    isInline: z.ZodBoolean;
+    contentId: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type Attachment = z.infer<typeof Attachment>;
+/** What AI made of a reply to one of your sends (see the tenant setting aiReplyClassification). */
+export declare const ReplyKind: z.ZodEnum<{
+    opt_out: "opt_out";
+    auto_reply: "auto_reply";
+    bounce: "bounce";
+    human_reply: "human_reply";
+}>;
+export type ReplyKind = z.infer<typeof ReplyKind>;
+/** What kind of automatic answer an auto_reply is. out_of_office: away for a while;
+ * left_company: the person no longer works there, or the mailbox is unmonitored; address_changed:
+ * gives a new address to use; ticket_acknowledgment: an automated receipt or ticket number;
+ * challenge_response: asks the sender to verify before the mail is delivered; other: any other
+ * automatic answer. */
+export declare const AutoReplyCategory: z.ZodEnum<{
+    other: "other";
+    out_of_office: "out_of_office";
+    left_company: "left_company";
+    address_changed: "address_changed";
+    ticket_acknowledgment: "ticket_acknowledgment";
+    challenge_response: "challenge_response";
+}>;
+export type AutoReplyCategory = z.infer<typeof AutoReplyCategory>;
+export declare const MessageClassification: z.ZodObject<{
+    kind: z.ZodEnum<{
+        opt_out: "opt_out";
+        auto_reply: "auto_reply";
+        bounce: "bounce";
+        human_reply: "human_reply";
+    }>;
+    probabilities: z.ZodRecord<z.ZodString, z.ZodNumber>;
+    optOutProbability: z.ZodNumber;
+    autoReplyCategory: z.ZodNullable<z.ZodEnum<{
+        other: "other";
+        out_of_office: "out_of_office";
+        left_company: "left_company";
+        address_changed: "address_changed";
+        ticket_acknowledgment: "ticket_acknowledgment";
+        challenge_response: "challenge_response";
+    }>>;
+    returnDate: z.ZodNullable<z.ZodISODate>;
+    alternateContacts: z.ZodArray<z.ZodString>;
+    outboxId: z.ZodNullable<z.ZodUUID>;
+    model: z.ZodString;
+    classifiedAt: z.ZodPreprocess<z.ZodDate, Date>;
+}, z.core.$strip>;
+export type MessageClassification = z.infer<typeof MessageClassification>;
+/** Served from stored content when the account stores bodies (bodyStorage cache or full),
+ * otherwise fetched from the provider on request; null parts are absent from the message. */
+export declare const MessageBody: z.ZodObject<{
+    text: z.ZodNullable<z.ZodString>;
+    html: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type MessageBody = z.infer<typeof MessageBody>;
+export declare const Message: z.ZodObject<{
+    id: z.ZodUUID;
+    threadId: z.ZodNullable<z.ZodString>;
+    internetMessageId: z.ZodNullable<z.ZodString>;
+    mailboxIds: z.ZodArray<z.ZodUUID>;
+    subject: z.ZodNullable<z.ZodString>;
+    from: z.ZodNullable<z.ZodObject<{
+        name: z.ZodNullable<z.ZodString>;
+        address: z.ZodString;
+    }, z.core.$strip>>;
+    to: z.ZodArray<z.ZodObject<{
+        name: z.ZodNullable<z.ZodString>;
+        address: z.ZodString;
+    }, z.core.$strip>>;
+    cc: z.ZodArray<z.ZodObject<{
+        name: z.ZodNullable<z.ZodString>;
+        address: z.ZodString;
+    }, z.core.$strip>>;
+    snippet: z.ZodNullable<z.ZodString>;
+    receivedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    sentAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    isRead: z.ZodBoolean;
+    isFlagged: z.ZodBoolean;
+    isDraft: z.ZodBoolean;
+    hasAttachments: z.ZodBoolean;
+    categories: z.ZodArray<z.ZodString>;
+    direction: z.ZodEnum<{
+        inbound: "inbound";
+        outbound: "outbound";
+    }>;
+    outboxId: z.ZodNullable<z.ZodUUID>;
+    reference: z.ZodNullable<z.ZodString>;
+    importance: z.ZodNullable<z.ZodEnum<{
+        normal: "normal";
+        high: "high";
+        low: "low";
+    }>>;
+    bcc: z.ZodArray<z.ZodObject<{
+        name: z.ZodNullable<z.ZodString>;
+        address: z.ZodString;
+    }, z.core.$strip>>;
+    replyTo: z.ZodArray<z.ZodObject<{
+        name: z.ZodNullable<z.ZodString>;
+        address: z.ZodString;
+    }, z.core.$strip>>;
+    body: z.ZodObject<{
+        text: z.ZodNullable<z.ZodString>;
+        html: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    attachments: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        filename: z.ZodNullable<z.ZodString>;
+        contentType: z.ZodString;
+        size: z.ZodNullable<z.ZodNumber>;
+        isInline: z.ZodBoolean;
+        contentId: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+    classification: z.ZodNullable<z.ZodObject<{
+        kind: z.ZodEnum<{
+            opt_out: "opt_out";
+            auto_reply: "auto_reply";
+            bounce: "bounce";
+            human_reply: "human_reply";
+        }>;
+        probabilities: z.ZodRecord<z.ZodString, z.ZodNumber>;
+        optOutProbability: z.ZodNumber;
+        autoReplyCategory: z.ZodNullable<z.ZodEnum<{
+            other: "other";
+            out_of_office: "out_of_office";
+            left_company: "left_company";
+            address_changed: "address_changed";
+            ticket_acknowledgment: "ticket_acknowledgment";
+            challenge_response: "challenge_response";
+        }>>;
+        returnDate: z.ZodNullable<z.ZodISODate>;
+        alternateContacts: z.ZodArray<z.ZodString>;
+        outboxId: z.ZodNullable<z.ZodUUID>;
+        model: z.ZodString;
+        classifiedAt: z.ZodPreprocess<z.ZodDate, Date>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type Message = z.infer<typeof Message>;
+/** Where a search looks: the index, the provider, or the index first (see messages.search). */
+export declare const SearchSource: z.ZodEnum<{
+    provider: "provider";
+    auto: "auto";
+    index: "index";
+}>;
+export type SearchSource = z.infer<typeof SearchSource>;
+/** Which source answered a search. */
+export declare const SearchResultSource: z.ZodEnum<{
+    provider: "provider";
+    index: "index";
+}>;
+export type SearchResultSource = z.infer<typeof SearchResultSource>;
+/** A search result. `id` is null for a provider result the index does not hold (a message older
+ * than the sync window); such a result cannot be opened through the API. */
+export declare const SearchHit: z.ZodObject<{
+    threadId: z.ZodNullable<z.ZodString>;
+    internetMessageId: z.ZodNullable<z.ZodString>;
+    mailboxIds: z.ZodArray<z.ZodUUID>;
+    subject: z.ZodNullable<z.ZodString>;
+    from: z.ZodNullable<z.ZodObject<{
+        name: z.ZodNullable<z.ZodString>;
+        address: z.ZodString;
+    }, z.core.$strip>>;
+    to: z.ZodArray<z.ZodObject<{
+        name: z.ZodNullable<z.ZodString>;
+        address: z.ZodString;
+    }, z.core.$strip>>;
+    cc: z.ZodArray<z.ZodObject<{
+        name: z.ZodNullable<z.ZodString>;
+        address: z.ZodString;
+    }, z.core.$strip>>;
+    snippet: z.ZodNullable<z.ZodString>;
+    receivedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    sentAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    isRead: z.ZodBoolean;
+    isFlagged: z.ZodBoolean;
+    isDraft: z.ZodBoolean;
+    hasAttachments: z.ZodBoolean;
+    categories: z.ZodArray<z.ZodString>;
+    direction: z.ZodEnum<{
+        inbound: "inbound";
+        outbound: "outbound";
+    }>;
+    outboxId: z.ZodNullable<z.ZodUUID>;
+    reference: z.ZodNullable<z.ZodString>;
+    importance: z.ZodNullable<z.ZodEnum<{
+        normal: "normal";
+        high: "high";
+        low: "low";
+    }>>;
+    id: z.ZodNullable<z.ZodUUID>;
+}, z.core.$strip>;
+export type SearchHit = z.infer<typeof SearchHit>;
+/** A search page, with the source that answered; later pages (through nextCursor) stay with it. */
+export declare const SearchPage: z.ZodObject<{
+    source: z.ZodEnum<{
+        provider: "provider";
+        index: "index";
+    }>;
+    items: z.ZodArray<z.ZodObject<{
+        threadId: z.ZodNullable<z.ZodString>;
+        internetMessageId: z.ZodNullable<z.ZodString>;
+        mailboxIds: z.ZodArray<z.ZodUUID>;
+        subject: z.ZodNullable<z.ZodString>;
+        from: z.ZodNullable<z.ZodObject<{
+            name: z.ZodNullable<z.ZodString>;
+            address: z.ZodString;
+        }, z.core.$strip>>;
+        to: z.ZodArray<z.ZodObject<{
+            name: z.ZodNullable<z.ZodString>;
+            address: z.ZodString;
+        }, z.core.$strip>>;
+        cc: z.ZodArray<z.ZodObject<{
+            name: z.ZodNullable<z.ZodString>;
+            address: z.ZodString;
+        }, z.core.$strip>>;
+        snippet: z.ZodNullable<z.ZodString>;
+        receivedAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+        sentAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+        isRead: z.ZodBoolean;
+        isFlagged: z.ZodBoolean;
+        isDraft: z.ZodBoolean;
+        hasAttachments: z.ZodBoolean;
+        categories: z.ZodArray<z.ZodString>;
+        direction: z.ZodEnum<{
+            inbound: "inbound";
+            outbound: "outbound";
+        }>;
+        outboxId: z.ZodNullable<z.ZodUUID>;
+        reference: z.ZodNullable<z.ZodString>;
+        importance: z.ZodNullable<z.ZodEnum<{
+            normal: "normal";
+            high: "high";
+            low: "low";
+        }>>;
+        id: z.ZodNullable<z.ZodUUID>;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type SearchPage = z.infer<typeof SearchPage>;
+/** Stored message content, for the whole tenant or one account. */
+export declare const BodyStorageUsage: z.ZodObject<{
+    available: z.ZodBoolean;
+    storedMessages: z.ZodNumber;
+    storedBytes: z.ZodNumber;
+    cachedBytes: z.ZodNumber;
+    cacheBudgetBytes: z.ZodNumber;
+    cacheMaxAgeDays: z.ZodNumber;
+}, z.core.$strip>;
+export type BodyStorageUsage = z.infer<typeof BodyStorageUsage>;
+export declare const MessageIdInput: z.ZodObject<{
+    accountId: z.ZodUUID;
+    messageId: z.ZodUUID;
+}, z.core.$strip>;
+export type MessageIdInput = z.infer<typeof MessageIdInput>;
+export declare const AttachmentIdInput: z.ZodObject<{
+    accountId: z.ZodUUID;
+    messageId: z.ZodUUID;
+    attachmentId: z.ZodString;
+}, z.core.$strip>;
+export type AttachmentIdInput = z.infer<typeof AttachmentIdInput>;
+export declare const ListMessagesQuery: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    cursor: z.ZodOptional<z.ZodString>;
+    mailboxId: z.ZodOptional<z.ZodUUID>;
+    unread: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>;
+    importance: z.ZodOptional<z.ZodEnum<{
+        normal: "normal";
+        high: "high";
+        low: "low";
+    }>>;
+}, z.core.$strip>;
+export type ListMessagesQuery = z.infer<typeof ListMessagesQuery>;
+export declare const SearchMessagesQuery: z.ZodObject<{
+    q: z.ZodString;
+    mailboxId: z.ZodOptional<z.ZodUUID>;
+    after: z.ZodOptional<z.ZodPreprocess<z.ZodDate, string | Date>>;
+    before: z.ZodOptional<z.ZodPreprocess<z.ZodDate, string | Date>>;
+    source: z.ZodDefault<z.ZodEnum<{
+        provider: "provider";
+        auto: "auto";
+        index: "index";
+    }>>;
+    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    cursor: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type SearchMessagesQuery = z.infer<typeof SearchMessagesQuery>;
+export declare const UpdateMessage: z.ZodObject<{
+    isRead: z.ZodOptional<z.ZodBoolean>;
+    isFlagged: z.ZodOptional<z.ZodBoolean>;
+    mailboxId: z.ZodOptional<z.ZodUUID>;
+    addMailboxIds: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
+    removeMailboxIds: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
+}, z.core.$strip>;
+export type UpdateMessage = z.infer<typeof UpdateMessage>;
+export declare const DeleteMessageQuery: z.ZodObject<{
+    permanent: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>;
+}, z.core.$strip>;
+export type DeleteMessageQuery = z.infer<typeof DeleteMessageQuery>;
+/** The path's message and the query's options, as a DELETE takes them. */
+export declare const DeleteMessageInput: z.ZodObject<{
+    params: z.ZodObject<{
+        accountId: z.ZodUUID;
+        messageId: z.ZodUUID;
+    }, z.core.$strip>;
+    query: z.ZodObject<{
+        permanent: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
+            true: "true";
+            false: "false";
+        }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type DeleteMessageInput = z.infer<typeof DeleteMessageInput>;