From cf4d62d8a0238568d8099adc2348ae5ce7689dab Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 5 Oct 2026 16:24:07 +0000 Subject: [PATCH] docs: fix stale beta-operation count, add missing CLI/SDK references - docs/api.md: the summary sentence said "31 beta operations" while the detailed table immediately below it (and the full beta-operations table later in the doc, which TestDocumentedBetaOperationsMatchOpenAPI pins) both list 33. Corrected the summary to match api/openapi.yaml's actual 33 beta / 43 GA / 76 total operations. - README.md: the CLI command table omitted `e2a account delete` and `e2a sending-access status|request`, both real top-level commands wired in cli/src/bin/e2a.ts and documented in cli/README.md. - sdks/typescript/README.md, sdks/python/README.md: the Resources section documented `getLifecycle`/`get_lifecycle` but never mentioned the sibling `messages.getMetrics()`/`get_metrics()` or `account.metrics()` methods, which ship in the SDKs today. Co-Authored-By: Claude Sonnet 5 Claude-Session: https://claude.ai/code/session_017YTaQzrVUnHyWDPHq4u1Nz --- README.md | 2 ++ docs/api.md | 2 +- sdks/python/README.md | 7 ++++++- sdks/typescript/README.md | 6 +++++- 4 files changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e1b52a5ef..a2e2d6940 100644 --- a/README.md +++ b/README.md @@ -342,6 +342,8 @@ domains/webhooks in the **web dashboard**. | `e2a metrics []` | Print delivery counters — account rollup, or one inbox (`--by-agent`, `--by-day`, `--json`) | | `e2a listen --agent ` | Stream inbound email for an agent over WebSocket (real-time; `--json` for raw, `--forward ` to bridge to a local HTTP handler) | | `e2a config [list\|get\|set]` | View or update the local config | +| `e2a account delete` | Delete your account — moves to trash by default, restorable by signing back in; `--permanent --yes` erases immediately | +| `e2a sending-access status\|request` | Check or request external sending access when the account is restricted to a shared-identity allowlist (beta) | When the `--forward ` endpoint path ends in `/v1/responses`, `listen` switches to **OpenAI Responses API forwarding**: each inbound email is formatted as a Responses payload and the model's output is sent back as an auto-reply. Add `--forward-token ` to attach a bearer token to the forwarded request: diff --git a/docs/api.md b/docs/api.md index a86ff470d..314b08071 100644 --- a/docs/api.md +++ b/docs/api.md @@ -28,7 +28,7 @@ machine-readable source of truth is **`x-stability-level`** in `x-stability-level: beta` may change before it is promoted to stable, and **everything not marked beta (or experimental) is GA**, covered by the [compatibility rules](#compatibility-rules) below. At the operation level that -is currently 43 GA operations and 31 beta operations: +is currently 43 GA operations and 33 beta operations: | Resource group | Stability | Operations | | --- | --- | --- | diff --git a/sdks/python/README.md b/sdks/python/README.md index 5b3ee5e0d..4554d787f 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -335,7 +335,12 @@ attachments within the server's 256 KB inline cap. methods take the agent `address` first. Also on `client.messages`: `get_lifecycle(email, message_id, *, cursor=None, limit=None)` (beta) — page through a message's canonical lifecycle transitions (send, delivery, -bounce, review, deletion, …). +bounce, review, deletion, …); and `get_metrics(email, *, start=None, +end=None)` (beta) — per-agent cohort-window delivery counters with +`None`-safe rates. `client.account.metrics(*, start=None, end=None, +group_by=None, bucket=None)` (beta, account-scoped) rolls up the same +counters across every agent, optionally `group_by="agent"` or +`bucket="day"`. Two more, both account-scoped: `client.reviews` — the human-review queue for messages held in `pending_review` (outbound drafts awaiting send approval, diff --git a/sdks/typescript/README.md b/sdks/typescript/README.md index 1f1dc1d2e..08fb5bb53 100644 --- a/sdks/typescript/README.md +++ b/sdks/typescript/README.md @@ -285,7 +285,11 @@ take the agent `address` as the first argument. Beyond the resource tree, [WebSocket](#websocket-real-time-delivery-for-local-agents)). Also on `client.messages`: `getLifecycle(email, messageId, { cursor, limit })` (beta, 5.3.0) — page through a message's canonical lifecycle transitions (send, delivery, bounce, -review, deletion, …). +review, deletion, …); and `getMetrics(email, { start?, end? })` (beta, 5.7.0) — +per-agent cohort-window delivery counters with null-safe rates. +`client.account.metrics({ start?, end?, groupBy?: "agent", bucket?: "day" })` +(beta, 5.7.0, account-scoped) rolls up the same counters across every agent, +optionally broken down per-agent or bucketed by UTC day. Two more, both account-scoped: `client.reviews` — the human-review queue for messages held in `pending_review` (outbound drafts awaiting send approval,