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

package/contract/settings/models.d.ts

@@ -0,0 +1,103 @@
+import * as z from "zod";
+export declare const BodyStorage: z.ZodEnum<{
+    none: "none";
+    cache: "cache";
+    full: "full";
+}>;
+export type BodyStorage = z.infer<typeof BodyStorage>;
+/** null syncWindowDays = full mailbox history. */
+export declare const EffectiveSettings: z.ZodObject<{
+    bodyStorage: z.ZodEnum<{
+        none: "none";
+        cache: "cache";
+        full: "full";
+    }>;
+    syncWindowDays: z.ZodNullable<z.ZodNumber>;
+    calendarEnabled: z.ZodBoolean;
+    contactsEnabled: z.ZodBoolean;
+    undoSendSeconds: z.ZodNumber;
+    trackOpens: z.ZodBoolean;
+    trackClicks: z.ZodBoolean;
+    trackingHoneypot: z.ZodBoolean;
+}, z.core.$strip>;
+export type EffectiveSettings = z.infer<typeof EffectiveSettings>;
+/** Keys present override the tenant default; absent keys inherit it. */
+export declare const SettingsOverride: z.ZodObject<{
+    bodyStorage: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        cache: "cache";
+        full: "full";
+    }>>;
+    syncWindowDays: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    calendarEnabled: z.ZodOptional<z.ZodBoolean>;
+    contactsEnabled: z.ZodOptional<z.ZodBoolean>;
+    undoSendSeconds: z.ZodOptional<z.ZodNumber>;
+    trackOpens: z.ZodOptional<z.ZodBoolean>;
+    trackClicks: z.ZodOptional<z.ZodBoolean>;
+    trackingHoneypot: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type SettingsOverride = z.infer<typeof SettingsOverride>;
+/**
+ * Why `uri` cannot go on the redirect URI allowlist, or null when it can: entries are absolute
+ * https URLs, plain http only for local development hosts.
+ */
+export declare function redirectUriProblem(uri: string): string | null;
+/** off: detected opt-outs are ignored; review: AI-classified replies wait in
+ * GET /v1/suppression-reviews for a person, while feedback-loop complaints, which are certain,
+ * suppress at once; suppress: the address goes on the list at once. Auto-replies saying the
+ * person is no longer at the address (source inactive) wait for review under both review and
+ * suppress. Unsubscribe links and one-click unsubscribe always suppress, whatever this says
+ * (RFC 8058, Gmail and Yahoo sender rules). */
+export declare const OptOutHandling: z.ZodEnum<{
+    off: "off";
+    review: "review";
+    suppress: "suppress";
+}>;
+export type OptOutHandling = z.infer<typeof OptOutHandling>;
+export declare const TenantSettings: z.ZodObject<{
+    bodyStorage: z.ZodEnum<{
+        none: "none";
+        cache: "cache";
+        full: "full";
+    }>;
+    syncWindowDays: z.ZodNullable<z.ZodNumber>;
+    calendarEnabled: z.ZodBoolean;
+    contactsEnabled: z.ZodBoolean;
+    undoSendSeconds: z.ZodNumber;
+    trackOpens: z.ZodBoolean;
+    trackClicks: z.ZodBoolean;
+    trackingHoneypot: z.ZodBoolean;
+    optOutHandling: z.ZodEnum<{
+        off: "off";
+        review: "review";
+        suppress: "suppress";
+    }>;
+    eventRetentionDays: z.ZodNumber;
+    redirectUris: z.ZodArray<z.ZodURL>;
+    aiReplyClassification: z.ZodBoolean;
+}, z.core.$strip>;
+export type TenantSettings = z.infer<typeof TenantSettings>;
+/** Keys present change; absent keys stay. */
+export declare const UpdateTenantSettings: z.ZodObject<{
+    bodyStorage: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        cache: "cache";
+        full: "full";
+    }>>;
+    syncWindowDays: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    calendarEnabled: z.ZodOptional<z.ZodBoolean>;
+    contactsEnabled: z.ZodOptional<z.ZodBoolean>;
+    undoSendSeconds: z.ZodOptional<z.ZodNumber>;
+    trackOpens: z.ZodOptional<z.ZodBoolean>;
+    trackClicks: z.ZodOptional<z.ZodBoolean>;
+    trackingHoneypot: z.ZodOptional<z.ZodBoolean>;
+    optOutHandling: z.ZodOptional<z.ZodEnum<{
+        off: "off";
+        review: "review";
+        suppress: "suppress";
+    }>>;
+    eventRetentionDays: z.ZodOptional<z.ZodNumber>;
+    redirectUris: z.ZodOptional<z.ZodArray<z.ZodURL>>;
+    aiReplyClassification: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type UpdateTenantSettings = z.infer<typeof UpdateTenantSettings>;

