@sendmux/management 0.0.0-bootstrap.0

package/dist/generated/sdk.gen.js

@@ -0,0 +1,566 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { client } from './client.gen.js';
+/**
+ * Get current balance
+ *
+ * Returns the current team balance and auto top-up configuration.
+ */
+export const managementListBalance = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/billing/balance',
+    ...options
+});
+/**
+ * Get spend summary
+ *
+ * Returns a spend summary over a configurable lookback period.
+ */
+export const managementGetSpendSummary = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/billing/summary',
+    ...options
+});
+/**
+ * List transactions
+ *
+ * Returns paginated credit transaction history with optional type filter. Uses cursor-based pagination ordered by created_at descending — pass `cursor=<next_cursor>` from the previous response to fetch the next page.
+ */
+export const managementListTransactions = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/billing/transactions',
+    ...options
+});
+/**
+ * List mailbox domains
+ *
+ * Returns a cursor-paginated list of sending domains configured for the team, ordered by `created_at` descending. Each entry includes the DNS records the customer must place, the current verification status, and the SES DKIM state. Pass `cursor=<next_cursor>` from the previous response to fetch the next page.
+ */
+export const managementListDomains = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/domains',
+    ...options
+});
+/**
+ * Add a mailbox domain
+ *
+ * Creates a new sending domain and returns the DNS records the customer must place before verification can succeed. Provisioning touches both our mail platform and Amazon SES — on any failure the partial state is automatically rolled back.
+ *
+ * Supply an `Idempotency-Key` header (any unique string, max 255 chars) to safely retry on network errors. Replays with the same key return the original response; replays with a different body return `409 idempotency_conflict`.
+ */
+export const managementCreateDomain = (options) => (options?.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/domains',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options?.headers
+    }
+});
+/**
+ * Delete a mailbox domain
+ *
+ * Removes a domain from our mail platform, Amazon SES, and Sendmux. Blocked if any active mailbox still uses the domain — delete those mailboxes first.
+ */
+export const managementDeleteDomain = (options) => (options.client ?? client).delete({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/domains/{public_id}',
+    ...options
+});
+/**
+ * Get a mailbox domain
+ *
+ * Returns a single domain including its DNS records and latest verification state. Responses carry a weak `ETag` header — send it back as `If-None-Match` on the next request and the server will return `304 Not Modified` (no body) when the resource has not changed.
+ */
+export const managementGetDomain = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/domains/{public_id}',
+    ...options
+});
+/**
+ * Get domain-wide sender filters
+ *
+ * Returns the current sender-filter mode and rule set applied to every mailbox under this domain. Per-mailbox rules take precedence at match time.
+ *
+ * Responses carry a weak `ETag` — send it as `If-None-Match` to skip the body when the filter set has not changed (returns `304 Not Modified`). The same ETag is the value to use in `If-Match` on the corresponding PUT for optimistic concurrency.
+ */
+export const managementGetDomainFilters = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/domains/{public_id}/filters',
+    ...options
+});
+/**
+ * Replace domain-wide sender filters
+ *
+ * Atomically replaces the sender-filter mode and rule set for an entire domain. Applies to every mailbox under the domain unless that mailbox has its own per-mailbox rules (which take precedence). Maximum 1000 rules per request.
+ *
+ * For optimistic concurrency, send `If-Match: <etag>` using the ETag from a prior GET. A mismatched `If-Match` returns `409 conflict` (the server's ETag is echoed back so you can decide whether to re-fetch). Responses carry the new ETag so chained edits can pipeline without a re-GET.
+ */
+export const managementSetDomainFilters = (options) => (options.client ?? client).put({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/domains/{public_id}/filters',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Verify a mailbox domain
+ *
+ * Runs an immediate DNS-over-HTTPS check of the domain's MX, SPF, DMARC and ownership TXT records, then asks SES for the latest DKIM status. If every check passes the domain is marked verified. Domains automatically re-verify every 6 hours — this endpoint is only needed to trigger a check on demand.
+ */
+export const managementVerifyDomain = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/domains/{public_id}/verify',
+    ...options
+});
+/**
+ * Download a domain as a zone file
+ *
+ * Returns the domain's DNS records formatted as a BIND-style zone file fragment. Suitable for direct paste into a DNS provider that accepts zone-file imports.
+ */
+export const managementGetDomainZoneFile = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/domains/{public_id}/zone-file',
+    ...options
+});
+/**
+ * List delivery logs
+ *
+ * Returns paginated delivery logs with cursor-based pagination and filters.
+ */
+export const managementListEmailLogs = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/emails/logs',
+    ...options
+});
+/**
+ * Get delivery log
+ *
+ * Returns a single delivery log by its public ID. Responses carry a weak `ETag` header — send it back as `If-None-Match` on the next request and the server will return `304 Not Modified` (no body) when the log has not changed. Logs in a terminal status (sent/failed/rejected) stop changing, so 304 replay is a real bandwidth win on repeated polls.
+ */
+export const managementGetEmailLog = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/emails/logs/{public_id}',
+    ...options
+});
+/**
+ * Get email metrics
+ *
+ * Returns aggregated email delivery counts with flexible time windowing and comparison period.
+ */
+export const managementGetEmailMetrics = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/emails/metrics',
+    ...options
+});
+/**
+ * List incoming logs
+ *
+ * Returns paginated incoming message logs for billing accountability.
+ */
+export const managementListInboxLogs = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/inboxes/logs',
+    ...options
+});
+/**
+ * Get incoming log
+ *
+ * Returns one incoming message log by public ID.
+ */
+export const managementGetInboxLog = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/inboxes/logs/{public_id}',
+    ...options
+});
+/**
+ * List mailboxes
+ *
+ * Returns a cursor-paginated list of mailboxes configured for the team, ordered by `created_at` descending. Pass `cursor=<next_cursor>` from the previous response to fetch the next page.
+ */
+export const managementListMailboxes = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/mailboxes',
+    ...options
+});
+/**
+ * Create a mailbox
+ *
+ * Provisions a new mailbox plus an initial bearer token and matching IMAP/SMTP mailbox password. The domain portion of the email must already be verified via POST /domains. If supplied, `quota_bytes` must be one of the current storage tiers: 1073741824 (1 GB), 5368709120 (5 GB), or 53687091200 (50 GB). Creation provisions resources on our mail platform and, for `@myagent.mx` addresses, on Amazon SES — any failure rolls the partial state back automatically.
+ *
+ * Supply an `Idempotency-Key` header (any unique string, max 255 chars) to safely retry on network errors. Replays with the same key return the original response; replays with a different body return `409 idempotency_conflict`.
+ */
+export const managementCreateMailbox = (options) => (options?.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/mailboxes',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options?.headers
+    }
+});
+/**
+ * Delete a mailbox
+ *
+ * Removes a mailbox from our mail platform, Amazon SES (for `@myagent.mx` addresses), and Sendmux. All associated API keys are revoked.
+ */
+export const managementDeleteMailbox = (options) => (options.client ?? client).delete({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/mailboxes/{public_id}',
+    ...options
+});
+/**
+ * Get a mailbox
+ *
+ * Returns a single mailbox, tenant-scoped to the caller's team. Responses carry a weak `ETag` header — send it back as `If-None-Match` on the next request and the server will return `304 Not Modified` (no body) when the resource has not changed. The same ETag is the value to use in `If-Match` on PATCH for optimistic concurrency.
+ */
+export const managementGetMailbox = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/mailboxes/{public_id}',
+    ...options
+});
+/**
+ * Update a mailbox
+ *
+ * Updates any combination of display_name, quota_bytes, and send_scope on a mailbox. The display_name and send_scope changes land in a single transaction; quota_bytes is applied afterwards because it also updates external state on our mail platform. Quota can only be set to 1073741824 (1 GB), 5368709120 (5 GB), or 53687091200 (50 GB), and cannot be shrunk below the mailbox's current usage.
+ *
+ * For optimistic concurrency, send `If-Match: <etag>` using the ETag from a prior GET. A mismatched `If-Match` returns `409 conflict` (the server's ETag is echoed back so you can decide whether to re-fetch). Responses carry the new ETag so chained edits can pipeline without a re-GET.
+ */
+export const managementUpdateMailbox = (options) => (options.client ?? client).patch({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/mailboxes/{public_id}',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Get mailbox sender filters
+ *
+ * Returns the current sender-filter mode and rule set for a mailbox. Mailbox-scoped rules override any domain-wide rules set on the parent domain.
+ *
+ * Responses carry a weak `ETag` — send it as `If-None-Match` to skip the body when the filter set has not changed (returns `304 Not Modified`). The same ETag is the value to use in `If-Match` on the corresponding PUT for optimistic concurrency.
+ */
+export const managementGetMailboxFilters = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/mailboxes/{public_id}/filters',
+    ...options
+});
+/**
+ * Replace mailbox sender filters
+ *
+ * Atomically replaces the sender-filter mode and rule set for a mailbox. The entire rule set is swapped in a single operation — there is no intermediate state where the mailbox has a partial ruleset. A maximum of 1000 rules per request is enforced.
+ *
+ * For optimistic concurrency, send `If-Match: <etag>` using the ETag from a prior GET. A mismatched `If-Match` returns `409 conflict` (the server's ETag is echoed back so you can decide whether to re-fetch). Responses carry the new ETag so chained edits can pipeline without a re-GET.
+ */
+export const managementSetMailboxFilters = (options) => (options.client ?? client).put({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/mailboxes/{public_id}/filters',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Create a mailbox API key
+ *
+ * Mints an additional bearer token plus IMAP/SMTP mailbox password for an existing mailbox. The plaintext key and password are shown exactly once — store them immediately.
+ *
+ * Supply an `Idempotency-Key` header (any unique string, max 255 chars) to safely retry on network errors. Replays with the same key return the original response; replays with a different body return `409 idempotency_conflict`.
+ */
+export const managementCreateMailboxKey = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/mailboxes/{public_id}/keys',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Revoke a mailbox API key
+ *
+ * Revokes a specific bearer token + matching mailbox password. Idempotent on already-revoked keys.
+ */
+export const managementDeleteMailboxKey = (options) => (options.client ?? client).delete({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/mailboxes/{public_id}/keys/{key_id}',
+    ...options
+});
+/**
+ * Resume a mailbox
+ *
+ * Restores a suspended mailbox so it can authenticate, receive mail, and send from the mailbox address again. The operation is idempotent and accepts `Idempotency-Key` for safe retries.
+ */
+export const managementResumeMailbox = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/mailboxes/{public_id}/resume',
+    ...options
+});
+/**
+ * Suspend a mailbox
+ *
+ * Suspends a mailbox without deleting messages, credentials, or settings. Suspended mailboxes cannot receive mail, authenticate to mailbox protocols, or send from the mailbox address. The operation is idempotent and accepts `Idempotency-Key` for safe retries.
+ */
+export const managementSuspendMailbox = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/mailboxes/{public_id}/suspend',
+    ...options
+});
+/**
+ * List sending accounts
+ *
+ * Returns a cursor-paginated list of sending accounts. Credentials are never returned. The shared Amazon SES account is included and marked with `is_shared: true`.
+ */
+export const managementListProviders = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers',
+    ...options
+});
+/**
+ * Create an SMTP sending account
+ *
+ * Creates a custom SMTP sending account. Supply an `Idempotency-Key` header to safely retry on network errors. The SMTP password is stored securely and is never returned.
+ */
+export const managementCreateProvider = (options) => (options?.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options?.headers
+    }
+});
+/**
+ * Delete a sending account
+ *
+ * Deletes a custom or connected sending account. The shared Amazon SES account cannot be deleted.
+ */
+export const managementDeleteProvider = (options) => (options.client ?? client).delete({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers/{public_id}',
+    ...options
+});
+/**
+ * Get a sending account
+ *
+ * Returns one sending account. Responses include an ETag for conditional GET and optimistic PATCH.
+ */
+export const managementGetProvider = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers/{public_id}',
+    ...options
+});
+/**
+ * Update a sending account
+ *
+ * Updates a custom sending account. The shared Amazon SES account cannot be edited here; use activate/deactivate and the limit-request endpoint for the allowed shared-account actions.
+ */
+export const managementUpdateProvider = (options) => (options.client ?? client).patch({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers/{public_id}',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Activate a sending account
+ *
+ * Enables a sending account. OAuth accounts without an active connection are moved to pending until reconnected in the dashboard. The shared Amazon SES account can be activated.
+ */
+export const managementActivateProvider = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers/{public_id}/activate',
+    ...options
+});
+/**
+ * Deactivate a sending account
+ *
+ * Disables a sending account. The shared Amazon SES account can be deactivated.
+ */
+export const managementDeactivateProvider = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers/{public_id}/deactivate',
+    ...options
+});
+/**
+ * Test an SMTP sending account
+ *
+ * Runs a connection test for a custom SMTP account. The shared Amazon SES account and OAuth accounts cannot be tested through this endpoint.
+ */
+export const managementTestProvider = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers/{public_id}/test',
+    ...options
+});
+/**
+ * Get sending account limits
+ *
+ * Returns custom-account capacity and shared Amazon SES daily sending limit state.
+ */
+export const managementGetProviderLimits = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers/limits',
+    ...options
+});
+/**
+ * Request a sending account limit increase
+ *
+ * Creates a request to increase the number of custom or connected sending accounts allowed for the team.
+ */
+export const managementRequestSendingAccountLimitIncrease = (options) => (options?.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers/limits/sending-accounts/request-increase',
+    ...options
+});
+/**
+ * Get shared Amazon SES limit request state
+ *
+ * Returns the shared Amazon SES daily limit state and any pending increase request.
+ */
+export const managementGetSharedAmazonSesLimitRequest = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers/shared-amazon-ses-limit-request',
+    ...options
+});
+/**
+ * Request a shared Amazon SES daily limit increase
+ *
+ * Creates a review request for the shared Amazon SES daily sending limit. This does not modify the limit directly.
+ */
+export const managementCreateSharedAmazonSesLimitRequest = (options) => (options?.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers/shared-amazon-ses-limit-request',
+    ...options
+});
+/**
+ * Get sending account statistics
+ *
+ * Returns aggregate counts of configured sending accounts with breakdowns by type and status.
+ */
+export const managementGetProviderStats = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers/stats',
+    ...options
+});
+/**
+ * Get sending account usage
+ *
+ * Returns per-account delivery-log counts for today and the trailing 7-day window.
+ */
+export const managementGetProviderUsage = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/providers/usage',
+    ...options
+});
+/**
+ * List webhook subscriptions
+ *
+ * Returns a cursor-paginated list of webhook subscriptions configured for the team, ordered by `created_at` descending. The signing secret is never included. Pass `cursor=<next_cursor>` from the previous response to fetch the next page.
+ */
+export const managementListWebhooks = (options) => (options?.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/webhooks',
+    ...options
+});
+/**
+ * Create a webhook subscription
+ *
+ * Creates a new webhook subscription and returns the signing secret ONCE in the response body. Store it securely — it cannot be retrieved later. Use `POST /webhooks/{id}/rotate-secret` to issue a new one.
+ *
+ * Supply an `Idempotency-Key` header (any unique string, max 255 chars) to safely retry on network errors. Replays with the same key return the original response; replays with a different body return `409 idempotency_conflict`.
+ */
+export const managementCreateWebhook = (options) => (options?.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/webhooks',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options?.headers
+    }
+});
+/**
+ * Delete a webhook subscription
+ *
+ * Permanently removes the subscription. In-flight retries are dropped.
+ */
+export const managementDeleteWebhook = (options) => (options.client ?? client).delete({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/webhooks/{public_id}',
+    ...options
+});
+/**
+ * Get a webhook subscription
+ *
+ * Returns a single webhook subscription. The signing secret is never included. Responses carry a weak `ETag` header — send it back as `If-None-Match` on the next request and the server will return `304 Not Modified` (no body) when the resource has not changed. The same ETag is the value to use in `If-Match` on PATCH for optimistic concurrency.
+ */
+export const managementGetWebhook = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/webhooks/{public_id}',
+    ...options
+});
+/**
+ * Update a webhook subscription
+ *
+ * Updates the URL, event types, or enabled flag. Any field omitted from the request body is left unchanged. The signing secret is unaffected — use `POST /webhooks/{id}/rotate-secret` to rotate it.
+ *
+ * For optimistic concurrency, send `If-Match: <etag>` using the ETag from a prior GET. A mismatched `If-Match` returns `409 conflict` (the server's ETag is echoed back so you can decide whether to re-fetch). Responses carry the new ETag so chained edits can pipeline without a re-GET.
+ */
+export const managementUpdateWebhook = (options) => (options.client ?? client).patch({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/webhooks/{public_id}',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * List webhook delivery attempts
+ *
+ * Returns recent delivery attempts for one webhook subscription, ordered by `created_at` descending. Delivery metadata is retained for 7 days. Use the payload endpoint while `payload_available` is true to inspect the exact JSON request body that was delivered.
+ */
+export const managementListDelivery = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/webhooks/{public_id}/deliveries',
+    ...options
+});
+/**
+ * Get a webhook delivery payload
+ *
+ * Returns the retained JSON request body for one delivery attempt. Payloads are retained for 7 days and may no longer be available after `payload_expires_at`.
+ */
+export const managementGetDeliveryPayload = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/webhooks/{public_id}/deliveries/{delivery_id}/payload',
+    ...options
+});
+/**
+ * Rotate the signing secret
+ *
+ * Generates a fresh signing secret and returns it ONCE. The old secret is immediately invalidated — the next event delivery is signed with the new secret. Store the new value securely; it cannot be retrieved later.
+ *
+ * Supply an `Idempotency-Key` header to safely retry on network errors — replays under the same key return the original rotation response rather than minting a fresh secret. Replays against a different `public_id` under the same key return `409 idempotency_conflict`.
+ */
+export const managementRotateWebhookSecret = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/webhooks/{public_id}/rotate-secret',
+    ...options
+});
+/**
+ * Send a synthetic test event
+ *
+ * Publishes a synthetic `sendmux.test` event to this webhook subscription. The subscription must include `"sendmux.test"` in `event_types`, and mailbox filters do not block the test delivery. Returns the generated `event_id` so you can correlate the `X-Sendmux-Event-Id` header on your endpoint.
+ *
+ * Supply an `Idempotency-Key` header to safely retry on network errors — replays under the same key return the original `event_id` rather than publishing a second test event.
+ */
+export const managementTestWebhook = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/webhooks/{public_id}/test',
+    ...options
+});