@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/providerDomains.d.ts

@@ -0,0 +1,866 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.providerDomains` (Provider Domains): 34 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"add_external_domains_provider_domains_add_external_post">;
+ *
+ * Reference with examples: providerDomains.md
+ */
+/* eslint-disable */
+
+/** `g8.api.providerDomains.<member>` -> the operationId it calls. */
+export interface ProviderDomainsMembers {
+  addExternalDomains: "add_external_domains_provider_domains_add_external_post";
+  cancelDomainTransfer: "cancel_domain_transfer_provider_domains_cancel_transfer_post";
+  checkDomainAvailability: "check_domain_availability_provider_domains_check_availability_post";
+  checkDomainPropagation: "check_domain_propagation_provider_domains__domain_id__check_propagation_post";
+  checkExternalAvailability: "check_external_availability_provider_domains_check_external_availability_post";
+  checkMailboxStatus: "check_mailbox_status_provider_domains__domain_id__check_mailbox_status_post";
+  checkTransferAvailability: "check_transfer_availability_provider_domains_check_transfer_availability_post";
+  checkoutPurchaseDomains: "checkout_purchase_domains_provider_domains_checkout_purchase_post";
+  checkoutPurchaseMailboxes: "checkout_purchase_mailboxes_provider_domains__domain_id__checkout_mailboxes_post";
+  checkoutTransferDomain: "checkout_transfer_domain_provider_domains_checkout_transfer_post";
+  connectProvider: "connect_provider_provider_domains__domain_id__connect_provider_post";
+  deleteDomainForwarding: "delete_domain_forwarding_provider_domains__domain_id__forwarding_delete";
+  deleteDomainMailbox: "delete_domain_mailbox_provider_domains__domain_id__delete_mailbox_post";
+  generateDomainNames: "generate_domain_names_provider_domains_generate_domains_post";
+  getDomainInfo: "get_domain_info_provider_domains__domain_id__info_post";
+  getExternalDomainInfo: "get_external_domain_info_provider_domains__domain_id__external_info_post";
+  getProviderStatus: "get_provider_status_provider_domains__domain_id__provider_status_post";
+  getProvisioningStates: "get_provisioning_states_provider_domains__domain_id__provisioning_states_post";
+  getSendingDomainStats: "get_sending_domain_stats_provider_domains_stats_get";
+  getSendingPricing: "get_sending_pricing_provider_domains_pricing_get";
+  getTransferInfo: "get_transfer_info_provider_domains__domain_id__transfer_info_post";
+  listDomainMailboxes: "list_domain_mailboxes_provider_domains__domain_id__mailboxes_get";
+  listMailboxesForStat: "list_mailboxes_for_stat_provider_domains_stats_mailboxes__stat_key__get";
+  listProviderDomains: "list_provider_domains_provider_domains_get";
+  refreshDomainFromProvider: "refresh_domain_from_provider_provider_domains__domain_id__refresh_from_provider_post";
+  regenerateNameservers: "regenerate_nameservers_provider_domains__domain_id__regenerate_nameservers_post";
+  resendRegistrantVerification: "resend_registrant_verification_provider_domains__domain_id__resend_verification_post";
+  resendTransferPassword: "resend_transfer_password_provider_domains__domain_id__resend_transfer_password_post";
+  resetMailboxPassword: "reset_mailbox_password_provider_domains__domain_id__reset_password_post";
+  setAutoWarmup: "set_auto_warmup_provider_domains__domain_id__auto_warmup_post";
+  setDnsRecords: "set_dns_records_provider_domains__domain_id__dns_post";
+  setDomainForwarding: "set_domain_forwarding_provider_domains__domain_id__forwarding_post";
+  setNameservers: "set_nameservers_provider_domains__domain_id__set_nameservers_post";
+  updateMailboxProfilePicture: "update_mailbox_profile_picture_provider_domains__domain_id__mailbox_profile_picture_post";
+}
+
+/** Input and output of every `g8.api.providerDomains` operation, keyed by operationId. */
+export interface ProviderDomainsOperations {
+  /**
+   * POST /provider-domains/add-external
+   * Add External Domains
+   * tier: billable · scope: campaigns:run
+   */
+  add_external_domains_provider_domains_add_external_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AddExternalDomainsRequest;
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /provider-domains/cancel-transfer
+   * Cancel Domain Transfer
+   * tier: destructive · scope: campaigns:delete
+   */
+  cancel_domain_transfer_provider_domains_cancel_transfer_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DomainTransferCancelRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/check-availability
+   * Check Domain Availability
+   * tier: billable · scope: campaigns:run
+   */
+  check_domain_availability_provider_domains_check_availability_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DomainAvailabilityCheckRequest;
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/check-propagation
+   * Check Domain Propagation
+   * tier: billable · scope: campaigns:run
+   */
+  check_domain_propagation_provider_domains__domain_id__check_propagation_post: {
+    input: {
+    path: {
+      /** Provider domain ID (provider_domains.id) — from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /provider-domains/check-external-availability
+   * Check External Availability
+   * tier: read · scope: campaigns:read
+   */
+  check_external_availability_provider_domains_check_external_availability_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ExternalDomainAvailabilityRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/check-mailbox-status
+   * Check Mailbox Status
+   * tier: write · scope: campaigns:write
+   */
+  check_mailbox_status_provider_domains__domain_id__check_mailbox_status_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DomainMailboxRefRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/check-transfer-availability
+   * Check Transfer Availability
+   * tier: read · scope: campaigns:read
+   */
+  check_transfer_availability_provider_domains_check_transfer_availability_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DomainTransferAvailabilityRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/checkout-purchase
+   * Checkout Purchase Domains
+   * tier: billable · scope: campaigns:run
+   */
+  checkout_purchase_domains_provider_domains_checkout_purchase_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DomainPurchaseRequest;
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/checkout-mailboxes
+   * Checkout Purchase Mailboxes
+   * tier: billable · scope: campaigns:run
+   */
+  checkout_purchase_mailboxes_provider_domains__domain_id__checkout_mailboxes_post: {
+    input: {
+    path: {
+      /** Provider domain ID (provider_domains.id) — from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MailboxPurchaseRequest;
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /provider-domains/checkout-transfer
+   * Checkout Transfer Domain
+   * tier: billable · scope: campaigns:run
+   */
+  checkout_transfer_domain_provider_domains_checkout_transfer_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DomainTransferRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/connect-provider
+   * Connect Provider
+   * tier: billable · scope: campaigns:run
+   */
+  connect_provider_provider_domains__domain_id__connect_provider_post: {
+    input: {
+    path: {
+      /** Provider domain ID (provider_domains.id) — from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * DELETE /provider-domains/{domain_id}/forwarding
+   * Delete Domain Forwarding
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_domain_forwarding_provider_domains__domain_id__forwarding_delete: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/delete-mailbox
+   * Delete Domain Mailbox
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_domain_mailbox_provider_domains__domain_id__delete_mailbox_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DomainMailboxRefRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/generate-domains
+   * Generate Domain Names
+   * tier: read · scope: campaigns:read
+   */
+  generate_domain_names_provider_domains_generate_domains_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DomainNameGenerateRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/info
+   * Get Domain Info
+   * tier: read · scope: campaigns:read
+   */
+  get_domain_info_provider_domains__domain_id__info_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/external-info
+   * Get External Domain Info
+   * tier: read · scope: campaigns:read
+   */
+  get_external_domain_info_provider_domains__domain_id__external_info_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/provider-status
+   * Get Provider Status
+   * tier: read · scope: campaigns:read
+   */
+  get_provider_status_provider_domains__domain_id__provider_status_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/provisioning-states
+   * Get Provisioning States
+   * tier: read · scope: campaigns:read
+   */
+  get_provisioning_states_provider_domains__domain_id__provisioning_states_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ProvisioningStatesRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * GET /provider-domains/stats
+   * Get Sending Domain Stats
+   * tier: read · scope: campaigns:read
+   */
+  get_sending_domain_stats_provider_domains_stats_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * GET /provider-domains/pricing
+   * Get Sending Pricing
+   * tier: read · scope: campaigns:read
+   */
+  get_sending_pricing_provider_domains_pricing_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/transfer-info
+   * Get Transfer Info
+   * tier: read · scope: campaigns:read
+   */
+  get_transfer_info_provider_domains__domain_id__transfer_info_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * GET /provider-domains/{domain_id}/mailboxes
+   * List Domain Mailboxes
+   * tier: read · scope: campaigns:read
+   */
+  list_domain_mailboxes_provider_domains__domain_id__mailboxes_get: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    query?: {
+      /** First row, zero-based */
+      start_row?: number;
+      /** Row after the last one returned */
+      end_row?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainListPayload_;
+  };
+  /**
+   * GET /provider-domains/stats/mailboxes/{stat_key}
+   * List Mailboxes For Stat
+   * tier: read · scope: campaigns:read
+   */
+  list_mailboxes_for_stat_provider_domains_stats_mailboxes__stat_key__get: {
+    input: {
+    path: {
+      /** Which stat to drill into */
+      stat_key: "warmup_ready_to_outreach";
+    };
+    query?: {
+      /** Newest first. The app's own ceiling. */
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainListPayload_;
+  };
+  /**
+   * GET /provider-domains
+   * List Provider Domains
+   * tier: read · scope: campaigns:read
+   */
+  list_provider_domains_provider_domains_get: {
+    input: {
+    query?: {
+      page?: number;
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_List_ProviderDomainResponse__;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/refresh-from-provider
+   * Refresh Domain From Provider
+   * tier: write · scope: campaigns:write
+   */
+  refresh_domain_from_provider_provider_domains__domain_id__refresh_from_provider_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/regenerate-nameservers
+   * Regenerate Nameservers
+   * tier: external · scope: campaigns:run
+   */
+  regenerate_nameservers_provider_domains__domain_id__regenerate_nameservers_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/resend-verification
+   * Resend Registrant Verification
+   * tier: external · scope: campaigns:run
+   */
+  resend_registrant_verification_provider_domains__domain_id__resend_verification_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/resend-transfer-password
+   * Resend Transfer Password
+   * tier: external · scope: campaigns:run
+   */
+  resend_transfer_password_provider_domains__domain_id__resend_transfer_password_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/reset-password
+   * Reset Mailbox Password
+   * tier: destructive · scope: campaigns:delete
+   */
+  reset_mailbox_password_provider_domains__domain_id__reset_password_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MailboxPasswordResetRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/auto-warmup
+   * Set Auto Warmup
+   * tier: billable · scope: campaigns:run
+   */
+  set_auto_warmup_provider_domains__domain_id__auto_warmup_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AutoWarmupRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/dns
+   * Set Dns Records
+   * tier: billable · scope: campaigns:run
+   */
+  set_dns_records_provider_domains__domain_id__dns_post: {
+    input: {
+    path: {
+      /** Provider domain ID (provider_domains.id) — from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DnsRecordsRequest;
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/forwarding
+   * Set Domain Forwarding
+   * tier: external · scope: campaigns:run
+   */
+  set_domain_forwarding_provider_domains__domain_id__forwarding_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DomainForwardingRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/set-nameservers
+   * Set Nameservers
+   * tier: external · scope: campaigns:run
+   */
+  set_nameservers_provider_domains__domain_id__set_nameservers_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+  /**
+   * POST /provider-domains/{domain_id}/mailbox-profile-picture
+   * Update Mailbox Profile Picture
+   * tier: external · scope: campaigns:run
+   */
+  update_mailbox_profile_picture_provider_domains__domain_id__mailbox_profile_picture_post: {
+    input: {
+    path: {
+      /** Sending domain id (provider_domains.id) - from GET /provider-domains */
+      domain_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MailboxProfilePictureRequest;
+  };
+    output: ApiResponse_MailboxDomainPayload_;
+  };
+}
+
+// 25 schemas referenced above (the same as G8Contract.<Name>).
+
+/** Register domains you already own elsewhere so they can be used for sending. */
+export interface AddExternalDomainsRequest {
+  /** Domains already owned outside graph8, e.g. ['acme.com'] */
+  domains: Array<string>;
+}
+
+export interface ApiResponse_List_ProviderDomainResponse__ {
+  data: Array<ProviderDomainResponse>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_MailboxDomainListPayload_ {
+  data: MailboxDomainListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_MailboxDomainPayload_ {
+  data: MailboxDomainPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_dict_ {
+  data: Record<string, unknown>;
+  pagination?: PaginationMeta | null;
+}
+
+/**
+ * Turn automatic warmup enrolment on or off for this domain.
+ *
+ * ON means every mailbox bought on this domain is enrolled in warmup
+ * automatically, which is a RECURRING credit charge per mailbox.
+ */
+export interface AutoWarmupRequest {
+  /** True enrols new mailboxes automatically and bills warmup for them */
+  enabled: boolean;
+}
+
+/** Set the sending DNS records (SPF/DKIM/MX/tracking CNAME) for a domain. */
+export interface DnsRecordsRequest {
+  /** DNS records by type, e.g. {'TXT': [...], 'MX': [...], 'CNAME': [...]} */
+  records?: Record<string, Array<Record<string, unknown>>>;
+  /** Discard `records` and (re)apply graph8's default sending DNS zone */
+  reset_to_default?: boolean;
+}
+
+/** Check whether a domain can be bought, and its price. Spends no credits. */
+export interface DomainAvailabilityCheckRequest {
+  /** Domain to check, e.g. acme-outreach.com */
+  domain: string;
+  /** Provisioning path to check availability/price against. */
+  provider?: "registrar" | "managed";
+}
+
+/** Forward mail arriving at this domain somewhere else. */
+export interface DomainForwardingRequest {
+  /** Forwarding attributes accepted by the registrar */
+  attributes: Record<string, unknown>;
+}
+
+/**
+ * Names one mailbox on the domain in the path.
+ *
+ * Shared by the info / TOTP / delete / status routes, all of which read
+ * ``request["mailbox_id"]`` off an untyped dict in the app.
+ */
+export interface DomainMailboxRefRequest {
+  /** Mailbox id (mailboxes.id) on this domain */
+  mailbox_id: number;
+}
+
+/** Suggest buyable domain names around a keyword. SPENDS NOTHING. */
+export interface DomainNameGenerateRequest {
+  /** How many suggestions to return */
+  count?: number;
+  /** Seed word the generated names are built around, e.g. 'acme' */
+  keyword: string;
+  /** Comma-separated prefixes to try, e.g. 'get,try' */
+  prefixes?: string | null;
+  /** Provisioning path to generate for */
+  provider?: "registrar" | "managed" | "pilot";
+  /** Comma-separated suffixes to try, e.g. 'hq,mail' */
+  suffixes?: string | null;
+}
+
+/**
+ * Buy one or more sending domains. Spends real credits — see the 402 contract
+ * on the route docstring.
+ */
+export interface DomainPurchaseRequest {
+  /** Registrant contact used for domain registration */
+  contact_info: Record<string, string>;
+  /** Domains to buy, e.g. ['acme-outreach.com']. Up to 50 per request. */
+  domains: Array<string>;
+  /** Registration period, in years */
+  period?: number;
+  /** Provisioning path. 'pilot' is limited to allowlisted orgs and otherwise returns 400. */
+  provider?: "registrar" | "managed" | "pilot";
+  /** Extra domains bought as spare warm-up capacity (warm from day 0, excluded from sending until promoted). Up to 50 per request. */
+  spare_domains?: Array<string>;
+}
+
+/** Check whether a domain you own elsewhere can be transferred in. SPENDS NOTHING. */
+export interface DomainTransferAvailabilityRequest {
+  /** Domain to check, e.g. acme-outreach.com */
+  domain: string;
+}
+
+/**
+ * Abort an in-flight transfer.
+ *
+ * The app handler reads ``request["domain_id"]`` off an untyped dict, so a
+ * missing key is a 500 there. Typed here, it is a 422.
+ */
+export interface DomainTransferCancelRequest {
+  /** Provider domain id whose transfer should be aborted */
+  domain_id: number;
+}
+
+/** Transfer a domain you already own INTO graph8. SPENDS REAL MONEY. */
+export interface DomainTransferRequest {
+  /** Transfer authorisation code from your current registrar */
+  auth_info: string;
+  /** Registrant contact recorded with the registrar */
+  contact_info: Record<string, string>;
+  /** Domain to transfer in, e.g. acme-outreach.com */
+  domain: string;
+}
+
+/** Check whether a domain can be attached as an external sending domain. SPENDS NOTHING. */
+export interface ExternalDomainAvailabilityRequest {
+  /** Domain to check, e.g. acme.com */
+  domain: string;
+}
+
+/**
+ * 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>;
+
+/** Replace a provider mailbox's password. Write-only - it is never returned. */
+export interface MailboxPasswordResetRequest {
+  /** Mailbox address whose password is being replaced */
+  email: string;
+  /** Write-only. Never returned by any endpoint. */
+  new_password: string;
+}
+
+/** Set the avatar shown on mail this mailbox sends. */
+export interface MailboxProfilePictureRequest {
+  /** Mailbox id (mailboxes.id) on this domain */
+  mailbox_id: number;
+  /** Publicly reachable image URL */
+  profile_picture: string;
+}
+
+/**
+ * One mailbox to create. Supply `username` for a managed purchase
+ * (`provider='managed'`) or a full `email` for `registrar`/`pilot`.
+ */
+export interface MailboxPurchaseItem {
+  /** Full mailbox address, e.g. sales@acme.com */
+  email?: string | null;
+  first_name?: string | null;
+  /** Required (non-empty) for a managed purchase — an empty last name is rejected upstream and stalls provisioning. */
+  last_name?: string | null;
+  /** Write-only. Never returned by any endpoint. */
+  password?: string | null;
+  /** Local-part, e.g. 'sales' for sales@domain */
+  username?: string | null;
+}
+
+/**
+ * Buy one or more mailboxes on an already-purchased/connected domain.
+ * Spends real credits — see the 402 contract on the route docstring.
+ */
+export interface MailboxPurchaseRequest {
+  /** Enroll each mailbox in warmup immediately after purchase */
+  enable_warmup?: boolean;
+  /** Mailboxes to create. Up to 5 per domain for a provider='managed' purchase, and up to 250 per request. */
+  mailboxes: Array<MailboxPurchaseItem>;
+  /** Mailbox platform. Required when provider='managed'. */
+  platform?: ("GOOGLE" | "MICROSOFT") | null;
+  provider?: "registrar" | "managed" | "pilot";
+  /** Warmup engine. Omit to use the account default. */
+  warmup_engine?: ("instantly" | "smartlead" | "managed") | null;
+  warmup_settings?: Record<string, unknown> | null;
+}
+
+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 sending domain owned (or connected) by the org. */
+export interface ProviderDomainResponse {
+  created_at?: string | null;
+  created_by?: string | null;
+  dns_zone_created?: boolean;
+  domain: string;
+  expires_at?: string | null;
+  id: number;
+  is_external?: boolean;
+  is_transfer?: boolean;
+  mailbox_count?: number;
+  /** Whether this domain is connected to the managed mailbox-provisioning backend. Required before checkout-mailboxes will succeed for a managed purchase — connect it first with POST .../connect-provider. */
+  provider_connected: boolean;
+  purchase_date?: string | null;
+  purchase_period?: number | null;
+  /** How the domain entered the org, e.g. purchased | transferred | external */
+  source: string;
+  status?: string | null;
+  updated_at?: string | null;
+}
+
+/** Ask for the live provisioning step of up to 50 mailboxes. */
+export interface ProvisioningStatesRequest {
+  /** Mailbox ids to report on. Up to 50. */
+  mailbox_ids?: Array<number>;
+}