package/contract/settings/routes.d.ts

@@ -0,0 +1,110 @@
+export declare const settings: {
+    get: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, import("zod").ZodObject<{
+        bodyStorage: import("zod").ZodEnum<{
+            none: "none";
+            cache: "cache";
+            full: "full";
+        }>;
+        syncWindowDays: import("zod").ZodNullable<import("zod").ZodNumber>;
+        calendarEnabled: import("zod").ZodBoolean;
+        contactsEnabled: import("zod").ZodBoolean;
+        undoSendSeconds: import("zod").ZodNumber;
+        trackOpens: import("zod").ZodBoolean;
+        trackClicks: import("zod").ZodBoolean;
+        trackingHoneypot: import("zod").ZodBoolean;
+        optOutHandling: import("zod").ZodEnum<{
+            off: "off";
+            review: "review";
+            suppress: "suppress";
+        }>;
+        eventRetentionDays: import("zod").ZodNumber;
+        redirectUris: import("zod").ZodArray<import("zod").ZodURL>;
+        aiReplyClassification: import("zod").ZodBoolean;
+    }, import("zod/v4/core").$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, import("../errors.js").DeclaredErrors<{
+        readonly invalid_input: "The request does not match the operation's input schema (a malformed body included); data.issues names each problem.";
+        readonly unauthenticated: "No usable credential: none was sent, or it is malformed, unknown, revoked or an expired account token.";
+        readonly api_key_expired: "The API key is past its expiry (or the grace of the rotation that replaced it).";
+        readonly missing_scope: "The API key lacks the scope the operation needs.";
+        readonly role_forbidden: "The member's role does not allow the operation.";
+        readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
+        readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
+        readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
+        readonly overloaded: "The API is shedding load; retry after Retry-After.";
+        readonly payload_too_large: "The request body is larger than the API accepts.";
+        readonly internal_error: "An unexpected failure on our side.";
+        readonly invalid_idempotency_key: "POST only: the Idempotency-Key header is not 1 to 255 printable ASCII characters.";
+        readonly idempotency_key_reused: "POST only: the Idempotency-Key was used in the last 24 hours with another method, path or body.";
+        readonly idempotency_key_in_progress: "POST only: the request first sent with this Idempotency-Key has not been answered yet.";
+    }>>, Record<never, never>>;
+    update: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<import("zod").ZodObject<{
+        bodyStorage: import("zod").ZodOptional<import("zod").ZodEnum<{
+            none: "none";
+            cache: "cache";
+            full: "full";
+        }>>;
+        syncWindowDays: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
+        calendarEnabled: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        contactsEnabled: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        undoSendSeconds: import("zod").ZodOptional<import("zod").ZodNumber>;
+        trackOpens: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        trackClicks: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        trackingHoneypot: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        optOutHandling: import("zod").ZodOptional<import("zod").ZodEnum<{
+            off: "off";
+            review: "review";
+            suppress: "suppress";
+        }>>;
+        eventRetentionDays: import("zod").ZodOptional<import("zod").ZodNumber>;
+        redirectUris: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodURL>>;
+        aiReplyClassification: import("zod").ZodOptional<import("zod").ZodBoolean>;
+    }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+        bodyStorage: import("zod").ZodEnum<{
+            none: "none";
+            cache: "cache";
+            full: "full";
+        }>;
+        syncWindowDays: import("zod").ZodNullable<import("zod").ZodNumber>;
+        calendarEnabled: import("zod").ZodBoolean;
+        contactsEnabled: import("zod").ZodBoolean;
+        undoSendSeconds: import("zod").ZodNumber;
+        trackOpens: import("zod").ZodBoolean;
+        trackClicks: import("zod").ZodBoolean;
+        trackingHoneypot: import("zod").ZodBoolean;
+        optOutHandling: import("zod").ZodEnum<{
+            off: "off";
+            review: "review";
+            suppress: "suppress";
+        }>;
+        eventRetentionDays: import("zod").ZodNumber;
+        redirectUris: import("zod").ZodArray<import("zod").ZodURL>;
+        aiReplyClassification: import("zod").ZodBoolean;
+    }, import("zod/v4/core").$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, import("../errors.js").DeclaredErrors<{
+        readonly invalid_input: "The request does not match the operation's input schema (a malformed body included); data.issues names each problem.";
+        readonly unauthenticated: "No usable credential: none was sent, or it is malformed, unknown, revoked or an expired account token.";
+        readonly api_key_expired: "The API key is past its expiry (or the grace of the rotation that replaced it).";
+        readonly missing_scope: "The API key lacks the scope the operation needs.";
+        readonly role_forbidden: "The member's role does not allow the operation.";
+        readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
+        readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
+        readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
+        readonly overloaded: "The API is shedding load; retry after Retry-After.";
+        readonly payload_too_large: "The request body is larger than the API accepts.";
+        readonly internal_error: "An unexpected failure on our side.";
+        readonly invalid_idempotency_key: "POST only: the Idempotency-Key header is not 1 to 255 printable ASCII characters.";
+        readonly idempotency_key_reused: "POST only: the Idempotency-Key was used in the last 24 hours with another method, path or body.";
+        readonly idempotency_key_in_progress: "POST only: the request first sent with this Idempotency-Key has not been answered yet.";
+    }>>, {
+        redirect_uri_not_allowed: {
+            status: 400;
+            message: string;
+        };
+        plan_limit_storage: {
+            status: 403;
+            message: string;
+        };
+        storage_unavailable: {
+            status: 400;
+            message: string;
+        };
+    }>, Record<never, never>>;
+};

