@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/mailboxes.d.ts

@@ -0,0 +1,1050 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.mailboxes` (Mailboxes): 38 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"archive_mailbox_mailboxes__mailbox_id__archive_post">;
+ *
+ * Reference with examples: mailboxes.md
+ */
+/* eslint-disable */
+
+/** `g8.api.mailboxes.<member>` -> the operationId it calls. */
+export interface MailboxesMembers {
+  archiveMailbox: "archive_mailbox_mailboxes__mailbox_id__archive_post";
+  archivePersona: "archive_persona_mailboxes_personas__persona_id__delete";
+  bulkImportMailboxes: "bulk_import_mailboxes_mailboxes_bulk_import_post";
+  createMailbox: "create_mailbox_mailboxes_post";
+  createPlacementTest: "create_placement_test_placement_tests_post";
+  createSenderPersona: "create_sender_persona_mailboxes_personas_post";
+  deleteMailbox: "delete_mailbox_mailboxes__mailbox_id__delete";
+  deleteScheduledPlacementTest: "delete_scheduled_placement_test_placement_scheduled__schedule_id__delete";
+  deleteWarmup: "delete_warmup_warmup__mailbox_id__delete";
+  disableWarmup: "disable_warmup_warmup__mailbox_id__disable_post";
+  enableWarmup: "enable_warmup_warmup__mailbox_id__enable_post";
+  estimatePlacementTestCost: "estimate_placement_test_cost_placement_tests_estimate_post";
+  getFleetHealth: "get_fleet_health_mailboxes_fleet_health_get";
+  getMailbox: "get_mailbox_mailboxes__mailbox_id__get";
+  getMailboxAssociatedSequences: "get_mailbox_associated_sequences_mailboxes__mailbox_id__associated_sequences_get";
+  getMailboxHealth: "get_mailbox_health_mailboxes__mailbox_id__health_get";
+  getPlacementDomainStats: "get_placement_domain_stats_placement_domains_stats_get";
+  getPlacementDomainSummary: "get_placement_domain_summary_placement_domains__domain_id__summary_get";
+  getPlacementTest: "get_placement_test_placement_tests__test_id__get";
+  getScheduledPlacementTest: "get_scheduled_placement_test_placement_scheduled__schedule_id__get";
+  getSenderPersona: "get_sender_persona_mailboxes_personas__persona_id__get";
+  getWarmupAnalytics: "get_warmup_analytics_warmup__mailbox_id__analytics_get";
+  listMyMailboxes: "list_my_mailboxes_mailboxes_my_get";
+  listPlacementTests: "list_placement_tests_placement_tests_get";
+  listScheduledPlacementTests: "list_scheduled_placement_tests_placement_scheduled_get";
+  listSenderPersonas: "list_sender_personas_mailboxes_personas_get";
+  pauseScheduledPlacementTest: "pause_scheduled_placement_test_placement_scheduled__schedule_id__pause_post";
+  requestMailboxCancellation: "request_mailbox_cancellation_mailboxes__mailbox_id__request_cancellation_post";
+  resumeScheduledPlacementTest: "resume_scheduled_placement_test_placement_scheduled__schedule_id__resume_post";
+  runMailboxPlacementTest: "run_mailbox_placement_test_mailboxes__mailbox_id__health_placement_test_post";
+  setupWarmup: "setup_warmup_warmup_setup_post";
+  shareMailbox: "share_mailbox_mailboxes__mailbox_id__share_post";
+  testMailboxConnection: "test_mailbox_connection_mailboxes__mailbox_id__test_connection_post";
+  uncancelMailboxes: "uncancel_mailboxes_mailboxes_uncancel_post";
+  updateMailbox: "update_mailbox_mailboxes__mailbox_id__patch";
+  updateSenderPersona: "update_sender_persona_mailboxes_personas__persona_id__patch";
+  updateWarmupSettings: "update_warmup_settings_warmup__mailbox_id__settings_patch";
+  uploadPersonaPhoto: "upload_persona_photo_mailboxes_personas__persona_id__photo_post";
+}
+
+/** Input and output of every `g8.api.mailboxes` operation, keyed by operationId. */
+export interface MailboxesOperations {
+  /**
+   * POST /mailboxes/{mailbox_id}/archive
+   * Archive Mailbox
+   * tier: destructive · scope: campaigns:delete
+   */
+  archive_mailbox_mailboxes__mailbox_id__archive_post: {
+    input: {
+    path: {
+      /** Mailbox id (mailboxes.id) */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MailboxArchiveRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * DELETE /mailboxes/personas/{persona_id}
+   * Archive Persona
+   * tier: destructive · scope: campaigns:delete
+   */
+  archive_persona_mailboxes_personas__persona_id__delete: {
+    input: {
+    path: {
+      /** Sender persona id - from GET /mailboxes/personas */
+      persona_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /mailboxes/bulk-import
+   * Bulk Import Mailboxes
+   * tier: write · scope: campaigns:write
+   */
+  bulk_import_mailboxes_mailboxes_bulk_import_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MailboxBulkImportRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /mailboxes
+   * Create Mailbox
+   * tier: write · scope: campaigns:write
+   */
+  create_mailbox_mailboxes_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MailboxCreateRequest;
+  };
+    output: ApiResponse_MailboxResponse_;
+  };
+  /**
+   * POST /placement/tests
+   * Create Placement Test
+   * tier: billable · scope: campaigns:run
+   */
+  create_placement_test_placement_tests_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CreateTestRequest;
+  };
+    output: ApiResponse_DeliverabilityPayload_;
+  };
+  /**
+   * POST /mailboxes/personas
+   * Create Sender Persona
+   * tier: write · scope: campaigns:write
+   */
+  create_sender_persona_mailboxes_personas_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SenderPersonaWriteRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * DELETE /mailboxes/{mailbox_id}
+   * Delete Mailbox
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_mailbox_mailboxes__mailbox_id__delete: {
+    input: {
+    path: {
+      /** Mailbox ID (mailboxes.id) */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDeleteResponse_;
+  };
+  /**
+   * DELETE /placement/scheduled/{schedule_id}
+   * Delete Scheduled Placement Test
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_scheduled_placement_test_placement_scheduled__schedule_id__delete: {
+    input: {
+    path: {
+      /** 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. */
+      schedule_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DeliverabilityPayload_;
+  };
+  /**
+   * DELETE /warmup/{mailbox_id}
+   * Delete Warmup
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_warmup_warmup__mailbox_id__delete: {
+    input: {
+    path: {
+      /** Mailbox id (mailboxes.id) */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /warmup/{mailbox_id}/disable
+   * Disable Warmup
+   * tier: write · scope: campaigns:write
+   */
+  disable_warmup_warmup__mailbox_id__disable_post: {
+    input: {
+    path: {
+      /** Mailbox id. */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DeliverabilityPayload_;
+  };
+  /**
+   * POST /warmup/{mailbox_id}/enable
+   * Enable Warmup
+   * tier: write · scope: campaigns:write
+   */
+  enable_warmup_warmup__mailbox_id__enable_post: {
+    input: {
+    path: {
+      /** Mailbox id. */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DeliverabilityPayload_;
+  };
+  /**
+   * POST /placement/tests/estimate
+   * Estimate Placement Test Cost
+   * tier: read · scope: campaigns:read
+   */
+  estimate_placement_test_cost_placement_tests_estimate_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: EstimateTestRequest;
+  };
+    output: ApiResponse_DeliverabilityPayload_;
+  };
+  /**
+   * GET /mailboxes/fleet-health
+   * Get Fleet Health
+   * tier: read · scope: campaigns:read
+   */
+  get_fleet_health_mailboxes_fleet_health_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxFleetHealthResponse_;
+  };
+  /**
+   * GET /mailboxes/{mailbox_id}
+   * Get Mailbox
+   * tier: read · scope: campaigns:read
+   */
+  get_mailbox_mailboxes__mailbox_id__get: {
+    input: {
+    path: {
+      /** Mailbox ID (mailboxes.id) */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxResponse_;
+  };
+  /**
+   * GET /mailboxes/{mailbox_id}/associated-sequences
+   * Get Mailbox Associated Sequences
+   * tier: read · scope: campaigns:read
+   */
+  get_mailbox_associated_sequences_mailboxes__mailbox_id__associated_sequences_get: {
+    input: {
+    path: {
+      /** Mailbox id. */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxAssociatedSequencesResponse_;
+  };
+  /**
+   * GET /mailboxes/{mailbox_id}/health
+   * Get Mailbox Health
+   * tier: read · scope: campaigns:read
+   */
+  get_mailbox_health_mailboxes__mailbox_id__health_get: {
+    input: {
+    path: {
+      /** Mailbox id. */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxHealthResponse_;
+  };
+  /**
+   * GET /placement/domains/stats
+   * Get Placement Domain Stats
+   * tier: read · scope: campaigns:read
+   */
+  get_placement_domain_stats_placement_domains_stats_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DeliverabilityListPayload_;
+  };
+  /**
+   * GET /placement/domains/{domain_id}/summary
+   * Get Placement Domain Summary
+   * tier: read · scope: campaigns:read
+   */
+  get_placement_domain_summary_placement_domains__domain_id__summary_get: {
+    input: {
+    path: {
+      /** Domain id. */
+      domain_id: number;
+    };
+    query?: {
+      history_page?: number;
+      history_limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DeliverabilityPayload_;
+  };
+  /**
+   * GET /placement/tests/{test_id}
+   * Get Placement Test
+   * tier: read · scope: campaigns:read
+   */
+  get_placement_test_placement_tests__test_id__get: {
+    input: {
+    path: {
+      /** Test id. */
+      test_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DeliverabilityPayload_;
+  };
+  /**
+   * GET /placement/scheduled/{schedule_id}
+   * Get Scheduled Placement Test
+   * tier: read · scope: campaigns:read
+   */
+  get_scheduled_placement_test_placement_scheduled__schedule_id__get: {
+    input: {
+    path: {
+      /** 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. */
+      schedule_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DeliverabilityPayload_;
+  };
+  /**
+   * GET /mailboxes/personas/{persona_id}
+   * Get Sender Persona
+   * tier: read · scope: campaigns:read
+   */
+  get_sender_persona_mailboxes_personas__persona_id__get: {
+    input: {
+    path: {
+      /** Sender persona id - from GET /mailboxes/personas */
+      persona_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * GET /warmup/{mailbox_id}/analytics
+   * Get Warmup Analytics
+   * tier: read · scope: campaigns:read
+   */
+  get_warmup_analytics_warmup__mailbox_id__analytics_get: {
+    input: {
+    path: {
+      /** Mailbox id. */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DeliverabilityPayload_;
+  };
+  /**
+   * GET /mailboxes/my
+   * List My Mailboxes
+   * tier: read · scope: campaigns:read
+   */
+  list_my_mailboxes_mailboxes_my_get: {
+    input: {
+    query?: {
+      /** Include archived mailboxes. */
+      include_archived?: boolean;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MyMailboxesResponse_;
+  };
+  /**
+   * GET /placement/tests
+   * List Placement Tests
+   * tier: read · scope: campaigns:read
+   */
+  list_placement_tests_placement_tests_get: {
+    input: {
+    query?: {
+      page?: number;
+      limit?: number;
+      /** 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. */
+      status?: string | null;
+      /** Only tests for this domain. */
+      domain_id?: number | null;
+      /** Only tests for this mailbox. */
+      mailbox_id?: number | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DeliverabilityListPayload_;
+  };
+  /**
+   * GET /placement/scheduled
+   * List Scheduled Placement Tests
+   * tier: read · scope: campaigns:read
+   */
+  list_scheduled_placement_tests_placement_scheduled_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DeliverabilityListPayload_;
+  };
+  /**
+   * GET /mailboxes/personas
+   * List Sender Personas
+   * tier: read · scope: campaigns:read
+   */
+  list_sender_personas_mailboxes_personas_get: {
+    input: {
+    query?: {
+      /** Include archived personas */
+      include_archived?: boolean;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainListPayload_;
+  };
+  /**
+   * POST /placement/scheduled/{schedule_id}/pause
+   * Pause Scheduled Placement Test
+   * tier: write · scope: campaigns:write
+   */
+  pause_scheduled_placement_test_placement_scheduled__schedule_id__pause_post: {
+    input: {
+    path: {
+      /** 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. */
+      schedule_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DeliverabilityPayload_;
+  };
+  /**
+   * POST /mailboxes/{mailbox_id}/request-cancellation
+   * Request Mailbox Cancellation
+   * tier: destructive · scope: campaigns:delete
+   */
+  request_mailbox_cancellation_mailboxes__mailbox_id__request_cancellation_post: {
+    input: {
+    path: {
+      /** Mailbox id (mailboxes.id) */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /placement/scheduled/{schedule_id}/resume
+   * Resume Scheduled Placement Test
+   * tier: write · scope: campaigns:write
+   */
+  resume_scheduled_placement_test_placement_scheduled__schedule_id__resume_post: {
+    input: {
+    path: {
+      /** 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. */
+      schedule_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DeliverabilityPayload_;
+  };
+  /**
+   * POST /mailboxes/{mailbox_id}/health/placement-test
+   * Run Mailbox Placement Test
+   * tier: billable · scope: campaigns:run
+   */
+  run_mailbox_placement_test_mailboxes__mailbox_id__health_placement_test_post: {
+    input: {
+    path: {
+      /** Mailbox id (mailboxes.id) */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /warmup/setup
+   * Setup Warmup
+   * tier: write · scope: campaigns:write
+   */
+  setup_warmup_warmup_setup_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SetupWarmupRequest;
+  };
+    output: ApiResponse_DeliverabilityPayload_;
+  };
+  /**
+   * POST /mailboxes/{mailbox_id}/share
+   * Share Mailbox
+   * tier: write · scope: campaigns:write
+   */
+  share_mailbox_mailboxes__mailbox_id__share_post: {
+    input: {
+    path: {
+      /** Mailbox id (mailboxes.id) */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MailboxShareRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /mailboxes/{mailbox_id}/test-connection
+   * Test Mailbox Connection
+   * tier: write · scope: campaigns:write
+   */
+  test_mailbox_connection_mailboxes__mailbox_id__test_connection_post: {
+    input: {
+    path: {
+      /** Mailbox ID (mailboxes.id) */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body?: MailboxTestConnectionRequest | null;
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /mailboxes/uncancel
+   * Uncancel Mailboxes
+   * tier: billable · scope: campaigns:run
+   */
+  uncancel_mailboxes_mailboxes_uncancel_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MailboxUncancelRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * PATCH /mailboxes/{mailbox_id}
+   * Update Mailbox
+   * tier: write · scope: campaigns:write
+   */
+  update_mailbox_mailboxes__mailbox_id__patch: {
+    input: {
+    path: {
+      /** Mailbox ID (mailboxes.id) */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MailboxUpdateRequest;
+  };
+    output: ApiResponse_MailboxResponse_;
+  };
+  /**
+   * PATCH /mailboxes/personas/{persona_id}
+   * Update Sender Persona
+   * tier: write · scope: campaigns:write
+   */
+  update_sender_persona_mailboxes_personas__persona_id__patch: {
+    input: {
+    path: {
+      /** Sender persona id - from GET /mailboxes/personas */
+      persona_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SenderPersonaWriteRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * PATCH /warmup/{mailbox_id}/settings
+   * Update Warmup Settings
+   * tier: write · scope: campaigns:write
+   */
+  update_warmup_settings_warmup__mailbox_id__settings_patch: {
+    input: {
+    path: {
+      /** Mailbox id. */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: UpdateWarmupSettingsRequest;
+  };
+    output: ApiResponse_DeliverabilityPayload_;
+  };
+  /**
+   * POST /mailboxes/personas/{persona_id}/photo
+   * Upload Persona Photo
+   * tier: write · scope: campaigns:write
+   */
+  upload_persona_photo_mailboxes_personas__persona_id__photo_post: {
+    input: {
+    path: {
+      /** Sender persona id - from GET /mailboxes/personas */
+      persona_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+}
+
+// 36 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_DeliverabilityListPayload_ {
+  data: DeliverabilityListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_DeliverabilityPayload_ {
+  data: DeliverabilityPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_MailboxAssociatedSequencesResponse_ {
+  data: MailboxAssociatedSequencesResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_MailboxDeleteResponse_ {
+  data: MailboxDeleteResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_MailboxDomainListPayload_ {
+  data: MailboxDomainListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_MailboxDomainPayload_ {
+  data: MailboxDomainPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_MailboxFleetHealthResponse_ {
+  data: MailboxFleetHealthResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_MailboxHealthResponse_ {
+  data: MailboxHealthResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_MailboxResponse_ {
+  data: MailboxResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_MyMailboxesResponse_ {
+  data: MyMailboxesResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_dict_ {
+  data: Record<string, unknown>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface AssociatedSequence {
+  id?: number | null;
+  status?: string | null;
+  title?: string | null;
+  [key: string]: unknown;
+}
+
+/**
+ * Run an inbox-placement test. THIS SPENDS CREDITS.
+ *
+ * 20 credits per mailbox, charged when the test is created, not when it
+ * finishes. `frequency` other than `once` creates a RECURRING schedule that
+ * keeps charging - use `GET /placement/scheduled` to see what is running and
+ * `/pause` to stop it.
+ */
+export interface CreateTestRequest {
+  custom_body?: string | null;
+  custom_subject?: string | null;
+  /** `once`, `weekly`, `biweekly` or `monthly`. Anything but `once` keeps charging on that cadence until paused. */
+  frequency?: string;
+  /** 1-20 mailboxes. The app's own ceiling; each one costs credits. */
+  mailbox_ids: Array<number>;
+  /** 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. */
+  receiver_types?: Array<string> | null;
+  /** Minutes between sends, spreading the test out. */
+  sending_interval?: number;
+  test_name: string;
+}
+
+/** An open envelope for a LIST result, so a bare list keeps its shape. */
+export interface DeliverabilityListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/**
+ * An open envelope for a test, a schedule or a warmup report.
+ *
+ * Open because placement results carry one panel per seed provider and the
+ * provider set changes; a closed model would drop a panel, and a missing
+ * panel on a deliverability report reads as "we did not test there" when the
+ * truth may be "you did not land there".
+ */
+export type DeliverabilityPayload = Record<string, unknown>;
+
+/**
+ * What a placement test WOULD cost. Charges nothing.
+ *
+ * Worth calling first: creating the test charges 20 credits per mailbox, and
+ * this is the only way to learn the number before spending it.
+ */
+export interface EstimateTestRequest {
+  /** The mailboxes the test would send from. */
+  mailbox_ids: Array<number>;
+}
+
+/** Archive a mailbox, or bring it back. Mirrors the app's `ArchiveMailboxRequest`. */
+export interface MailboxArchiveRequest {
+  /** True hides the mailbox from pickers and stops new use; false restores it */
+  is_archived: boolean;
+}
+
+/**
+ * Sequences wired to a mailbox, at ANY status.
+ *
+ * `has_associations` is the field to branch on before archiving or
+ * cancelling - it is true whenever the list is non-empty, including for
+ * draft and terminated sequences, which is exactly how the app gates those
+ * actions.
+ */
+export interface MailboxAssociatedSequencesResponse {
+  has_associations?: boolean;
+  sequences?: Array<AssociatedSequence>;
+  [key: string]: unknown;
+}
+
+/** Import mailboxes from CSV. Credentials in the CSV are write-only. */
+export interface MailboxBulkImportRequest {
+  /** Raw CSV. Credential columns are stored encrypted and never returned. */
+  csv_content: string;
+}
+
+/**
+ * Connect an existing mailbox over IMAP/SMTP.
+ *
+ * Google/Microsoft mailboxes are not connectable through this endpoint: OAuth
+ * needs a browser redirect that an API call cannot complete on its own. Connect
+ * those in the app for now.
+ */
+export interface MailboxCreateRequest {
+  authentication?: string;
+  /** Max sends per day for this mailbox */
+  daily_limit?: number;
+  display_name?: string | null;
+  /** The mailbox address, e.g. sales@acme.com */
+  email: string;
+  enable_starttls_auto?: boolean;
+  /** IMAP host, e.g. imap.acme.com */
+  imap_address: string;
+  /** Write-only. Never returned by any endpoint. */
+  imap_password: string;
+  imap_port?: number;
+  imap_username: string;
+  signature_html?: string | null;
+  signature_plain?: string | null;
+  /** SMTP host, e.g. smtp.acme.com */
+  smtp_address: string;
+  /** Write-only. Never returned by any endpoint. */
+  smtp_password: string;
+  smtp_port?: number;
+  smtp_username: string;
+  use_html_signature?: boolean;
+}
+
+export interface MailboxDeleteResponse {
+  deleted: boolean;
+  mailbox_id: number;
+}
+
+/**
+ * An open envelope for a LIST result, so a bare list keeps its shape.
+ *
+ * A named collection (``{"plans": [...]}``) keeps its own key AND gains
+ * ``items``, so a caller can page every list surface the same way without
+ * memorising which key each route chose.
+ */
+export interface MailboxDomainListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/**
+ * An open envelope for one provider/deliverability result.
+ *
+ * Open on purpose. These payloads are provider state and advisory reads whose
+ * contents grow with the product, and a dropped field reads as "nothing to
+ * report" rather than "we did not tell you". Every value passes through
+ * ``scrub_vendor_names`` on the way in.
+ */
+export type MailboxDomainPayload = Record<string, unknown>;
+
+/** Health roll-up across every mailbox in the org. */
+export type MailboxFleetHealthResponse = Record<string, unknown>;
+
+/** Deliverability health for a single mailbox. */
+export interface MailboxHealthResponse {
+  mailbox_id?: number | null;
+  /** Health status as the app computes it. */
+  status?: string | null;
+  [key: string]: unknown;
+}
+
+/** A sending mailbox. Credentials are never returned. */
+export interface MailboxResponse {
+  allows_nurture?: boolean | null;
+  /** active | paused | disconnected | expired | ... */
+  connection_status?: string | null;
+  created_at?: string | null;
+  created_by?: string | null;
+  daily_limit?: number | null;
+  display_name?: string | null;
+  email?: string | null;
+  id: number;
+  is_archived?: boolean | null;
+  provider?: string | null;
+  updated_at?: string | null;
+  warmup_enabled?: boolean | null;
+}
+
+/** Share a mailbox with the rest of the org, or stop sharing it. */
+export interface MailboxShareRequest {
+  /** True makes the mailbox usable by every member of the org */
+  shared_with_team: boolean;
+}
+
+/** One mailbox as the inventory surfaces it. */
+export interface MailboxSummary {
+  /** SMTP, GMAIL or INBOXKIT. */
+  channel_type?: string | null;
+  email?: string | null;
+  id?: number | null;
+  is_archived?: boolean | null;
+  status?: string | null;
+  [key: string]: unknown;
+}
+
+/** Optionally override credentials for the test without saving them. */
+export interface MailboxTestConnectionRequest {
+  imap_address?: string | null;
+  imap_password?: string | null;
+  imap_port?: number | null;
+  imap_username?: string | null;
+  smtp_address?: string | null;
+  smtp_password?: string | null;
+  smtp_port?: number | null;
+  smtp_username?: string | null;
+}
+
+/** Reverse a scheduled cancellation. RESUMES BILLING on every mailbox listed. */
+export interface MailboxUncancelRequest {
+  /** Mailboxes to restore. Up to 50. */
+  mailbox_ids: Array<number>;
+}
+
+/** Partial update. Only supplied fields are changed. */
+export interface MailboxUpdateRequest {
+  allows_nurture?: boolean | null;
+  daily_limit?: number | null;
+  display_name?: string | null;
+  imap_address?: string | null;
+  /** Write-only. */
+  imap_password?: string | null;
+  imap_port?: number | null;
+  imap_username?: string | null;
+  signature_html?: string | null;
+  signature_plain?: string | null;
+  smtp_address?: string | null;
+  /** Write-only. */
+  smtp_password?: string | null;
+  smtp_port?: number | null;
+  smtp_username?: string | null;
+  use_html_signature?: boolean | null;
+}
+
+export interface MyMailboxesResponse {
+  mailboxes?: Array<MailboxSummary>;
+  total?: number;
+  [key: string]: unknown;
+}
+
+export interface PaginationMeta {
+  /** Whether there are more pages */
+  has_next: boolean;
+  /** Items per page */
+  limit: number;
+  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
+  next_cursor?: string | null;
+  /** Current page number (1-indexed) */
+  page: number;
+  /** Total number of items */
+  total: number;
+}
+
+/**
+ * A sender identity: the real person mail is bought and sent under.
+ *
+ * Mirrors the app's persona fields (`CreateSenderPersonaData` /
+ * `SenderPersonaPatch`). The app's own validators - name alphabet, email
+ * normalisation, photo URL, "identity or team member" - run on the app model
+ * and surface as a 422, so they are delegated rather than copied here.
+ *
+ * On CREATE: give `first_name`, `last_name` and `email`, or a `team_member_id`
+ * to take the identity from. On UPDATE: send only what changes; an identity
+ * field cannot be set to null.
+ */
+export interface SenderPersonaWriteRequest {
+  /** Registrant address, line 1 */
+  address_line1?: string | null;
+  /** Registrant address, line 2 */
+  address_line2?: string | null;
+  /** City */
+  city?: string | null;
+  /** Country */
+  country?: string | null;
+  /** The persona's own address */
+  email?: string | null;
+  /** Given name */
+  first_name?: string | null;
+  /** Family name */
+  last_name?: string | null;
+  /** Organisation name */
+  organization?: string | null;
+  /** Contact phone */
+  phone?: string | null;
+  /** Photo URL */
+  photo_url?: string | null;
+  /** Postal code */
+  postal_code?: string | null;
+  /** State or region */
+  state?: string | null;
+  /** Team member whose identity this persona uses */
+  team_member_id?: string | null;
+  /** Job title shown in signatures */
+  title?: string | null;
+}
+
+/** Put a mailbox onto a warmup provider. */
+export interface SetupWarmupRequest {
+  mailbox_id: number;
+  /** The warmup provider to enrol with. */
+  provider: string;
+  /** 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. */
+  warmup_settings?: Record<string, unknown> | null;
+}
+
+/**
+ * Change how an already-running warmup behaves.
+ *
+ * OPEN (`extra="allow"`), and deliberately: the app types this parameter as
+ * a bare `Dict[str, Any]` and forwards it to the warmup provider untouched.
+ * The accepted keys differ per provider and change with them, so a closed
+ * mirror here would reject a setting the provider supports - and the app
+ * would have accepted it.
+ */
+export type UpdateWarmupSettingsRequest = Record<string, unknown>;