@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/mailboxes.md

@@ -0,0 +1,1690 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.mailboxes`: Mailboxes
+
+38 operations (15 read, 14 write, 6 destructive, 3 billable).
+
+5 of these also have a hand-written method (`g8.mailboxes`), marked **★** below. Prefer the hand-written method when one exists: it unwraps the `data` envelope and takes friendlier arguments. See [../sdk-clients.md](../sdk-clients.md).
+
+Every example below assumes this setup (server-side, API key):
+
+```ts
+import { g8 } from "@graph8/sdk";
+
+g8.init({ apiKey: process.env.G8_API_KEY! });
+```
+
+Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
+
+Exact TypeScript types for every operation on this page, and every schema they use: [mailboxes.d.ts](mailboxes.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`archiveMailbox`](#op-archivemailbox) | `POST /api/v1/mailboxes/{mailbox_id}/archive` | destructive | `campaigns:delete` | Archive Mailbox |
+| [`archivePersona`](#op-archivepersona) | `DELETE /api/v1/mailboxes/personas/{persona_id}` | destructive | `campaigns:delete` | Archive Persona |
+| [`bulkImportMailboxes`](#op-bulkimportmailboxes) | `POST /api/v1/mailboxes/bulk-import` | write | `campaigns:write` | Bulk Import Mailboxes |
+| [`createMailbox`](#op-createmailbox) ★ | `POST /api/v1/mailboxes` | write | `campaigns:write` | Create Mailbox |
+| [`createPlacementTest`](#op-createplacementtest) | `POST /api/v1/placement/tests` | billable | `campaigns:run` | Create Placement Test |
+| [`createSenderPersona`](#op-createsenderpersona) | `POST /api/v1/mailboxes/personas` | write | `campaigns:write` | Create Sender Persona |
+| [`deleteMailbox`](#op-deletemailbox) ★ | `DELETE /api/v1/mailboxes/{mailbox_id}` | destructive | `campaigns:delete` | Delete Mailbox |
+| [`deleteScheduledPlacementTest`](#op-deletescheduledplacementtest) | `DELETE /api/v1/placement/scheduled/{schedule_id}` | destructive | `campaigns:delete` | Delete Scheduled Placement Test |
+| [`deleteWarmup`](#op-deletewarmup) | `DELETE /api/v1/warmup/{mailbox_id}` | destructive | `campaigns:delete` | Delete Warmup |
+| [`disableWarmup`](#op-disablewarmup) | `POST /api/v1/warmup/{mailbox_id}/disable` | write | `campaigns:write` | Disable Warmup |
+| [`enableWarmup`](#op-enablewarmup) | `POST /api/v1/warmup/{mailbox_id}/enable` | write | `campaigns:write` | Enable Warmup |
+| [`estimatePlacementTestCost`](#op-estimateplacementtestcost) | `POST /api/v1/placement/tests/estimate` | read | `campaigns:read` | Estimate Placement Test Cost |
+| [`getFleetHealth`](#op-getfleethealth) | `GET /api/v1/mailboxes/fleet-health` | read | `campaigns:read` | Get Fleet Health |
+| [`getMailbox`](#op-getmailbox) ★ | `GET /api/v1/mailboxes/{mailbox_id}` | read | `campaigns:read` | Get Mailbox |
+| [`getMailboxAssociatedSequences`](#op-getmailboxassociatedsequences) | `GET /api/v1/mailboxes/{mailbox_id}/associated-sequences` | read | `campaigns:read` | Get Mailbox Associated Sequences |
+| [`getMailboxHealth`](#op-getmailboxhealth) | `GET /api/v1/mailboxes/{mailbox_id}/health` | read | `campaigns:read` | Get Mailbox Health |
+| [`getPlacementDomainStats`](#op-getplacementdomainstats) | `GET /api/v1/placement/domains/stats` | read | `campaigns:read` | Get Placement Domain Stats |
+| [`getPlacementDomainSummary`](#op-getplacementdomainsummary) | `GET /api/v1/placement/domains/{domain_id}/summary` | read | `campaigns:read` | Get Placement Domain Summary |
+| [`getPlacementTest`](#op-getplacementtest) | `GET /api/v1/placement/tests/{test_id}` | read | `campaigns:read` | Get Placement Test |
+| [`getScheduledPlacementTest`](#op-getscheduledplacementtest) | `GET /api/v1/placement/scheduled/{schedule_id}` | read | `campaigns:read` | Get Scheduled Placement Test |
+| [`getSenderPersona`](#op-getsenderpersona) | `GET /api/v1/mailboxes/personas/{persona_id}` | read | `campaigns:read` | Get Sender Persona |
+| [`getWarmupAnalytics`](#op-getwarmupanalytics) | `GET /api/v1/warmup/{mailbox_id}/analytics` | read | `campaigns:read` | Get Warmup Analytics |
+| [`listMyMailboxes`](#op-listmymailboxes) | `GET /api/v1/mailboxes/my` | read | `campaigns:read` | List My Mailboxes |
+| [`listPlacementTests`](#op-listplacementtests) | `GET /api/v1/placement/tests` | read | `campaigns:read` | List Placement Tests |
+| [`listScheduledPlacementTests`](#op-listscheduledplacementtests) | `GET /api/v1/placement/scheduled` | read | `campaigns:read` | List Scheduled Placement Tests |
+| [`listSenderPersonas`](#op-listsenderpersonas) | `GET /api/v1/mailboxes/personas` | read | `campaigns:read` | List Sender Personas |
+| [`pauseScheduledPlacementTest`](#op-pausescheduledplacementtest) | `POST /api/v1/placement/scheduled/{schedule_id}/pause` | write | `campaigns:write` | Pause Scheduled Placement Test |
+| [`requestMailboxCancellation`](#op-requestmailboxcancellation) | `POST /api/v1/mailboxes/{mailbox_id}/request-cancellation` | destructive | `campaigns:delete` | Request Mailbox Cancellation |
+| [`resumeScheduledPlacementTest`](#op-resumescheduledplacementtest) | `POST /api/v1/placement/scheduled/{schedule_id}/resume` | write | `campaigns:write` | Resume Scheduled Placement Test |
+| [`runMailboxPlacementTest`](#op-runmailboxplacementtest) | `POST /api/v1/mailboxes/{mailbox_id}/health/placement-test` | billable | `campaigns:run` | Run Mailbox Placement Test |
+| [`setupWarmup`](#op-setupwarmup) | `POST /api/v1/warmup/setup` | write | `campaigns:write` | Setup Warmup |
+| [`shareMailbox`](#op-sharemailbox) | `POST /api/v1/mailboxes/{mailbox_id}/share` | write | `campaigns:write` | Share Mailbox |
+| [`testMailboxConnection`](#op-testmailboxconnection) ★ | `POST /api/v1/mailboxes/{mailbox_id}/test-connection` | write | `campaigns:write` | Test Mailbox Connection |
+| [`uncancelMailboxes`](#op-uncancelmailboxes) | `POST /api/v1/mailboxes/uncancel` | billable | `campaigns:run` | Uncancel Mailboxes |
+| [`updateMailbox`](#op-updatemailbox) ★ | `PATCH /api/v1/mailboxes/{mailbox_id}` | write | `campaigns:write` | Update Mailbox |
+| [`updateSenderPersona`](#op-updatesenderpersona) | `PATCH /api/v1/mailboxes/personas/{persona_id}` | write | `campaigns:write` | Update Sender Persona |
+| [`updateWarmupSettings`](#op-updatewarmupsettings) | `PATCH /api/v1/warmup/{mailbox_id}/settings` | write | `campaigns:write` | Update Warmup Settings |
+| [`uploadPersonaPhoto`](#op-uploadpersonaphoto) | `POST /api/v1/mailboxes/personas/{persona_id}/photo` | write | `campaigns:write` | Upload Persona Photo |
+
+---
+
+<a id="op-archivemailbox"></a>
+
+### `g8.api.mailboxes.archiveMailbox(input)`
+
+**Archive Mailbox**
+
+- HTTP: `POST /api/v1/mailboxes/{mailbox_id}/archive`
+- operationId: `archive_mailbox_mailboxes__mailbox_id__archive_post` (also callable as `g8.api.call("archive_mailbox_mailboxes__mailbox_id__archive_post", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+Archive a mailbox, or restore it. Explicit rather than a toggle.
+
+Archiving hides the mailbox from pickers so nothing new is attached to it;
+it is not deleted, keeps its history, and `is_archived=false` brings it
+back. It does not cancel a purchased mailbox's billing - that is
+`request-cancellation`.
+
+Needs a personal API key whose user holds a mailbox write permission.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox id (mailboxes.id) |
+| `body` | `MailboxArchiveRequest` | yes | Request body; fields below. |
+
+Body fields (`MailboxArchiveRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.is_archived` | `boolean` | yes | True hides the mailbox from pickers and stops new use; false restores it |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.mailboxes.archiveMailbox({ path: { mailbox_id: 1 }, body: { is_archived: true } });
+```
+
+---
+
+<a id="op-archivepersona"></a>
+
+### `g8.api.mailboxes.archivePersona(input)`
+
+**Archive Persona**
+
+- HTTP: `DELETE /api/v1/mailboxes/personas/{persona_id}`
+- operationId: `archive_persona_mailboxes_personas__persona_id__delete` (also callable as `g8.api.call("archive_persona_mailboxes_personas__persona_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+Archive a sender persona. It stops being usable for new purchases.
+
+ARCHIVES rather than erases: mailboxes already bought under this identity
+keep working, and the persona stays readable so their provenance is not
+lost. 409 if an active buying plan still depends on it - cancel or finish
+the plan first.
+
+Org admins and owners only, and a personal API key: a persona carries a
+real person's identity details.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.persona_id` | `integer` | yes | Sender persona id - from GET /mailboxes/personas |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.mailboxes.archivePersona({ path: { persona_id: 1 } });
+```
+
+---
+
+<a id="op-bulkimportmailboxes"></a>
+
+### `g8.api.mailboxes.bulkImportMailboxes(input)`
+
+**Bulk Import Mailboxes**
+
+- HTTP: `POST /api/v1/mailboxes/bulk-import`
+- operationId: `bulk_import_mailboxes_mailboxes_bulk_import_post` (also callable as `g8.api.call("bulk_import_mailboxes_mailboxes_bulk_import_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Connect many mailboxes you already own, from CSV. Buys nothing.
+
+202 means ACCEPTED, not imported: the work runs in the background and the
+response carries no per-row outcome. Poll `GET /mailboxes` to see what
+landed, and expect rows to appear gradually rather than all at once.
+
+Credentials in the CSV are write-only - stored encrypted and never
+returned by this or any other endpoint.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `MailboxBulkImportRequest` | yes | Request body; fields below. |
+
+Body fields (`MailboxBulkImportRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.csv_content` | `string` | yes | Raw CSV. Credential columns are stored encrypted and never returned. |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.bulkImportMailboxes({ body: { csv_content: "example" } });
+```
+
+---
+
+<a id="op-createmailbox"></a>
+
+### `g8.api.mailboxes.createMailbox(input)`
+
+**Create Mailbox**
+
+- HTTP: `POST /api/v1/mailboxes`
+- operationId: `create_mailbox_mailboxes_post` (also callable as `g8.api.call("create_mailbox_mailboxes_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+- ★ Hand-written: [`g8.mailboxes.create()`](../sdk-clients.md#g8-mailboxes-create)
+
+Connect an existing mailbox over IMAP/SMTP.
+
+Credentials are write-only — they are stored encrypted and never returned by
+this or any other endpoint. Google/Microsoft mailboxes need the browser OAuth
+flow and cannot be connected here.
+
+Routes to the same ``CreateMailboxHandler`` the in-app "add mailbox" screen
+uses, so validation and provider detection behave identically.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `MailboxCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`MailboxCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.email` | `string` | yes | The mailbox address, e.g. sales@acme.com |
+| `body.imap_address` | `string` | yes | IMAP host, e.g. imap.acme.com |
+| `body.imap_password` | `string` | yes | Write-only. Never returned by any endpoint. |
+| `body.imap_username` | `string` | yes |  |
+| `body.smtp_address` | `string` | yes | SMTP host, e.g. smtp.acme.com |
+| `body.smtp_password` | `string` | yes | Write-only. Never returned by any endpoint. |
+| `body.smtp_username` | `string` | yes |  |
+| `body.authentication` | `string` | no | default `"plain"` |
+| `body.daily_limit` | `integer` | no | Max sends per day for this mailbox default `40`, min 1 |
+| `body.display_name` | `string \| null` | no |  |
+| `body.enable_starttls_auto` | `boolean` | no | default `true` |
+| `body.imap_port` | `integer` | no | default `993` |
+| `body.signature_html` | `string \| null` | no |  |
+| `body.signature_plain` | `string \| null` | no |  |
+| `body.smtp_port` | `integer` | no | default `465` |
+| `body.use_html_signature` | `boolean` | no | default `false` |
+
+**Returns** `ApiResponse_MailboxResponse_`: the envelope `{ data: MailboxResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`MailboxResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `integer` | yes |  |
+| `allows_nurture` | `boolean \| null` | no |  |
+| `connection_status` | `string \| null` | no | active \| paused \| disconnected \| expired \| ... |
+| `created_at` | `string \| null` | no |  |
+| `created_by` | `string \| null` | no |  |
+| `daily_limit` | `integer \| null` | no |  |
+| `display_name` | `string \| null` | no |  |
+| `email` | `string \| null` | no |  |
+| `is_archived` | `boolean \| null` | no |  |
+| `provider` | `string \| null` | no |  |
+| `updated_at` | `string \| null` | no |  |
+| `warmup_enabled` | `boolean \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.createMailbox({
+  body: {
+    email: "jane@acme.com",
+    imap_address: "example",
+    imap_password: "example",
+    imap_username: "Example",
+    smtp_address: "example",
+    smtp_password: "example",
+    smtp_username: "Example",
+  },
+});
+```
+
+---
+
+<a id="op-createplacementtest"></a>
+
+### `g8.api.mailboxes.createPlacementTest(input)`
+
+**Create Placement Test**
+
+- HTTP: `POST /api/v1/placement/tests`
+- operationId: `create_placement_test_placement_tests_post` (also callable as `g8.api.call("create_placement_test_placement_tests_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+
+Run an inbox-placement test. THIS CHARGES 20 CREDITS PER MAILBOX.
+
+Charged when the test is CREATED, not when it finishes, so a cancelled or
+failed test has still cost. Estimate first.
+
+A `frequency` other than `once` creates a recurring schedule that charges
+again on every run - see `GET /placement/scheduled` and `/pause`.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `CreateTestRequest` | yes | Request body; fields below. |
+
+Body fields (`CreateTestRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.mailbox_ids` | `Array<integer>` | yes | 1-20 mailboxes. The app's own ceiling; each one costs credits. min items 1, max items 20 |
+| `body.test_name` | `string` | yes |  |
+| `body.custom_body` | `string \| null` | no |  |
+| `body.custom_subject` | `string \| null` | no |  |
+| `body.frequency` | `string` | no | `once`, `weekly`, `biweekly` or `monthly`. Anything but `once` keeps charging on that cadence until paused. default `"once"` |
+| `body.receiver_types` | `Array<string> \| null` | no | Which seed inboxes to test against, e.g. `personal_gmail`. Omit for the app's default panel - a narrower list tests less and costs the same. |
+| `body.sending_interval` | `integer` | no | Minutes between sends, spreading the test out. default `1` |
+
+**Returns** `ApiResponse_DeliverabilityPayload_`: the envelope `{ data: DeliverabilityPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.mailboxes.createPlacementTest({ body: { mailbox_ids: [123], test_name: "Example" } });
+```
+
+---
+
+<a id="op-createsenderpersona"></a>
+
+### `g8.api.mailboxes.createSenderPersona(input)`
+
+**Create Sender Persona**
+
+- HTTP: `POST /api/v1/mailboxes/personas`
+- operationId: `create_sender_persona_mailboxes_personas_post` (also callable as `g8.api.call("create_sender_persona_mailboxes_personas_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Create a sender persona - an identity mailboxes can be bought under.
+
+Give `first_name`, `last_name` and `email`, or a `team_member_id` to take
+them from. The identity is registrant data at the registrar for every
+domain bought under it, so use a real person who has agreed to it.
+
+409 if the email is already a persona. Org admins and owners only, and a
+personal API key.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `SenderPersonaWriteRequest` | yes | Request body; fields below. |
+
+Body fields (`SenderPersonaWriteRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.address_line1` | `string \| null` | no | Registrant address, line 1 max length 255 |
+| `body.address_line2` | `string \| null` | no | Registrant address, line 2 max length 255 |
+| `body.city` | `string \| null` | no | City max length 255 |
+| `body.country` | `string \| null` | no | Country max length 100 |
+| `body.email` | `string \| null` | no | The persona's own address max length 254 |
+| `body.first_name` | `string \| null` | no | Given name max length 100 |
+| `body.last_name` | `string \| null` | no | Family name max length 100 |
+| `body.organization` | `string \| null` | no | Organisation name max length 255 |
+| `body.phone` | `string \| null` | no | Contact phone max length 50 |
+| `body.photo_url` | `string \| null` | no | Photo URL max length 1000 |
+| `body.postal_code` | `string \| null` | no | Postal code max length 100 |
+| `body.state` | `string \| null` | no | State or region max length 100 |
+| `body.team_member_id` | `string (uuid) \| null` | no | Team member whose identity this persona uses |
+| `body.title` | `string \| null` | no | Job title shown in signatures max length 100 |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.createSenderPersona({ body: {} });
+```
+
+---
+
+<a id="op-deletemailbox"></a>
+
+### `g8.api.mailboxes.deleteMailbox(input)`
+
+**Delete Mailbox**
+
+- HTTP: `DELETE /api/v1/mailboxes/{mailbox_id}`
+- operationId: `delete_mailbox_mailboxes__mailbox_id__delete` (also callable as `g8.api.call("delete_mailbox_mailboxes__mailbox_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+- ★ Hand-written: [`g8.mailboxes.delete()`](../sdk-clients.md#g8-mailboxes-delete)
+
+Delete a mailbox. Sequences already referencing it stop being able to send from it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox ID (mailboxes.id) |
+
+**Returns** `ApiResponse_MailboxDeleteResponse_`: the envelope `{ data: MailboxDeleteResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`MailboxDeleteResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `deleted` | `boolean` | yes |  |
+| `mailbox_id` | `integer` | yes |  |
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.mailboxes.deleteMailbox({ path: { mailbox_id: 123 } });
+```
+
+---
+
+<a id="op-deletescheduledplacementtest"></a>
+
+### `g8.api.mailboxes.deleteScheduledPlacementTest(input)`
+
+**Delete Scheduled Placement Test**
+
+- HTTP: `DELETE /api/v1/placement/scheduled/{schedule_id}`
+- operationId: `delete_scheduled_placement_test_placement_scheduled__schedule_id__delete` (also callable as `g8.api.call("delete_scheduled_placement_test_placement_scheduled__schedule_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+Remove a recurring test. Tests it has already run are kept.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.schedule_id` | `string` | yes | Schedule id. A STRING, not a number: it is an opaque InboxKit identifier persisted as `inboxkit_schedule_id VARCHAR(100)` and interpolated straight into an InboxKit URL. `test_id`, `domain_id` and `mailbox_id` on this surface really are integers - the app draws the same distinction, and flattening it would 422 every id `GET /placement/scheduled` hands back. |
+
+**Returns** `ApiResponse_DeliverabilityPayload_`: the envelope `{ data: DeliverabilityPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.mailboxes.deleteScheduledPlacementTest({ path: { schedule_id: "id" } });
+```
+
+---
+
+<a id="op-deletewarmup"></a>
+
+### `g8.api.mailboxes.deleteWarmup(input)`
+
+**Delete Warmup**
+
+- HTTP: `DELETE /api/v1/warmup/{mailbox_id}`
+- operationId: `delete_warmup_warmup__mailbox_id__delete` (also callable as `g8.api.call("delete_warmup_warmup__mailbox_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+Remove this mailbox's warmup account entirely. NOT REVERSIBLE.
+
+Different from `POST /warmup/{mailbox_id}/disable`, which pauses warmup
+and keeps the account: this deletes it at the provider and clears every
+warmup field on the mailbox, so re-enrolling starts the reputation build
+from zero. Disable is what you want for a pause.
+
+Best-effort at the provider: if the provider call fails the local fields
+are still cleared, so a success here means graph8 no longer considers the
+mailbox warmed - confirm with `GET /warmup/{mailbox_id}/analytics`.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox id (mailboxes.id) |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.mailboxes.deleteWarmup({ path: { mailbox_id: 1 } });
+```
+
+---
+
+<a id="op-disablewarmup"></a>
+
+### `g8.api.mailboxes.disableWarmup(input)`
+
+**Disable Warmup**
+
+- HTTP: `POST /api/v1/warmup/{mailbox_id}/disable`
+- operationId: `disable_warmup_warmup__mailbox_id__disable_post` (also callable as `g8.api.call("disable_warmup_warmup__mailbox_id__disable_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Stop warming this mailbox.
+
+Reversible, but reputation is not: a mailbox taken off warmup and left
+idle loses the standing the warmup was building.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox id. |
+
+**Returns** `ApiResponse_DeliverabilityPayload_`: the envelope `{ data: DeliverabilityPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.disableWarmup({ path: { mailbox_id: 123 } });
+```
+
+---
+
+<a id="op-enablewarmup"></a>
+
+### `g8.api.mailboxes.enableWarmup(input)`
+
+**Enable Warmup**
+
+- HTTP: `POST /api/v1/warmup/{mailbox_id}/enable`
+- operationId: `enable_warmup_warmup__mailbox_id__enable_post` (also callable as `g8.api.call("enable_warmup_warmup__mailbox_id__enable_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Start warming this mailbox. It begins SENDING MAIL on its own.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox id. |
+
+**Returns** `ApiResponse_DeliverabilityPayload_`: the envelope `{ data: DeliverabilityPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.enableWarmup({ path: { mailbox_id: 123 } });
+```
+
+---
+
+<a id="op-estimateplacementtestcost"></a>
+
+### `g8.api.mailboxes.estimatePlacementTestCost(input)`
+
+**Estimate Placement Test Cost**
+
+- HTTP: `POST /api/v1/placement/tests/estimate`
+- operationId: `estimate_placement_test_cost_placement_tests_estimate_post` (also callable as `g8.api.call("estimate_placement_test_cost_placement_tests_estimate_post", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+What a placement test WOULD cost, and whether the mailboxes qualify.
+
+Charges nothing. Call this before `POST /placement/tests`, which charges
+20 credits per mailbox - this is the only way to learn the number before
+spending it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `EstimateTestRequest` | yes | Request body; fields below. |
+
+Body fields (`EstimateTestRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.mailbox_ids` | `Array<integer>` | yes | The mailboxes the test would send from. |
+
+**Returns** `ApiResponse_DeliverabilityPayload_`: the envelope `{ data: DeliverabilityPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.estimatePlacementTestCost({ body: { mailbox_ids: [123] } });
+```
+
+---
+
+<a id="op-getfleethealth"></a>
+
+### `g8.api.mailboxes.getFleetHealth(input?)`
+
+**Get Fleet Health**
+
+- HTTP: `GET /api/v1/mailboxes/fleet-health`
+- operationId: `get_fleet_health_mailboxes_fleet_health_get` (also callable as `g8.api.call("get_fleet_health_mailboxes_fleet_health_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Deliverability health across every mailbox in the org.
+
+The roll-up a sending dashboard opens with: how many mailboxes are healthy,
+degraded or failing, so a rebuilt UI can show the same headline.
+
+**Input**: none.
+
+**Returns** `ApiResponse_MailboxFleetHealthResponse_`: the envelope `{ data: MailboxFleetHealthResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.getFleetHealth();
+```
+
+---
+
+<a id="op-getmailbox"></a>
+
+### `g8.api.mailboxes.getMailbox(input)`
+
+**Get Mailbox**
+
+- HTTP: `GET /api/v1/mailboxes/{mailbox_id}`
+- operationId: `get_mailbox_mailboxes__mailbox_id__get` (also callable as `g8.api.call("get_mailbox_mailboxes__mailbox_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+- ★ Hand-written: [`g8.mailboxes.get()`](../sdk-clients.md#g8-mailboxes-get)
+
+Get a single mailbox by id. Credentials are never included.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox ID (mailboxes.id) |
+
+**Returns** `ApiResponse_MailboxResponse_`: the envelope `{ data: MailboxResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`MailboxResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `integer` | yes |  |
+| `allows_nurture` | `boolean \| null` | no |  |
+| `connection_status` | `string \| null` | no | active \| paused \| disconnected \| expired \| ... |
+| `created_at` | `string \| null` | no |  |
+| `created_by` | `string \| null` | no |  |
+| `daily_limit` | `integer \| null` | no |  |
+| `display_name` | `string \| null` | no |  |
+| `email` | `string \| null` | no |  |
+| `is_archived` | `boolean \| null` | no |  |
+| `provider` | `string \| null` | no |  |
+| `updated_at` | `string \| null` | no |  |
+| `warmup_enabled` | `boolean \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.getMailbox({ path: { mailbox_id: 123 } });
+```
+
+---
+
+<a id="op-getmailboxassociatedsequences"></a>
+
+### `g8.api.mailboxes.getMailboxAssociatedSequences(input)`
+
+**Get Mailbox Associated Sequences**
+
+- HTTP: `GET /api/v1/mailboxes/{mailbox_id}/associated-sequences`
+- operationId: `get_mailbox_associated_sequences_mailboxes__mailbox_id__associated_sequences_get` (also callable as `g8.api.call("get_mailbox_associated_sequences_mailboxes__mailbox_id__associated_sequences_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Every sequence that references this mailbox, at any status.
+
+Check this before archiving or cancelling a mailbox - the app blocks those
+actions while a sequence is still wired to it, and a rebuilt UI needs the
+same signal to avoid silently breaking a live send.
+
+Exposed as GET rather than the app's POST: it reads and has no body. The
+app's POST is left untouched.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox id. |
+
+**Returns** `ApiResponse_MailboxAssociatedSequencesResponse_`: the envelope `{ data: MailboxAssociatedSequencesResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`MailboxAssociatedSequencesResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `has_associations` | `boolean` | no | default `false` |
+| `sequences` | `Array<AssociatedSequence>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.getMailboxAssociatedSequences({ path: { mailbox_id: 1 } });
+```
+
+---
+
+<a id="op-getmailboxhealth"></a>
+
+### `g8.api.mailboxes.getMailboxHealth(input)`
+
+**Get Mailbox Health**
+
+- HTTP: `GET /api/v1/mailboxes/{mailbox_id}/health`
+- operationId: `get_mailbox_health_mailboxes__mailbox_id__health_get` (also callable as `g8.api.call("get_mailbox_health_mailboxes__mailbox_id__health_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Deliverability health for one mailbox.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox id. |
+
+**Returns** `ApiResponse_MailboxHealthResponse_`: the envelope `{ data: MailboxHealthResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`MailboxHealthResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `mailbox_id` | `integer \| null` | no |  |
+| `status` | `string \| null` | no | Health status as the app computes it. |
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.getMailboxHealth({ path: { mailbox_id: 1 } });
+```
+
+---
+
+<a id="op-getplacementdomainstats"></a>
+
+### `g8.api.mailboxes.getPlacementDomainStats(input?)`
+
+**Get Placement Domain Stats**
+
+- HTTP: `GET /api/v1/placement/domains/stats`
+- operationId: `get_placement_domain_stats_placement_domains_stats_get` (also callable as `g8.api.call("get_placement_domain_stats_placement_domains_stats_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Placement across every sending domain, at a glance.
+
+**Input**: none.
+
+**Returns** `ApiResponse_DeliverabilityListPayload_`: the envelope `{ data: DeliverabilityListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`DeliverabilityListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.getPlacementDomainStats();
+```
+
+---
+
+<a id="op-getplacementdomainsummary"></a>
+
+### `g8.api.mailboxes.getPlacementDomainSummary(input)`
+
+**Get Placement Domain Summary**
+
+- HTTP: `GET /api/v1/placement/domains/{domain_id}/summary`
+- operationId: `get_placement_domain_summary_placement_domains__domain_id__summary_get` (also callable as `g8.api.call("get_placement_domain_summary_placement_domains__domain_id__summary_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+One domain's placement, with its test history paged beneath it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.domain_id` | `integer` | yes | Domain id. |
+| `query.history_page` | `integer` | no | default `1` |
+| `query.history_limit` | `integer` | no | default `20` |
+
+**Returns** `ApiResponse_DeliverabilityPayload_`: the envelope `{ data: DeliverabilityPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.getPlacementDomainSummary({ path: { domain_id: 123 } });
+```
+
+---
+
+<a id="op-getplacementtest"></a>
+
+### `g8.api.mailboxes.getPlacementTest(input)`
+
+**Get Placement Test**
+
+- HTTP: `GET /api/v1/placement/tests/{test_id}`
+- operationId: `get_placement_test_placement_tests__test_id__get` (also callable as `g8.api.call("get_placement_test_placement_tests__test_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+One test, with a panel per seed provider.
+
+Open-shaped: the panel set changes as providers are added, and a missing
+panel reads as "we did not test there" when the truth may be "you did not
+land there".
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.test_id` | `integer` | yes | Test id. |
+
+**Returns** `ApiResponse_DeliverabilityPayload_`: the envelope `{ data: DeliverabilityPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.getPlacementTest({ path: { test_id: 123 } });
+```
+
+---
+
+<a id="op-getscheduledplacementtest"></a>
+
+### `g8.api.mailboxes.getScheduledPlacementTest(input)`
+
+**Get Scheduled Placement Test**
+
+- HTTP: `GET /api/v1/placement/scheduled/{schedule_id}`
+- operationId: `get_scheduled_placement_test_placement_scheduled__schedule_id__get` (also callable as `g8.api.call("get_scheduled_placement_test_placement_scheduled__schedule_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+One recurring test: its cadence, its mailboxes and its next run.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.schedule_id` | `string` | yes | Schedule id. A STRING, not a number: it is an opaque InboxKit identifier persisted as `inboxkit_schedule_id VARCHAR(100)` and interpolated straight into an InboxKit URL. `test_id`, `domain_id` and `mailbox_id` on this surface really are integers - the app draws the same distinction, and flattening it would 422 every id `GET /placement/scheduled` hands back. |
+
+**Returns** `ApiResponse_DeliverabilityPayload_`: the envelope `{ data: DeliverabilityPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.getScheduledPlacementTest({ path: { schedule_id: "id" } });
+```
+
+---
+
+<a id="op-getsenderpersona"></a>
+
+### `g8.api.mailboxes.getSenderPersona(input)`
+
+**Get Sender Persona**
+
+- HTTP: `GET /api/v1/mailboxes/personas/{persona_id}`
+- operationId: `get_sender_persona_mailboxes_personas__persona_id__get` (also callable as `g8.api.call("get_sender_persona_mailboxes_personas__persona_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+One sender persona in full, archived or not. Org admins and owners only.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.persona_id` | `integer` | yes | Sender persona id - from GET /mailboxes/personas |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.getSenderPersona({ path: { persona_id: 1 } });
+```
+
+---
+
+<a id="op-getwarmupanalytics"></a>
+
+### `g8.api.mailboxes.getWarmupAnalytics(input)`
+
+**Get Warmup Analytics**
+
+- HTTP: `GET /api/v1/warmup/{mailbox_id}/analytics`
+- operationId: `get_warmup_analytics_warmup__mailbox_id__analytics_get` (also callable as `g8.api.call("get_warmup_analytics_warmup__mailbox_id__analytics_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+How the warmup is going: volume, landing rate and reputation trend.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox id. |
+
+**Returns** `ApiResponse_DeliverabilityPayload_`: the envelope `{ data: DeliverabilityPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.getWarmupAnalytics({ path: { mailbox_id: 123 } });
+```
+
+---
+
+<a id="op-listmymailboxes"></a>
+
+### `g8.api.mailboxes.listMyMailboxes(input?)`
+
+**List My Mailboxes**
+
+- HTTP: `GET /api/v1/mailboxes/my`
+- operationId: `list_my_mailboxes_mailboxes_my_get` (also callable as `g8.api.call("list_my_mailboxes_mailboxes_my_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Mailboxes created by the principal behind this key.
+
+Hard-scoped server-side to the caller - it does not trust a client-supplied
+owner filter, which is what separates it from the generic mailbox list.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.include_archived` | `boolean` | no | Include archived mailboxes. default `false` |
+
+**Returns** `ApiResponse_MyMailboxesResponse_`: the envelope `{ data: MyMailboxesResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`MyMailboxesResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `mailboxes` | `Array<MailboxSummary>` | no |  |
+| `total` | `integer` | no | default `0` |
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.listMyMailboxes();
+```
+
+---
+
+<a id="op-listplacementtests"></a>
+
+### `g8.api.mailboxes.listPlacementTests(input?)`
+
+**List Placement Tests**
+
+- HTTP: `GET /api/v1/placement/tests`
+- operationId: `list_placement_tests_placement_tests_get` (also callable as `g8.api.call("list_placement_tests_placement_tests_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Placement tests, newest first.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.page` | `integer` | no | default `1` |
+| `query.limit` | `integer` | no | default `50` |
+| `query.status` | `string \| null` | no | Filter by test status. The wire name is `status`, matching the app; the handler parameter is renamed only because `status` is already imported from FastAPI in this module. |
+| `query.domain_id` | `integer \| null` | no | Only tests for this domain. |
+| `query.mailbox_id` | `integer \| null` | no | Only tests for this mailbox. |
+
+**Returns** `ApiResponse_DeliverabilityListPayload_`: the envelope `{ data: DeliverabilityListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`DeliverabilityListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.listPlacementTests();
+```
+
+---
+
+<a id="op-listscheduledplacementtests"></a>
+
+### `g8.api.mailboxes.listScheduledPlacementTests(input?)`
+
+**List Scheduled Placement Tests**
+
+- HTTP: `GET /api/v1/placement/scheduled`
+- operationId: `list_scheduled_placement_tests_placement_scheduled_get` (also callable as `g8.api.call("list_scheduled_placement_tests_placement_scheduled_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Every recurring test, and therefore every recurring CHARGE.
+
+Read this before wondering where credits are going: a test created with a
+`frequency` other than `once` charges again on every run until paused.
+
+**Input**: none.
+
+**Returns** `ApiResponse_DeliverabilityListPayload_`: the envelope `{ data: DeliverabilityListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`DeliverabilityListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.listScheduledPlacementTests();
+```
+
+---
+
+<a id="op-listsenderpersonas"></a>
+
+### `g8.api.mailboxes.listSenderPersonas(input?)`
+
+**List Sender Personas**
+
+- HTTP: `GET /api/v1/mailboxes/personas`
+- operationId: `list_sender_personas_mailboxes_personas_get` (also callable as `g8.api.call("list_sender_personas_mailboxes_personas_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+The org's sender personas, with how many mailboxes each one holds.
+
+Org admins and owners only, and a personal API key: a persona carries a
+real person's identity details.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.include_archived` | `boolean` | no | Include archived personas default `false` |
+
+**Returns** `ApiResponse_MailboxDomainListPayload_`: the envelope `{ data: MailboxDomainListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`MailboxDomainListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.listSenderPersonas();
+```
+
+---
+
+<a id="op-pausescheduledplacementtest"></a>
+
+### `g8.api.mailboxes.pauseScheduledPlacementTest(input)`
+
+**Pause Scheduled Placement Test**
+
+- HTTP: `POST /api/v1/placement/scheduled/{schedule_id}/pause`
+- operationId: `pause_scheduled_placement_test_placement_scheduled__schedule_id__pause_post` (also callable as `g8.api.call("pause_scheduled_placement_test_placement_scheduled__schedule_id__pause_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Stop a recurring test charging. Reversible with `/resume`.
+
+Pausing does not refund a run already charged; it stops the next one.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.schedule_id` | `string` | yes | Schedule id. A STRING, not a number: it is an opaque InboxKit identifier persisted as `inboxkit_schedule_id VARCHAR(100)` and interpolated straight into an InboxKit URL. `test_id`, `domain_id` and `mailbox_id` on this surface really are integers - the app draws the same distinction, and flattening it would 422 every id `GET /placement/scheduled` hands back. |
+
+**Returns** `ApiResponse_DeliverabilityPayload_`: the envelope `{ data: DeliverabilityPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.pauseScheduledPlacementTest({ path: { schedule_id: "id" } });
+```
+
+---
+
+<a id="op-requestmailboxcancellation"></a>
+
+### `g8.api.mailboxes.requestMailboxCancellation(input)`
+
+**Request Mailbox Cancellation**
+
+- HTTP: `POST /api/v1/mailboxes/{mailbox_id}/request-cancellation`
+- operationId: `request_mailbox_cancellation_mailboxes__mailbox_id__request_cancellation_post` (also callable as `g8.api.call("request_mailbox_cancellation_mailboxes__mailbox_id__request_cancellation_post", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+Stop paying for a purchased mailbox. STOPS SPEND; eventually destroys it.
+
+Two steps, and this is the first: the mailbox is scheduled for
+cancellation at the provider and keeps working until its current period
+ends. A poller then flips it to cancelled, after which
+`DELETE /mailboxes/{mailbox_id}` removes graph8's record of it.
+
+Reversible with `POST /mailboxes/uncancel` while it is still scheduled -
+which resumes billing.
+
+422 for a mailbox that was not purchased through graph8, or one already in
+the cancellation flow. 502 if the provider refused - read that as "nothing
+was cancelled", not as a partial success.
+
+Needs a personal API key whose user holds a mailbox write permission.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox id (mailboxes.id) |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.mailboxes.requestMailboxCancellation({ path: { mailbox_id: 1 } });
+```
+
+---
+
+<a id="op-resumescheduledplacementtest"></a>
+
+### `g8.api.mailboxes.resumeScheduledPlacementTest(input)`
+
+**Resume Scheduled Placement Test**
+
+- HTTP: `POST /api/v1/placement/scheduled/{schedule_id}/resume`
+- operationId: `resume_scheduled_placement_test_placement_scheduled__schedule_id__resume_post` (also callable as `g8.api.call("resume_scheduled_placement_test_placement_scheduled__schedule_id__resume_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Start a paused recurring test again. IT RESUMES CHARGING.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.schedule_id` | `string` | yes | Schedule id. A STRING, not a number: it is an opaque InboxKit identifier persisted as `inboxkit_schedule_id VARCHAR(100)` and interpolated straight into an InboxKit URL. `test_id`, `domain_id` and `mailbox_id` on this surface really are integers - the app draws the same distinction, and flattening it would 422 every id `GET /placement/scheduled` hands back. |
+
+**Returns** `ApiResponse_DeliverabilityPayload_`: the envelope `{ data: DeliverabilityPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.resumeScheduledPlacementTest({ path: { schedule_id: "id" } });
+```
+
+---
+
+<a id="op-runmailboxplacementtest"></a>
+
+### `g8.api.mailboxes.runMailboxPlacementTest(input)`
+
+**Run Mailbox Placement Test**
+
+- HTTP: `POST /api/v1/mailboxes/{mailbox_id}/health/placement-test`
+- operationId: `run_mailbox_placement_test_mailboxes__mailbox_id__health_placement_test_post` (also callable as `g8.api.call("run_mailbox_placement_test_mailboxes__mailbox_id__health_placement_test_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+
+Run an inbox-placement test for ONE mailbox. THIS CHARGES CREDITS.
+
+Same charging path as `POST /placement/tests`: credits are held and
+charged when the test is CREATED, not when it completes. Call
+`POST /placement/tests/estimate` first if you want the figure - that one
+is free.
+
+One test per mailbox per 72 hours; a call inside the window is a 429
+carrying `cooldown_until`. The test itself completes asynchronously - read
+it back with `GET /placement/tests/{test_id}`.
+
+Org admins and owners only, enforced by the handler itself.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox id (mailboxes.id) |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.mailboxes.runMailboxPlacementTest({ path: { mailbox_id: 1 } });
+```
+
+---
+
+<a id="op-setupwarmup"></a>
+
+### `g8.api.mailboxes.setupWarmup(input)`
+
+**Setup Warmup**
+
+- HTTP: `POST /api/v1/warmup/setup`
+- operationId: `setup_warmup_warmup_setup_post` (also callable as `g8.api.call("setup_warmup_warmup_setup_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Enrol a mailbox with a warmup provider.
+
+`warmup_settings` is passed through untouched: the accepted keys differ
+per provider and change with them, so this contract does not second-guess
+what the provider takes.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `SetupWarmupRequest` | yes | Request body; fields below. |
+
+Body fields (`SetupWarmupRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.mailbox_id` | `integer` | yes |  |
+| `body.provider` | `string` | yes | The warmup provider to enrol with. |
+| `body.warmup_settings` | `Record<string, unknown> \| null` | no | Provider-specific settings. Open because the accepted keys differ per provider and change with them - the app passes this through untouched, and a closed mirror here would drop a setting the provider supports. |
+
+**Returns** `ApiResponse_DeliverabilityPayload_`: the envelope `{ data: DeliverabilityPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.setupWarmup({ body: { mailbox_id: 123, provider: "example" } });
+```
+
+---
+
+<a id="op-sharemailbox"></a>
+
+### `g8.api.mailboxes.shareMailbox(input)`
+
+**Share Mailbox**
+
+- HTTP: `POST /api/v1/mailboxes/{mailbox_id}/share`
+- operationId: `share_mailbox_mailboxes__mailbox_id__share_post` (also callable as `g8.api.call("share_mailbox_mailboxes__mailbox_id__share_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Let the rest of the org send from this mailbox, or stop letting them.
+
+Sharing hands over a sending CREDENTIAL, not a view: anyone in the org can
+then attach it to their own sequences. Explicit rather than a toggle, so a
+retried request cannot silently flip it back.
+
+Owner-only (plus org admins and owners) - sharing is the one mailbox
+mutation a team-mate the mailbox is already shared with cannot perform.
+Needs a personal API key.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox id (mailboxes.id) |
+| `body` | `MailboxShareRequest` | yes | Request body; fields below. |
+
+Body fields (`MailboxShareRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.shared_with_team` | `boolean` | yes | True makes the mailbox usable by every member of the org |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.shareMailbox({ path: { mailbox_id: 1 }, body: { shared_with_team: true } });
+```
+
+---
+
+<a id="op-testmailboxconnection"></a>
+
+### `g8.api.mailboxes.testMailboxConnection(input)`
+
+**Test Mailbox Connection**
+
+- HTTP: `POST /api/v1/mailboxes/{mailbox_id}/test-connection`
+- operationId: `test_mailbox_connection_mailboxes__mailbox_id__test_connection_post` (also callable as `g8.api.call("test_mailbox_connection_mailboxes__mailbox_id__test_connection_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+- ★ Hand-written: [`g8.mailboxes.testConnection()`](../sdk-clients.md#g8-mailboxes-testconnection)
+
+Verify a mailbox's IMAP/SMTP credentials and refresh its connection status.
+
+Send an empty body to test what is stored. Supply credentials to test
+candidate values without saving them — useful for validating before a PATCH.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox ID (mailboxes.id) |
+| `body` | `MailboxTestConnectionRequest \| null` | no | Request body; fields below. |
+
+Body fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.imap_address` | `string \| null` | no |  |
+| `body.imap_password` | `string \| null` | no |  |
+| `body.imap_port` | `integer \| null` | no |  |
+| `body.imap_username` | `string \| null` | no |  |
+| `body.smtp_address` | `string \| null` | no |  |
+| `body.smtp_password` | `string \| null` | no |  |
+| `body.smtp_port` | `integer \| null` | no |  |
+| `body.smtp_username` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.testMailboxConnection({ path: { mailbox_id: 123 } });
+```
+
+---
+
+<a id="op-uncancelmailboxes"></a>
+
+### `g8.api.mailboxes.uncancelMailboxes(input)`
+
+**Uncancel Mailboxes**
+
+- HTTP: `POST /api/v1/mailboxes/uncancel`
+- operationId: `uncancel_mailboxes_mailboxes_uncancel_post` (also callable as `g8.api.call("uncancel_mailboxes_mailboxes_uncancel_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+
+Undo a scheduled cancellation. RESUMES BILLING on every mailbox listed.
+
+Bulk by design; pass one id for a single undo. Idempotent - a mailbox that
+is already active is a no-op success rather than an error.
+
+Read the per-id breakdown in `results`, not the HTTP status: a mailbox
+that could not be restored is REPORTED, and the request still returns 200
+with the ones that were.
+
+422 for an org without an active or pre-funded plan. A churned org must
+not resume mailbox billing, and restoring one would be re-cancelled within
+days anyway.
+
+Needs a personal API key whose user holds a mailbox write permission.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `MailboxUncancelRequest` | yes | Request body; fields below. |
+
+Body fields (`MailboxUncancelRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.mailbox_ids` | `Array<integer>` | yes | Mailboxes to restore. Up to 50. min items 1, max items 50 |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.mailboxes.uncancelMailboxes({ body: { mailbox_ids: [123] } });
+```
+
+---
+
+<a id="op-updatemailbox"></a>
+
+### `g8.api.mailboxes.updateMailbox(input)`
+
+**Update Mailbox**
+
+- HTTP: `PATCH /api/v1/mailboxes/{mailbox_id}`
+- operationId: `update_mailbox_mailboxes__mailbox_id__patch` (also callable as `g8.api.call("update_mailbox_mailboxes__mailbox_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+- ★ Hand-written: [`g8.mailboxes.update()`](../sdk-clients.md#g8-mailboxes-update)
+
+Update a mailbox. Only supplied fields change; omitted fields are untouched.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox ID (mailboxes.id) |
+| `body` | `MailboxUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`MailboxUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.allows_nurture` | `boolean \| null` | no |  |
+| `body.daily_limit` | `integer \| null` | no | min 1 |
+| `body.display_name` | `string \| null` | no |  |
+| `body.imap_address` | `string \| null` | no |  |
+| `body.imap_password` | `string \| null` | no | Write-only. |
+| `body.imap_port` | `integer \| null` | no |  |
+| `body.imap_username` | `string \| null` | no |  |
+| `body.signature_html` | `string \| null` | no |  |
+| `body.signature_plain` | `string \| null` | no |  |
+| `body.smtp_address` | `string \| null` | no |  |
+| `body.smtp_password` | `string \| null` | no | Write-only. |
+| `body.smtp_port` | `integer \| null` | no |  |
+| `body.smtp_username` | `string \| null` | no |  |
+| `body.use_html_signature` | `boolean \| null` | no |  |
+
+**Returns** `ApiResponse_MailboxResponse_`: the envelope `{ data: MailboxResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`MailboxResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `integer` | yes |  |
+| `allows_nurture` | `boolean \| null` | no |  |
+| `connection_status` | `string \| null` | no | active \| paused \| disconnected \| expired \| ... |
+| `created_at` | `string \| null` | no |  |
+| `created_by` | `string \| null` | no |  |
+| `daily_limit` | `integer \| null` | no |  |
+| `display_name` | `string \| null` | no |  |
+| `email` | `string \| null` | no |  |
+| `is_archived` | `boolean \| null` | no |  |
+| `provider` | `string \| null` | no |  |
+| `updated_at` | `string \| null` | no |  |
+| `warmup_enabled` | `boolean \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.updateMailbox({ path: { mailbox_id: 123 }, body: {} });
+```
+
+---
+
+<a id="op-updatesenderpersona"></a>
+
+### `g8.api.mailboxes.updateSenderPersona(input)`
+
+**Update Sender Persona**
+
+- HTTP: `PATCH /api/v1/mailboxes/personas/{persona_id}`
+- operationId: `update_sender_persona_mailboxes_personas__persona_id__patch` (also callable as `g8.api.call("update_sender_persona_mailboxes_personas__persona_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Change a sender persona. Send only the fields that change.
+
+`first_name`, `last_name` and `email` cannot be set to null. Domains
+already registered keep the registrant details they were bought with.
+Org admins and owners only, and a personal API key.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.persona_id` | `integer` | yes | Sender persona id - from GET /mailboxes/personas |
+| `body` | `SenderPersonaWriteRequest` | yes | Request body; fields below. |
+
+Body fields (`SenderPersonaWriteRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.address_line1` | `string \| null` | no | Registrant address, line 1 max length 255 |
+| `body.address_line2` | `string \| null` | no | Registrant address, line 2 max length 255 |
+| `body.city` | `string \| null` | no | City max length 255 |
+| `body.country` | `string \| null` | no | Country max length 100 |
+| `body.email` | `string \| null` | no | The persona's own address max length 254 |
+| `body.first_name` | `string \| null` | no | Given name max length 100 |
+| `body.last_name` | `string \| null` | no | Family name max length 100 |
+| `body.organization` | `string \| null` | no | Organisation name max length 255 |
+| `body.phone` | `string \| null` | no | Contact phone max length 50 |
+| `body.photo_url` | `string \| null` | no | Photo URL max length 1000 |
+| `body.postal_code` | `string \| null` | no | Postal code max length 100 |
+| `body.state` | `string \| null` | no | State or region max length 100 |
+| `body.team_member_id` | `string (uuid) \| null` | no | Team member whose identity this persona uses |
+| `body.title` | `string \| null` | no | Job title shown in signatures max length 100 |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.updateSenderPersona({ path: { persona_id: 1 }, body: {} });
+```
+
+---
+
+<a id="op-updatewarmupsettings"></a>
+
+### `g8.api.mailboxes.updateWarmupSettings(input)`
+
+**Update Warmup Settings**
+
+- HTTP: `PATCH /api/v1/warmup/{mailbox_id}/settings`
+- operationId: `update_warmup_settings_warmup__mailbox_id__settings_patch` (also callable as `g8.api.call("update_warmup_settings_warmup__mailbox_id__settings_patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Change how an already-running warmup behaves.
+
+The body is OPEN and forwarded as-is, matching the app, which types this
+parameter as a bare `Dict[str, Any]` and hands it to the provider. Closing
+it here would reject a setting the provider supports.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mailbox_id` | `integer` | yes | Mailbox id. |
+| `body` | `UpdateWarmupSettingsRequest` | yes | Request body; fields below. |
+
+Body type: `UpdateWarmupSettingsRequest` (Record<string, unknown>).
+
+**Returns** `ApiResponse_DeliverabilityPayload_`: the envelope `{ data: DeliverabilityPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.updateWarmupSettings({ path: { mailbox_id: 123 }, body: {} });
+```
+
+---
+
+<a id="op-uploadpersonaphoto"></a>
+
+### `g8.api.mailboxes.uploadPersonaPhoto(input)`
+
+**Upload Persona Photo**
+
+- HTTP: `POST /api/v1/mailboxes/personas/{persona_id}/photo`
+- operationId: `upload_persona_photo_mailboxes_personas__persona_id__photo_post` (also callable as `g8.api.call("upload_persona_photo_mailboxes_personas__persona_id__photo_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Set the photo this sender persona uses. Multipart upload.
+
+REPLACES the current photo. The image is stored by graph8 and referenced
+from the returned `photo_url`; 503 means photo storage was unavailable and
+the persona is unchanged, so it is safe to retry.
+
+Org admins and owners only, and a personal API key.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.persona_id` | `integer` | yes | Sender persona id - from GET /mailboxes/personas |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.mailboxes.uploadPersonaPhoto({ path: { persona_id: 1 } });
+```
+
+---
+
+## Referenced types
+
+Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
+
+<a id="type-associatedsequence"></a>
+
+### `AssociatedSequence`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `integer \| null` | no |  |
+| `status` | `string \| null` | no |  |
+| `title` | `string \| null` | no |  |
+
+<a id="type-mailboxsummary"></a>
+
+### `MailboxSummary`
+
+One mailbox as the inventory surfaces it.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `channel_type` | `string \| null` | no | SMTP, GMAIL or INBOXKIT. |
+| `email` | `string \| null` | no |  |
+| `id` | `integer \| null` | no |  |
+| `is_archived` | `boolean \| null` | no |  |
+| `status` | `string \| null` | no |  |