package/contract/suppressions/models.d.ts

@@ -0,0 +1,231 @@
+import * as z from "zod";
+/** The list every send that names a list consults. Not a name a send can give. */
+export declare const GLOBAL_LIST_ID = "global";
+/** The built-in global list's name; it cannot be renamed. */
+export declare const GLOBAL_LIST_NAME = "Everyone (global)";
+/** A hostname label, as EmailEngine's listId: letters, digits and inner hyphens, 1 to 63. */
+export declare const LIST_ID_PATTERN: RegExp;
+/** A list id as the suppression routes take it: a named list or "global". Case-insensitive. */
+export declare const SuppressionListId: z.ZodString;
+/** A list a send names: a hostname label other than "global". */
+export declare const ListId: z.ZodString;
+/** unsubscribe: the recipient's one-click POST or the confirm page; bounce: a permanent bounce
+ * saying the address is gone; api: POST /v1/suppressions/{listId}/entries; reply: a reply asking to opt
+ * out; complaint: an abuse report (ARF) from the recipient's provider; inactive: an auto-reply
+ * saying the person is no longer at this address. reply, complaint and inactive are detected, and
+ * land per the tenant's optOutHandling. */
+export declare const SuppressionSource: z.ZodEnum<{
+    api: "api";
+    bounce: "bounce";
+    unsubscribe: "unsubscribe";
+    reply: "reply";
+    complaint: "complaint";
+    inactive: "inactive";
+}>;
+export type SuppressionSource = z.infer<typeof SuppressionSource>;
+/** Opt-outs detected in mail rather than stated by a link: see optOutHandling. inactive (an
+ * auto-reply saying the person left or moved to another address) always waits for review. */
+export declare const DetectedOptOutSource: z.ZodEnum<{
+    reply: "reply";
+    complaint: "complaint";
+    inactive: "inactive";
+}>;
+export type DetectedOptOutSource = z.infer<typeof DetectedOptOutSource>;
+export declare const SuppressionEntry: z.ZodObject<{
+    address: z.ZodString;
+    source: z.ZodEnum<{
+        api: "api";
+        bounce: "bounce";
+        unsubscribe: "unsubscribe";
+        reply: "reply";
+        complaint: "complaint";
+        inactive: "inactive";
+    }>;
+    reason: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodPreprocess<z.ZodDate, Date>;
+}, z.core.$strip>;
+export type SuppressionEntry = z.infer<typeof SuppressionEntry>;
+export declare const SuppressionEntryPage: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        address: z.ZodString;
+        source: z.ZodEnum<{
+            api: "api";
+            bounce: "bounce";
+            unsubscribe: "unsubscribe";
+            reply: "reply";
+            complaint: "complaint";
+            inactive: "inactive";
+        }>;
+        reason: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodPreprocess<z.ZodDate, Date>;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type SuppressionEntryPage = z.infer<typeof SuppressionEntryPage>;
+/** Addresses on a list by source. */
+export declare const SuppressionCounts: z.ZodObject<{
+    unsubscribe: z.ZodNumber;
+    bounce: z.ZodNumber;
+    api: z.ZodNumber;
+    reply: z.ZodNumber;
+    complaint: z.ZodNumber;
+    inactive: z.ZodNumber;
+}, z.core.$strip>;
+export type SuppressionCounts = z.infer<typeof SuppressionCounts>;
+export declare const SuppressionList: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    count: z.ZodNumber;
+    counts: z.ZodObject<{
+        unsubscribe: z.ZodNumber;
+        bounce: z.ZodNumber;
+        api: z.ZodNumber;
+        reply: z.ZodNumber;
+        complaint: z.ZodNumber;
+        inactive: z.ZodNumber;
+    }, z.core.$strip>;
+    createdAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+}, z.core.$strip>;
+export type SuppressionList = z.infer<typeof SuppressionList>;
+export declare const SuppressionListList: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        count: z.ZodNumber;
+        counts: z.ZodObject<{
+            unsubscribe: z.ZodNumber;
+            bounce: z.ZodNumber;
+            api: z.ZodNumber;
+            reply: z.ZodNumber;
+            complaint: z.ZodNumber;
+            inactive: z.ZodNumber;
+        }, z.core.$strip>;
+        createdAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SuppressionListList = z.infer<typeof SuppressionListList>;
+/** A detected opt-out waiting for a person (optOutHandling "review"). */
+export declare const SuppressionReview: z.ZodObject<{
+    id: z.ZodUUID;
+    listId: z.ZodString;
+    address: z.ZodString;
+    source: z.ZodEnum<{
+        reply: "reply";
+        complaint: "complaint";
+        inactive: "inactive";
+    }>;
+    accountId: z.ZodUUID;
+    messageId: z.ZodUUID;
+    probability: z.ZodNumber;
+    alternateContacts: z.ZodArray<z.ZodString>;
+    createdAt: z.ZodPreprocess<z.ZodDate, Date>;
+}, z.core.$strip>;
+export type SuppressionReview = z.infer<typeof SuppressionReview>;
+export declare const SuppressionReviewPage: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        listId: z.ZodString;
+        address: z.ZodString;
+        source: z.ZodEnum<{
+            reply: "reply";
+            complaint: "complaint";
+            inactive: "inactive";
+        }>;
+        accountId: z.ZodUUID;
+        messageId: z.ZodUUID;
+        probability: z.ZodNumber;
+        alternateContacts: z.ZodArray<z.ZodString>;
+        createdAt: z.ZodPreprocess<z.ZodDate, Date>;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type SuppressionReviewPage = z.infer<typeof SuppressionReviewPage>;
+export declare const ListIdInput: z.ZodObject<{
+    listId: z.ZodString;
+}, z.core.$strip>;
+export type ListIdInput = z.infer<typeof ListIdInput>;
+export declare const SuppressionListIdInput: z.ZodObject<{
+    listId: z.ZodString;
+}, z.core.$strip>;
+export type SuppressionListIdInput = z.infer<typeof SuppressionListIdInput>;
+export declare const ReviewIdInput: z.ZodObject<{
+    reviewId: z.ZodUUID;
+}, z.core.$strip>;
+export type ReviewIdInput = z.infer<typeof ReviewIdInput>;
+export declare const CreateSuppressionList: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type CreateSuppressionList = z.infer<typeof CreateSuppressionList>;
+export declare const UpdateSuppressionList: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type UpdateSuppressionList = z.infer<typeof UpdateSuppressionList>;
+export declare const DeleteSuppressionListQuery: z.ZodObject<{
+    withEntries: 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 DeleteSuppressionListQuery = z.infer<typeof DeleteSuppressionListQuery>;
+/** The path's list and the query's options, as a DELETE takes them. */
+export declare const DeleteSuppressionListInput: z.ZodObject<{
+    params: z.ZodObject<{
+        listId: z.ZodString;
+    }, z.core.$strip>;
+    query: z.ZodObject<{
+        withEntries: 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 DeleteSuppressionListInput = z.infer<typeof DeleteSuppressionListInput>;
+export declare const ListSuppressionEntriesQuery: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    cursor: z.ZodOptional<z.ZodString>;
+    address: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodEnum<{
+        api: "api";
+        bounce: "bounce";
+        unsubscribe: "unsubscribe";
+        reply: "reply";
+        complaint: "complaint";
+        inactive: "inactive";
+    }>>;
+}, z.core.$strip>;
+export type ListSuppressionEntriesQuery = z.infer<typeof ListSuppressionEntriesQuery>;
+/** Addresses to put on a list; a repeated address counts once. */
+export declare const AddSuppressionEntriesRequest: z.ZodObject<{
+    addresses: z.ZodArray<z.ZodEmail>;
+    reason: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type AddSuppressionEntriesRequest = z.infer<typeof AddSuppressionEntriesRequest>;
+/** An entry of a list, by its address. Any stored address can be released, including one an
+ * older rule let in. */
+export declare const SuppressionEntryInput: z.ZodObject<{
+    listId: z.ZodString;
+    address: z.ZodString;
+}, z.core.$strip>;
+export type SuppressionEntryInput = z.infer<typeof SuppressionEntryInput>;
+export declare const ListSuppressionReviewsQuery: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    cursor: z.ZodOptional<z.ZodString>;
+    listId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type ListSuppressionReviewsQuery = z.infer<typeof ListSuppressionReviewsQuery>;
+/** added: false when the address was on the list already, which is left as it was. */
+export declare const SuppressionAdded: z.ZodObject<{
+    added: z.ZodBoolean;
+}, z.core.$strip>;
+export type SuppressionAdded = z.infer<typeof SuppressionAdded>;
+/** added: addresses put on the list; alreadyListed: those on it already, left as they were. */
+export declare const SuppressionEntriesAdded: z.ZodObject<{
+    added: z.ZodNumber;
+    alreadyListed: z.ZodNumber;
+}, z.core.$strip>;
+export type SuppressionEntriesAdded = z.infer<typeof SuppressionEntriesAdded>;