samva 0.18.0 → 0.19.0

package/dist/effect/mailboxes.d.ts

@@ -1,5 +1,5 @@
 export { events } from "./internal/mailbox-events";
-export { type MailboxEvent, MailboxEventStreamError, type MailboxEventStreamErrorFields, type MailboxEventStreamErrorTag, type MailboxEventStreamFailure, type MailboxEventStreamOptions, type MailboxEventType, } from "../mailbox-events";
+export { type MailboxEvent, MailboxEventStreamError, type MailboxEventStreamErrorFields, type MailboxEventStreamErrorReason, type MailboxEventStreamErrorTag, type MailboxEventStreamFailure, type MailboxEventStreamOptions, type MailboxEventStreamReconnect, type MailboxEventType, } from "../mailbox-events";
 export declare const list: ((input?: {
     readonly limit?: string | null | undefined;
     readonly cursor?: string | null | undefined;
@@ -2215,6 +2215,17 @@ export declare const listActions: ((input: {
             readonly source: "grant" | "installation" | "policy" | null;
             readonly decidedAt: string;
         } | null;
+        readonly resolution: {
+            readonly outcome: "approved" | "cancelled" | "denied";
+            readonly actor: {
+                readonly kind: "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system" | "user";
+                readonly id: string;
+                readonly displayName?: string | null;
+                readonly source: "extension" | "externalAgent" | "externalApi" | "humanUi" | "system";
+            };
+            readonly resolvedAt: string;
+            readonly reason: string | null;
+        } | null;
         readonly createdAt: string;
         readonly updatedAt: string;
         readonly type: "reply" | "sendMessage";
@@ -2328,6 +2339,17 @@ export declare const listActions: ((input: {
             readonly source: "grant" | "installation" | "policy" | null;
             readonly decidedAt: string;
         } | null;
+        readonly resolution: {
+            readonly outcome: "approved" | "cancelled" | "denied";
+            readonly actor: {
+                readonly kind: "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system" | "user";
+                readonly id: string;
+                readonly displayName?: string | null;
+                readonly source: "extension" | "externalAgent" | "externalApi" | "humanUi" | "system";
+            };
+            readonly resolvedAt: string;
+            readonly reason: string | null;
+        } | null;
         readonly createdAt: string;
         readonly updatedAt: string;
         readonly type: "assignThread" | "call" | "changeThreadState" | "createNote" | "extensionRequest" | "updateDraft";
@@ -2361,6 +2383,17 @@ export declare const listActions: ((input: {
                 readonly source: "grant" | "installation" | "policy" | null;
                 readonly decidedAt: string;
             } | null;
+            readonly resolution: {
+                readonly outcome: "approved" | "cancelled" | "denied";
+                readonly actor: {
+                    readonly kind: "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system" | "user";
+                    readonly id: string;
+                    readonly displayName?: string | null;
+                    readonly source: "extension" | "externalAgent" | "externalApi" | "humanUi" | "system";
+                };
+                readonly resolvedAt: string;
+                readonly reason: string | null;
+            } | null;
             readonly createdAt: string;
             readonly updatedAt: string;
             readonly type: "reply" | "sendMessage";
@@ -2474,6 +2507,17 @@ export declare const listActions: ((input: {
                 readonly source: "grant" | "installation" | "policy" | null;
                 readonly decidedAt: string;
             } | null;
+            readonly resolution: {
+                readonly outcome: "approved" | "cancelled" | "denied";
+                readonly actor: {
+                    readonly kind: "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system" | "user";
+                    readonly id: string;
+                    readonly displayName?: string | null;
+                    readonly source: "extension" | "externalAgent" | "externalApi" | "humanUi" | "system";
+                };
+                readonly resolvedAt: string;
+                readonly reason: string | null;
+            } | null;
             readonly createdAt: string;
             readonly updatedAt: string;
             readonly type: "assignThread" | "call" | "changeThreadState" | "createNote" | "extensionRequest" | "updateDraft";
@@ -2506,6 +2550,17 @@ export declare const listActions: ((input: {
             readonly source: "grant" | "installation" | "policy" | null;
             readonly decidedAt: string;
         } | null;
+        readonly resolution: {
+            readonly outcome: "approved" | "cancelled" | "denied";
+            readonly actor: {
+                readonly kind: "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system" | "user";
+                readonly id: string;
+                readonly displayName?: string | null;
+                readonly source: "extension" | "externalAgent" | "externalApi" | "humanUi" | "system";
+            };
+            readonly resolvedAt: string;
+            readonly reason: string | null;
+        } | null;
         readonly createdAt: string;
         readonly updatedAt: string;
         readonly type: "reply" | "sendMessage";
@@ -2619,6 +2674,17 @@ export declare const listActions: ((input: {
             readonly source: "grant" | "installation" | "policy" | null;
             readonly decidedAt: string;
         } | null;
+        readonly resolution: {
+            readonly outcome: "approved" | "cancelled" | "denied";
+            readonly actor: {
+                readonly kind: "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system" | "user";
+                readonly id: string;
+                readonly displayName?: string | null;
+                readonly source: "extension" | "externalAgent" | "externalApi" | "humanUi" | "system";
+            };
+            readonly resolvedAt: string;
+            readonly reason: string | null;
+        } | null;
         readonly createdAt: string;
         readonly updatedAt: string;
         readonly type: "assignThread" | "call" | "changeThreadState" | "createNote" | "extensionRequest" | "updateDraft";
@@ -2645,6 +2711,17 @@ export declare const getAction: (input: {
         readonly source: "grant" | "installation" | "policy" | null;
         readonly decidedAt: string;
     } | null;
+    readonly resolution: {
+        readonly outcome: "approved" | "cancelled" | "denied";
+        readonly actor: {
+            readonly kind: "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system" | "user";
+            readonly id: string;
+            readonly displayName?: string | null;
+            readonly source: "extension" | "externalAgent" | "externalApi" | "humanUi" | "system";
+        };
+        readonly resolvedAt: string;
+        readonly reason: string | null;
+    } | null;
     readonly createdAt: string;
     readonly updatedAt: string;
     readonly type: "reply" | "sendMessage";
@@ -2758,6 +2835,17 @@ export declare const getAction: (input: {
         readonly source: "grant" | "installation" | "policy" | null;
         readonly decidedAt: string;
     } | null;
+    readonly resolution: {
+        readonly outcome: "approved" | "cancelled" | "denied";
+        readonly actor: {
+            readonly kind: "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system" | "user";
+            readonly id: string;
+            readonly displayName?: string | null;
+            readonly source: "extension" | "externalAgent" | "externalApi" | "humanUi" | "system";
+        };
+        readonly resolvedAt: string;
+        readonly reason: string | null;
+    } | null;
     readonly createdAt: string;
     readonly updatedAt: string;
     readonly type: "assignThread" | "call" | "changeThreadState" | "createNote" | "extensionRequest" | "updateDraft";
@@ -3063,6 +3151,17 @@ export declare const approveAction: (input: {
         readonly source: "grant" | "installation" | "policy" | null;
         readonly decidedAt: string;
     } | null;
+    readonly resolution: {
+        readonly outcome: "approved" | "cancelled" | "denied";
+        readonly actor: {
+            readonly kind: "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system" | "user";
+            readonly id: string;
+            readonly displayName?: string | null;
+            readonly source: "extension" | "externalAgent" | "externalApi" | "humanUi" | "system";
+        };
+        readonly resolvedAt: string;
+        readonly reason: string | null;
+    } | null;
     readonly createdAt: string;
     readonly updatedAt: string;
     readonly type: "reply" | "sendMessage";
@@ -3176,6 +3275,17 @@ export declare const approveAction: (input: {
         readonly source: "grant" | "installation" | "policy" | null;
         readonly decidedAt: string;
     } | null;
+    readonly resolution: {
+        readonly outcome: "approved" | "cancelled" | "denied";
+        readonly actor: {
+            readonly kind: "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system" | "user";
+            readonly id: string;
+            readonly displayName?: string | null;
+            readonly source: "extension" | "externalAgent" | "externalApi" | "humanUi" | "system";
+        };
+        readonly resolvedAt: string;
+        readonly reason: string | null;
+    } | null;
     readonly createdAt: string;
     readonly updatedAt: string;
     readonly type: "assignThread" | "call" | "changeThreadState" | "createNote" | "extensionRequest" | "updateDraft";
@@ -3202,6 +3312,17 @@ export declare const denyAction: (input: {
         readonly source: "grant" | "installation" | "policy" | null;
         readonly decidedAt: string;
     } | null;
+    readonly resolution: {
+        readonly outcome: "approved" | "cancelled" | "denied";
+        readonly actor: {
+            readonly kind: "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system" | "user";
+            readonly id: string;
+            readonly displayName?: string | null;
+            readonly source: "extension" | "externalAgent" | "externalApi" | "humanUi" | "system";
+        };
+        readonly resolvedAt: string;
+        readonly reason: string | null;
+    } | null;
     readonly createdAt: string;
     readonly updatedAt: string;
     readonly type: "reply" | "sendMessage";
@@ -3315,6 +3436,17 @@ export declare const denyAction: (input: {
         readonly source: "grant" | "installation" | "policy" | null;
         readonly decidedAt: string;
     } | null;
+    readonly resolution: {
+        readonly outcome: "approved" | "cancelled" | "denied";
+        readonly actor: {
+            readonly kind: "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system" | "user";
+            readonly id: string;
+            readonly displayName?: string | null;
+            readonly source: "extension" | "externalAgent" | "externalApi" | "humanUi" | "system";
+        };
+        readonly resolvedAt: string;
+        readonly reason: string | null;
+    } | null;
     readonly createdAt: string;
     readonly updatedAt: string;
     readonly type: "assignThread" | "call" | "changeThreadState" | "createNote" | "extensionRequest" | "updateDraft";

package/dist/effect/messages.d.ts

@@ -455,6 +455,11 @@ export declare const listDeliveries: (input: {
             readonly message: string | null;
             readonly retryable: boolean | null;
         } | null;
+        readonly estimatedProviderCost: {
+            readonly amount: string;
+            readonly currency: string;
+            readonly billingMode: "pass_through";
+        } | null;
         readonly createdAt: string;
         readonly updatedAt: string;
     }[];

package/dist/effect/organizations.d.ts

@@ -5,7 +5,7 @@ export declare const create: (input: {
     readonly billingAccountId: string;
     readonly name: string;
     readonly slug: string;
-    readonly countryCode: string;
+    readonly defaultRegion: string | null;
     readonly timezone: string;
     readonly plan: string;
     readonly isActive: boolean;
@@ -30,7 +30,7 @@ export declare const get: (_?: never) => import("effect/Effect").Effect<{
     readonly billingAccountId: string;
     readonly name: string;
     readonly slug: string;
-    readonly countryCode: string;
+    readonly defaultRegion: string | null;
     readonly timezone: string;
     readonly plan: string;
     readonly isActive: boolean;
@@ -88,7 +88,7 @@ export declare const getTrustTier: (_?: never) => import("effect/Effect").Effect
 export declare const update: (input?: {
     readonly name?: string | null | undefined;
     readonly slug?: string | null | undefined;
-    readonly countryCode?: string | null | undefined;
+    readonly defaultRegion?: string | null | undefined;
     readonly timezone?: string | null | undefined;
     readonly isActive?: boolean | null | undefined;
     readonly metadata?: {
@@ -125,7 +125,7 @@ export declare const update: (input?: {
     readonly billingAccountId: string;
     readonly name: string;
     readonly slug: string;
-    readonly countryCode: string;
+    readonly defaultRegion: string | null;
     readonly timezone: string;
     readonly plan: string;
     readonly isActive: boolean;

package/dist/effect/unsubscribe-groups.d.ts

@@ -60,9 +60,8 @@ export declare const listMembers: ((input: {
     readonly cursor?: string | null | undefined;
 }) => import("effect/Effect").Effect<{
     readonly items: readonly {
-        readonly id: string;
-        readonly email: string;
-        readonly contactId: string | null;
+        readonly id: string & import("effect/Brand").Brand<"UnsubscribeGroupMemberId">;
+        readonly contactId: string & import("effect/Brand").Brand<"ContactId">;
         readonly source: "api" | "complaint" | "link" | "manual";
         readonly unsubscribedAt: string;
         readonly createdAt: string;
@@ -75,9 +74,8 @@ export declare const listMembers: ((input: {
         readonly cursor?: string | null | undefined;
     }) => import("effect/Stream").Stream<{
         readonly items: readonly {
-            readonly id: string;
-            readonly email: string;
-            readonly contactId: string | null;
+            readonly id: string & import("effect/Brand").Brand<"UnsubscribeGroupMemberId">;
+            readonly contactId: string & import("effect/Brand").Brand<"ContactId">;
             readonly source: "api" | "complaint" | "link" | "manual";
             readonly unsubscribedAt: string;
             readonly createdAt: string;
@@ -89,33 +87,46 @@ export declare const listMembers: ((input: {
         readonly limit?: string | null | undefined;
         readonly cursor?: string | null | undefined;
     }) => import("effect/Stream").Stream<{
-        readonly id: string;
-        readonly email: string;
-        readonly contactId: string | null;
+        readonly id: string & import("effect/Brand").Brand<"UnsubscribeGroupMemberId">;
+        readonly contactId: string & import("effect/Brand").Brand<"ContactId">;
         readonly source: "api" | "complaint" | "link" | "manual";
         readonly unsubscribedAt: string;
         readonly createdAt: string;
     }, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
 };
-export declare const addEmails: (input: {
+export declare const addMembers: (input: {
     readonly id: string;
-    readonly emails: readonly string[];
+    readonly members: readonly ({
+        readonly contactId: string;
+    } | {
+        readonly email: string;
+    } | {
+        readonly phone: string;
+    })[];
     readonly source?: "api" | "complaint" | "link" | "manual" | null | undefined;
 }) => import("effect/Effect").Effect<{
     readonly added: number;
     readonly skipped: number;
-}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
-export declare const removeEmails: (input: {
+}, import("./errors").BillingProviderError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").PaymentRequiredError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
+export declare const removeMembers: (input: {
     readonly id: string;
-    readonly emails: readonly string[];
+    readonly members: readonly ({
+        readonly contactId: string;
+    } | {
+        readonly email: string;
+    } | {
+        readonly phone: string;
+    })[];
 }) => import("effect/Effect").Effect<{
     readonly removed: number;
 }, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
-export declare const checkSubscription: (input: {
-    readonly email: string;
+export declare const checkSubscription: (input?: {
+    readonly contactId?: string | null | undefined;
+    readonly email?: string | null | undefined;
+    readonly phone?: string | null | undefined;
     readonly groupIds?: string | null | undefined;
-}) => import("effect/Effect").Effect<{
-    readonly email: string;
+} | undefined) => import("effect/Effect").Effect<{
+    readonly contactId: (string & import("effect/Brand").Brand<"ContactId">) | null;
     readonly unsubscribedGroups: readonly {
         readonly groupId: string;
         readonly groupName: string;

package/dist/effect/unsubscribe-groups.js

@@ -3,13 +3,13 @@ import { forGroup } from "./internal/operation.js";
 import { UnsubscribeGroupsGroup } from "./generated/unsubscribe-groups.js";
 //#region src/effect/unsubscribe-groups.ts
 var unsubscribe_groups_exports = /* @__PURE__ */ __exportAll({
-	addEmails: () => addEmails,
+	addMembers: () => addMembers,
 	checkSubscription: () => checkSubscription,
 	create: () => create,
 	list: () => list,
 	listMembers: () => listMembers,
 	remove: () => remove,
-	removeEmails: () => removeEmails,
+	removeMembers: () => removeMembers,
 	setDefault: () => setDefault,
 	update: () => update
 });
@@ -20,10 +20,10 @@ const update = /* @__PURE__ */ make("unsubscribeUpdate");
 const remove = /* @__PURE__ */ make("unsubscribeRemove");
 const setDefault = /* @__PURE__ */ make("unsubscribeSetDefault");
 const listMembers = /* @__PURE__ */ make("unsubscribeListMembers");
-const addEmails = /* @__PURE__ */ make("unsubscribeAddEmails");
-const removeEmails = /* @__PURE__ */ make("unsubscribeRemoveEmails");
+const addMembers = /* @__PURE__ */ make("unsubscribeAddMembers");
+const removeMembers = /* @__PURE__ */ make("unsubscribeRemoveMembers");
 const checkSubscription = /* @__PURE__ */ make("unsubscribeCheckSubscription");
 //#endregion
-export { addEmails, checkSubscription, create, list, listMembers, remove, removeEmails, setDefault, unsubscribe_groups_exports, update };
+export { addMembers, checkSubscription, create, list, listMembers, remove, removeMembers, setDefault, unsubscribe_groups_exports, update };
 
 //# sourceMappingURL=unsubscribe-groups.js.map

package/dist/effect/webhooks.d.ts

@@ -9,7 +9,7 @@ export declare const list: ((input?: {
         readonly id: string & import("effect/Brand").Brand<"WebhookEndpointId">;
         readonly name: string;
         readonly url: string;
-        readonly eventTypes: readonly ("contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
+        readonly eventTypes: readonly ("contact.consent_changed" | "contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.action.resolved" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
         readonly channels: readonly "email"[] | null;
         readonly mailboxIds: readonly (string & import("effect/Brand").Brand<"MailboxId">)[] | null;
         readonly namespaceId: (string & import("effect/Brand").Brand<"NamespaceId">) | null;
@@ -39,7 +39,7 @@ export declare const list: ((input?: {
             readonly id: string & import("effect/Brand").Brand<"WebhookEndpointId">;
             readonly name: string;
             readonly url: string;
-            readonly eventTypes: readonly ("contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
+            readonly eventTypes: readonly ("contact.consent_changed" | "contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.action.resolved" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
             readonly channels: readonly "email"[] | null;
             readonly mailboxIds: readonly (string & import("effect/Brand").Brand<"MailboxId">)[] | null;
             readonly namespaceId: (string & import("effect/Brand").Brand<"NamespaceId">) | null;
@@ -68,7 +68,7 @@ export declare const list: ((input?: {
         readonly id: string & import("effect/Brand").Brand<"WebhookEndpointId">;
         readonly name: string;
         readonly url: string;
-        readonly eventTypes: readonly ("contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
+        readonly eventTypes: readonly ("contact.consent_changed" | "contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.action.resolved" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
         readonly channels: readonly "email"[] | null;
         readonly mailboxIds: readonly (string & import("effect/Brand").Brand<"MailboxId">)[] | null;
         readonly namespaceId: (string & import("effect/Brand").Brand<"NamespaceId">) | null;
@@ -90,7 +90,7 @@ export declare const list: ((input?: {
 export declare const create: (input: {
     readonly name: string;
     readonly url: string;
-    readonly eventTypes: readonly ("contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
+    readonly eventTypes: readonly ("contact.consent_changed" | "contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.action.resolved" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
     readonly channels?: readonly "email"[] | null | undefined;
     readonly mailboxIds?: readonly string[] | null | undefined;
     readonly namespaceId?: string | null | undefined;
@@ -103,7 +103,7 @@ export declare const create: (input: {
         readonly id: string & import("effect/Brand").Brand<"WebhookEndpointId">;
         readonly name: string;
         readonly url: string;
-        readonly eventTypes: readonly ("contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
+        readonly eventTypes: readonly ("contact.consent_changed" | "contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.action.resolved" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
         readonly channels: readonly "email"[] | null;
         readonly mailboxIds: readonly (string & import("effect/Brand").Brand<"MailboxId">)[] | null;
         readonly namespaceId: (string & import("effect/Brand").Brand<"NamespaceId">) | null;
@@ -122,7 +122,7 @@ export declare const get: (input: {
     readonly id: string & import("effect/Brand").Brand<"WebhookEndpointId">;
     readonly name: string;
     readonly url: string;
-    readonly eventTypes: readonly ("contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
+    readonly eventTypes: readonly ("contact.consent_changed" | "contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.action.resolved" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
     readonly channels: readonly "email"[] | null;
     readonly mailboxIds: readonly (string & import("effect/Brand").Brand<"MailboxId">)[] | null;
     readonly namespaceId: (string & import("effect/Brand").Brand<"NamespaceId">) | null;
@@ -142,7 +142,7 @@ export declare const update: (input: {
     readonly id: string;
     readonly name?: string | null | undefined;
     readonly url?: string | null | undefined;
-    readonly eventTypes?: readonly ("contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[] | null | undefined;
+    readonly eventTypes?: readonly ("contact.consent_changed" | "contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.action.resolved" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[] | null | undefined;
     readonly channels?: readonly "email"[] | null | undefined;
     readonly mailboxIds?: readonly string[] | null | undefined;
     readonly namespaceId?: string | null | undefined;
@@ -154,7 +154,7 @@ export declare const update: (input: {
     readonly id: string & import("effect/Brand").Brand<"WebhookEndpointId">;
     readonly name: string;
     readonly url: string;
-    readonly eventTypes: readonly ("contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
+    readonly eventTypes: readonly ("contact.consent_changed" | "contact.created" | "contact.deleted" | "contact.resubscribed" | "contact.subscribed" | "contact.unsubscribed" | "contact.updated" | "conversation.archived" | "conversation.created" | "conversation.updated" | "domain.updated" | "domain.warming.updated" | "journey.webhook" | "mailbox.action.pending_approval" | "mailbox.action.resolved" | "mailbox.message.discarded" | "mailbox.message.quarantined" | "mailbox.message.received" | "mailbox.message.released" | "mailbox.message.sent" | "message.bounced" | "message.clicked" | "message.complained" | "message.delivered" | "message.failed" | "message.opened" | "message.read" | "message.received" | "message.sent" | "webhook.created" | "webhook.deleted" | "webhook.test" | "webhook.updated")[];
     readonly channels: readonly "email"[] | null;
     readonly mailboxIds: readonly (string & import("effect/Brand").Brand<"MailboxId">)[] | null;
     readonly namespaceId: (string & import("effect/Brand").Brand<"NamespaceId">) | null;

package/dist/mailbox-events.d.ts

@@ -5,7 +5,8 @@
  * {@link MailboxEventStream} is an async iterable. The loop body handling an event is the
  * acknowledgement: asking for the next event marks the previous one handled, and the stream
  * resumes from the last handled event whenever it reconnects. Transient closes reconnect by
- * themselves; a close the caller has to act on ends the loop with a {@link MailboxEventStreamError}.
+ * themselves, and a normal close (1000) from the host ends the loop after the events already
+ * received; a close the caller has to act on ends the loop with a {@link MailboxEventStreamError}.
  *
  * This module has no runtime dependencies so the Promise and Effect clients share it.
  */
@@ -29,7 +30,7 @@ export declare const MailboxEventStreamCloseCode: {
     readonly accessUnavailable: 4503;
 };
 /** The event types the stream carries: the `mailbox.*` webhook events. */
-export type MailboxEventType = "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded";
+export type MailboxEventType = "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.action.resolved" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded";
 /** One event, as a webhook delivery of it would carry it, plus its stream position. */
 export interface MailboxEvent {
     /** The stream position of this event. Persist it after handling to resume from here. */
@@ -44,12 +45,19 @@ export interface MailboxEvent {
 /**
  * Why a stream ended, as the `_tag` of its {@link MailboxEventStreamError}. The first nine are the
  * API error tags the events host refuses with, or that a close code stands for. The rest are the
- * client's own: `StreamDisconnectedError` is a close or an unreachable host that was not retried
- * because `reconnect` is `false`, `StreamClientError` is a request this client could not make,
+ * client's own: `StreamDisconnectedError` is a close, an idle timeout, or an unreachable host that
+ * was not retried because `reconnect` is `false`, `StreamClientError` is a request this client could not make,
  * `StreamProtocolError` is a frame from the host it could not read, and `StreamRefusedError` is a refusal whose tag and status this client
  * does not know (`serverTag` carries the tag the host sent).
  */
 export type MailboxEventStreamErrorTag = "UnauthorizedError" | "ForbiddenError" | "ResourceNotFoundError" | "CursorExpiredError" | "ValidationError" | "UpgradeRequiredError" | "RateLimitedError" | "ServiceUnavailableError" | "MethodNotAllowedError" | "StreamDisconnectedError" | "StreamClientError" | "StreamProtocolError" | "StreamRefusedError";
+/**
+ * Why a {@link MailboxEventStreamError} ended a stream, when `_tag` alone does not say.
+ * `idleTimeout`: the client heard no frame, not even a pong, for
+ * {@link MAILBOX_EVENT_STREAM_IDLE_MILLIS}, so it closed the connection itself. No close code
+ * accompanies it; a `closeCode` of `1006` is a close the client observed without a status.
+ */
+export type MailboxEventStreamErrorReason = "idleTimeout";
 /** Field-level validation messages, keyed by dotted path, as a `ValidationError` carries them. */
 export type MailboxEventStreamErrorFields = Readonly<Record<string, ReadonlyArray<string>>>;
 /**
@@ -76,6 +84,8 @@ export declare class MailboxEventStreamError<Tag extends MailboxEventStreamError
     readonly retryAfterSeconds: number | undefined;
     /** The tag the host sent, when it is not one this client maps. */
     readonly serverTag: string | undefined;
+    /** Set when the client ended the connection itself; see {@link MailboxEventStreamErrorReason}. */
+    readonly reason: MailboxEventStreamErrorReason | undefined;
     constructor(input: {
         readonly _tag: Tag;
         readonly message: string;
@@ -85,6 +95,7 @@ export declare class MailboxEventStreamError<Tag extends MailboxEventStreamError
         readonly fields?: MailboxEventStreamErrorFields | undefined;
         readonly retryAfterSeconds?: number | undefined;
         readonly serverTag?: string | undefined;
+        readonly reason?: MailboxEventStreamErrorReason | undefined;
     });
 }
 /** Every stream error as a union over `_tag`, so `Effect.catchTag` can narrow it. */
@@ -113,6 +124,17 @@ export interface MailboxEventStreamSocket {
 export type MailboxEventStreamWebSocket = new (url: string, options: {
     readonly headers: Readonly<Record<string, string>>;
 }) => MailboxEventStreamSocket;
+/** A reconnect the stream is about to make. */
+export interface MailboxEventStreamReconnect {
+    /** Why the connection ended: the error the stream would have ended with had it not retried. */
+    readonly error: MailboxEventStreamError;
+    /** The cursor the next connection resumes from; undefined when the stream started live and has none yet. */
+    readonly cursor: string | undefined;
+    /** Failed attempts in a row, starting at 1; a connection that went live resets it. */
+    readonly attempt: number;
+    /** How long the stream waits before connecting again. */
+    readonly delayMillis: number;
+}
 export interface MailboxEventStreamOptions {
     /** Resume after this cursor: every retained event after it, then live. Omit to start live. */
     readonly cursor?: string | undefined;
@@ -124,6 +146,11 @@ export interface MailboxEventStreamOptions {
     readonly onLive?: (() => void) | undefined;
     /** Reconnect after transient closes. Defaults to `true`. */
     readonly reconnect?: boolean | undefined;
+    /**
+     * Called when a transient failure ends a connection and the stream is about to reconnect from
+     * its last handled cursor, before the backoff wait. Never called when `reconnect` is `false`.
+     */
+    readonly onReconnect?: ((reconnect: MailboxEventStreamReconnect) => void) | undefined;
     /**
      * The events origin, such as `wss://events.samva.dev`. Defaults to the API origin with its
      * `api` host label replaced by `events`.