diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 000000000..6313b56c5
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1 @@
+* text=auto eol=lf
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 76d5a5a72..49286cd62 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,7 +3,7 @@
## Unreleased
- Client tokens cover a messaging frontend. All six SDKs, the drop-in handler
- and the UI Kit accept the new session actions `conversations_read`,
+ and the UI Kit accept the new Connection actions `conversations_read`,
`conversations_manage`, `labels_read`, `labels_manage`, `contacts_manage`,
`profile_read`, `profile_manage`, `channels_read`, `channels_manage`,
`business_read` and `presence_write`. Customer-scoped tokens accept every
@@ -12,17 +12,17 @@
- UI Kit: `client.messaging()` gains `chats` (history, archive, disappearing
messages, edit and delete), `labels`, `profile` (profile and privacy),
`channels`, `catalog`, `presence.set`, contact block, unblock and info, and
- `groups.setPicture` (base64). Browser Calls take `clientTokenSession` so a
- Customer token names the number it calls from.
+ `groups.setPicture` (base64). Browser Calls take `clientTokenConnection` so a
+ Customer token names the Connection it calls from.
-- A number's call history with the other party's identity: `GET
-/messaging/{session}/calls` in all six SDKs (`calls.list`,
- `SessionCalls().List` in Go, `Calls.ListAsync` in .NET). `peer` carries the
+- A Connection's call history with the other party's identity: `GET
+/messaging/{connection}/calls` in all six SDKs (`calls.list`,
+ `ConnectionCalls().List` in Go, `Calls.ListAsync` in .NET). `peer` carries the
user ID, phone number and username. Records are served from the number's
data region; client tokens need the new `read_calls` action. Platform call
records are unchanged and keep `peerRef`. Requires the matching API change.
- UI Kit call log: ` `, `` and an Inbox Chats/Calls
- switch read the number's calls from the API, merge repeat calls as WhatsApp
+ switch read the Connection's calls from the API, merge repeat calls as WhatsApp
does and offer call back. `ContactListView` now takes `className` and
`classNames`; `ContactList` and `` show the Contacts list
on their own.
@@ -43,7 +43,7 @@
back both. Relayed group messages no longer rename the chat after their
sender.
- Client tokens: `groups_read` and `groups_manage` in all six server SDKs,
- the drop-in handler and the UI Kit, for session and Customer tokens. Requires the
+ the drop-in handler and the UI Kit, for Connection and Customer tokens. Requires the
matching API change; until it is accepted the API refuses these actions.
- UI Kit calls: toggle buttons no longer report `aria-pressed` alongside an
action label ("Turn camera on", pressed).
@@ -70,17 +70,17 @@
replacement contacts at once and can be moved in the document. A group read
that finishes after leaving no longer marks the group ready again.
-- Breaking: Test number phone and event methods use the Number-scoped routes
+- Breaking: Test Connection phone and event methods use the Connection-scoped routes
in API contract revision `f180dc1ee2`. `testing.getPhone`, `sendPhoneMessage`
- and `unlinkPhoneDevice` take a Number ID and no project argument, and
- `testing.triggerEvent(numberId, body)` omits body `session` and accepts
- `fromNumber`. `listEventFixtures()` has no project argument. History fixtures
+ and `unlinkPhoneDevice` take a Connection ID and no project argument, and
+ `testing.triggerEvent(connectionId, body)` omits body `connection` and accepts
+ `fromConnection`. `listEventFixtures()` has no project argument. History fixtures
keep their project argument and use
- `/messaging/projects/{projectId}/test-history-fixtures`. Real Numbers return
+ `/messaging/projects/{projectId}/test-history-fixtures`. Real Connections return
`404 resource_not_found`. Scope names remain `sandbox:read` / `sandbox:write`.
Applies to all six SDKs. Source-only and unpublished.
-- UI Kit: give `CallNumberPicker` built-in themes, appearance variables and
+- UI Kit: give `CallConnectionPicker` built-in themes, appearance variables and
styling slots. It supports `classNames` and unstyled mode without a host
stylesheet.
- UI Kit: remove `TemplateManager`, `SessionStatus`, `ConnectWhatsAppButton`,
diff --git a/README.md b/README.md
index 028ccbdef..580556edf 100644
--- a/README.md
+++ b/README.md
@@ -132,8 +132,8 @@ const messaging = new MessagingClient({
apiVersion: "2026-09-22",
});
-const sessions = await messaging.sessions.list();
-console.log(sessions.data.data, sessions.metadata.requestId);
+const connections = await messaging.connections.list();
+console.log(connections.data.data, connections.metadata.requestId);
const sent = await messaging.messages.send(
"support",
@@ -155,15 +155,15 @@ any network request. Server credentials are rejected in browser runtimes.
The handwritten Messaging resources in this milestone are:
- `banSafe`: retrieve and update project Safe Mode, warm-up, Ban Insurance
- evidence, and Health policy settings, and one number's Safe Mode override,
+ evidence, and Health policy settings, and one Connection's Safe Mode override,
with a team key or project token
-- `sessions`: list, retrieve, update, delete, start, stop, restart,
+- `connections`: list, retrieve, update, delete, start, stop, restart,
logout, account, and entitlement-gated direct JSON QR or phone pairing
-- `quickLinks`: create, retrieve, and cancel hosted QuickLink pairing sessions
+- `quickLinks`: create, retrieve, and cancel hosted QuickLink pairing flows
- `cloudOnboarding`: continue an issued Meta Cloud API QuickLink from a trusted
server
- `cloudTemplates`: list, retrieve, create, edit and delete Meta templates for a
- Number with an Official API connection; separate from project template drafts
+ Connection using the Cloud API method; separate from project template drafts
- `cloudCatalogs`: read WABA product-catalog links through the Graph facade
- `cloudMarketing`: read Meta's raw WABA Marketing Messages status strings without interpreting eligibility
- `flowEncryption`: read or register a public Flow encryption key for one Meta phone number
@@ -171,8 +171,8 @@ The handwritten Messaging resources in this milestone are:
products, collections, orders, compliance, linked accounts, and eligibility
- `calls`: reject an identified incoming Linked Device call
- `voip`: place, accept, reject, leave, and end Polymorfa Calls, add
- participants, read a person's call permission on a Cloud API Number, check a
- destination before dialing, and read or update a session's call settings
+ participants, read a person's call permission on a Cloud API Connection, check a
+ destination before dialing, and read or update a connection's call settings
- `campaigns`: list, create (with inline recipients), retrieve, inspect
analytics, launch, pause, resume, stop, requeue, and page or append campaign
recipients through the Messaging control plane
@@ -194,13 +194,13 @@ The handwritten Messaging resources in this milestone are:
chat's complete label set
- `identities`: resolve one phone number, public user ID, BSUID, or username to known
identity aliases
-- `observationPolicies`: retrieve and update project ceilings and session
+- `observationPolicies`: retrieve and update project ceilings and connection
overrides for presence, typing, and label observation
-- `profile`: retrieve the session profile and set its name, status, or JSON
+- `profile`: retrieve the connection profile and set its name, status, or JSON
URL/base64 picture source, plus delete the picture
- `privacy`: retrieve account privacy, update setting-specific values, and set
the account default disappearing-message timer
-- `presence`: set and inspect the session's own non-authoritative presence
+- `presence`: set and inspect the connection's own non-authoritative presence
snapshot, inspect retained chat observations, and subscribe to user presence
- `quickReplies`: list, create, replace, and delete remembered Business App
quick replies
@@ -223,7 +223,7 @@ const client = new Client({
});
const projects = await client.projects.list();
-const sessions = await client.sessions.list({
+const connections = await client.connections.list({
projectId: projects.data.data[0]?._id,
});
@@ -304,7 +304,7 @@ The team view also exposes these management resources:
- `members`: list team members
- `auditLogs`: list the team audit trail with live action, resource,
and limit filters
-- `sessionBans`: list all or active session bans
+- `connectionBans`: list all or active connection bans
- `securityIncidents`: list and acknowledge leaked-credential incidents
- `projectTokens`: list token metadata for an explicit project
- `sipTrunks`: list, create, retrieve, update, delete, and rotate the
@@ -319,7 +319,7 @@ The team view also exposes these management resources:
- `billing`: retrieve balance and currency, inspect usage meters, list
transactions and tier pricing
- `usage`: read metered call usage for a month, list or iterate usage records
- for a call or number (also on project clients), and read usage gate modes,
+ for a call or Connection (also on project clients), and read usage gate modes,
limits and decisions (team clients only). Usage is measured, not
charged.
- `banSafe`: inspect Health, telemetry collection, signal definitions, findings,
@@ -328,10 +328,10 @@ The team view also exposes these management resources:
- `projects`: list, create, request production enrollment, approve, and cancel;
retrieve and update Safe Mode, warm-up, Ban Insurance evidence, and Health
policy settings; list same-number pairs that can merge into Hybrid Link
-- `sessions`: list, start, stop, or delete one session; stop or delete a bounded
+- `connections`: list, start, stop, or delete one connection; stop or delete a bounded
batch; review and confirm a tier change, including the Hybrid Link
- resolution or merge; create a testing session; and retrieve or update the
- session Safe Mode override
+ resolution or merge; create a testing connection; and retrieve or update the
+ connection Safe Mode override
- `campaigns`: list, create, retrieve, update, delete, lifecycle actions,
analytics, events, and paged or appended recipients. The single-campaign
operations require the owning `projectId`. This resource is available only
@@ -340,8 +340,8 @@ The team view also exposes these management resources:
`update` accepts `recipientListId` to point an unlaunched draft at another
audience, or null to detach it
- `customers`: enable Customers for a project; create, list, retrieve, update,
- archive, and restore Customers; inspect Numbers and events; create, list,
- and revoke pairing links; and transfer Numbers between Customers
+ archive, and restore Customers; inspect Connections and events; create, list,
+ and revoke pairing links; and transfer Connections between Customers
- `audiences`: list, create from inline members or a spreadsheet import,
retrieve, delete, create an upload URL, and add, page, or remove members
- `optOuts`: list, create one, create a batch, delete by phone number, and read
@@ -390,20 +390,20 @@ adapter that authorizes the signed-in user.
### WhatsApp analytics
-`client.analytics.get({projectId, sessionId, start, end})` reads activity,
+`client.analytics.get({projectId, connectionId, start, end})` reads activity,
completed 24-hour direct-chat delivery/read/reply cohorts, response times and
connection vitals. Times are Unix milliseconds and the range is at most 366
days. A project-bound client confines the request to its own project. Requires
-`sessions:read` and Analytics enabled by a team owner or admin in the Console.
+`connections:read` and Analytics enabled by a team owner or admin in the Console.
Disabled results contain no business data. Missing coverage has null rates;
read receipts do not prove an app open. `measured` distinguishes observed zero
-activity from a number without telemetry. No contact identities or message
+activity from a Connection without telemetry. No contact identities or message
content are returned. See the [Analytics guide](https://docs.polymorfa.com/console/analytics).
### Recipient observations
`analytics.get()` exposes optional `recipientActivity` on the combined summary
-and each number. Hourly rows preserve recipient numbering country, complete-list
+and each Connection. Hourly rows preserve recipient numbering country, complete-list
linked-device count range and primary/linked/unknown signal source. Country and
count fields also appear on joint `conversationBreakdown` rows; older buckets use
Unknown. `primary_only`, `one_linked` and `two_plus_linked` exclude device zero from
@@ -426,7 +426,7 @@ Analytics remains unmeasured.
`client.analytics.metrics({windowHours: 24, format: "openmetrics", segments: true})` returns Prometheus/OpenMetrics text with HTTP metadata, on root and project clients.
Counts are overlapping-window gauges, with denominators, measurement coverage and observation times.
-Requires `sessions:read` and the same Analytics opt-in. Disabled exports contain only
+Requires `connections:read` and the same Analytics opt-in. Disabled exports contain only
enablement and window metadata. [Collector configuration](https://docs.polymorfa.com/console/analytics-collectors).
Analytics responses also expose completed observed phone activity spans and
@@ -437,23 +437,23 @@ See the [measurement definitions](https://docs.polymorfa.com/console/analytics#p
### Device analytics
-`client.analytics.get({start, end, projectId, sessionId})` reads scoped Analytics.
-A project-bound client is confined to its project. Requires `sessions:read` and
+`client.analytics.get({start, end, projectId, connectionId})` reads scoped Analytics.
+A project-bound client is confined to its project. Requires `connections:read` and
Analytics enabled by a team owner or admin. `deviceAnalytics` counts observed
live direct messages by estimated sending client family, separately for people
-messaging your numbers and for your own numbers sending. Message ID prefixes are
+messaging your Connections and for your own Connections sending. Message ID prefixes are
estimates, not hardware verification. Unknown is included; incomplete coverage
has null shares. Older retained buckets have no device measurements.
-`numbers[].deviceAnalytics.inventory` lists up to 25 observed device indexes
-belonging to that connected number, with a coarse reported class and last
+`connections[].deviceAnalytics.inventory` lists up to 25 observed device indexes
+belonging to that Connection, with a coarse reported class and last
observed sending activity. A later device-list change sets `listCurrent=false`
and makes the count/membership unknown until a fresh list arrives. The combined
summary has no inventory. No recipient device identities or raw message IDs
are retained in Analytics.
For a fresh list of a recipient's linked-device indexes, use
-`client.messaging.contacts.devices(numberId, contactId)`. This existing
+`client.messaging.contacts.devices(connectionId, contactId)`. This existing
scoped read does not establish OS, model or device ownership. See the
[device guide](https://docs.polymorfa.com/sdks/typescript/devices).
@@ -532,7 +532,7 @@ overwrite (`409 state_conflict`). `import` adds up to 5,000 entries at once and
reports invalid ones in `rejected`. A full list (100,000 entries) fails with
`409 call_opt_out_limit`.
-A Cloud API Number can call a person only after that person grants permission.
+A Cloud API Connection can call a person only after that person grants permission.
Ask with `callPermissionRequest` content, then read the answer:
```ts
@@ -559,7 +559,7 @@ const permission = await messaging.voip.retrieveCallPermission(
permission.data.data.status; // "none" | "temporary" | "permanent" | "revoked"
const check = await messaging.voip.check({
- session: "support",
+ connection: "support",
to: "+14155550123",
});
check.data.data.refusal; // null, or the first reason a call would fail
@@ -570,7 +570,7 @@ when WhatsApp could not be reached and the stored state is returned with
`actions: null`. `check` runs the same checks a placement runs without placing
a call or reserving anything. Both need a server credential.
`retrieveCallPermission` answers `409 unsupported_for_connection` on a
-linked-device Number; `check` supports linked-device Numbers and returns
+Linked Device Connection; `check` supports Linked Device Connections and returns
`permission: null` for them. If required call-check state is unavailable,
`check` raises `PolymorfaServerError` (`503 service_unavailable`); no allow or
refusal result is returned.
@@ -759,7 +759,7 @@ if (isEvent(event, "message.received")) {
Native deliveries use the hexadecimal `X-Webhook-Signature` value. The helper
also accepts the `sha256=` compatibility form. Verification uses
HMAC-SHA256 and constant-time comparison over the unmodified bytes. Recognized
-events narrow to exported payload types, including messages, sessions, groups,
+events narrow to exported payload types, including messages, connections, groups,
presence, contacts, chats, calls, labels, history sync, Meta Cloud API contact
sync and Business app echoes, command results, call permission changes, and business quick replies. Unknown event names and payloads are preserved for
forward compatibility.
@@ -824,7 +824,7 @@ import {
const getClientToken = createClientTokenProvider();
const messaging = new BrowserMessagingClient({
- session: "support",
+ connection: "support",
getClientToken,
});
@@ -834,7 +834,7 @@ await messaging.messages.setTyping({
});
```
-The browser Messaging client is session-bound and exposes only the runtime's
+The browser Messaging client is connection-bound and exposes only the runtime's
exact client-token action allowlist. `createBrowserComposerActions` connects
text/reply compose boxes to that client. Conversation history, template
management, media upload, and call lifecycle/control stay behind explicit
@@ -844,7 +844,7 @@ The canonical template builder is the paired path for template management:
`MessagingClient.templates` performs server operations,
`createTemplateBuilderRoute` authorizes and scopes same-origin browser actions,
and `createSameOriginTemplateBuilderTransport` connects the framework-neutral
-controller without exposing a server key, project slug, or submission session.
+controller without exposing a server key, project slug, or submission connection.
The controller models standard, carousel, authentication, and limited-time
offer definitions and keeps saving separate from Meta submission.
@@ -857,14 +857,14 @@ controller lifecycles.
### Call links in this source revision
`MessagingClient.voip.createCallLink` and `previewCallLink` require a server
-credential with `sessions:manage` and a Linked Device Number with calling
+credential with `connections:manage` and a Linked Device Connection with calling
enabled. They are source additions pending matching API deployment and SDK
publication; client tokens are refused. They do not place or join a call.
```ts
-const created = await messaging.voip.createCallLink({ session: "support" });
+const created = await messaging.voip.createCallLink({ connection: "support" });
const preview = await messaging.voip.previewCallLink({
- session: "support",
+ connection: "support",
token: created.data.data.token,
video: created.data.data.video,
});
@@ -879,28 +879,28 @@ are `VoipCreateCallLinkRequest`, `VoipPreviewCallLinkRequest`,
### Client-token action ceilings
-Client tokens accept an immutable `allow` ceiling for a session or Customer.
-Every request still requires live Number rules and current ownership. Session
-`allow` requires the action-ceilings beta. Until it is enabled, session `allow`
+Client tokens accept an immutable `allow` ceiling for a connection or Customer.
+Every request still requires live Connection rules and current ownership. Connection
+`allow` requires the action-ceilings beta. Until it is enabled, connection `allow`
is refused and omission keeps the existing token format. After enabling it,
-omitting `allow` snapshots a session's configured actions; Customer omission selects the
+omitting `allow` snapshots a connection's configured actions; Customer omission selects the
original Customer action set. `chats_read`, `chats_manage`, `contact_write`, and
`contact_delete` are reserved for enrolled regional beta access. These types do
not establish regional availability or enable access by themselves.
-An explicit empty session list seals zero actions. Keep it distinct from
+An explicit empty connection list seals zero actions. Keep it distinct from
omission when constructing the server-side mint request:
-| SDK | Omit the session ceiling | Seal zero session actions |
-| ---------- | ----------------------------------------------------- | ------------------------- |
-| TypeScript | Omit `allow` | `allow: []` |
-| Go | `Allow: nil` | `Allow: []string{}` |
-| Python | Omit the `allow` key | `"allow": []` |
-| PHP | Omit the `allow` key | `'allow' => []` |
-| Rust | `ClientTokenTarget::Session { session, allow: None }` | Set `allow: Some(vec![])` |
-| C# | Omit `Allow` or use `null` | `Allow: []` |
+| SDK | Omit the connection ceiling | Seal zero connection actions |
+| ---------- | ----------------------------------------------------------- | ---------------------------- |
+| TypeScript | Omit `allow` | `allow: []` |
+| Go | `Allow: nil` | `Allow: []string{}` |
+| Python | Omit the `allow` key | `"allow": []` |
+| PHP | Omit the `allow` key | `'allow' => []` |
+| Rust | `ClientTokenTarget::Connection { connection, allow: None }` | Set `allow: Some(vec![])` |
+| C# | Omit `Allow` or use `null` | `Allow: []` |
-Rust uses `SessionClientAction` for session ceilings and `CustomerClientAction`
+Rust uses `ConnectionClientAction` for connection ceilings and `CustomerClientAction`
for Customer ceilings. Customer lists remain non-empty. The API validates
actions, enrollment and live rules; these request types grant no authority.
@@ -914,7 +914,7 @@ model as `controller.call`. Pass its controller to React or Web Components.
```ts
import { createBrowserCalls } from "@polymorfa/ui-kit";
-const calls = createBrowserCalls({ session: "support", getClientToken });
+const calls = createBrowserCalls({ connection: "support", getClientToken });
await calls.connect();
await calls.controller.place("+15550100");
// Release the widget and connections when leaving the application.
@@ -924,7 +924,7 @@ await calls.dispose();
The token needs `voip_place`, `voip_answer` and `voip_signal` actions. Your
server mints it with `POST /platform/client-tokens`; the browser uses it
directly for REST calls and for the first frame of each call socket. No
-calling ticket is involved. Requests use the token's bound session.
+calling ticket is involved. Requests use the token's bound connection.
Incoming calls ring until a participant answers or declines them. Several
calls can ring at once, and the widget never declines one for you. Answer
@@ -965,7 +965,7 @@ colors derive from the shared appearance variables.
`@polymorfa/ui-kit/store` keeps an opt-in IndexedDB copy of webhook-shaped events for
applications that store messages themselves. Your backend receives webhooks
and streams them to the browser; the store files messages, conversations,
-contacts, presence, calls, labels, sessions, templates, and other events into
+contacts, presence, calls, labels, connections, templates, and other events into
separate stores and feeds `ConversationController` through
`createStoreConversationSource()`. Message content is written to the device;
see the [store guide](packages/ui-kit/docs/store.md#privacy) for encryption,
@@ -979,7 +979,7 @@ logic; webhook helpers read raw bytes once and delegate verification to
`webhooks.verify` from the server SDK.
Template routes use the same application-owned authorization boundary. Project
-scope and Cloud API session selection are resolver callbacks that run only on
+scope and Cloud API connection selection are resolver callbacks that run only on
the server; browser-provided replacements are ignored.
`@polymorfa/ui-kit/devtools` provides an explicit development overlay for appearance,
@@ -1026,9 +1026,9 @@ release instruction.
## Contract update notes
-The typed webhook catalog includes `session.restriction_updated` with
+The typed webhook catalog includes `connection.restriction_updated` with
`type`, `active`, `enforcementType`, `expiresAt`, and `observedAt`.
-`session.logged_out` requires a numeric `code` and a `reason` of `banned`,
+`connection.logged_out` requires a numeric `code` and a `reason` of `banned`,
`device_removed`, or `unknown`. Test event requests support the restriction
fixture with `restrictionActive` and the call-end reason `call_restricted`.
@@ -1051,15 +1051,15 @@ SDK exports `BrowserWhatsAppMessageIds`. See the pinned component revision in
## Hybrid Link contract additions
The development SDK types include Hybrid Link controls. Their presence does not
-enable the private preview: the API checks live team/project enrollment, Number
+enable the private preview: the API checks live team/project enrollment, Connection
entitlement, and operational availability. Browser client tokens cannot use the
Hybrid control or message-operation methods, and Hybrid sends through browser
client tokens are unavailable in this preview.
-Use `quickLinks.availability({projectId, session})` before offering an added
-connection. Initial setup uses `quickLinks.create({connectionGoal: "hybrid"})`;
-adding a transport uses `purpose: "add_connection"`, the existing `session`, and
-`addConnection: "linked_devices" | "official_api"`. The Number and Customer stay
+Use `quickLinks.availability({projectId, connection})` before offering an added
+method. Initial setup uses `quickLinks.create({connectionGoal: "hybrid"})`;
+adding a method uses `purpose: "add_method"`, the existing `connection`, and
+`addMethod: "linked_devices" | "official_api"`. The Connection and Customer stay
the same. `configuration.connectionPreference: "both"` still chooses one transport.
QuickLink status includes `hybridPhase` for Cloud setup, Linked pairing, repair,
and readiness.
@@ -1075,16 +1075,16 @@ An accepted uncertain send raises `send_outcome_unknown` with its operation ID.
The SDK stops automatic retries when a response carries an accepted operation ID,
even if its body cannot be read. In that case the thrown error carries the ID in
`error.metadata.operationId`.
-Read `messages.operationStatus(session, operationId)` with the original issuing
+Read `messages.operationStatus(connection, operationId)` with the original issuing
server principal. `pending` and `unknown` do not permit another send or a
transport switch. A terminal `rejected` result carries
`rejectionCode: "hybrid_authority_unavailable"` and proves that this operation
ended before the provider effect. Fix the cause before starting a new operation.
`hybridLink.getPolicy(scope)` and `setPolicy(scope, body)` preserve team, project,
-or Number authority. Writes require the exact `expectedRevision`, `prefer`, and
+or Connection authority. Writes require the exact `expectedRevision`, `prefer`, and
`allowedTransports`; narrower policies cannot widen ancestor restrictions.
-`hybridLink.state(session)` reads connection status. `setPaused(session,
+`hybridLink.state(connection)` reads connection status. `setPaused(connection,
{expectedRevision, paused})` changes routing at the exact current revision.
## License
@@ -1092,3 +1092,8 @@ or Number authority. Writes require the exact `expectedRevision`, `prefer`, and
MIT
Treat every Polymorfa credential as an opaque string. Never parse it or assume a fixed length. Credential storage must support at least 512 characters, preferably unrestricted text. Client-token length varies with its bindings and Customer scope.
+
+Event-stream items expose a decoded Connection view. A retained native body's
+old account selector becomes `connection` in that view. The event's encoded
+payload keeps the original bytes. Mixed selector generations are refused;
+active webhook verification and parsing keep the current envelope contract.
diff --git a/contracts/abprops-capabilities.json b/contracts/abprops-capabilities.json
index ca515dcf4..66e7708e7 100644
--- a/contracts/abprops-capabilities.json
+++ b/contracts/abprops-capabilities.json
@@ -1,13 +1,13 @@
{
"repository": "polymorfa/polymorfa",
- "sourceCommit": "2f9efad933b3a7a455f73245a566c827ac004608",
+ "sourceCommit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
"sourcePath": "apps/api/docs/openapi.json",
- "sourceSha256": "53b2c76e344052152b3fc627a478adcd79130b7876d528aac8056b13e555b127",
+ "sourceSha256": "e84c7ff814c6b59ca7f32c3fda1aedbed3f672e728910adb883f0aa8c6cf3ab7",
"published": false,
- "scope": "Group capability read and canonical session capability webhook only. Other SDK contracts retain their recorded source revisions.",
+ "scope": "Group capability read and canonical Connection capability webhook only. Other SDK contracts retain their recorded source revisions.",
"openapi": "3.0.3",
"paths": {
- "/messaging/{session}/groups/{id}/capabilities": {
+ "/messaging/{connection}/groups/{id}/capabilities": {
"get": {
"operationId": "getGroupCapabilities",
"tags": ["Groups"],
@@ -24,7 +24,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -39,7 +39,7 @@
],
"responses": {
"200": {
- "description": "Account-bound stored group capabilities. Unknown until successful number and group syncs for the linked account. Requires current group membership and the enrolled number-capabilities beta.",
+ "description": "Account-bound stored group capabilities. Unknown until successful connection and group syncs for the linked account. Requires current group membership and the enrolled connection-capabilities beta.",
"content": {
"application/json": {
"schema": {
@@ -252,9 +252,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:read "
- },
"x-protocols": ["Linked Device API"],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`"
}
@@ -344,6 +341,7 @@
"invalid_request_error",
"authentication_error",
"permission_error",
+ "billing_error",
"conflict_error",
"rate_limit_error",
"api_error",
@@ -353,11 +351,16 @@
"code": {
"type": "string",
"enum": [
+ "zero_knowledge_connection",
"invalid_parameter",
"invalid_credential",
"entitlement_required",
"cloud_template_authority_restricted",
"gate_limit_reached",
+ "billing_credit_required",
+ "addon_required",
+ "safe_mode_not_entitled",
+ "warmup_plan_not_entitled",
"method_not_allowed",
"permission_denied",
"missing_scope",
@@ -370,17 +373,21 @@
"stream_cursor_expired",
"stream_connection_limit_reached",
"state_conflict",
+ "team_deletion_scheduled",
"hybrid_routing_paused",
"hybrid_choice_required",
"hybrid_transition_ineligible",
"hybrid_automation_unavailable",
+ "hybrid_group_linked_devices_unavailable",
"hybrid_transport_unavailable",
"hybrid_target_reference_unavailable",
"send_outcome_unknown",
+ "terms_acceptance_required",
+ "terms_activation_blocked",
"idempotency_conflict",
"idempotency_in_progress",
- "idempotency_completed",
"idempotency_outcome_unknown",
+ "idempotency_replay_unavailable",
"call_claimed",
"call_not_ringing",
"connection_limit",
@@ -395,7 +402,7 @@
"order_status_transition_invalid",
"order_cancellation_failed",
"call_opt_out_limit",
- "number_restricted",
+ "connection_restricted",
"sip_trunk_in_use",
"sip_trunk_revision_conflict",
"sip_trunk_limit",
@@ -413,16 +420,21 @@
"upstream_failure",
"service_unavailable",
"credential_verification_unavailable",
- "session_not_ready",
+ "connection_not_ready",
"command_dispatch_failed",
"result_unknown",
+ "parent_bsuid_not_supported",
"recipient_not_on_whatsapp",
"conversation_window_closed",
"template_not_approved",
"media_too_large",
"whatsapp_rate_limited",
"new_chat_limit_reached",
+ "marketing_disabled_on_cloud_api",
"whatsapp_account_restricted",
+ "whatsapp_authorization_required",
+ "whatsapp_payment_method_required",
+ "whatsapp_number_not_registered",
"whatsapp_groups_ineligible",
"whatsapp_group_creation_paused",
"whatsapp_group_limit_reached",
@@ -476,40 +488,43 @@
},
"required": ["error", "data", "docs"]
},
- "SessionCapabilitiesUpdatedEvent": {
+ "ConnectionCapabilitiesUpdatedEvent": {
"type": "object",
"properties": {
"id": {
"type": "string",
- "description": "Unique event identifier"
+ "description": "Unique event identifier",
+ "example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event"
+ "description": "Connection that produced this event",
+ "example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
- "description": "ISO 8601 timestamp"
+ "description": "ISO 8601 timestamp",
+ "example": "2026-10-19T14:03:22.000Z"
},
"event": {
"type": "string",
- "enum": ["session.capabilities_updated"],
+ "enum": ["connection.capabilities_updated"],
"description": "Event type"
},
"payload": {
- "$ref": "#/components/schemas/SessionCapabilitiesUpdatedPayload"
+ "$ref": "#/components/schemas/ConnectionCapabilitiesUpdatedPayload"
}
},
- "required": ["id", "session", "timestamp", "event", "payload"]
+ "required": ["id", "connection", "timestamp", "event", "payload"]
},
- "SessionCapabilitiesUpdatedPayload": {
+ "ConnectionCapabilitiesUpdatedPayload": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string",
"maxLength": 256
},
@@ -588,7 +603,7 @@
}
},
"required": [
- "session",
+ "connection",
"projectId",
"status",
"syncedAt",
@@ -601,5 +616,9 @@
}
}
},
- "family": "messaging"
+ "family": "messaging",
+ "previousExport": {
+ "path": "contracts/history/pre-connections/abprops-capabilities.json",
+ "sha256": "4eae2c0370fe97e4a6302191e54b18ecc984e9e23ff8ba778cefa8dc9a6c349d"
+ }
}
diff --git a/contracts/analytics-device-signals.json b/contracts/analytics-device-signals.json
index 677dc6919..ddb8e7d51 100644
--- a/contracts/analytics-device-signals.json
+++ b/contracts/analytics-device-signals.json
@@ -1,8 +1,8 @@
{
"repository": "polymorfa/polymorfa",
- "sourceCommit": "113d91b12a1db19cbddc4130cea308f38663bb9d",
+ "sourceCommit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
"sourcePath": "apps/api/docs/openapi.management.json",
- "sourceSha256": "f1d08f7f9605a39b0c96da1567ba2231bc8c456e2ef039a9ea67db8a4a252fac",
+ "sourceSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
"scope": "Analytics operations and their referenced schemas only; all other SDK operations retain contracts/source.json",
"published": false,
"paths": {
@@ -11,14 +11,14 @@
"operationId": "exportWhatsAppAnalyticsMetrics",
"tags": ["Analytics"],
"summary": "Export analytics metrics",
- "description": "**Required scope:** `sessions:read`\n\nAuthenticated metrics for a customer's Prometheus or OpenTelemetry Collector. Requires live Analytics enablement. Disabled Analytics returns only enablement and export-window metrics, with no business measurements. All samples are gauges: counts describe an overlapping window, not monotonic counters. Do not use rate() or increase() on them. Labels contain number/project record IDs and bounded categories, never contact identities or message content. Null or unmeasured values are omitted; coverage and observation timestamps are included. API request vitals retain project/team scope even when filtering a number.",
+ "description": "**Required scope:** `connections:read`\n\nAuthenticated metrics for a customer's Prometheus or OpenTelemetry Collector. Requires live Analytics enablement. Disabled Analytics returns only enablement and export-window metrics, with no business measurements. All samples are gauges: counts describe an overlapping window, not monotonic counters. Do not use rate() or increase() on them. Labels contain connection/project record IDs and bounded categories, never contact identities or message content. Null or unmeasured values are omitted; coverage and observation timestamps are included. API request vitals retain project/team scope even when filtering a connection.",
"security": [
{
"ApiKeyAuth": []
}
],
"x-polymorfa-resource-boundary": "project",
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -33,11 +33,11 @@
"schema": {
"type": "string",
"format": "uuid",
- "description": "One number record UUID, within the authorized project or team."
+ "description": "One connection record UUID, within the authorized project or team."
},
"required": false,
- "description": "One number record UUID, within the authorized project or team.",
- "name": "sessionId",
+ "description": "One connection record UUID, within the authorized project or team.",
+ "name": "connectionId",
"in": "query"
},
{
@@ -298,9 +298,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
"x-audience": "public"
}
},
@@ -309,14 +306,14 @@
"operationId": "exportProjectWhatsAppAnalyticsMetrics",
"tags": ["Analytics"],
"summary": "Export project analytics metrics",
- "description": "**Required scope:** `sessions:read`\n\nAuthenticated metrics for a customer's Prometheus or OpenTelemetry Collector. Requires live Analytics enablement. Disabled Analytics returns only enablement and export-window metrics, with no business measurements. All samples are gauges: counts describe an overlapping window, not monotonic counters. Do not use rate() or increase() on them. Labels contain number/project record IDs and bounded categories, never contact identities or message content. Null or unmeasured values are omitted; coverage and observation timestamps are included. API request vitals retain project/team scope even when filtering a number.",
+ "description": "**Required scope:** `connections:read`\n\nAuthenticated metrics for a customer's Prometheus or OpenTelemetry Collector. Requires live Analytics enablement. Disabled Analytics returns only enablement and export-window metrics, with no business measurements. All samples are gauges: counts describe an overlapping window, not monotonic counters. Do not use rate() or increase() on them. Labels contain connection/project record IDs and bounded categories, never contact identities or message content. Null or unmeasured values are omitted; coverage and observation timestamps are included. API request vitals retain project/team scope even when filtering a connection.",
"security": [
{
"ApiKeyAuth": []
}
],
"x-polymorfa-resource-boundary": "project",
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -331,11 +328,11 @@
"schema": {
"type": "string",
"format": "uuid",
- "description": "One number record UUID, within the authorized project or team."
+ "description": "One connection record UUID, within the authorized project or team."
},
"required": false,
- "description": "One number record UUID, within the authorized project or team.",
- "name": "sessionId",
+ "description": "One connection record UUID, within the authorized project or team.",
+ "name": "connectionId",
"in": "query"
},
{
@@ -596,9 +593,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
"x-audience": "public"
}
},
@@ -606,12 +600,12 @@
"get": {
"operationId": "getWhatsAppAnalytics",
"tags": ["Analytics"],
- "summary": "Get WhatsApp number analytics",
- "description": "Aggregated number activity and operational vitals. Returns disabled with null summary and empty data until a team owner or admin enables Analytics. Conversation rates use completed 24-hour direct-chat cohorts, booked in the period when they mature; missing or dropped cohort coverage returns null rates. Read means an observed read receipt, not a verified app open. No contact identifiers or message content. Linked Devices telemetry only; unsupported or unobserved numbers carry measured=false. Bucket timestamps use UTC. Activity series use hourly buckets for ranges up to 48 hours and daily buckets for longer ranges. Call series use daily buckets. Message metadata compares direct sends and completed conversations by type, coarse text/caption length, source, calling code and observed device count. Device observations are bounded samples. Calling-code shares describe conversations, not distinct people or location. Presence signals require existing subscriptions. Primary phone activity spans end at their last observed signal and close after 15 minutes without evidence. Quiet gaps end at the next observed signal. Duration sums and averages count completed intervals and exclude open or restart-censored intervals; they do not measure phone online/offline or power state. Metadata collection uses the current team opt-in; disable erases these aggregates and stale queued metadata is rejected. Calls aggregate retained records by their immutable original number/project ownership, including supported Official API calls; message measured/coverage fields do not apply to calls. Call series groups starts by UTC day. Answer rate excludes still-ringing calls; timing fields have explicit observation counts. Missed-call follow-up observes an answered outgoing call to the same pseudonymous contact within 24h, including after the requested end; only completed windows with a known contact form the denominator. It does not prove callback intent. Quality uses reported measurements, latest cumulative app reports per connection and per-call averages. Breakdown counts can overlap. Disabling hides this call view without deleting operational call history. Device analytics estimates sending client families from message ID prefixes, not verified hardware. Customer/account distributions count observed live direct messages, not unique people or installed devices; unknown is included. Older retained buckets lack device coverage and return null shares. Each number exposes at most 25 of its own device indexes, coarse reported class and last observed sending activity. A list change makes inventory membership/count unknown until another full list. Inventory is null in the combined summary. No recipient device identity or raw message ID is retained by this analytics block. Joint conversation breakdown rows retain first outgoing message type, length band, send source, inferred calling code and observed customer device-count class together with UTC completion bucket. Combine rows matching all selected categories to drill into countries and message attributes without inferring intersections from independent marginal totals. Calling codes do not establish current location and shared codes do not identify a unique country. Counts describe completed 24-hour conversation cohorts, not distinct customers. Rates and averages are null when coverage is missing, dropped or truncated. At most 4096 number/time/category groups are returned in one scope, prioritizing largest groups and marking truncation; raw reply latency sums support weighted aggregation. Connection/call vitals and live message platform distributions are separate measurements, not recipient-country filtered cohorts. Recipient country and recipient linked-device-count fields refine joint conversation metadata. Recipient activity remains hourly even for long date ranges, supporting incoming-message timing in an explicit time zone. Delivery signals do not prove reading; read signals are distinct. Presence subscriptions are best-effort around permitted direct sends, reuse a live bounded local lease, preserve observation-off policies and never poll every contact. Missing presence is Unknown, not offline.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "Get WhatsApp connection analytics",
+ "description": "Aggregated connection activity and operational vitals. Returns disabled with null summary and empty data until a team owner or admin enables Analytics. Conversation rates use completed 24-hour direct-chat cohorts, booked in the period when they mature; missing or dropped cohort coverage returns null rates. Read means an observed read receipt, not a verified app open. No contact identifiers or message content. Linked Devices telemetry only; unsupported or unobserved connections carry measured=false. Bucket timestamps use UTC. Activity series use hourly buckets for ranges up to 48 hours and daily buckets for longer ranges. Call series use daily buckets. Message metadata compares direct sends and completed conversations by type, coarse text/caption length, source, calling code and observed device count. Device observations are bounded samples. Calling-code shares describe conversations, not distinct people or location. Presence signals require existing subscriptions. Primary phone activity spans end at their last observed signal and close after 15 minutes without evidence. Quiet gaps end at the next observed signal. Duration sums and averages count completed intervals and exclude open or restart-censored intervals; they do not measure phone online/offline or power state. Metadata collection uses the current team opt-in; disable erases these aggregates and stale queued metadata is rejected. Calls aggregate retained records by their immutable original connection/project ownership, including supported Official API calls; message measured/coverage fields do not apply to calls. Call series groups starts by UTC day. Answer rate excludes still-ringing calls; timing fields have explicit observation counts. Missed-call follow-up observes an answered outgoing call to the same pseudonymous contact within 24h, including after the requested end; only completed windows with a known contact form the denominator. It does not prove callback intent. Quality uses reported measurements, latest cumulative app reports per connection and per-call averages. Breakdown counts can overlap. Disabling hides this call view without deleting operational call history. Device analytics estimates sending client families from message ID prefixes, not verified hardware. Customer/account distributions count observed live direct messages, not unique people or installed devices; unknown is included. Older retained buckets lack device coverage and return null shares. Each number exposes at most 25 of its own device indexes, coarse reported class and last observed sending activity. A list change makes inventory membership/count unknown until another full list. Inventory is null in the combined summary. No recipient device identity or raw message ID is retained by this analytics block. Joint conversation breakdown rows retain first outgoing message type, length band, send source, inferred calling code and observed customer device-count class together with UTC completion bucket. Combine rows matching all selected categories to drill into countries and message attributes without inferring intersections from independent marginal totals. Calling codes do not establish current location and shared codes do not identify a unique country. Counts describe completed 24-hour conversation cohorts, not distinct customers. Rates and averages are null when coverage is missing, dropped or truncated. At most 4096 connection/time/category groups are returned in one scope, prioritizing largest groups and marking truncation; raw reply latency sums support weighted aggregation. Connection/call vitals and live message platform distributions are separate measurements, not recipient-country filtered cohorts. Recipient country and recipient linked-device-count fields refine joint conversation metadata. Recipient activity remains hourly even for long date ranges, supporting incoming-message timing in an explicit time zone. Delivery signals do not prove reading; read signals are distinct. Presence subscriptions are best-effort around permitted direct sends, reuse a live bounded local lease, preserve observation-off policies and never poll every contact. Missing presence is Unknown, not offline.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -631,13 +625,13 @@
}
},
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
- "description": "Number record UUID."
+ "description": "Connection record UUID."
}
},
{
@@ -671,6 +665,13 @@
},
"description": "Stable request correlation identifier."
},
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
"Polymorfa-Version": {
"schema": {
"type": "string"
@@ -715,12 +716,12 @@
"get": {
"operationId": "getProjectWhatsAppAnalytics",
"tags": ["Analytics"],
- "summary": "Get WhatsApp number analytics",
- "description": "Aggregated number activity and operational vitals. Returns disabled with null summary and empty data until a team owner or admin enables Analytics. Conversation rates use completed 24-hour direct-chat cohorts, booked in the period when they mature; missing or dropped cohort coverage returns null rates. Read means an observed read receipt, not a verified app open. No contact identifiers or message content. Linked Devices telemetry only; unsupported or unobserved numbers carry measured=false. Bucket timestamps use UTC. Activity series use hourly buckets for ranges up to 48 hours and daily buckets for longer ranges. Call series use daily buckets. Message metadata compares direct sends and completed conversations by type, coarse text/caption length, source, calling code and observed device count. Device observations are bounded samples. Calling-code shares describe conversations, not distinct people or location. Presence signals require existing subscriptions. Primary phone activity spans end at their last observed signal and close after 15 minutes without evidence. Quiet gaps end at the next observed signal. Duration sums and averages count completed intervals and exclude open or restart-censored intervals; they do not measure phone online/offline or power state. Metadata collection uses the current team opt-in; disable erases these aggregates and stale queued metadata is rejected. Calls aggregate retained records by their immutable original number/project ownership, including supported Official API calls; message measured/coverage fields do not apply to calls. Call series groups starts by UTC day. Answer rate excludes still-ringing calls; timing fields have explicit observation counts. Missed-call follow-up observes an answered outgoing call to the same pseudonymous contact within 24h, including after the requested end; only completed windows with a known contact form the denominator. It does not prove callback intent. Quality uses reported measurements, latest cumulative app reports per connection and per-call averages. Breakdown counts can overlap. Disabling hides this call view without deleting operational call history. Device analytics estimates sending client families from message ID prefixes, not verified hardware. Customer/account distributions count observed live direct messages, not unique people or installed devices; unknown is included. Older retained buckets lack device coverage and return null shares. Each number exposes at most 25 of its own device indexes, coarse reported class and last observed sending activity. A list change makes inventory membership/count unknown until another full list. Inventory is null in the combined summary. No recipient device identity or raw message ID is retained by this analytics block. Joint conversation breakdown rows retain first outgoing message type, length band, send source, inferred calling code and observed customer device-count class together with UTC completion bucket. Combine rows matching all selected categories to drill into countries and message attributes without inferring intersections from independent marginal totals. Calling codes do not establish current location and shared codes do not identify a unique country. Counts describe completed 24-hour conversation cohorts, not distinct customers. Rates and averages are null when coverage is missing, dropped or truncated. At most 4096 number/time/category groups are returned in one scope, prioritizing largest groups and marking truncation; raw reply latency sums support weighted aggregation. Connection/call vitals and live message platform distributions are separate measurements, not recipient-country filtered cohorts. Recipient country and recipient linked-device-count fields refine joint conversation metadata. Recipient activity remains hourly even for long date ranges, supporting incoming-message timing in an explicit time zone. Delivery signals do not prove reading; read signals are distinct. Presence subscriptions are best-effort around permitted direct sends, reuse a live bounded local lease, preserve observation-off policies and never poll every contact. Missing presence is Unknown, not offline.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "Get WhatsApp connection analytics",
+ "description": "Aggregated connection activity and operational vitals. Returns disabled with null summary and empty data until a team owner or admin enables Analytics. Conversation rates use completed 24-hour direct-chat cohorts, booked in the period when they mature; missing or dropped cohort coverage returns null rates. Read means an observed read receipt, not a verified app open. No contact identifiers or message content. Linked Devices telemetry only; unsupported or unobserved connections carry measured=false. Bucket timestamps use UTC. Activity series use hourly buckets for ranges up to 48 hours and daily buckets for longer ranges. Call series use daily buckets. Message metadata compares direct sends and completed conversations by type, coarse text/caption length, source, calling code and observed device count. Device observations are bounded samples. Calling-code shares describe conversations, not distinct people or location. Presence signals require existing subscriptions. Primary phone activity spans end at their last observed signal and close after 15 minutes without evidence. Quiet gaps end at the next observed signal. Duration sums and averages count completed intervals and exclude open or restart-censored intervals; they do not measure phone online/offline or power state. Metadata collection uses the current team opt-in; disable erases these aggregates and stale queued metadata is rejected. Calls aggregate retained records by their immutable original connection/project ownership, including supported Official API calls; message measured/coverage fields do not apply to calls. Call series groups starts by UTC day. Answer rate excludes still-ringing calls; timing fields have explicit observation counts. Missed-call follow-up observes an answered outgoing call to the same pseudonymous contact within 24h, including after the requested end; only completed windows with a known contact form the denominator. It does not prove callback intent. Quality uses reported measurements, latest cumulative app reports per connection and per-call averages. Breakdown counts can overlap. Disabling hides this call view without deleting operational call history. Device analytics estimates sending client families from message ID prefixes, not verified hardware. Customer/account distributions count observed live direct messages, not unique people or installed devices; unknown is included. Older retained buckets lack device coverage and return null shares. Each number exposes at most 25 of its own device indexes, coarse reported class and last observed sending activity. A list change makes inventory membership/count unknown until another full list. Inventory is null in the combined summary. No recipient device identity or raw message ID is retained by this analytics block. Joint conversation breakdown rows retain first outgoing message type, length band, send source, inferred calling code and observed customer device-count class together with UTC completion bucket. Combine rows matching all selected categories to drill into countries and message attributes without inferring intersections from independent marginal totals. Calling codes do not establish current location and shared codes do not identify a unique country. Counts describe completed 24-hour conversation cohorts, not distinct customers. Rates and averages are null when coverage is missing, dropped or truncated. At most 4096 connection/time/category groups are returned in one scope, prioritizing largest groups and marking truncation; raw reply latency sums support weighted aggregation. Connection/call vitals and live message platform distributions are separate measurements, not recipient-country filtered cohorts. Recipient country and recipient linked-device-count fields refine joint conversation metadata. Recipient activity remains hourly even for long date ranges, supporting incoming-message timing in an explicit time zone. Delivery signals do not prove reading; read signals are distinct. Presence subscriptions are best-effort around permitted direct sends, reuse a live bounded local lease, preserve observation-off policies and never poll every contact. Missing presence is Unknown, not offline.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -740,13 +741,13 @@
}
},
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
- "description": "Number record UUID."
+ "description": "Connection record UUID."
}
},
{
@@ -780,6 +781,13 @@
},
"description": "Stable request correlation identifier."
},
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
"Polymorfa-Version": {
"schema": {
"type": "string"
@@ -835,6 +843,7 @@
"invalid_request_error",
"authentication_error",
"permission_error",
+ "billing_error",
"conflict_error",
"rate_limit_error",
"api_error",
@@ -844,11 +853,16 @@
"code": {
"type": "string",
"enum": [
+ "zero_knowledge_connection",
"invalid_parameter",
"invalid_credential",
"entitlement_required",
"cloud_template_authority_restricted",
"gate_limit_reached",
+ "billing_credit_required",
+ "addon_required",
+ "safe_mode_not_entitled",
+ "warmup_plan_not_entitled",
"method_not_allowed",
"permission_denied",
"missing_scope",
@@ -861,17 +875,21 @@
"stream_cursor_expired",
"stream_connection_limit_reached",
"state_conflict",
+ "team_deletion_scheduled",
"hybrid_routing_paused",
"hybrid_choice_required",
"hybrid_transition_ineligible",
"hybrid_automation_unavailable",
+ "hybrid_group_linked_devices_unavailable",
"hybrid_transport_unavailable",
"hybrid_target_reference_unavailable",
"send_outcome_unknown",
+ "terms_acceptance_required",
+ "terms_activation_blocked",
"idempotency_conflict",
"idempotency_in_progress",
- "idempotency_completed",
"idempotency_outcome_unknown",
+ "idempotency_replay_unavailable",
"call_claimed",
"call_not_ringing",
"connection_limit",
@@ -886,7 +904,7 @@
"order_status_transition_invalid",
"order_cancellation_failed",
"call_opt_out_limit",
- "number_restricted",
+ "connection_restricted",
"sip_trunk_in_use",
"sip_trunk_revision_conflict",
"sip_trunk_limit",
@@ -904,16 +922,21 @@
"upstream_failure",
"service_unavailable",
"credential_verification_unavailable",
- "session_not_ready",
+ "connection_not_ready",
"command_dispatch_failed",
"result_unknown",
+ "parent_bsuid_not_supported",
"recipient_not_on_whatsapp",
"conversation_window_closed",
"template_not_approved",
"media_too_large",
"whatsapp_rate_limited",
"new_chat_limit_reached",
+ "marketing_disabled_on_cloud_api",
"whatsapp_account_restricted",
+ "whatsapp_authorization_required",
+ "whatsapp_payment_method_required",
+ "whatsapp_number_not_registered",
"whatsapp_groups_ineligible",
"whatsapp_group_creation_paused",
"whatsapp_group_limit_reached",
@@ -929,7 +952,10 @@
"bansafe_accounting_unavailable",
"bansafe_send_outcome_unknown",
"campaigns_not_entitled",
- "campaign_throughput_capped"
+ "campaign_throughput_capped",
+ "campaign_approval_required",
+ "campaign_approval_stale",
+ "campaign_variables_missing"
]
},
"message": {
@@ -1157,15 +1183,15 @@
"droppedReceiptJoins"
]
},
- "totalNumbers": {
+ "totalConnections": {
"type": "integer",
"minimum": 0
},
- "measuredNumbers": {
+ "measuredConnections": {
"type": "integer",
"minimum": 0
},
- "connectedNumbers": {
+ "connectedConnections": {
"type": "integer",
"minimum": 0
},
@@ -2088,7 +2114,7 @@
"properties": {
"listObserved": {
"type": "boolean",
- "description": "True after a full device list for this number was observed."
+ "description": "True after a full device list for this connection was observed."
},
"listCurrent": {
"type": "boolean",
@@ -2206,7 +2232,7 @@
"accountPlatforms",
"inventory"
],
- "description": "Observed message client-family distributions and a bounded inventory of this number's own devices. The combined summary has null inventory."
+ "description": "Observed message client-family distributions and a bounded inventory of this connection's own devices. The combined summary has null inventory."
},
"conversationBreakdown": {
"type": "object",
@@ -2230,7 +2256,7 @@
},
"truncated": {
"type": "boolean",
- "description": "True when the requested scope exceeded 4096 number/time/category groups. The largest groups are retained; rates and averages are null."
+ "description": "True when the requested scope exceeded 4096 connection/time/category groups. The largest groups are retained; rates and averages are null."
},
"buckets": {
"type": "array",
@@ -2244,7 +2270,7 @@
},
"complete": {
"type": "boolean",
- "description": "True when this UTC time bucket has joint category coverage and no conversations or records were dropped. A summary bucket also requires every scoped number to have a bucket."
+ "description": "True when this UTC time bucket has joint category coverage and no conversations or records were dropped. A summary bucket also requires every scoped connection to have a bucket."
}
},
"required": ["ts", "complete"]
@@ -2294,6 +2320,21 @@
"other": "Other or unclassified send source."
}
},
+ "recipientCountry": {
+ "type": "string",
+ "pattern": "^(unknown|[A-Z]{2})$",
+ "description": "Calling country inferred from a full phone number or valid BSUID prefix; Unknown for missing historical metadata. Not current location."
+ },
+ "recipientDeviceCount": {
+ "type": "string",
+ "enum": [
+ "primary_only",
+ "one_linked",
+ "two_plus_linked",
+ "unknown"
+ ],
+ "description": "Observed linked-device range; device zero is the primary and is excluded from linked counts."
+ },
"callingCode": {
"type": "string",
"pattern": "^(unknown|[1-9][0-9]{0,2})$"
@@ -2345,6 +2386,8 @@
"messageType",
"textBand",
"origin",
+ "recipientCountry",
+ "recipientDeviceCount",
"callingCode",
"customerDevices",
"completedConversations",
@@ -2370,6 +2413,126 @@
"rows"
],
"description": "Completed 24-hour conversation cohorts grouped jointly by completion bucket, first outgoing message metadata, calling code and observed device-count class."
+ },
+ "recipientActivity": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "measured": {
+ "type": "boolean"
+ },
+ "complete": {
+ "type": "boolean"
+ },
+ "observedBuckets": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "droppedSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "truncated": {
+ "type": "boolean"
+ },
+ "rows": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "ts": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ },
+ "recipientCountry": {
+ "type": "string",
+ "pattern": "^(unknown|[A-Z]{2})$"
+ },
+ "recipientDeviceCount": {
+ "type": "string",
+ "enum": [
+ "primary_only",
+ "one_linked",
+ "two_plus_linked",
+ "unknown"
+ ]
+ },
+ "deviceSource": {
+ "type": "string",
+ "enum": ["primary", "linked", "unknown"]
+ },
+ "incomingMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "deliveryReceipts": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "readReceipts": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "onlineSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "offlineSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "typingSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "lastSignalAt": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ },
+ "quietGaps": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "quietGapMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageQuietGapMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ }
+ },
+ "required": [
+ "ts",
+ "recipientCountry",
+ "recipientDeviceCount",
+ "deviceSource",
+ "incomingMessages",
+ "deliveryReceipts",
+ "readReceipts",
+ "onlineSignals",
+ "offlineSignals",
+ "typingSignals",
+ "lastSignalAt",
+ "quietGaps",
+ "quietGapMs",
+ "averageQuietGapMs"
+ ]
+ },
+ "maxItems": 4096
+ }
+ },
+ "required": [
+ "measured",
+ "complete",
+ "observedBuckets",
+ "droppedSignals",
+ "truncated",
+ "rows"
+ ],
+ "description": "Hourly aggregate recipient observations, grouped jointly by connectioning country, observed linked-device count and sender-device class. Incoming messages and matched delivery/read receipts are deduplicated by native message and device in bounded memory. Presence is user-level and uses Unknown device source. Quiet gaps of at least 15 minutes are completed gaps between observed signals on the same device, never verified offline periods. No recipient identity, native message ID or recipient device index is retained. Coverage is explicit; older retained buckets are unmeasured. Message telemetry remains Linked Devices only; Official API message activity is not measured."
}
},
"required": [
@@ -2389,9 +2552,9 @@
"streamErrors",
"keepaliveTimeouts",
"engagement",
- "totalNumbers",
- "measuredNumbers",
- "connectedNumbers",
+ "totalConnections",
+ "measuredConnections",
+ "connectedConnections",
"messageAnalysis",
"customerActivity",
"accountActivity",
@@ -2403,13 +2566,13 @@
}
]
},
- "numbers": {
+ "connections": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -3490,7 +3653,7 @@
"properties": {
"listObserved": {
"type": "boolean",
- "description": "True after a full device list for this number was observed."
+ "description": "True after a full device list for this connection was observed."
},
"listCurrent": {
"type": "boolean",
@@ -3608,7 +3771,7 @@
"accountPlatforms",
"inventory"
],
- "description": "Observed message client-family distributions and a bounded inventory of this number's own devices. The combined summary has null inventory."
+ "description": "Observed message client-family distributions and a bounded inventory of this connection's own devices. The combined summary has null inventory."
},
"conversationBreakdown": {
"type": "object",
@@ -3632,7 +3795,7 @@
},
"truncated": {
"type": "boolean",
- "description": "True when the requested scope exceeded 4096 number/time/category groups. The largest groups are retained; rates and averages are null."
+ "description": "True when the requested scope exceeded 4096 connection/time/category groups. The largest groups are retained; rates and averages are null."
},
"buckets": {
"type": "array",
@@ -3646,7 +3809,7 @@
},
"complete": {
"type": "boolean",
- "description": "True when this UTC time bucket has joint category coverage and no conversations or records were dropped. A summary bucket also requires every scoped number to have a bucket."
+ "description": "True when this UTC time bucket has joint category coverage and no conversations or records were dropped. A summary bucket also requires every scoped connection to have a bucket."
}
},
"required": ["ts", "complete"]
@@ -3696,6 +3859,21 @@
"other": "Other or unclassified send source."
}
},
+ "recipientCountry": {
+ "type": "string",
+ "pattern": "^(unknown|[A-Z]{2})$",
+ "description": "Calling country inferred from a full phone number or valid BSUID prefix; Unknown for missing historical metadata. Not current location."
+ },
+ "recipientDeviceCount": {
+ "type": "string",
+ "enum": [
+ "primary_only",
+ "one_linked",
+ "two_plus_linked",
+ "unknown"
+ ],
+ "description": "Observed linked-device range; device zero is the primary and is excluded from linked counts."
+ },
"callingCode": {
"type": "string",
"pattern": "^(unknown|[1-9][0-9]{0,2})$"
@@ -3747,6 +3925,8 @@
"messageType",
"textBand",
"origin",
+ "recipientCountry",
+ "recipientDeviceCount",
"callingCode",
"customerDevices",
"completedConversations",
@@ -3772,10 +3952,130 @@
"rows"
],
"description": "Completed 24-hour conversation cohorts grouped jointly by completion bucket, first outgoing message metadata, calling code and observed device-count class."
+ },
+ "recipientActivity": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "measured": {
+ "type": "boolean"
+ },
+ "complete": {
+ "type": "boolean"
+ },
+ "observedBuckets": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "droppedSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "truncated": {
+ "type": "boolean"
+ },
+ "rows": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "ts": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ },
+ "recipientCountry": {
+ "type": "string",
+ "pattern": "^(unknown|[A-Z]{2})$"
+ },
+ "recipientDeviceCount": {
+ "type": "string",
+ "enum": [
+ "primary_only",
+ "one_linked",
+ "two_plus_linked",
+ "unknown"
+ ]
+ },
+ "deviceSource": {
+ "type": "string",
+ "enum": ["primary", "linked", "unknown"]
+ },
+ "incomingMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "deliveryReceipts": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "readReceipts": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "onlineSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "offlineSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "typingSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "lastSignalAt": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ },
+ "quietGaps": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "quietGapMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageQuietGapMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ }
+ },
+ "required": [
+ "ts",
+ "recipientCountry",
+ "recipientDeviceCount",
+ "deviceSource",
+ "incomingMessages",
+ "deliveryReceipts",
+ "readReceipts",
+ "onlineSignals",
+ "offlineSignals",
+ "typingSignals",
+ "lastSignalAt",
+ "quietGaps",
+ "quietGapMs",
+ "averageQuietGapMs"
+ ]
+ },
+ "maxItems": 4096
+ }
+ },
+ "required": [
+ "measured",
+ "complete",
+ "observedBuckets",
+ "droppedSignals",
+ "truncated",
+ "rows"
+ ],
+ "description": "Hourly aggregate recipient observations, grouped jointly by connectioning country, observed linked-device count and sender-device class. Incoming messages and matched delivery/read receipts are deduplicated by native message and device in bounded memory. Presence is user-level and uses Unknown device source. Quiet gaps of at least 15 minutes are completed gaps between observed signals on the same device, never verified offline periods. No recipient identity, native message ID or recipient device index is retained. Coverage is explicit; older retained buckets are unmeasured. Message telemetry remains Linked Devices only; Official API message activity is not measured."
}
},
"required": [
- "sessionId",
+ "connectionId",
"projectId",
"name",
"backend",
@@ -3846,7 +4146,7 @@
"type": "integer",
"minimum": 0
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -3900,7 +4200,7 @@
"averageBusinessResponseMs",
"onlineMs",
"disconnects",
- "sessionId",
+ "connectionId",
"customerOnlineSignals",
"customerTypingSignals",
"primaryPhoneMessages",
@@ -3995,7 +4295,7 @@
"type": "integer",
"minimum": 0
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -4022,7 +4322,7 @@
"p95PickupMs",
"shortAnswered",
"video",
- "sessionId",
+ "connectionId",
"ts"
]
}
@@ -4033,12 +4333,16 @@
"period",
"requestVitals",
"summary",
- "numbers",
+ "connections",
"series",
"callSeries"
]
}
}
},
- "family": "platform"
+ "family": "platform",
+ "previousExport": {
+ "path": "contracts/history/pre-connections/analytics-device-signals.json",
+ "sha256": "68086bd358c750833d3a37d83a1136ffb83d52ab8b16c28801734abc2c7e427a"
+ }
}
diff --git a/contracts/campaign-custody-20261014.json b/contracts/campaign-custody-20261014.json
index b7904dd18..5c8ae1cb5 100644
--- a/contracts/campaign-custody-20261014.json
+++ b/contracts/campaign-custody-20261014.json
@@ -1,13 +1,13 @@
{
"repository": "polymorfa/polymorfa",
- "commit": "f97ad78b172e80788c33bdc0fcf28f75db9283ec",
+ "commit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
"published": false,
- "apiVersion": "2026-10-14",
- "note": "Thirty campaign, audience profile, STOP confirmation and custody-default operations. TypeScript adoption is in source; five native ports, full 625-operation reconciliation, deployed acceptance and publication remain required. Global snapshots and their coverage ledger remain unchanged.",
+ "apiVersion": "2026-09-22",
+ "note": "Connection source projection at the exact candidate revision in contracts/source.json. This is not deployment or package acceptance.",
"sources": {
"messaging": {
"sourcePath": "apps/api/docs/openapi.json",
- "sourceSha256": "009bf72f1c0bb65c6f2d168e804fdd50f60ab1394a5a06632391b87986a5fcb4",
+ "sourceSha256": "e84c7ff814c6b59ca7f32c3fda1aedbed3f672e728910adb883f0aa8c6cf3ab7",
"paths": {
"/messaging/projects/{projectSlug}/campaigns/{id}/links": {
"get": {
@@ -62,7 +62,7 @@
}
},
"400": {
- "description": "Bad request — request body or params failed validation",
+ "description": "Bad request \u2014 request body or params failed validation",
"content": {
"application/json": {
"schema": {
@@ -221,9 +221,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:read "
}
}
},
@@ -232,7 +229,7 @@
"operationId": "testSendCampaign",
"tags": ["Campaigns"],
"summary": "Send a test of a draft campaign",
- "description": "**Required scopes (all):** `campaigns:manage` · `campaigns:read`\n\nRequires campaigns:manage and campaigns:read because the test can use stored recipient samples. Sends one copy of a draft campaign's content to a seed recipient, through the same rendering, sending, and BanSafe checks as a launched campaign. The seed recipient must be a number connected to your team. A test is not a campaign recipient and is not counted in the campaign's statistics or webhooks. A team can send 20 tests an hour, and at most 5 an hour to one seed recipient.",
+ "description": "**Required scopes (all):** `campaigns:manage` \u00b7 `campaigns:read`\n\nRequires campaigns:manage and campaigns:read because the test can use stored recipient samples. Sends one copy of a draft campaign's content to a seed recipient, through the same rendering, sending, and BanSafe checks as a launched campaign. The seed recipient must be the phone of a Connection connected to your team. A test is not a campaign recipient and is not counted in the campaign's statistics or webhooks. A team can send 20 tests an hour, and at most 5 an hour to one seed recipient.",
"security": [
{
"BearerAuth": []
@@ -261,7 +258,7 @@
"name": "Idempotency-Key",
"in": "header",
"required": false,
- "description": "Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version`, and request never runs the write again: it returns `409 idempotency_completed` when the original succeeded, or the original server error, with `Idempotent-Replayed: true`. Reusing the key for a different request returns `409 idempotency_conflict`; a retry while the original is still running returns `409 idempotency_in_progress`, and a retry after an unrecorded outcome returns `409 idempotency_outcome_unknown`.",
+ "description": "Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 1 hour. A retry with the same key, credential, `Polymorfa-Version`, and request never runs the write again while its receipt is retained. Keep the first response. Exact response replay requires authorized replay data; opaque message or campaign bodies are not retained by default. An available exact replay carries `Idempotent-Replayed: true`. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns `422 idempotency_conflict`. A retry while the original is still running returns `409 idempotency_in_progress`, and a retry after an unrecorded outcome returns `409 idempotency_outcome_unknown`. If the recorded response cannot be read, the retry returns `503 idempotency_replay_unavailable` with `Retry-After` and the write still does not run again.",
"schema": {
"type": "string",
"minLength": 1,
@@ -290,6 +287,13 @@
}
},
"headers": {
+ "Idempotent-Replayed": {
+ "description": "`true` when this response is the recorded response of an earlier request with the same Idempotency-Key.",
+ "schema": {
+ "type": "string",
+ "enum": ["true"]
+ }
+ },
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
},
@@ -302,7 +306,7 @@
}
},
"400": {
- "description": "Bad request — request body or params failed validation",
+ "description": "Bad request \u2014 request body or params failed validation",
"content": {
"application/json": {
"schema": {
@@ -366,7 +370,7 @@
}
},
"402": {
- "description": "`campaigns_not_entitled`: the sending number's plan does not include Campaigns.",
+ "description": "`campaigns_not_entitled`: the sending connection's plan does not include Campaigns.",
"content": {
"application/json": {
"schema": {
@@ -374,9 +378,9 @@
},
"example": {
"error": {
- "type": "permission_error",
+ "type": "billing_error",
"code": "campaigns_not_entitled",
- "message": "This number’s plan does not include Campaigns.",
+ "message": "This connection\u2019s plan does not include Campaigns.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -462,7 +466,7 @@
}
},
"409": {
- "description": "`state_conflict`: The campaign is not a draft or has A/B or weighted content alternatives, the sending number is a Hybrid Link number, or the seed recipient opted out. `bansafe_cold_held`: the seed recipient has never written to the sending number and the campaign holds first messages. The Idempotency-Key already succeeded (`idempotency_completed`), was used for a different request (`idempotency_conflict`), belongs to a request that is still running (`idempotency_in_progress`, with Retry-After), or belongs to a request whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "description": "`state_conflict`: The campaign is not a draft or has A/B or weighted content alternatives, the sending connection is a Hybrid Link connection, or the seed recipient opted out. `bansafe_cold_held`: the seed recipient has never written to the sending connection and the campaign holds first messages. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
"content": {
"application/json": {
"schema": {
@@ -483,17 +487,16 @@
},
"headers": {
"Retry-After": {
- "description": "Seconds to wait before retrying `idempotency_in_progress`.",
+ "description": "Seconds to wait before checking again with the same key. Waiting does not release the execution fence or guarantee that replay data becomes available. Same-key retries are protected only within the one-hour receipt window.",
"schema": {
"type": "integer",
"minimum": 0
}
},
- "Idempotent-Replayed": {
- "description": "`true` when this response reports the recorded outcome of an earlier request with the same Idempotency-Key.",
+ "Link": {
+ "description": "Link to the documentation for this Idempotency-Key error (`rel=\"describedby\"`).",
"schema": {
- "type": "string",
- "enum": ["true"]
+ "type": "string"
}
},
"X-RateLimit-Limit": {
@@ -508,7 +511,7 @@
}
},
"422": {
- "description": "`campaign_variables_missing`: the selected sample and explicit values cannot fill a variable in the content.",
+ "description": "`campaign_variables_missing`: the selected sample and explicit values cannot fill a variable in the content. The Idempotency-Key was already used for a different request (`idempotency_conflict`)",
"content": {
"application/json": {
"schema": {
@@ -528,6 +531,12 @@
}
},
"headers": {
+ "Link": {
+ "description": "Link to the documentation for this Idempotency-Key error (`rel=\"describedby\"`).",
+ "schema": {
+ "type": "string"
+ }
+ },
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
},
@@ -540,7 +549,7 @@
}
},
"429": {
- "description": "The team or seed recipient reached its test-send limit (`rate_limit_exceeded`), or BanSafe is pacing the sending number. Follow `Retry-After`.",
+ "description": "The team or seed recipient reached its test-send limit (`rate_limit_exceeded`), or BanSafe is pacing the sending connection. Follow `Retry-After`.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before retrying.",
@@ -643,7 +652,7 @@
}
},
"503": {
- "description": "The test was not sent: the sending number is not connected (`session_not_ready`), test sends or the send path are unavailable (`service_unavailable`, `command_dispatch_failed`), or the sending number's allowance could not be checked (`bansafe_accounting_unavailable`). Retry later.",
+ "description": "The test was not sent: the sending connection is not connected (`connection_not_ready`), test sends or the send path are unavailable (`service_unavailable`, `command_dispatch_failed`), or the sending connection's allowance could not be checked (`bansafe_accounting_unavailable`). Retry later. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend",
"content": {
"application/json": {
"schema": {
@@ -663,6 +672,13 @@
}
},
"headers": {
+ "Retry-After": {
+ "description": "Seconds to wait before checking again with the same key. Waiting does not release the execution fence or guarantee that replay data becomes available. Same-key retries are protected only within the one-hour receipt window.",
+ "schema": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
},
@@ -706,9 +722,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage campaigns:read "
}
}
},
@@ -767,7 +780,7 @@
}
},
"400": {
- "description": "Bad request — request body or params failed validation",
+ "description": "Bad request \u2014 request body or params failed validation",
"content": {
"application/json": {
"schema": {
@@ -958,9 +971,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -1017,7 +1027,7 @@
}
},
"400": {
- "description": "Bad request — request body or params failed validation",
+ "description": "Bad request \u2014 request body or params failed validation",
"content": {
"application/json": {
"schema": {
@@ -1177,9 +1187,6 @@
}
}
},
- "x-mint": {
- "content": "campaigns:read "
- },
"description": "**Required scope:** `campaigns:read`"
}
},
@@ -1247,7 +1254,7 @@
}
},
"400": {
- "description": "Bad request — request body or params failed validation",
+ "description": "Bad request \u2014 request body or params failed validation",
"content": {
"application/json": {
"schema": {
@@ -1438,9 +1445,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -1498,11 +1502,12 @@
"cold_held",
"campaign_cancelled",
"invalid_recipient",
- "session_not_connected",
+ "connection_not_connected",
"ack_timeout",
"blocked_by_safety",
"send_failed",
"missing_variable",
+ "frequency_cap",
"other"
],
"description": "Only recipients whose `failureReason` is this code."
@@ -1565,7 +1570,7 @@
}
},
"400": {
- "description": "Bad request — request body or params failed validation",
+ "description": "Bad request \u2014 request body or params failed validation",
"content": {
"application/json": {
"schema": {
@@ -1756,9 +1761,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:read "
}
}
}
@@ -1819,6 +1821,7 @@
"invalid_request_error",
"authentication_error",
"permission_error",
+ "billing_error",
"conflict_error",
"rate_limit_error",
"api_error",
@@ -1828,12 +1831,16 @@
"code": {
"type": "string",
"enum": [
- "zero_knowledge_session",
+ "zero_knowledge_connection",
"invalid_parameter",
"invalid_credential",
"entitlement_required",
"cloud_template_authority_restricted",
"gate_limit_reached",
+ "billing_credit_required",
+ "addon_required",
+ "safe_mode_not_entitled",
+ "warmup_plan_not_entitled",
"method_not_allowed",
"permission_denied",
"missing_scope",
@@ -1846,17 +1853,21 @@
"stream_cursor_expired",
"stream_connection_limit_reached",
"state_conflict",
+ "team_deletion_scheduled",
"hybrid_routing_paused",
"hybrid_choice_required",
"hybrid_transition_ineligible",
"hybrid_automation_unavailable",
+ "hybrid_group_linked_devices_unavailable",
"hybrid_transport_unavailable",
"hybrid_target_reference_unavailable",
"send_outcome_unknown",
+ "terms_acceptance_required",
+ "terms_activation_blocked",
"idempotency_conflict",
"idempotency_in_progress",
- "idempotency_completed",
"idempotency_outcome_unknown",
+ "idempotency_replay_unavailable",
"call_claimed",
"call_not_ringing",
"connection_limit",
@@ -1871,7 +1882,7 @@
"order_status_transition_invalid",
"order_cancellation_failed",
"call_opt_out_limit",
- "number_restricted",
+ "connection_restricted",
"sip_trunk_in_use",
"sip_trunk_revision_conflict",
"sip_trunk_limit",
@@ -1889,16 +1900,21 @@
"upstream_failure",
"service_unavailable",
"credential_verification_unavailable",
- "session_not_ready",
+ "connection_not_ready",
"command_dispatch_failed",
"result_unknown",
+ "parent_bsuid_not_supported",
"recipient_not_on_whatsapp",
"conversation_window_closed",
"template_not_approved",
"media_too_large",
"whatsapp_rate_limited",
"new_chat_limit_reached",
+ "marketing_disabled_on_cloud_api",
"whatsapp_account_restricted",
+ "whatsapp_authorization_required",
+ "whatsapp_payment_method_required",
+ "whatsapp_number_not_registered",
"whatsapp_groups_ineligible",
"whatsapp_group_creation_paused",
"whatsapp_group_limit_reached",
@@ -1955,16 +1971,16 @@
"CampaignTestSendRequest": {
"type": "object",
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid",
- "description": "The number to send the test from. It must be connected, on a plan that includes Campaigns, and, when the campaign selects numbers, one of them."
+ "description": "The connection to send the test from. It must be connected, on a plan that includes Campaigns, and, when the campaign selects connections, one of them."
},
"to": {
"type": "string",
"minLength": 1,
"maxLength": 32,
- "description": "The seed recipient in international format. It must be the phone of a number connected to your team.",
+ "description": "The seed recipient in international format. It must be the phone of a connection connected to your team.",
"example": "+5511999990000"
},
"sampleRecipientId": {
@@ -1992,7 +2008,7 @@
"maxProperties": 50
}
},
- "required": ["sessionId", "to"]
+ "required": ["connectionId", "to"]
},
"TestSendCampaignResponse": {
"type": "object",
@@ -2026,7 +2042,7 @@
"from": {
"type": "object",
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -2034,8 +2050,8 @@
"type": "string"
}
},
- "required": ["sessionId", "phone"],
- "description": "The number the test was sent from."
+ "required": ["connectionId", "phone"],
+ "description": "The connection the test was sent from."
},
"to": {
"type": "string",
@@ -2290,7 +2306,7 @@
},
"required": ["kind", "flowId", "body", "buttonText", "screen"],
"additionalProperties": false,
- "description": "A published WhatsApp Flow form. Official numbers only."
+ "description": "A published WhatsApp Flow form. Official connections only."
}
]
},
@@ -2471,18 +2487,18 @@
},
"platform": {
"sourcePath": "apps/api/docs/openapi.management.json",
- "sourceSha256": "160fbc57b94ae0be9e5b1e9c183361582fe4b179e1b03c5917959d108990a057",
+ "sourceSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
"paths": {
"/platform/projects/{projectId}/signal-custody": {
"get": {
"operationId": "getProjectSignalCustody",
"tags": ["signal-custody"],
"summary": "Read Project Signal custody default",
- "description": "Returns the custody default for future Number reservations. Existing Number custody is immutable. Customer null defaults inherit the Project default.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns the custody default for future Connection reservations. Existing Connection custody is immutable. Customer null defaults inherit the Project default.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -2559,11 +2575,11 @@
"operationId": "updateProjectSignalCustody",
"tags": ["signal-custody"],
"summary": "Update Project Signal custody default",
- "description": "Changes the default for future Number reservations with a revision check. Customer-owned custody requires beta admission and runtime availability. Existing Numbers keep their custody. Dashboard writes require a team owner or admin. Setting a Customer default to null restores Project inheritance.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Changes the default for future Connection reservations with a revision check. Customer-owned custody requires beta admission and runtime availability. Existing Connections keep their custody. Dashboard writes require a team owner or admin. Setting a Customer default to null restores Project inheritance.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -2655,11 +2671,11 @@
"operationId": "getCustomerSignalCustody",
"tags": ["signal-custody"],
"summary": "Read Customer Signal custody default",
- "description": "Returns the custody default for future Number reservations. Existing Number custody is immutable. Customer null defaults inherit the Project default.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns the custody default for future Connection reservations. Existing Connection custody is immutable. Customer null defaults inherit the Project default.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -2745,11 +2761,11 @@
"operationId": "updateCustomerSignalCustody",
"tags": ["signal-custody"],
"summary": "Update Customer Signal custody default",
- "description": "Changes the default for future Number reservations with a revision check. Customer-owned custody requires beta admission and runtime availability. Existing Numbers keep their custody. Dashboard writes require a team owner or admin. Setting a Customer default to null restores Project inheritance.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Changes the default for future Connection reservations with a revision check. Customer-owned custody requires beta admission and runtime availability. Existing Connections keep their custody. Dashboard writes require a team owner or admin. Setting a Customer default to null restores Project inheritance.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -2850,7 +2866,7 @@
"operationId": "testSendPlatformCampaign",
"tags": ["campaigns"],
"summary": "Send a test of a draft campaign",
- "description": "Requires campaigns:manage and campaigns:read because the test can use stored recipient samples. Sends one copy of a draft campaign's content to a seed recipient, through the same rendering, sending and BanSafe checks as a launched campaign. The seed recipient must be a number connected to your team. The sending number must be connected, on a plan that includes Campaigns and, when the campaign selects numbers, one of them. A test is not a campaign recipient and is not counted in the campaign's statistics or webhooks. A team can send 20 tests an hour, and at most 5 an hour to one seed recipient. `429` means one of these limits was reached or BanSafe is pacing the sending number; follow `Retry-After`. `409 bansafe_cold_held` means the seed recipient has never written to the sending number and the campaign holds first messages. `409 state_conflict` means the campaign is not a draft or has A/B or weighted content alternatives, the sending number is a Hybrid Link number, or the seed recipient opted out. `504 result_unknown` means the outcome was not received in time and the test may still arrive. Send `projectId` in the body when using a team API key. `422 campaign_variables_missing` means the test's sample values, the mapped recipient value and the fallback all leave a variable in the campaign content empty.\n\nRequires `campaigns:manage` and `campaigns:read`. Project tokens only access resources in their own project.",
+ "description": "Requires campaigns:manage and campaigns:read because the test can use stored recipient samples. Sends one copy of a draft campaign's content to a seed recipient, through the same rendering, sending and BanSafe checks as a launched campaign. The seed recipient must be the phone of a Connection connected to your team. The sending connection must be connected, on a plan that includes Campaigns and, when the campaign selects connections, one of them. A test is not a campaign recipient and is not counted in the campaign's statistics or webhooks. A team can send 20 tests an hour, and at most 5 an hour to one seed recipient. `429` means one of these limits was reached or BanSafe is pacing the sending connection; follow `Retry-After`. `409 bansafe_cold_held` means the seed recipient has never written to the sending connection and the campaign holds first messages. `409 state_conflict` means the campaign is not a draft or has A/B or weighted content alternatives, the sending connection is a Hybrid Link connection, or the seed recipient opted out. `504 result_unknown` means the outcome was not received in time and the test may still arrive. Send `projectId` in the body when using a team API key. `422 campaign_variables_missing` means the test's sample values, the mapped recipient value and the fallback all leave a variable in the campaign content empty.\n\nRequires `campaigns:manage` and `campaigns:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
@@ -2877,7 +2893,7 @@
"name": "Idempotency-Key",
"in": "header",
"required": false,
- "description": "Optional unique key, 1 to 255 bytes, that makes this request safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version` and request never runs it again: it returns `409 idempotency_completed` when the original succeeded, or the original server error. Reusing the key for a different request returns `409 idempotency_conflict`; a retry while the original is still running returns `409 idempotency_in_progress`, and a retry after an unrecorded outcome returns `409 idempotency_outcome_unknown`.",
+ "description": "Optional unique key, 1 to 255 bytes, that makes this request safe to retry for 1 hour. A retry with the same key, credential, `Polymorfa-Version` and request never runs it again while its receipt is retained. Keep the first response. Opaque campaign bodies are not retained by default; an available authorized exact replay carries `Idempotent-Replayed: true`. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns `422 idempotency_conflict`. A retry while the original is still running returns `409 idempotency_in_progress`, and a retry after an unrecorded outcome returns `409 idempotency_outcome_unknown`. If the recorded response cannot be read, the retry returns `503 idempotency_replay_unavailable` with `Retry-After`; the request does not run again. Missing replay data never releases the execution fence.",
"schema": {
"type": "string",
"minLength": 1,
@@ -2917,6 +2933,13 @@
"type": "string"
},
"description": "API version applied to this response."
+ },
+ "Idempotent-Replayed": {
+ "description": "`true` when this response is the recorded response of an earlier request with the same Idempotency-Key.",
+ "schema": {
+ "type": "string",
+ "enum": ["true"]
+ }
}
},
"content": {
@@ -2941,7 +2964,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"402": {
- "$ref": "#/components/responses/PaymentRequired"
+ "$ref": "#/components/responses/CampaignsNotEntitled"
},
"403": {
"$ref": "#/components/responses/Forbidden"
@@ -2953,7 +2976,41 @@
"$ref": "#/components/responses/Conflict"
},
"422": {
- "$ref": "#/components/responses/CampaignVariablesMissing"
+ "description": "`campaign_variables_missing`: a recipient or test sample has no value or fallback for a campaign variable; nothing was sent by that request. `idempotency_conflict`: this key belongs to a different request; the earlier request is not run again and this refusal does not establish its outcome.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ },
+ "Link": {
+ "description": "Documentation for an Idempotency-Key error (`rel=\"describedby\"`).",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
},
"429": {
"$ref": "#/components/responses/RateLimited"
@@ -2962,7 +3019,42 @@
"$ref": "#/components/responses/UpstreamFailure"
},
"503": {
- "$ref": "#/components/responses/SendPathUnavailable"
+ "description": "`idempotency_replay_unavailable`: the recorded response cannot be read. The original request is not run again, and its execution fence remains in place. Keep the first response; do not switch keys to resend. The send path can also be unavailable before a send (`connection_not_ready`, `command_dispatch_failed`, `service_unavailable`, or `bansafe_accounting_unavailable`).",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ },
+ "Retry-After": {
+ "description": "Seconds to wait before checking again with the same key. Waiting does not release the execution fence or guarantee that replay data becomes available.",
+ "schema": {
+ "type": "integer",
+ "minimum": 1
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
},
"504": {
"$ref": "#/components/responses/ResultUnknown"
@@ -2975,7 +3067,7 @@
"operationId": "createPlatformCampaignReplyFlow",
"tags": ["campaigns"],
"summary": "Create campaign reply flow",
- "description": "Creates an immutable reply flow revision: the steps a campaign runs when a recipient replies. Each step can send a text, reply buttons, a list, or a Flow form (Official numbers only), and branches on the button or list row chosen, an exact keyword, or a Flow form submission. Beta: returns `403` unless campaign reply flows are enabled for the team. `409` means this flow key and revision already exist.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
+ "description": "Creates an immutable reply flow revision: the steps a campaign runs when a recipient replies. Each step can send a text, reply buttons, a list, or a Flow form (Official connections only), and branches on the button or list row chosen, an exact keyword, or a Flow form submission. Beta: returns `403` unless campaign reply flows are enabled for the team. `409` means this flow key and revision already exist.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
@@ -3591,7 +3683,7 @@
"operationId": "getCampaignSettings",
"tags": ["campaign-settings"],
"summary": "Get campaign settings",
- "description": "Returns the team's campaign settings. `launchApproval.recipientThreshold` is the number of recipients above which a launch needs a team owner or admin; null means no launch needs approval. A team that never saved settings receives `launchApproval.recipientThreshold: null`.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "description": "Returns the team's campaign settings. `launchApproval.recipientThreshold` is the number of recipients above which a launch needs a team owner or admin; null means no launch needs approval. A team that never saved settings receives `launchApproval.recipientThreshold: null`.\n\nTeam keys require `campaigns:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -3660,7 +3752,7 @@
"operationId": "createAudienceFromCampaign",
"tags": ["audiences"],
"summary": "Create an audience from a campaign",
- "description": "Creates an audience from the recipients of a previous campaign that had one `outcome`, to send them a follow-up campaign. The members are a snapshot taken when the request runs: later receipts, reads or replies on the source campaign do not change the audience. Numbers on the team's opt-out list are left out and counted in `optedOutCount`; each member keeps the template variables it had on the source campaign. Outcomes: `delivered` (the device confirmed delivery), `not_delivered` (sent, with no delivery confirmation), `read`, `not_read` (sent and not read, including sends never delivered), `replied`, `not_replied` (sent and no reply was attributed), and `failed` (confirmed failed sends; sends whose outcome is uncertain, such as a timeout waiting for WhatsApp, are excluded). Read outcomes depend on the recipient's read receipts. `404` means the campaign is not in your team (or not in `projectId` when given); `409` means no recipient that is not opted out has the outcome, and nothing is created.\n\nRequires a team API key with `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Creates an audience from the recipients of a previous campaign that had one `outcome`, to send them a follow-up campaign. The members are a snapshot taken when the request runs: later receipts, reads or replies on the source campaign do not change the audience. Phone numbers on the team's opt-out list are left out and counted in `optedOutCount`; each member keeps the template variables it had on the source campaign. Outcomes: `delivered` (the device confirmed delivery), `not_delivered` (sent, with no delivery confirmation), `read`, `not_read` (sent and not read, including sends never delivered), `replied`, `not_replied` (sent and no reply was attributed), and `failed` (confirmed failed sends; sends whose outcome is uncertain, such as a timeout waiting for WhatsApp, are excluded). Read outcomes depend on the recipient's read receipts. `404` means the campaign is not in your team (or not in `projectId` when given); `409` means no recipient that is not opted out has the outcome, and nothing is created.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -3776,7 +3868,7 @@
"operationId": "listAudienceProfiles",
"tags": ["audience-profiles"],
"summary": "List audience profiles",
- "description": "Lists customer-supplied profiles for the team with cursor pagination. Deleted profiles are omitted.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "description": "Lists customer-supplied profiles for the team with cursor pagination. Deleted profiles are omitted.\n\nTeam keys require `campaigns:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -3795,7 +3887,8 @@
"in": "query",
"required": false,
"schema": {
- "type": "string"
+ "type": "string",
+ "format": "uuid"
}
},
{
@@ -3806,7 +3899,31 @@
"type": "integer",
"minimum": 1,
"maximum": 100,
- "default": 25
+ "default": 25,
+ "description": "Page size as decimal digits without leading zeros. Omit for 25."
+ }
+ },
+ {
+ "name": "tag",
+ "in": "query",
+ "required": false,
+ "description": "Only profiles that carry this exact tag.",
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "pattern": "^[^\\u0000-\\u001f\\u007f]+$",
+ "x-polymorfa-max-utf8-bytes": 48,
+ "description": "Exact tag, 1-48 UTF-8 bytes, without control characters."
+ }
+ },
+ {
+ "name": "phonePrefix",
+ "in": "query",
+ "required": false,
+ "description": "Only profiles whose E.164 phone number starts with this prefix, such as `+4479`.",
+ "schema": {
+ "type": "string",
+ "pattern": "^\\+[0-9]{1,15}$"
}
}
],
@@ -3947,7 +4064,7 @@
"operationId": "getAudienceProfile",
"tags": ["audience-profiles"],
"summary": "Get an audience profile",
- "description": "Gets one customer-supplied profile by its E.164 phone. Deleted profiles return 404.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "description": "Gets one customer-supplied profile by its E.164 phone. Deleted profiles return 404.\n\nTeam keys require `campaigns:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -4102,7 +4219,7 @@
"operationId": "putAudienceProfile",
"tags": ["audience-profiles"],
"summary": "Create or update an audience profile",
- "description": "Creates a bounded team profile, or replaces tags and attributes at the observed revision. A stale revision returns 409. To recreate a profile deleted in the last 30 days, send the `revision` the delete returned as `expectedRevision`; a put without it returns 409 with a message naming that revision. A consent assertion records the customer's statement; it does not clear an opt-out or authorize a send. This beta requires enrollment and release eligibility.\n\nRequires a team API key with `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Creates a bounded team profile, or replaces tags and attributes at the observed revision. A stale revision returns 409. To recreate a profile deleted in the last 30 days, send the `revision` the delete returned as `expectedRevision`; a put without it returns 409 with a message naming that revision. A consent assertion records the customer's statement; it does not clear an opt-out or authorize a send. This beta requires enrollment and release eligibility.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -4353,7 +4470,7 @@
"operationId": "deleteAudienceProfile",
"tags": ["audience-profiles"],
"summary": "Delete an audience profile",
- "description": "Removes profile fields, consent assertions and reusable audience-list memberships at the observed revision, and clears the preview row of each audience the phone belonged to. Recipients already added to campaigns (including drafts), previously uploaded files and opt-outs are not changed. The phone's deletion record is kept for 30 days; `revision` is its revision. During that time, adding the phone to an audience returns 409, and recreating the profile requires `expectedRevision` set to this revision. Deletion remains available after beta withdrawal.\n\nRequires a team API key with `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Removes profile fields, consent assertions and reusable audience-list memberships at the observed revision, and clears the preview row of each audience the phone belonged to. Recipients already added to campaigns (including drafts), previously uploaded files and opt-outs are not changed. The phone's deletion record is kept for 30 days; `revision` is its revision. During that time, adding the phone to an audience returns 409, and recreating the profile requires `expectedRevision` set to this revision. Deletion remains available after beta withdrawal.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -4462,7 +4579,7 @@
"operationId": "listAudienceProfileConsent",
"tags": ["audience-profiles"],
"summary": "List audience consent assertions",
- "description": "Lists the customer's recorded campaign consent assertions for one profile. Assertions do not override opt-outs.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "description": "Lists the customer's recorded campaign consent assertions for one profile. Assertions do not override opt-outs.\n\nTeam keys require `campaigns:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -4500,7 +4617,8 @@
"type": "integer",
"minimum": 1,
"maximum": 100,
- "default": 25
+ "default": 25,
+ "description": "Page size as decimal digits without leading zeros. Omit for 25."
}
}
],
@@ -4612,7 +4730,7 @@
"operationId": "createAudienceProfileImport",
"tags": ["audience-profiles"],
"summary": "Start an audience profile CSV import",
- "description": "Queues a bounded CSV import of customer-supplied team profiles. Exact CSV header names can be mapped to profile fields. At most one import is active per team. Files contain at most 10 MiB and 10,000 rows; the CSV is removed after completion or cancellation. The same replay key, file and mapping return the existing job. Requires beta enrollment.\n\nRequires a team API key with `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Queues a bounded CSV import of customer-supplied team profiles. Exact CSV header names can be mapped to profile fields. At most one import is active per team. Files contain at most 10 MiB and 10,000 rows; the CSV is removed after completion or cancellation. The same replay key, file and mapping return the existing job. Requires beta enrollment.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -4868,7 +4986,7 @@
"operationId": "getAudienceProfileImport",
"tags": ["audience-profiles"],
"summary": "Get an audience profile import report",
- "description": "Returns aggregate counts and up to 20 row-number/reason samples. Raw phone numbers and custom values are not included. Reports expire 30 days after completion or cancellation.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "description": "Returns aggregate counts and up to 20 row-number/reason samples. Raw phone numbers and custom values are not included. Reports expire 30 days after completion or cancellation.\n\nTeam keys require `campaigns:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -5054,7 +5172,7 @@
"operationId": "cancelAudienceProfileImport",
"tags": ["audience-profiles"],
"summary": "Cancel an audience profile import",
- "description": "Stops the next batch and removes the CSV. Already committed profile edits remain. Cancellation and report reads remain available after beta withdrawal.\n\nRequires a team API key with `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Stops the next batch and removes the CSV. Already committed profile edits remain. Cancellation and report reads remain available after beta withdrawal.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -5242,7 +5360,7 @@
"operationId": "getStopConfirmationSettings",
"tags": ["optouts"],
"summary": "Get STOP confirmation settings",
- "description": "Returns the team's optional acknowledgement preference. Confirmations are disabled by default. A locale is explicitly selected from English, Brazilian Portuguese or Spanish; the response includes the reviewed acknowledgement text. Reads remain available after beta withdrawal.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "description": "Returns the team's optional acknowledgement preference. Confirmations are disabled by default. A locale is explicitly selected from English, Brazilian Portuguese or Spanish; the response includes the reviewed acknowledgement text. Reads remain available after beta withdrawal.\n\nTeam keys require `campaigns:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -5309,7 +5427,7 @@
"operationId": "updateStopConfirmationSettings",
"tags": ["optouts"],
"summary": "Update STOP confirmation settings",
- "description": "Replaces the team's preference using the observed revision. Enabling requires STOP confirmations beta access and a selected locale. A team owner or admin can also change it in the console. A new STOP opt-out queues at most one plain acknowledgement from the receiving connection; manual opt-outs, repeated STOP while suppressed and START produce none. A confirmation cannot undo suppression. Disabling remains available after beta withdrawal and cancels queued acknowledgements. A changed revision returns 409. Unknown send outcomes are never resent with a new operation identity.\n\nRequires a team API key with `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Replaces the team's preference using the observed revision. Enabling requires STOP confirmations beta access and a selected locale. A team owner or admin can also change it in the console. A new STOP opt-out queues at most one plain acknowledgement from the receiving method; manual opt-outs, repeated STOP while suppressed and START produce none. A confirmation cannot undo suppression. Disabling remains available after beta withdrawal and cancels queued acknowledgements. A changed revision returns 409. Unknown send outcomes are never resent with a new operation identity.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -5391,7 +5509,7 @@
"operationId": "getStopConfirmationSummary",
"tags": ["optouts"],
"summary": "Get STOP confirmation outcome counts",
- "description": "Returns aggregate acknowledgement outcomes from the last 30 days, without recipient phones or message content. Disabled is the preference state, queued is waiting, admitted may have been submitted, completed means the provider accepted the send rather than delivered it, failed is a proven skip or rejection, and unknown means the send outcome could not be established. All outcomes preserve the opt-out.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "description": "Returns aggregate acknowledgement outcomes from the last 30 days, without recipient phones or message content. Disabled is the preference state, queued is waiting, admitted may have been submitted, completed means the provider accepted the send rather than delivered it, failed is a proven skip or rejection, and unknown means the send outcome could not be established. All outcomes preserve the opt-out.\n\nTeam keys require `campaigns:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -5492,6 +5610,7 @@
"invalid_request_error",
"authentication_error",
"permission_error",
+ "billing_error",
"conflict_error",
"rate_limit_error",
"api_error",
@@ -5577,16 +5696,16 @@
"format": "uuid",
"description": "Required when using a team API key. Project tokens derive the project from the credential."
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid",
- "description": "The number to send the test from. It must be connected, on a plan that includes Campaigns and, when the campaign selects numbers, one of them."
+ "description": "The connection to send the test from. It must be connected, on a plan that includes Campaigns and, when the campaign selects connections, one of them."
},
"to": {
"type": "string",
"minLength": 1,
"maxLength": 32,
- "description": "The seed recipient in international format. It must be the phone of a number connected to your team.",
+ "description": "The seed recipient in international format. It must be the phone of a connection connected to your team.",
"example": "+5511999990000"
},
"sampleRecipientId": {
@@ -5614,7 +5733,7 @@
"description": "Variable values for the test. They override the sample recipient's values; without `sampleRecipientId`, only these values are used."
}
},
- "required": ["sessionId", "to"]
+ "required": ["connectionId", "to"]
},
"CampaignTestSend": {
"type": "object",
@@ -5637,7 +5756,7 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -5645,8 +5764,8 @@
"type": "string"
}
},
- "required": ["sessionId", "phone"],
- "description": "The number the test was sent from."
+ "required": ["connectionId", "phone"],
+ "description": "The connection the test was sent from."
},
"to": {
"type": "string",
@@ -5738,7 +5857,7 @@
"type": "object",
"required": ["kind"],
"additionalProperties": true,
- "description": "`text` (`text`), `buttons` (`body`, up to 3 `buttons` with `id` and `text`), `list` (`body`, `buttonText`, up to 10 `rows`), or `flow_form` (`flowId`, `body`, `buttonText`, `screen`; Official numbers only).",
+ "description": "`text` (`text`), `buttons` (`body`, up to 3 `buttons` with `id` and `text`), `list` (`body`, `buttonText`, up to 10 `rows`), or `flow_form` (`flowId`, `body`, `buttonText`, `screen`; Official connections only).",
"properties": {
"kind": {
"type": "string",
@@ -5838,14 +5957,15 @@
"cold_held",
"campaign_cancelled",
"invalid_recipient",
- "session_not_connected",
+ "connection_not_connected",
"ack_timeout",
"blocked_by_safety",
"send_failed",
"missing_variable",
+ "frequency_cap",
"other"
],
- "description": "Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the number is on the team's opt-out list. `cold_held`: the number never wrote to the sending number and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the number is not a valid WhatsApp address. `session_not_connected`: the sending number was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `other`: any other reason. New codes may be added."
+ "description": "Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the phone number is on the team's opt-out list. `cold_held`: the recipient never wrote to the sending connection and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the recipient is not a valid WhatsApp address. `connection_not_connected`: the sending connection was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `frequency_cap`: the recipient reached the team's or campaign's rolling contact frequency cap. `other`: any other reason. New codes may be added."
},
"CampaignTrackedLinkReport": {
"type": "object",
@@ -6372,7 +6492,7 @@
}
},
"PaymentRequired": {
- "description": "The number's plan does not include this capability.",
+ "description": "`billing_error`: the team's plan, billing mode, credit or add-ons do not cover this request. `error.code` names the cause.",
"headers": {
"X-Request-Id": {
"schema": {
@@ -6398,6 +6518,17 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
+ },
+ "example": {
+ "error": {
+ "type": "billing_error",
+ "code": "entitlement_required",
+ "message": "Your team\u2019s plan or billing mode does not include this action.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#entitlement-required"
}
}
}
@@ -6509,7 +6640,7 @@
}
},
"SendPathUnavailable": {
- "description": "The send path is unavailable or the sending number is not ready (`session_not_ready`, `command_dispatch_failed`, `service_unavailable`, or `bansafe_accounting_unavailable`). No message was sent.",
+ "description": "The send path is unavailable or the sending connection is not ready (`connection_not_ready`, `command_dispatch_failed`, `service_unavailable`, or `bansafe_accounting_unavailable`). No message was sent.",
"headers": {
"X-Request-Id": {
"schema": {
@@ -6604,5 +6735,9 @@
}
}
}
+ },
+ "previousExport": {
+ "path": "contracts/history/pre-connections/campaign-custody-20261014.json",
+ "sha256": "e09bd5a076845aea3d049ccff15d19df805ebdf5b4a0576ce347e515d8577c1c"
}
}
diff --git a/contracts/campaign-follow-ups.json b/contracts/campaign-follow-ups.json
index d5921b020..205062256 100644
--- a/contracts/campaign-follow-ups.json
+++ b/contracts/campaign-follow-ups.json
@@ -1,11 +1,11 @@
{
"repository": "polymorfa/polymorfa",
- "commit": "87b25fd9e2494d90f01f7511fb47be6a28845fa1",
- "note": "Receipt-timed campaign follow-up beta (PR #503). Adds followUp to Messaging and Platform campaigns and recipients, and followUps to campaign analytics; the full snapshots stay pinned to contracts/source.json until the next repin.",
+ "commit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
+ "note": "Connection source projection at the exact candidate revision in contracts/source.json. This is not deployment or package acceptance.",
"sources": {
"messaging": {
"sourcePath": "apps/api/docs/openapi.json",
- "sourceSha256": "c30cd7523f3fbec9c83214f899781f6f43c7e3d5fd05dd828158d3dfb32df6cb",
+ "sourceSha256": "e84c7ff814c6b59ca7f32c3fda1aedbed3f672e728910adb883f0aa8c6cf3ab7",
"schemas": {
"CampaignFollowUpReport": {
"type": "object",
@@ -137,7 +137,7 @@
},
"required": ["message"],
"additionalProperties": false,
- "description": "One optional follow-up, sent from the Number that sent the first message. Null when the campaign has none. Content and timing freeze at launch."
+ "description": "One optional follow-up, sent from the Connection that sent the first message. Null when the campaign has none. Content and timing freeze at launch."
},
"CreateCampaignRequest.followUp": {
"type": "object",
@@ -259,7 +259,7 @@
"type": "string",
"format": "uuid"
},
- "numberId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -324,7 +324,7 @@
},
"required": [
"id",
- "numberId",
+ "connectionId",
"status",
"anchorKind",
"firstDeliveredAt",
@@ -347,13 +347,13 @@
},
"platform": {
"sourcePath": "apps/api/docs/openapi.management.json",
- "sourceSha256": "583b9d99426de8a13462eafa3a0095e3c7386282e73f23c14238f41a15ccab0d",
+ "sourceSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
"schemas": {
"CampaignFollowUp": {
"type": "object",
"additionalProperties": false,
"required": ["message"],
- "description": "One optional receipt-timed follow-up, sent from the Number that sent the first message. A beta; a team that is not enrolled gets `403 feature_unavailable`. Expiry must exceed delay and is counted from the first send. Configuration freezes at launch. The first read takes precedence over the first delivery; additional reads do not move it. Replies and opt-outs cancel it. Without a delivery or read receipt it never arms, and an expired wait never sends. Requires a single first message, and the text cannot contain tracked links.",
+ "description": "One optional receipt-timed follow-up, sent from the Connection that sent the first message. A beta; a team that is not enrolled gets `403 feature_unavailable`. Expiry must exceed delay and is counted from the first send. Configuration freezes at launch. The first read takes precedence over the first delivery; additional reads do not move it. Replies and opt-outs cancel it. Without a delivery or read receipt it never arms, and an expired wait never sends. Requires a single first message, and the text cannot contain tracked links.",
"properties": {
"delaySeconds": {
"type": "integer",
@@ -409,7 +409,7 @@
"additionalProperties": false,
"required": [
"id",
- "numberId",
+ "connectionId",
"status",
"anchorKind",
"firstDeliveredAt",
@@ -428,7 +428,7 @@
"type": "string",
"format": "uuid"
},
- "numberId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -616,5 +616,10 @@
}
}
}
+ },
+ "published": false,
+ "previousExport": {
+ "path": "contracts/history/pre-connections/campaign-follow-ups.json",
+ "sha256": "b9f2d52244a7bc1d3da90cf881e50cc56703364a80a068499f7861f66a85e724"
}
}
diff --git a/contracts/campaign-frequency-cap.json b/contracts/campaign-frequency-cap.json
index e507aa1a3..5fe31f2ad 100644
--- a/contracts/campaign-frequency-cap.json
+++ b/contracts/campaign-frequency-cap.json
@@ -1,11 +1,11 @@
{
"repository": "polymorfa/polymorfa",
- "commit": "9bb1e2ed92d8b4a07ff727f8e7ae185498f0868f",
- "note": "Contact frequency cap beta, merged backend #601 and Console #609. Full snapshots retain their independent pins.",
+ "commit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
+ "note": "Connection source projection at the exact candidate revision in contracts/source.json. This is not deployment or package acceptance.",
"sources": {
"messaging": {
"sourcePath": "apps/api/docs/openapi.json",
- "sourceSha256": "6d5b5477a86a85504f921933bf7b26f2c47506e21380fe73c8a5ff1002163b28",
+ "sourceSha256": "e84c7ff814c6b59ca7f32c3fda1aedbed3f672e728910adb883f0aa8c6cf3ab7",
"schemas": {},
"fields": {
"VoiceAssetFailedPayload.failureReason": {
@@ -55,7 +55,7 @@
"cold_held",
"campaign_cancelled",
"invalid_recipient",
- "session_not_connected",
+ "connection_not_connected",
"ack_timeout",
"blocked_by_safety",
"send_failed",
@@ -64,13 +64,13 @@
"other",
null
],
- "description": "Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the number is on the team's opt-out list. `cold_held`: the number never wrote to the sending number and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the number is not a valid WhatsApp address. `session_not_connected`: the sending number was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `frequency_cap`: the recipient reached the team's or campaign's rolling contact frequency cap. `other`: any other reason. New codes may be added."
+ "description": "Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the phone number is on the team's opt-out list. `cold_held`: the recipient never wrote to the sending connection and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the recipient is not a valid WhatsApp address. `connection_not_connected`: the sending connection was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `frequency_cap`: the recipient reached the team's or campaign's rolling contact frequency cap. `other`: any other reason. New codes may be added."
},
"TestEventOverrides.failureReason": {
"type": "string",
"enum": [
"invalid_recipient",
- "session_not_connected",
+ "connection_not_connected",
"ack_timeout",
"send_failed",
"blocked_by_safety"
@@ -132,7 +132,7 @@
"cold_held",
"campaign_cancelled",
"invalid_recipient",
- "session_not_connected",
+ "connection_not_connected",
"ack_timeout",
"blocked_by_safety",
"send_failed",
@@ -349,9 +349,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:read "
}
},
"post": {
@@ -389,7 +386,7 @@
"maxLength": 255
},
"required": false,
- "description": "Optional key, 1 to 255 bytes of UTF-8, that makes this request safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version` and request is not applied again: it returns `200` with `Idempotent-Replayed: true` and the replay result described for this operation. Reusing the key for a different request returns `409 idempotency_conflict`. A retry sent while the original is still running waits for it and then returns its result. A request that failed left no record, so retrying it with the same key runs it again. Access to the resource is checked again on every retry. A replay returns the original counts, even after the campaign has launched.",
+ "description": "Optional key, 1 to 255 bytes of UTF-8, that makes this request safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version` and request is not applied again: it returns `200` with `Idempotent-Replayed: true` and the replay result described for this operation. Reusing the key for a different request returns `422 idempotency_conflict`. A retry sent while the original is still running waits for it and then returns its result. A request that failed left no record, so retrying it with the same key runs it again. Access to the resource is checked again on every retry. A replay returns the original counts, even after the campaign has launched.",
"name": "Idempotency-Key",
"in": "header"
}
@@ -561,7 +558,7 @@
}
},
"409": {
- "description": "The campaign has started sending and no longer accepts recipients, or the Idempotency-Key was already used for a different request (`idempotency_conflict`)",
+ "description": "The campaign has started sending and no longer accepts recipients",
"content": {
"application/json": {
"schema": {
@@ -592,6 +589,43 @@
}
}
},
+ "422": {
+ "description": "The Idempotency-Key was already used for a different request (`idempotency_conflict`)",
+ "headers": {
+ "Link": {
+ "description": "Link to the documentation for this Idempotency-Key error (`rel=\"describedby\"`).",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "idempotency_conflict",
+ "message": "This Idempotency-Key was already used with a different request. Use a new key for a different request.",
+ "param": null
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#idempotency-conflict"
+ }
+ }
+ }
+ },
"500": {
"description": "Internal server error",
"content": {
@@ -624,9 +658,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
}
@@ -634,7 +665,7 @@
},
"platform": {
"sourcePath": "apps/api/docs/openapi.management.json",
- "sourceSha256": "bf4c6056b75e2fb0293b48edc5d8c12c36cdcbd194b9d11159f59522d30badc3",
+ "sourceSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
"schemas": {
"CampaignRecipientFailureReason": {
"type": "string",
@@ -643,7 +674,7 @@
"cold_held",
"campaign_cancelled",
"invalid_recipient",
- "session_not_connected",
+ "connection_not_connected",
"ack_timeout",
"blocked_by_safety",
"send_failed",
@@ -651,7 +682,7 @@
"frequency_cap",
"other"
],
- "description": "Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the number is on the team's opt-out list. `cold_held`: the number never wrote to the sending number and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the number is not a valid WhatsApp address. `session_not_connected`: the sending number was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `frequency_cap`: the recipient reached the team's or campaign's rolling contact frequency cap. `other`: any other reason. New codes may be added."
+ "description": "Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the phone number is on the team's opt-out list. `cold_held`: the recipient never wrote to the sending connection and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the recipient is not a valid WhatsApp address. `connection_not_connected`: the sending connection was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `frequency_cap`: the recipient reached the team's or campaign's rolling contact frequency cap. `other`: any other reason. New codes may be added."
},
"CampaignFrequencyCapSettings": {
"type": "object",
@@ -725,11 +756,11 @@
}
},
"fields": {
- "NumberTierChange.failureReason": {
+ "ConnectionTierChange.failureReason": {
"type": "string",
"nullable": true
},
- "NumberHybridTransition.failureReason": {
+ "ConnectionHybridTransition.failureReason": {
"type": "string",
"nullable": true
},
@@ -1003,7 +1034,7 @@
"name": "Idempotency-Key",
"in": "header",
"required": false,
- "description": "Optional key, 1 to 255 bytes of UTF-8, that makes this request safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version` and request is not applied again: it returns `200` with `Idempotent-Replayed: true` and the replay result described for this operation. Reusing the key for a different request returns `409 idempotency_conflict`. A retry sent while the original is still running waits for it and then returns its result. A request that failed left no record, so retrying it with the same key runs it again. Access to the resource is checked again on every retry. A replay returns the original counts, even after the campaign has launched.",
+ "description": "Optional key, 1 to 255 bytes of UTF-8, that makes this request safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version` and request is not applied again: it returns `200` with `Idempotent-Replayed: true` and the replay result described for this operation. Reusing the key for a different request returns `422 idempotency_conflict`. A retry sent while the original is still running waits for it and then returns its result. A request that failed left no record, so retrying it with the same key runs it again. Access to the resource is checked again on every retry. A replay returns the original counts, even after the campaign has launched.",
"schema": {
"type": "string",
"minLength": 1,
@@ -1098,6 +1129,9 @@
},
"409": {
"$ref": "#/components/responses/Conflict"
+ },
+ "422": {
+ "$ref": "#/components/responses/IdempotencyKeyReused"
}
}
}
@@ -1107,7 +1141,7 @@
"operationId": "getCampaignFrequencyCap",
"tags": ["campaign-settings"],
"summary": "Get the contact frequency cap",
- "description": "Returns the team's contact frequency cap: the most campaign messages one phone number receives from the team in any rolling 24 hours and any rolling 7 days. Every campaign message counts, first messages and later messages of a sequence, from every campaign, project and number in the team. Test sends and messages sent outside campaigns do not count. `null` means no limit for that window. A team that never saved a cap receives both limits `null` and `revision` 0. A campaign can set its own, stricter cap with `frequencyCap`. Accepts a team API key or a live signed-in team member.\n\nAPI keys require `campaigns:read`. Project tokens are not accepted.",
+ "description": "Returns the team's contact frequency cap: the most campaign messages one phone number receives from the team in any rolling 24 hours and any rolling 7 days. Every campaign message counts, first messages and later messages of a sequence, from every campaign, project and number in the team. Test sends and messages sent outside campaigns do not count. `null` means no limit for that window. A team that never saved a cap receives both limits `null` and `revision` 0. A campaign can set its own, stricter cap with `frequencyCap`. Accepts a team API key or a live signed-in team member.\n\nTeam keys require `campaigns:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -1174,7 +1208,7 @@
"operationId": "updateCampaignFrequencyCap",
"tags": ["campaign-settings"],
"summary": "Update the contact frequency cap",
- "description": "Replaces the team's contact frequency cap using the `revision` you read; a changed revision answers `409`. Send `null` for a window to remove its limit, or both `null` to remove the cap. Setting a limit requires the contact frequency caps beta and otherwise answers `403 feature_unavailable`; removing the cap does not. Requires a team API key or a signed-in team owner or admin; project tokens answer `403`. A message over the cap is skipped with `frequency_cap_exceeded`; a later sequence message stops that recipient's remaining sequence. Settled skips are never retried when a cap changes.\n\nAPI keys require `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Replaces the team's contact frequency cap using the `revision` you read; a changed revision answers `409`. Send `null` for a window to remove its limit, or both `null` to remove the cap. Setting a limit requires the contact frequency caps beta and otherwise answers `403 feature_unavailable`; removing the cap does not. Requires a team API key or a signed-in team owner or admin; project tokens answer `403`. A message over the cap is skipped with `frequency_cap_exceeded`; a later sequence message stops that recipient's remaining sequence. Settled skips are never retried when a cap changes.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -1253,5 +1287,10 @@
}
}
}
+ },
+ "published": false,
+ "previousExport": {
+ "path": "contracts/history/pre-connections/campaign-frequency-cap.json",
+ "sha256": "86eddc872316d2b05ed0701e0a6235f64b92b0498d21b9ceb6d660fc9024ce77"
}
}
diff --git a/contracts/campaign-segments-drip.json b/contracts/campaign-segments-drip.json
index 43a0c1ef3..9e4b47d5c 100644
--- a/contracts/campaign-segments-drip.json
+++ b/contracts/campaign-segments-drip.json
@@ -1,10 +1,10 @@
{
"repository": "polymorfa/polymorfa",
- "commit": "9bb1e2ed92d8b4a07ff727f8e7ae185498f0868f",
+ "commit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
"sources": {
"messaging": {
"sourcePath": "apps/api/docs/openapi.json",
- "sourceSha256": "6d5b5477a86a85504f921933bf7b26f2c47506e21380fe73c8a5ff1002163b28",
+ "sourceSha256": "e84c7ff814c6b59ca7f32c3fda1aedbed3f672e728910adb883f0aa8c6cf3ab7",
"schemas": {
"CampaignDrip": {
"type": "object",
@@ -17,7 +17,7 @@
},
"exitOnReply": {
"type": "boolean",
- "description": "When true, a contact who replies to the sending number gets no further steps."
+ "description": "When true, a contact who replies to the sending connection gets no further steps."
},
"exitOnLinkClick": {
"type": "boolean",
@@ -40,7 +40,7 @@
"exitOnReply": {
"type": "boolean",
"default": true,
- "description": "When true, a contact who replies to the sending number gets no further steps."
+ "description": "When true, a contact who replies to the sending connection gets no further steps."
},
"exitOnLinkClick": {
"type": "boolean",
@@ -62,7 +62,7 @@
},
"exitOnReply": {
"type": "boolean",
- "description": "When true, a contact who replies to the sending number gets no further steps."
+ "description": "When true, a contact who replies to the sending connection gets no further steps."
},
"exitOnLinkClick": {
"type": "boolean",
@@ -558,9 +558,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -569,7 +566,7 @@
"operationId": "launchCampaign",
"tags": ["Campaigns"],
"summary": "Launch a campaign",
- "description": "**Required scope:** `campaigns:manage`\n\nStarts a draft campaign. It begins sending at `scheduledAt`, or right away when no start time is set. Launch checks the saved sender selection against live plans: `402 campaigns_not_entitled` when a selected number is missing or its plan does not include Campaigns, or when an unselected campaign's project has no such number; `400 invalid_parameter` on `senderConfig.sessionIds` when a selected number is not connected or the selection mixes sending types; `400 campaign_throughput_capped` when a requested throughput is above its ceiling. Segment campaigns require a team API key; project tokens answer `403 permission_denied`, and unavailable audience betas answer `403 feature_unavailable`. An audience change during launch answers `409 state_conflict`. Segment evaluation that exceeds its time limit also answers `409 state_conflict`; simplify the rules and retry. A launched campaign whose segment was deleted remains launched and cannot be launched again (`409 state_conflict`). A message that references a `{{link:}}` the campaign does not define, or tracked links on a campaign that would send from Official API numbers, answers `400 invalid_parameter` on `trackedLinks`; tracked links without the campaign link tracking beta answer `403 feature_unavailable`. A drip without a sendable composed message answers `400 invalid_parameter` on `messagesArray`. Saving a draft does not apply this check. The template must be complete and approved on every Cloud API number; every recipient needs a value or fallback for each variable unless `skipMissingVariables` is true. When the team requires approval above a recipient threshold and the launch would send to more recipients, it answers `409 campaign_approval_required`, sends nothing, and records a pending approval request for a team owner or admin. Launching again with the campaign unchanged returns the same request. A launch requested by an AI agent through the hosted MCP server is held the same way, whatever the threshold. The response returns the campaign as it was when the launch was accepted.",
+ "description": "**Required scope:** `campaigns:manage`\n\nStarts a draft campaign. It begins sending at `scheduledAt`, or right away when no start time is set. Launch checks the saved sender selection against live plans: `402 campaigns_not_entitled` when a selected connection is missing or its plan does not include Campaigns, or when an unselected campaign's project has no such number; `400 invalid_parameter` on `senderConfig.connectionIds` when a selected connection is not connected or the selection mixes sending types; `400 campaign_throughput_capped` when a requested throughput is above its ceiling. Segment campaigns require a team API key; project tokens answer `403 permission_denied`, and unavailable audience betas answer `403 feature_unavailable`. An audience change during launch answers `409 state_conflict`. Segment evaluation that exceeds its time limit also answers `409 state_conflict`; simplify the rules and retry. A launched campaign whose segment was deleted remains launched and cannot be launched again (`409 state_conflict`). A message that references a `{{link:}}` the campaign does not define, or tracked links on a campaign that would send from Official API connections, answers `400 invalid_parameter` on `trackedLinks`; tracked links without the campaign link tracking beta answer `403 feature_unavailable`. A drip without a sendable composed message answers `400 invalid_parameter` on `messagesArray`. Saving a draft does not apply this check. The template must be complete and approved on every Cloud API connection; every recipient needs a value or fallback for each variable unless `skipMissingVariables` is true. When the team requires approval above a recipient threshold and the launch would send to more recipients, it answers `409 campaign_approval_required`, sends nothing, and records a pending approval request for a team owner or admin. Launching again with the campaign unchanged returns the same request. A launch requested by an AI agent through the hosted MCP server is held the same way, whatever the threshold. The response returns the campaign as it was when the launch was accepted.",
"security": [
{
"BearerAuth": []
@@ -597,7 +594,7 @@
"name": "Idempotency-Key",
"in": "header",
"required": false,
- "description": "Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version`, and request never runs the write again: it returns `409 idempotency_completed` when the original succeeded, or the original server error, with `Idempotent-Replayed: true`. Reusing the key for a different request returns `409 idempotency_conflict`; a retry while the original is still running returns `409 idempotency_in_progress`, and a retry after an unrecorded outcome returns `409 idempotency_outcome_unknown`.",
+ "description": "Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 1 hour. A retry with the same key, credential, `Polymorfa-Version`, and request never runs the write again while its receipt is retained. Keep the first response. Exact response replay requires authorized replay data; opaque message or campaign bodies are not retained by default. An available exact replay carries `Idempotent-Replayed: true`. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns `422 idempotency_conflict`. A retry while the original is still running returns `409 idempotency_in_progress`, and a retry after an unrecorded outcome returns `409 idempotency_outcome_unknown`. If the recorded response cannot be read, the retry returns `503 idempotency_replay_unavailable` with `Retry-After` and the write still does not run again.",
"schema": {
"type": "string",
"minLength": 1,
@@ -625,6 +622,13 @@
}
},
"headers": {
+ "Idempotent-Replayed": {
+ "description": "`true` when this response is the recorded response of an earlier request with the same Idempotency-Key.",
+ "schema": {
+ "type": "string",
+ "enum": ["true"]
+ }
+ },
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
},
@@ -637,7 +641,7 @@
}
},
"400": {
- "description": "`invalid_parameter` naming the field: an unconnected or mixed sender selection (`senderConfig.sessionIds`), an incomplete or authentication template (`templateId`), a composed attachment without a public URL, or a `{{link:}}` the campaign does not define or tracked links on Official API numbers (`trackedLinks`). `campaign_throughput_capped` when a requested throughput is above its ceiling; `template_not_approved` when a Cloud API number has not approved the template.",
+ "description": "`invalid_parameter` naming the field: an unconnected or mixed sender selection (`senderConfig.connectionIds`), an incomplete or authentication template (`templateId`), a composed attachment without a public URL, or a `{{link:}}` the campaign does not define or tracked links on Official API connections (`trackedLinks`). `campaign_throughput_capped` when a requested throughput is above its ceiling; `template_not_approved` when a Cloud API connection has not approved the template.",
"content": {
"application/json": {
"schema": {
@@ -701,7 +705,7 @@
}
},
"402": {
- "description": "`campaigns_not_entitled`: a selected number is missing or its plan does not include Campaigns, or the project has no number on such a plan. Drafts are saved on every plan.",
+ "description": "`campaigns_not_entitled`: a selected connection is missing or its plan does not include Campaigns, or the project has no connection on such a plan. Drafts are saved on every plan.",
"content": {
"application/json": {
"schema": {
@@ -709,9 +713,9 @@
},
"example": {
"error": {
- "type": "permission_error",
+ "type": "billing_error",
"code": "campaigns_not_entitled",
- "message": "This number\u2019s plan does not include Campaigns.",
+ "message": "This connection\u2019s plan does not include Campaigns.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -797,7 +801,7 @@
}
},
"409": {
- "description": "`campaign_approval_required`: the launch is held for a team owner or admin and nothing was sent; the message names the approval request. `state_conflict`: the campaign is not a draft, is already launched and waiting for its start time, its sending numbers or audience changed during launch, or segment evaluation exceeded its time limit (simplify the rules and retry). A launched campaign whose segment was deleted cannot be launched again.. The Idempotency-Key already succeeded (`idempotency_completed`), was used for a different request (`idempotency_conflict`), belongs to a request that is still running (`idempotency_in_progress`, with Retry-After), or belongs to a request whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "description": "`campaign_approval_required`: the launch is held for a team owner or admin and nothing was sent; the message names the approval request. `state_conflict`: the campaign is not a draft, is already launched and waiting for its start time, its sending connections or audience changed during launch, or segment evaluation exceeded its time limit (simplify the rules and retry). A launched campaign whose segment was deleted cannot be launched again. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
"content": {
"application/json": {
"schema": {
@@ -818,17 +822,16 @@
},
"headers": {
"Retry-After": {
- "description": "Seconds to wait before retrying `idempotency_in_progress`.",
+ "description": "Seconds to wait before checking again with the same key. Waiting does not release the execution fence or guarantee that replay data becomes available. Same-key retries are protected only within the one-hour receipt window.",
"schema": {
"type": "integer",
"minimum": 0
}
},
- "Idempotent-Replayed": {
- "description": "`true` when this response reports the recorded outcome of an earlier request with the same Idempotency-Key.",
+ "Link": {
+ "description": "Link to the documentation for this Idempotency-Key error (`rel=\"describedby\"`).",
"schema": {
- "type": "string",
- "enum": ["true"]
+ "type": "string"
}
},
"X-RateLimit-Limit": {
@@ -843,7 +846,7 @@
}
},
"422": {
- "description": "`campaign_variables_missing`: some recipients have no value and no fallback for a variable. The message names the variables and counts the recipients.",
+ "description": "`campaign_variables_missing`: some recipients have no value and no fallback for a variable. The message names the variables and counts the recipients. The Idempotency-Key was already used for a different request (`idempotency_conflict`)",
"content": {
"application/json": {
"schema": {
@@ -863,6 +866,12 @@
}
},
"headers": {
+ "Link": {
+ "description": "Link to the documentation for this Idempotency-Key error (`rel=\"describedby\"`).",
+ "schema": {
+ "type": "string"
+ }
+ },
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
},
@@ -907,7 +916,7 @@
}
},
"503": {
- "description": "`service_unavailable`: the selected numbers' plans could not be checked; retry",
+ "description": "`service_unavailable`: the selected connections' plans could not be checked; retry. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend",
"content": {
"application/json": {
"schema": {
@@ -927,6 +936,13 @@
}
},
"headers": {
+ "Retry-After": {
+ "description": "Seconds to wait before checking again with the same key. Waiting does not release the execution fence or guarantee that replay data becomes available. Same-key retries are protected only within the one-hour receipt window.",
+ "schema": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
},
@@ -938,9 +954,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
}
@@ -948,7 +961,7 @@
},
"platform": {
"sourcePath": "apps/api/docs/openapi.management.json",
- "sourceSha256": "bf4c6056b75e2fb0293b48edc5d8c12c36cdcbd194b9d11159f59522d30badc3",
+ "sourceSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
"schemas": {
"AudienceSegment": {
"type": "object",
@@ -1378,7 +1391,7 @@
"type": "object",
"additionalProperties": false,
"required": ["enrollment", "exitOnReply", "exitOnLinkClick"],
- "description": "Beta drip settings. Defaults: audience enrollment, exit on reply true, exit on link open false. Opt-outs always stop remaining steps. Cannot combine with a template, A/B variants, weighted alternatives or receipt-timed followUp. Linked-device and test numbers only.",
+ "description": "Beta drip settings. Defaults: audience enrollment, exit on reply true, exit on link open false. Opt-outs always stop remaining steps. Cannot combine with a template, A/B variants, weighted alternatives or receipt-timed followUp. Linked-device and test connections only.",
"properties": {
"enrollment": {
"type": "string",
@@ -1389,7 +1402,7 @@
"exitOnReply": {
"type": "boolean",
"default": true,
- "description": "When true, a contact who replies to the sending number gets no further steps."
+ "description": "When true, a contact who replies to the sending connection gets no further steps."
},
"exitOnLinkClick": {
"type": "boolean",
@@ -1401,7 +1414,7 @@
"CampaignDripInput": {
"type": "object",
"additionalProperties": false,
- "description": "Beta drip settings. Defaults: audience enrollment, exit on reply true, exit on link open false. Opt-outs always stop remaining steps. Cannot combine with a template, A/B variants, weighted alternatives or receipt-timed followUp. Linked-device and test numbers only.",
+ "description": "Beta drip settings. Defaults: audience enrollment, exit on reply true, exit on link open false. Opt-outs always stop remaining steps. Cannot combine with a template, A/B variants, weighted alternatives or receipt-timed followUp. Linked-device and test connections only.",
"properties": {
"enrollment": {
"type": "string",
@@ -1412,7 +1425,7 @@
"exitOnReply": {
"type": "boolean",
"default": true,
- "description": "When true, a contact who replies to the sending number gets no further steps."
+ "description": "When true, a contact who replies to the sending connection gets no further steps."
},
"exitOnLinkClick": {
"type": "boolean",
@@ -1433,7 +1446,7 @@
},
"exitOnReply": {
"type": "boolean",
- "description": "When true, a contact who replies to the sending number gets no further steps."
+ "description": "When true, a contact who replies to the sending connection gets no further steps."
},
"exitOnLinkClick": {
"type": "boolean",
@@ -1750,7 +1763,7 @@
"operationId": "launchPlatformCampaign",
"tags": ["campaigns"],
"summary": "Launch campaign",
- "description": "Starts a draft campaign. It begins sending at `scheduledAt`, or right away when no start time is set. Launch checks the stored sender selection against live plans: `402 campaigns_not_entitled` when a selected number is missing or its plan does not include Campaigns, or when an unselected campaign's project has no such number; `400 invalid_parameter` on `senderConfig.sessionIds` when a selected number is not connected or the selection mixes sending types; `400 campaign_throughput_capped` when a requested throughput is above its ceiling. A segment campaign requires a team API key or signed-in dashboard session; project tokens answer `403 permission_denied`. Both audience betas must be available, otherwise launch answers `403 feature_unavailable`. An audience change while launch is being authorized answers `409 state_conflict`. Segment evaluation that exceeds its time limit also answers `409 state_conflict`; simplify the rules and retry. A launched campaign whose segment was deleted remains launched and cannot be launched again (`409 state_conflict`). A drip without a sendable composed message answers `400 invalid_parameter` on `messagesArray`. Saving a draft does not apply this check. A composed attachment requires a public `media.url` (`400 invalid_parameter`). The template must be complete (`400 invalid_parameter`) and approved on every Cloud API number (`400 template_not_approved`). Every recipient needs a value or fallback for each variable (`422 campaign_variables_missing`); `skipMissingVariables: true` skips those recipients before the first send. A message that references a `{{link:}}` the campaign does not define, or tracked links on a campaign that would send from Official API numbers, answers `400 invalid_parameter` on `trackedLinks`; tracked links without the campaign link tracking beta answer `403 feature_unavailable`. `409` means the campaign is not a draft, is already launched and waiting for its start time, or its sending numbers changed during the launch. When the team requires approval above a recipient threshold and the launch would send to more recipients, a launch by anyone other than a team owner or admin signed in to the console answers `409 campaign_approval_required`, sends nothing, and records a pending approval request that `GET /platform/campaigns/{campaignId}/approvals` lists. Launching again with the campaign unchanged returns the same request. A launch requested by an AI agent through the hosted MCP server is held the same way, whatever the threshold.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
+ "description": "Starts a draft campaign. It begins sending at `scheduledAt`, or right away when no start time is set. Launch checks the stored sender selection against live plans: `402 campaigns_not_entitled` when a selected connection is missing or its plan does not include Campaigns, or when an unselected campaign's project has no such number; `400 invalid_parameter` on `senderConfig.connectionIds` when a selected connection is not connected or the selection mixes sending types; `400 campaign_throughput_capped` when a requested throughput is above its ceiling. A segment campaign requires a team API key or signed-in dashboard session; project tokens answer `403 permission_denied`. Both audience betas must be available, otherwise launch answers `403 feature_unavailable`. An audience change while launch is being authorized answers `409 state_conflict`. Segment evaluation that exceeds its time limit also answers `409 state_conflict`; simplify the rules and retry. A launched campaign whose segment was deleted remains launched and cannot be launched again (`409 state_conflict`). A drip without a sendable composed message answers `400 invalid_parameter` on `messagesArray`. Saving a draft does not apply this check. A composed attachment requires a public `media.url` (`400 invalid_parameter`). The template must be complete (`400 invalid_parameter`) and approved on every Cloud API connection (`400 template_not_approved`). Every recipient needs a value or fallback for each variable (`422 campaign_variables_missing`); `skipMissingVariables: true` skips those recipients before the first send. A message that references a `{{link:}}` the campaign does not define, or tracked links on a campaign that would send from Official API connections, answers `400 invalid_parameter` on `trackedLinks`; tracked links without the campaign link tracking beta answer `403 feature_unavailable`. `409` means the campaign is not a draft, is already launched and waiting for its start time, or its sending connections changed during the launch. When the team requires approval above a recipient threshold and the launch would send to more recipients, a launch by anyone other than a team owner or admin signed in to the console answers `409 campaign_approval_required`, sends nothing, and records a pending approval request that `GET /platform/campaigns/{campaignId}/approvals` lists. Launching again with the campaign unchanged returns the same request. A launch requested by an AI agent through the hosted MCP server is held the same way, whatever the threshold.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
@@ -1776,7 +1789,7 @@
"name": "Idempotency-Key",
"in": "header",
"required": false,
- "description": "Optional unique key, 1 to 255 bytes, that makes this request safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version` and request never runs it again: it returns `409 idempotency_completed` when the original succeeded, or the original server error. Reusing the key for a different request returns `409 idempotency_conflict`; a retry while the original is still running returns `409 idempotency_in_progress`, and a retry after an unrecorded outcome returns `409 idempotency_outcome_unknown`.",
+ "description": "Optional unique key, 1 to 255 bytes, that makes this request safe to retry for 1 hour. A retry with the same key, credential, `Polymorfa-Version` and request never runs it again while its receipt is retained. Keep the first response. Opaque campaign bodies are not retained by default; an available authorized exact replay carries `Idempotent-Replayed: true`. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns `422 idempotency_conflict`. A retry while the original is still running returns `409 idempotency_in_progress`, and a retry after an unrecorded outcome returns `409 idempotency_outcome_unknown`. If the recorded response cannot be read, the retry returns `503 idempotency_replay_unavailable` with `Retry-After`; the request does not run again. Missing replay data never releases the execution fence.",
"schema": {
"type": "string",
"minLength": 1,
@@ -1816,6 +1829,13 @@
"type": "string"
},
"description": "API version applied to this response."
+ },
+ "Idempotent-Replayed": {
+ "description": "`true` when this response is the recorded response of an earlier request with the same Idempotency-Key.",
+ "schema": {
+ "type": "string",
+ "enum": ["true"]
+ }
}
},
"content": {
@@ -1866,7 +1886,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"402": {
- "$ref": "#/components/responses/PaymentRequired"
+ "$ref": "#/components/responses/CampaignsNotEntitled"
},
"403": {
"$ref": "#/components/responses/CampaignLaunchForbidden"
@@ -1878,10 +1898,79 @@
"$ref": "#/components/responses/CampaignLaunchConflict"
},
"422": {
- "$ref": "#/components/responses/CampaignVariablesMissing"
+ "description": "`campaign_variables_missing`: a recipient or test sample has no value or fallback for a campaign variable; nothing was sent by that request. `idempotency_conflict`: this key belongs to a different request; the earlier request is not run again and this refusal does not establish its outcome.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ },
+ "Link": {
+ "description": "Documentation for an Idempotency-Key error (`rel=\"describedby\"`).",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
},
"503": {
- "$ref": "#/components/responses/CampaignEligibilityUnavailable"
+ "description": "`idempotency_replay_unavailable`: the recorded response cannot be read. The original request is not run again, and its execution fence remains in place. Keep the first response; do not switch keys to resend. The selected connections' plans can also fail to be checked (`service_unavailable`), before anything is launched or saved.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ },
+ "Retry-After": {
+ "description": "Seconds to wait before checking again with the same key. Waiting does not release the execution fence or guarantee that replay data becomes available.",
+ "schema": {
+ "type": "integer",
+ "minimum": 1
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
}
}
}
@@ -1986,7 +2075,7 @@
"operationId": "listAudienceSegments",
"tags": ["audience-segments"],
"summary": "List audience segments",
- "description": "Lists the team's saved segments with cursor pagination. Reads stay available after beta withdrawal.\n\nAPI keys require `campaigns:read`. Project tokens are not accepted.",
+ "description": "Lists the team's saved segments with cursor pagination. Reads stay available after beta withdrawal.\n\nTeam keys require `campaigns:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -2080,7 +2169,7 @@
"operationId": "createAudienceSegment",
"tags": ["audience-segments"],
"summary": "Create an audience segment",
- "description": "Saves a named rule set over the team's audience profiles. A team holds at most 100 segments. Every campaign a rule names must belong to the team. Both audience betas, `campaigns.audience-profiles` and `campaigns.segments`, must be available; otherwise the request answers `403 feature_unavailable`.\n\nAPI keys require `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Saves a named rule set over the team's audience profiles. A team holds at most 100 segments. Every campaign a rule names must belong to the team. Both audience betas, `campaigns.audience-profiles` and `campaigns.segments`, must be available; otherwise the request answers `403 feature_unavailable`.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -2174,7 +2263,7 @@
"operationId": "previewAudienceSegmentRules",
"tags": ["audience-segments"],
"summary": "Preview audience segment rules",
- "description": "Evaluates unsaved rules now and returns counts and up to five masked matching profiles. Nothing is saved. A campaign evaluates its segment again when it launches, so counts can change. Both audience betas, `campaigns.audience-profiles` and `campaigns.segments`, must be available; otherwise the request answers `403 feature_unavailable`.\n\nAPI keys require `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Evaluates unsaved rules now and returns counts and up to five masked matching profiles. Nothing is saved. A campaign evaluates its segment again when it launches, so counts can change. Both audience betas, `campaigns.audience-profiles` and `campaigns.segments`, must be available; otherwise the request answers `403 feature_unavailable`.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -2263,7 +2352,7 @@
"operationId": "getAudienceSegment",
"tags": ["audience-segments"],
"summary": "Get an audience segment",
- "description": "Returns one saved segment.\n\nAPI keys require `campaigns:read`. Project tokens are not accepted.",
+ "description": "Returns one saved segment.\n\nTeam keys require `campaigns:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -2343,7 +2432,7 @@
"operationId": "updateAudienceSegment",
"tags": ["audience-segments"],
"summary": "Update an audience segment",
- "description": "Replaces the name, the rules or both at the observed revision; a stale revision answers `409`. A draft campaign that uses the segment evaluates the new rules when it launches. Campaigns already launched keep their recipients. Both audience betas, `campaigns.audience-profiles` and `campaigns.segments`, must be available; otherwise the request answers `403 feature_unavailable`.\n\nAPI keys require `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Replaces the name, the rules or both at the observed revision; a stale revision answers `409`. A draft campaign that uses the segment evaluates the new rules when it launches. Campaigns already launched keep their recipients. Both audience betas, `campaigns.audience-profiles` and `campaigns.segments`, must be available; otherwise the request answers `403 feature_unavailable`.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -2452,7 +2541,7 @@
"operationId": "deleteAudienceSegment",
"tags": ["audience-segments"],
"summary": "Delete an audience segment",
- "description": "Deletes the segment at the observed revision. Answers `409` while an unlaunched draft campaign uses it as its audience. Launched campaigns keep their recipients and `segmentSnapshot`; their `segmentId` becomes null. Deletion stays available after beta withdrawal.\n\nAPI keys require `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Deletes the segment at the observed revision. Answers `409` while an unlaunched draft campaign uses it as its audience. Launched campaigns keep their recipients and `segmentSnapshot`; their `segmentId` becomes null. Deletion stays available after beta withdrawal.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -2559,7 +2648,7 @@
"operationId": "previewAudienceSegment",
"tags": ["audience-segments"],
"summary": "Preview an audience segment",
- "description": "Evaluates the saved segment now and returns counts, up to five masked matching profiles and the evaluated `revision`. Both audience betas, `campaigns.audience-profiles` and `campaigns.segments`, must be available; otherwise the request answers `403 feature_unavailable`.\n\nAPI keys require `campaigns:read`. Project tokens are not accepted.",
+ "description": "Evaluates the saved segment now and returns counts, up to five masked matching profiles and the evaluated `revision`. Both audience betas, `campaigns.audience-profiles` and `campaigns.segments`, must be available; otherwise the request answers `403 feature_unavailable`.\n\nTeam keys require `campaigns:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -2704,5 +2793,10 @@
}
}
}
+ },
+ "published": false,
+ "previousExport": {
+ "path": "contracts/history/pre-connections/campaign-segments-drip.json",
+ "sha256": "59d77789ba1dc035d8a9673a673ba4cf9fa1d553cf6042453951f914bae05377"
}
}
diff --git a/contracts/client-token-ceilings.json b/contracts/client-token-ceilings.json
index eeb9d7498..6480c8caf 100644
--- a/contracts/client-token-ceilings.json
+++ b/contracts/client-token-ceilings.json
@@ -1,9 +1,9 @@
{
"repository": "polymorfa/polymorfa",
- "sourceCommit": "02aee1d010c5009401c0b60ab98eafd3dfd69f08",
+ "sourceCommit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
"family": "platform",
"sourcePath": "apps/api/docs/openapi.management.json",
- "sourceSha256": "34ca9e3be9a71bdecf65a2978170f7d53ff488d8a584f759a45969548b27009c",
+ "sourceSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
"published": false,
"scope": "Client-token mint ceiling and live rule validation only. Reserved regional actions remain unavailable; reconcile full snapshots and exact API acceptance before publication.",
"paths": {
@@ -12,13 +12,14 @@
"operationId": "mintClientToken",
"tags": ["Client Tokens"],
"summary": "Mint a short-lived browser-safe client token",
+ "description": "**Required scopes (all):** `connections:manage` \u00b7 `messages:write` \u00b7 `contacts:read` \u00b7 `presence:read` \u00b7 `presence:observe` \u00b7 `mcp`\n\nMinting requires an active, unrevoked issuer with the required scopes and current resource ownership. A human-owned issuer must belong to a current team owner or admin who is not banned. Service-account credentials can delegate only actions allowed by the issuing credential's live scopes. Test-key clients remain restricted to test connections. Issuance eligibility denials return 403; unavailable issuance checks return 503 and no token.",
"security": [
{
"ApiKeyAuth": []
}
],
"x-required-scopes": [
- "sessions:manage",
+ "connections:manage",
"messages:write",
"contacts:read",
"presence:read",
@@ -218,25 +219,21 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage messages:write contacts:read presence:read presence:observe mcp "
- },
- "description": "**Required scopes (all):** `sessions:manage` \u00b7 `messages:write` \u00b7 `contacts:read` \u00b7 `presence:read` \u00b7 `presence:observe` \u00b7 `mcp`",
"x-audience": "public"
}
},
- "/platform/sessions/{session}/client-rules": {
+ "/platform/connections/{connection}/client-rules": {
"put": {
"operationId": "setClientRules",
"tags": ["Client Tokens"],
- "summary": "Set client-token rules for a session",
+ "summary": "Set client-token rules for a connection",
"security": [
{
"ApiKeyAuth": []
}
],
"x-required-scopes": [
- "sessions:manage",
+ "connections:manage",
"messages:write",
"contacts:read",
"presence:read",
@@ -250,7 +247,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -446,10 +443,7 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage messages:write contacts:read presence:read presence:observe mcp "
- },
- "description": "**Required scopes (all):** `sessions:manage` \u00b7 `messages:write` \u00b7 `contacts:read` \u00b7 `presence:read` \u00b7 `presence:observe` \u00b7 `mcp`",
+ "description": "**Required scopes (all):** `connections:manage` \u00b7 `messages:write` \u00b7 `contacts:read` \u00b7 `presence:read` \u00b7 `presence:observe` \u00b7 `mcp`",
"x-audience": "public"
}
}
@@ -471,15 +465,15 @@
"PlatformAccessMintClientTokenRequest": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string",
"minLength": 1,
- "description": "ID of the session this token can access. Provide exactly one of `session` or `customer`."
+ "description": "ID of the connection this token can access. Provide exactly one of `connection` or `customer`."
},
"customer": {
"type": "string",
"format": "uuid",
- "description": "Polymorfa Customer ID. The token covers the numbers this Customer owns when it is minted, and only while the Customer still owns each one. Provide exactly one of `session` or `customer`. Requires the `customers:read` scope and enrollment in the Customer-scoped client tokens beta."
+ "description": "Polymorfa Customer ID. The token covers the connections this Customer owns when it is minted, and only while the Customer still owns each one. Provide exactly one of `connection` or `customer`. Requires the `customers:read` scope and enrollment in the Customer-scoped client tokens beta."
},
"allow": {
"type": "array",
@@ -500,12 +494,27 @@
"chats_read",
"chats_manage",
"contact_write",
- "contact_delete"
+ "contact_delete",
+ "groups_read",
+ "groups_manage",
+ "read_calls",
+ "conversations_read",
+ "conversations_manage",
+ "labels_read",
+ "labels_manage",
+ "contacts_manage",
+ "profile_read",
+ "profile_manage",
+ "channels_read",
+ "channels_manage",
+ "business_read",
+ "presence_write",
+ "stickers_manage"
]
},
"minItems": 0,
- "maxItems": 15,
- "description": "Immutable action ceiling, intersected with live client rules. Session allow requires the action-ceilings beta. With ceiling issuance enabled, session omission snapshots its configured actions. For a Customer, omission uses the original Customer action set. An empty session allow grants no actions; Customer allow must be non-empty. Regional actions are reserved for enrolled beta access."
+ "maxItems": 30,
+ "description": "Immutable action ceiling, intersected with live client rules. Connection allow requires the action-ceilings beta. With ceiling issuance enabled, connection omission snapshots its configured actions. For a Customer, omission uses the original Customer action set. An empty connection allow grants no actions; Customer allow must be non-empty. Regional actions are reserved for enrolled beta access."
},
"ephemeralId": {
"type": "string",
@@ -544,6 +553,7 @@
"invalid_request_error",
"authentication_error",
"permission_error",
+ "billing_error",
"conflict_error",
"rate_limit_error",
"api_error",
@@ -553,11 +563,16 @@
"code": {
"type": "string",
"enum": [
+ "zero_knowledge_connection",
"invalid_parameter",
"invalid_credential",
"entitlement_required",
"cloud_template_authority_restricted",
"gate_limit_reached",
+ "billing_credit_required",
+ "addon_required",
+ "safe_mode_not_entitled",
+ "warmup_plan_not_entitled",
"method_not_allowed",
"permission_denied",
"missing_scope",
@@ -579,10 +594,12 @@
"hybrid_transport_unavailable",
"hybrid_target_reference_unavailable",
"send_outcome_unknown",
+ "terms_acceptance_required",
+ "terms_activation_blocked",
"idempotency_conflict",
"idempotency_in_progress",
- "idempotency_completed",
"idempotency_outcome_unknown",
+ "idempotency_replay_unavailable",
"call_claimed",
"call_not_ringing",
"connection_limit",
@@ -597,7 +614,7 @@
"order_status_transition_invalid",
"order_cancellation_failed",
"call_opt_out_limit",
- "number_restricted",
+ "connection_restricted",
"sip_trunk_in_use",
"sip_trunk_revision_conflict",
"sip_trunk_limit",
@@ -615,7 +632,7 @@
"upstream_failure",
"service_unavailable",
"credential_verification_unavailable",
- "session_not_ready",
+ "connection_not_ready",
"command_dispatch_failed",
"result_unknown",
"parent_bsuid_not_supported",
@@ -715,7 +732,9 @@
"maxConcurrency": {
"type": "integer",
"minimum": 0,
- "default": 0
+ "default": 0,
+ "description": "Deprecated. Has no effect. Client tokens use the same call limits as every other credential.",
+ "deprecated": true
},
"allowedNumber": {
"type": "string",
@@ -726,7 +745,9 @@
"type": "integer",
"minimum": 0,
"maximum": 600,
- "default": 0
+ "default": 0,
+ "description": "Deprecated. Has no effect. Client tokens use the same call limits as every other credential.",
+ "deprecated": true
},
"conversationTtlSeconds": {
"type": "integer",
@@ -750,5 +771,9 @@
},
"required": ["success"]
}
+ },
+ "previousExport": {
+ "path": "contracts/history/pre-connections/client-token-ceilings.json",
+ "sha256": "727cb09a3deef27b24416ef9f52c6fddc5d1af360014b59363b50573df720527"
}
}
diff --git a/contracts/coverage.json b/contracts/coverage.json
index bcbb5ad2a..d9b962106 100644
--- a/contracts/coverage.json
+++ b/contracts/coverage.json
@@ -1,6 +1,6 @@
{
"schemaVersion": 2,
- "sourceCommit": "f180dc1ee2bd45dbecf01702f73bdd75c664634b",
+ "sourceCommit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
"excludedContracts": [
{
"family": "graph",
@@ -11,9 +11,9 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/business/collections/{collectionId}",
+ "path": "/messaging/{connection}/business/collections/{collectionId}",
"operationId": "deleteBusinessCollection",
- "fingerprint": "22431fb0fc3eb74ad32a08934cbf8d872920ee5203cc5fa511aacb023cf52d59",
+ "fingerprint": "8e415e2456e42847a92cdfacb435e7634451f55134b85fb7a809f39555cb95ff",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.deleteCollection"
@@ -42,9 +42,9 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/business/products/{productId}",
+ "path": "/messaging/{connection}/business/products/{productId}",
"operationId": "deleteBusinessProduct",
- "fingerprint": "85c4212c68c6e68f7dbd07cbb24df4bee8d6b8c300202a92458cb4f40f9d0121",
+ "fingerprint": "ac46beab54f131543201ac55bffc5c4e0faa63af41593ae236043910878d0ee4",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.deleteProduct"
@@ -73,9 +73,9 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/business/profile/cover-photo/{coverPhotoId}",
+ "path": "/messaging/{connection}/business/profile/cover-photo/{coverPhotoId}",
"operationId": "deleteBusinessCoverPhoto",
- "fingerprint": "ada8eea9818a2ecff5cb7e60a78f82704aa4e75e2a70a54d9b568b65d662ddf7",
+ "fingerprint": "e5c9e7ce1bb14a4d046a4a210b1895798da80cf0150c5d89c058efd4f0833718",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.deleteCoverPhoto"
@@ -104,9 +104,9 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/business/quick-replies/{quickReplyId}",
+ "path": "/messaging/{connection}/business/quick-replies/{quickReplyId}",
"operationId": "deleteBusinessQuickReply",
- "fingerprint": "4c29182dd87c524b2add400468a8c673159271ac5a03f986c562e8e1c0c7d5ec",
+ "fingerprint": "b9f42a0f2675a469c8c7895b96979105cdcb314a1319a962dd1307b3c113921d",
"typescript": {
"status": "covered",
"method": "MessagingClient.quickReplies.delete"
@@ -135,9 +135,9 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/channels/{id}",
+ "path": "/messaging/{connection}/channels/{id}",
"operationId": "deleteChannel",
- "fingerprint": "092cab830ccab17571b9252094f5dfe0f8213af8c2db224404a21e9261153747",
+ "fingerprint": "2053083bf4423e7d431c732e8a6e778d36b91177bc67d55b15cfd6e13087dd85",
"typescript": {
"status": "covered",
"method": "MessagingClient.channels.delete"
@@ -166,9 +166,9 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/chats/{conversation}/messages/{messageId}",
+ "path": "/messaging/{connection}/chats/{conversation}/messages/{messageId}",
"operationId": "deleteMessage",
- "fingerprint": "07eab396ec40320df7d7e592f9edbd41fb795d132633cb86d585d3d9993c8a98",
+ "fingerprint": "ee38bd2f2e24aeb190c3cf8e068f7ce6739cd1d508366460636945699bf3a5b3",
"typescript": {
"status": "covered",
"method": "MessagingClient.chats.deleteMessage"
@@ -197,9 +197,9 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/groups/{id}",
+ "path": "/messaging/{connection}/groups/{id}",
"operationId": "deleteGroup",
- "fingerprint": "533b0197a278347bc57a5f4f75eec92b76b04d75f2e398f7d832e27d7ae68972",
+ "fingerprint": "752865767bb64d865869cc30c5835c15c8e1aa2a1eab73d695d2b41d34683d32",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.delete"
@@ -228,9 +228,9 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/labels/{labelId}",
+ "path": "/messaging/{connection}/labels/{labelId}",
"operationId": "deleteLabel",
- "fingerprint": "9df8069bbccca7769033b65bb88a2f5d61b5796c62848054cc50bd1ac1b3c58a",
+ "fingerprint": "b68e2234108c7118bbb00128a337613e3e5b82eee260417baf29c6686ccc362b",
"typescript": {
"status": "covered",
"method": "MessagingClient.labels.delete"
@@ -259,9 +259,9 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/official-groups/{group}",
+ "path": "/messaging/{connection}/official-groups/{group}",
"operationId": "deleteOfficialGroup",
- "fingerprint": "b25d7cdbc04be76235500fbdfb95d5b197dd9a9bc5376610ae873bde1887dd51",
+ "fingerprint": "13f045fc17a579f79dbfb886f380376413dc525233ca7bf538985c1806460f99",
"typescript": {
"status": "covered",
"method": "MessagingClient.officialGroups.delete"
@@ -290,9 +290,9 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/profile/picture",
+ "path": "/messaging/{connection}/profile/picture",
"operationId": "deleteProfilePicture",
- "fingerprint": "fa9d1114c624f5cf230a137918ef53897a0aef19243e27a7fa0ff18b8b868e6a",
+ "fingerprint": "6708f48690dd66b1184560b0e1e19e16ddefa9040da6c3e086eb0d0c958ad9a6",
"typescript": {
"status": "covered",
"method": "MessagingClient.profile.deletePicture"
@@ -321,9 +321,9 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/templates/{name}",
+ "path": "/messaging/{connection}/templates/{name}",
"operationId": "deleteTemplate",
- "fingerprint": "9c281604d6cabf0af16ae3715c1c246f3e55d5747cf8c6a6a1f3df271f790db2",
+ "fingerprint": "0f94644ac9a64fa3c495f4a4bd67de8327a2a89ee227157419b19e7ad14d5154",
"typescript": {
"status": "covered",
"method": "MessagingClient.cloudTemplates.delete"
@@ -354,7 +354,7 @@
"method": "DELETE",
"path": "/messaging/projects/{projectSlug}/templates/{id}",
"operationId": "deleteProjectTemplate",
- "fingerprint": "2af4ccead47f1447285fadca4c0a192c70b605103e35d0910670117d1a05360e",
+ "fingerprint": "f1d98457bee6ac88ee71964edb896996d4f11520e35d9615bc4378ae7f54dc5b",
"typescript": {
"status": "covered",
"method": "MessagingClient.templates.delete"
@@ -385,7 +385,7 @@
"method": "DELETE",
"path": "/messaging/quicklinks/{id}",
"operationId": "cancelQuickLink",
- "fingerprint": "6a5a189c7a9ca454ae76cb8b31c2350c5304fc3951bbca1050390a8635f57755",
+ "fingerprint": "8dac9d46b6eecc35b837f830a5514ff8fb6759119ea6cfd1964f9254a82aadc9",
"typescript": {
"status": "covered",
"method": "MessagingClient.quickLinks.cancel"
@@ -416,7 +416,7 @@
"method": "DELETE",
"path": "/messaging/voip/calls/{id}",
"operationId": "voipTeardown",
- "fingerprint": "eaaa19712b65ba495fa67ff390f05a575d12cec823448b6646dcc4cc4833e5c4",
+ "fingerprint": "767415907c81309fc411e713cbaa77f7d4065363d6daffd0346bb54b24c3f2ab",
"typescript": {
"status": "covered",
"method": "MessagingClient.voip.end"
@@ -447,30 +447,36 @@
"method": "DELETE",
"path": "/messaging/webhooks/{id}",
"operationId": "deleteWebhook",
- "fingerprint": "e0217306703fa12f435b92ac07903f02e24c822b2325c967815e210e884a14bd",
+ "fingerprint": "9fbcd5539e8bbf180cb2f2a5a54037eecfadfae7ffe0fb650720cfb58c97086d",
"typescript": {
"status": "covered",
- "method": "MessagingClient.webhooks.delete"
+ "method": "MessagingClient.webhooks.delete",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "covered",
- "method": "MessagingClient.Webhooks.Delete"
+ "method": "MessagingClient.Webhooks.Delete",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.webhooks.delete"
+ "method": "AsyncMessagingClient.webhooks.delete",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"php": {
"status": "covered",
- "method": "MessagingClient.webhooks.delete"
+ "method": "MessagingClient.webhooks.delete",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Webhooks.DeleteAsync"
+ "method": "MessagingClient.Webhooks.DeleteAsync",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "covered",
- "method": "MessagingClient.webhooks.delete"
+ "method": "MessagingClient.webhooks.delete",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
}
},
{
@@ -507,9 +513,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/catalog",
+ "path": "/messaging/{connection}/business/catalog",
"operationId": "getBusinessCatalog",
- "fingerprint": "6f3e73224f5e0d2e3d842b72ea64779ed5a084ff6b230fcd9dec25aafcaea6f8",
+ "fingerprint": "a68e7809f495df47269bf30439c11ac14ae9f6c7d4f7bcb0d827cb6f21204b72",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.getCatalog"
@@ -538,9 +544,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/collections",
+ "path": "/messaging/{connection}/business/collections",
"operationId": "getBusinessCollections",
- "fingerprint": "dbb275e288c966a09c51bfa2eaa8b295b9ddb2c6b8d07b84b0110d0917f896ec",
+ "fingerprint": "70264c734434e2526c3f0d4984aa9434429ebd98e57892d85e71f1be037c6cbb",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.listCollections"
@@ -569,9 +575,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/collections/{collectionId}",
+ "path": "/messaging/{connection}/business/collections/{collectionId}",
"operationId": "getBusinessCollection",
- "fingerprint": "9aaa2b44bb38a6d294fc261033f5fad857241d72ca1ecf6fe02b1df71454365a",
+ "fingerprint": "4d845065b19645c28be963c9b1050ddeca320a048ca1646650ee749fdaca2d07",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.getCollection"
@@ -600,9 +606,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/compliance",
+ "path": "/messaging/{connection}/business/compliance",
"operationId": "getBusinessMerchantCompliance",
- "fingerprint": "d001c9c649c4202de9b57706a7309bc08d08a96d76d3381a793a9488ae31ed8f",
+ "fingerprint": "1d854382b3dc790e98764ed11806fba22ebcae5e68eb9a215704ca729db0cec9",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.getMerchantCompliance"
@@ -631,9 +637,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/eligibility",
+ "path": "/messaging/{connection}/business/eligibility",
"operationId": "getBusinessEligibility",
- "fingerprint": "8a93ce612ce8c1260edd26a6104e1c8cfd1bae355a7d43cd1fbdc17bccdf7649",
+ "fingerprint": "b067b9d7a154e45a6d9306787fc1963f884912475bb47922092f22b9b02e3771",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.getEligibility"
@@ -662,9 +668,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/linked-accounts",
+ "path": "/messaging/{connection}/business/linked-accounts",
"operationId": "getBusinessLinkedAccounts",
- "fingerprint": "a7d78181f0ecbd56efb76d97152ec2c576e95b9c9121e8e3501095874aa21e5f",
+ "fingerprint": "d434c01cdb9a7f4b5487d20997747d151bf26c860aa6ab941d1ff243b826ba87",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.getLinkedAccounts"
@@ -693,9 +699,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/products/{productId}",
+ "path": "/messaging/{connection}/business/products/{productId}",
"operationId": "getBusinessProduct",
- "fingerprint": "a0ebf1e19a534e9ea385bdd8c64f79929af2cc4658f6d058b941a0aa0c76e3e1",
+ "fingerprint": "23947ec57f2500d8e1da92395dc0d86a7bb643b2082f3c8ce15e70c2ed419edf",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.getProduct"
@@ -724,9 +730,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/profile",
+ "path": "/messaging/{connection}/business/profile",
"operationId": "getOwnBusinessProfile",
- "fingerprint": "afe372d3583eff74219717238d74d9bee550e4d98426eb77b3469e823921cd68",
+ "fingerprint": "08658c1aaf8bf23ba218f477951e151c837d7f5f73c8255754c41ee95d2fb876",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.getProfile"
@@ -755,9 +761,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/quick-replies",
+ "path": "/messaging/{connection}/business/quick-replies",
"operationId": "listBusinessQuickReplies",
- "fingerprint": "7c1b37b759bef9a79b5a9aa753f23943d97b53ec42fcd4b21eae848b75a11ac6",
+ "fingerprint": "5bcf0417da4659138901b7dc740429945ed0c19556fc7be1f6ce996cf2bbf7b5",
"typescript": {
"status": "covered",
"method": "MessagingClient.quickReplies.list"
@@ -786,9 +792,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/call-permissions/{to}",
+ "path": "/messaging/{connection}/call-permissions/{to}",
"operationId": "getCallPermission",
- "fingerprint": "36a651afd5161c93c7d5df074742614a1b472abe14715e6a52848cadfc234c20",
+ "fingerprint": "db2dbcaf015e8574db31973b0d1a2a8fe47f46c771af5a4c814a79f586403ecf",
"typescript": {
"status": "covered",
"method": "MessagingClient.voip.retrieveCallPermission"
@@ -817,9 +823,133 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/channels",
+ "path": "/messaging/{connection}/calls",
+ "operationId": "listConnectionCalls",
+ "fingerprint": "f2d54d775be5105eb9044330417ee852f8daca639bd0034ea3cf0d5b6897697f",
+ "typescript": {
+ "status": "covered",
+ "method": "MessagingClient.calls.list"
+ },
+ "go": {
+ "status": "covered",
+ "method": "MessagingClient.ConnectionCalls.List"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncMessagingClient.calls.list"
+ },
+ "php": {
+ "status": "covered",
+ "method": "MessagingClient::$calls->list"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "MessagingClient.Calls.ListAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "MessagingClient.calls.list"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/{connection}/catalogs",
+ "operationId": "listCloudCatalogs",
+ "fingerprint": "9de0b25d4279f9b300035b5bd74ec1760f2d7d8c03d37a6eda592099726cb073",
+ "typescript": {
+ "status": "covered",
+ "method": "MessagingClient.catalogs.list"
+ },
+ "go": {
+ "status": "covered",
+ "method": "MessagingClient.Catalogs.List"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncMessagingClient.catalogs.list"
+ },
+ "php": {
+ "status": "covered",
+ "method": "MessagingClient.catalogs.list"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "MessagingClient.Catalogs.ListAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "MessagingClient.catalogs.list"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/{connection}/catalogs/{catalogId}",
+ "operationId": "getCloudCatalog",
+ "fingerprint": "aa43497d02f01de25ceea9771cf50e31f75550fd92277aa136fe85350a4d0e3e",
+ "typescript": {
+ "status": "covered",
+ "method": "MessagingClient.catalogs.retrieve"
+ },
+ "go": {
+ "status": "covered",
+ "method": "MessagingClient.Catalogs.Retrieve"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncMessagingClient.catalogs.retrieve"
+ },
+ "php": {
+ "status": "covered",
+ "method": "MessagingClient.catalogs.retrieve"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "MessagingClient.Catalogs.RetrieveAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "MessagingClient.catalogs.retrieve"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/{connection}/catalogs/{catalogId}/products",
+ "operationId": "listCloudCatalogProducts",
+ "fingerprint": "3ac8d37af9cc59b3c41ba0f159702a195d7c32dc8c7fee360ed641e98f5b6713",
+ "typescript": {
+ "status": "covered",
+ "method": "MessagingClient.catalogs.listProducts"
+ },
+ "go": {
+ "status": "covered",
+ "method": "MessagingClient.Catalogs.ListProducts"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncMessagingClient.catalogs.list_products"
+ },
+ "php": {
+ "status": "covered",
+ "method": "MessagingClient.catalogs.listProducts"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "MessagingClient.Catalogs.ListProductsAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "MessagingClient.catalogs.list_products"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/{connection}/channels",
"operationId": "listChannels",
- "fingerprint": "2e8d961430a61634b7bec54f27e7e36ac05a4a171a4aa67e85aafadc00c93fca",
+ "fingerprint": "09bb700fa7a102998a1a04bcb1e7832ad83ac0663a1a582286e5d44b36d2bb6c",
"typescript": {
"status": "covered",
"method": "MessagingClient.channels.list"
@@ -848,9 +978,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/channels/{id}",
+ "path": "/messaging/{connection}/channels/{id}",
"operationId": "getChannel",
- "fingerprint": "27c6be6adaa60699323c4d86209d851a123ba5b6352f6d5722bed1e55b0f8c9e",
+ "fingerprint": "31119749fd6a092536166b06f94c58bdf866ddb81148880630c5e23a129d5393",
"typescript": {
"status": "covered",
"method": "MessagingClient.channels.retrieve"
@@ -879,9 +1009,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/channels/{id}/message-updates",
+ "path": "/messaging/{connection}/channels/{id}/message-updates",
"operationId": "listChannelMessageUpdates",
- "fingerprint": "36e35f83fd9a21d7c6498dbeee61836a70dee81ca8d555a45912b295a4a05209",
+ "fingerprint": "fab80686570b089766abcfdc2f97e7f6110475850e3c9f77c6ad867752dd1b52",
"typescript": {
"status": "covered",
"method": "MessagingClient.channels.listMessageUpdates"
@@ -915,9 +1045,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/channels/{id}/messages",
+ "path": "/messaging/{connection}/channels/{id}/messages",
"operationId": "listChannelMessages",
- "fingerprint": "3c026e997dd3fa8189c9e6aaeaf39aa6bf7fec9d5237ca3d08ebc66b8dcb501d",
+ "fingerprint": "0d11c62a2c72a4c9c195bc6c8f928874f989bc77184b9e9cdb061d279c2bf0d1",
"typescript": {
"status": "covered",
"method": "MessagingClient.channels.listMessages"
@@ -951,9 +1081,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/chats",
+ "path": "/messaging/{connection}/chats",
"operationId": "listChats",
- "fingerprint": "6185664581b12f5ec9a0cc5ed5730822898ef3a1841cdc66c6108894ffbb8a7f",
+ "fingerprint": "746a049a0cc87738c703e61f46f8b8c167cf7c4243b98e82f5e989b3974576ed",
"typescript": {
"status": "covered",
"method": "MessagingClient.chats.list"
@@ -982,9 +1112,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/chats/{conversation}",
+ "path": "/messaging/{connection}/chats/{conversation}",
"operationId": "getChat",
- "fingerprint": "afa6a2b76a7f6d67bead0c0112dda653a23ce93bfbd08c4dd4e128020109a70e",
+ "fingerprint": "6504a702014ec761299bb7e5bea51e43eafd7f57bbed375fac77ae504416163e",
"typescript": {
"status": "covered",
"method": "MessagingClient.chats.retrieve"
@@ -1013,9 +1143,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/chats/{conversation}/messages",
+ "path": "/messaging/{connection}/chats/{conversation}/messages",
"operationId": "listChatMessages",
- "fingerprint": "95bb2cb171dc76e464fdc6385892a9ce8da2a199c80d694cee23a86b7c8d7cdf",
+ "fingerprint": "0dce2a051ae789fef98db29f907b8a1cfe98060c21eda5a5e4ebfc60391a0019",
"typescript": {
"status": "covered",
"method": "MessagingClient.chats.listMessages"
@@ -1069,9 +1199,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/chats/{conversation}/messages/{messageId}",
+ "path": "/messaging/{connection}/chats/{conversation}/messages/{messageId}",
"operationId": "getChatMessage",
- "fingerprint": "205e024e4859687af404a686c4575dbc99672a06ba054727b1c9bae7e838de68",
+ "fingerprint": "0c0e8816e27399d34f50bd8be95f34ebe3515e352948082db6dbc3a8647ebe77",
"typescript": {
"status": "covered",
"method": "MessagingClient.chats.retrieveMessage"
@@ -1125,9 +1255,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/chats/{conversation}/messages/{messageId}/media",
+ "path": "/messaging/{connection}/chats/{conversation}/messages/{messageId}/media",
"operationId": "getChatMessageMedia",
- "fingerprint": "354c34fd19a6788b3040acdf1c31afabc49dc5eb6a8424f83699b8a7263ee22f",
+ "fingerprint": "ebd1a71497574f0f4815439456f28f5c47697d69cf512689ef5821ae175d0cd2",
"typescript": {
"status": "covered",
"method": "MessagingClient.chats.downloadMessageMedia"
@@ -1156,9 +1286,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/chats/{conversation}/service-window",
+ "path": "/messaging/{connection}/chats/{conversation}/service-window",
"operationId": "getCustomerServiceWindow",
- "fingerprint": "25c1a9a86672dd20787035a04dee32fc8a56df10623d0202d25ccaa6a16a6523",
+ "fingerprint": "868d73ef182bec7053a50a4de1774c51eac42918c460952d3597515d03ee6c05",
"typescript": {
"status": "covered",
"method": "MessagingClient.chats.getServiceWindow"
@@ -1187,40 +1317,40 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/cloud-credentials",
+ "path": "/messaging/{connection}/cloud-credentials",
"operationId": "getCloudCredentialHealth",
- "fingerprint": "216aa61311a05cbc25ad1c2efa597d3abfaa8be57ee400f8c738cc24cf722118",
+ "fingerprint": "20b546daf955573372f6bc4659989afdc2680b6f3b8d631f82778b0aa7f1c409",
"typescript": {
"status": "covered",
- "method": "MessagingClient.sessions.getCloudCredentialHealth"
+ "method": "MessagingClient.connections.getCloudCredentialHealth"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Sessions.GetCloudCredentialHealth"
+ "method": "MessagingClient.Connections.GetCloudCredentialHealth"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.sessions.get_cloud_credential_health"
+ "method": "AsyncMessagingClient.connections.get_cloud_credential_health"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$sessions->getCloudCredentialHealth"
+ "method": "MessagingClient::$connections->getCloudCredentialHealth"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Sessions.GetCloudCredentialHealthAsync"
+ "method": "MessagingClient.Connections.GetCloudCredentialHealthAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.sessions.get_cloud_credential_health"
+ "method": "MessagingClient.connections.get_cloud_credential_health"
}
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts",
+ "path": "/messaging/{connection}/contacts",
"operationId": "listContacts",
- "fingerprint": "8d2c9e4f852187485aaecb91d476232010357f99a3fa08b39880b29d4c57b402",
+ "fingerprint": "937fd4a9913003272c4638c05743d5b1fa8ad7c0ee9205daf1c4107159d5b103",
"typescript": {
"status": "covered",
"method": "MessagingClient.contacts.list"
@@ -1249,9 +1379,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/{contactId}",
+ "path": "/messaging/{connection}/contacts/{contactId}",
"operationId": "getContact",
- "fingerprint": "23bceff38e6332a9a7e74d5474ef0c941ae87e67e2e8e647fa51a009de5fa0bb",
+ "fingerprint": "63c1227e89c6dfe52f7bb74ba6abcf7200618229ff11d5e53522d2ffcf82582e",
"typescript": {
"status": "covered",
"method": "MessagingClient.contacts.retrieve"
@@ -1280,9 +1410,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/{contactId}/business-profile",
+ "path": "/messaging/{connection}/contacts/{contactId}/business-profile",
"operationId": "getBusinessProfile",
- "fingerprint": "1265b809eecc1efb231c31303e25d76ce89a78c7c4afa6440746b9af72e8a9d0",
+ "fingerprint": "0717f78275b53309e4b82dd28708d355d02e71c96574bdff0210242ec95d0e09",
"typescript": {
"status": "covered",
"method": "MessagingClient.contacts.businessProfile"
@@ -1311,9 +1441,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/{contactId}/devices",
+ "path": "/messaging/{connection}/contacts/{contactId}/devices",
"operationId": "getUserDevices",
- "fingerprint": "04991168dec71b0b04d2f38adecdef22f327a588074bd2038e016fc2cb479309",
+ "fingerprint": "58f7b554d97f4fbfaa16a8744d8354cb2faf85e9ac500223e9e7868118fcb01a",
"typescript": {
"status": "covered",
"method": "MessagingClient.contacts.devices"
@@ -1342,9 +1472,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/{contactId}/info",
+ "path": "/messaging/{connection}/contacts/{contactId}/info",
"operationId": "getUserInfo",
- "fingerprint": "c0fef568cf02702f73fc5e48dfd48b5f172576fd2432105f953032347f9d1f37",
+ "fingerprint": "9e17b7dbd3cca519d5ae91a9f48bcdc2ad1851c4c237c80d66b02ba5287353c0",
"typescript": {
"status": "covered",
"method": "MessagingClient.contacts.info"
@@ -1373,9 +1503,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/{contactId}/picture",
+ "path": "/messaging/{connection}/contacts/{contactId}/picture",
"operationId": "getContactPicture",
- "fingerprint": "2cef26251c585c06205d3b20f6e195910bb26d196eff710d66bca1349604758d",
+ "fingerprint": "43a8ac79177a686769fc8c21076375f669c6f08b103ef3881a26c2164ed684ef",
"typescript": {
"status": "covered",
"method": "MessagingClient.contacts.picture"
@@ -1404,9 +1534,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/blocked",
+ "path": "/messaging/{connection}/contacts/blocked",
"operationId": "getBlocklist",
- "fingerprint": "b7a53bac8b3ae98d54a8111229174945ff1ecabcc021ccc1142d5fee3bd03401",
+ "fingerprint": "a1394fd2f9252a703d1081085ffe5da3def8482cccc179ae2c55e86d71d71eb2",
"typescript": {
"status": "covered",
"method": "MessagingClient.contacts.blocklist"
@@ -1435,9 +1565,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/check",
+ "path": "/messaging/{connection}/contacts/check",
"operationId": "checkContacts",
- "fingerprint": "473d34c0c22e8b65b68778c66e6f92a0a352514e5d4d92446fc43daea56359cd",
+ "fingerprint": "7a07fe494d29e31f5024bbf6a0d38246f8c90652d6241c018fd9c8c4bbc8faf7",
"typescript": {
"status": "covered",
"method": "MessagingClient.contacts.check"
@@ -1466,9 +1596,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/groups",
+ "path": "/messaging/{connection}/groups",
"operationId": "listGroups",
- "fingerprint": "58e42a82d8997c9f7ed9b5cbb22d540b8e71b5f849564090372e47329e6ded01",
+ "fingerprint": "d83426b1cbcaca707ae1075356acd72f93a91535d6492a4652adaa9585f891b5",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.list"
@@ -1497,9 +1627,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/groups/{id}",
+ "path": "/messaging/{connection}/groups/{id}",
"operationId": "getGroup",
- "fingerprint": "09a0b087f9f213d7d63f4c8a01c862f76e781adc59768b36f2f6a83ef1c0a3f6",
+ "fingerprint": "1ddf9a0b93edfcd1b10755d84535037eef010e0eab86057fe50b3239aac80b4f",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.retrieve"
@@ -1528,9 +1658,46 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/groups/{id}/invite-code",
+ "path": "/messaging/{connection}/groups/{id}/capabilities",
+ "operationId": "getGroupCapabilities",
+ "fingerprint": "5d51f1fd6f36ed1ec66642bca874a36717f09a5cb63adf54361533c56bf3b815",
+ "typescript": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "go": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "python": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "php": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "dotnet": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "rust": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/{connection}/groups/{id}/invite-code",
"operationId": "getGroupInviteCode",
- "fingerprint": "85fb0dcbd6e7dba705f8a1c879f322c915d98abb669708beab34f1876d6a21a8",
+ "fingerprint": "9e1ee10a1e79d1b693974a4f76d77a23c088a3a7a4f6b2ebc871fbca0f335847",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.getInviteCode"
@@ -1559,9 +1726,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/groups/{id}/participants",
+ "path": "/messaging/{connection}/groups/{id}/participants",
"operationId": "getGroupParticipants",
- "fingerprint": "8d061a68db8f738b43c7a8dab22ca687944dc8d3eb50f1b9fd10a5ec7d4b1088",
+ "fingerprint": "7d39dd7ef8d7ab1b6dc4d4248ebd1268bbadb8b2dbcdbf7fc812260c590edc2d",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.listParticipants"
@@ -1590,9 +1757,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/groups/join-info",
+ "path": "/messaging/{connection}/groups/join-info",
"operationId": "getGroupJoinInfo",
- "fingerprint": "f56af6c9abfffb10e9c40d7b4eec40ad41f5198a3855646ca115888145ead20f",
+ "fingerprint": "16588ba987dbbccfe27aa90477f9f7761535d3e82d4f77b85f4d3c2e8eb928c4",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.getJoinInfo"
@@ -1621,9 +1788,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/hybrid-link",
+ "path": "/messaging/{connection}/hybrid-link",
"operationId": "getHybridLinkState",
- "fingerprint": "7c030606845be225eaccb5da62148d4f1b1022f8c615479f56ab71d9883985ce",
+ "fingerprint": "8db051fee4864b10548227afea22f0763c8e353bb24763cc263364c0c4b4e8ea",
"typescript": {
"status": "covered",
"method": "MessagingClient.hybridLink.state"
@@ -1652,9 +1819,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/identities/resolve",
+ "path": "/messaging/{connection}/identities/resolve",
"operationId": "resolveIdentity",
- "fingerprint": "005fdeba1f542b2e0bf532b19c5a9011edf2974f6f2d6dd48729b9f4caf196a9",
+ "fingerprint": "a1e108a77d90988a8d98f0695a124b509e2166f2cfa514ca2d1e6497adf4640b",
"typescript": {
"status": "covered",
"method": "MessagingClient.identities.resolve"
@@ -1683,9 +1850,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/labels",
+ "path": "/messaging/{connection}/labels",
"operationId": "listLabels",
- "fingerprint": "54f26fdf557352c0cabc5513151daa61f9532909c760398e51b47df542c52d04",
+ "fingerprint": "147b9abf495f6804cc22e3d7c30fdf4a8e69ffef78f35e5ed758003fb0b663d3",
"typescript": {
"status": "covered",
"method": "MessagingClient.labels.list"
@@ -1714,9 +1881,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/labels/chats/{conversation}",
+ "path": "/messaging/{connection}/labels/chats/{conversation}",
"operationId": "getChatLabels",
- "fingerprint": "bff94915d1facad299ee48595f7800a3a4dd46f668728839db4642fbeeafc034",
+ "fingerprint": "7129a47f48a5d5daf7de86add08ba95b82d0a86c6709aa08175a9190cffb19bf",
"typescript": {
"status": "covered",
"method": "MessagingClient.labels.listForChat"
@@ -1745,71 +1912,102 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/meta-pricing",
+ "path": "/messaging/{connection}/marketing-messages/status",
+ "operationId": "getMarketingMessagesStatus",
+ "fingerprint": "7bc8d478b4a4b0829bd3572e390bcf7f417b670a394131889311906df31370ec",
+ "typescript": {
+ "status": "covered",
+ "method": "MessagingClient.cloudMarketing.getStatus"
+ },
+ "go": {
+ "status": "covered",
+ "method": "MessagingClient.CloudMarketing.GetStatus"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncMessagingClient.cloud_marketing.get_status"
+ },
+ "php": {
+ "status": "covered",
+ "method": "MessagingClient.cloudMarketing.getStatus"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "MessagingClient.CloudGraph.GetMarketingMessagesStatusAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "MessagingClient.cloud_marketing.get_status"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/{connection}/meta-pricing",
"operationId": "getMetaPricingSummary",
- "fingerprint": "0be297a3523d66bf77ffed4e7bffe360fbeffa66480b5dcdd2eb59cf8e78ecef",
+ "fingerprint": "fbc5d5f81020d2bdbfbd4297cbb408fe297ad507ba887c9c9d91c2e6504cd5c1",
"typescript": {
"status": "covered",
- "method": "MessagingClient.sessions.getMetaPricing"
+ "method": "MessagingClient.connections.getMetaPricing"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Sessions.GetMetaPricing"
+ "method": "MessagingClient.Connections.GetMetaPricing"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.sessions.get_meta_pricing"
+ "method": "AsyncMessagingClient.connections.get_meta_pricing"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$sessions->getMetaPricing"
+ "method": "MessagingClient::$connections->getMetaPricing"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Sessions.GetMetaPricingAsync"
+ "method": "MessagingClient.Connections.GetMetaPricingAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.sessions.get_meta_pricing"
+ "method": "MessagingClient.connections.get_meta_pricing"
}
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/observation-policy",
- "operationId": "getSessionObservationPolicy",
- "fingerprint": "620223960830c10a3874276c8b691475ad1bf04e1802d6b4a5e34854c2c8893e",
+ "path": "/messaging/{connection}/observation-policy",
+ "operationId": "getConnectionObservationPolicy",
+ "fingerprint": "57785756d0d741ae44777dba87ebfd55da444a06ceda72e2d2a20b2cf6c79593",
"typescript": {
"status": "covered",
- "method": "MessagingClient.observationPolicies.retrieveForSession"
+ "method": "MessagingClient.observationPolicies.retrieveForConnection"
},
"go": {
"status": "covered",
- "method": "MessagingClient.ObservationPolicies.RetrieveForSession"
+ "method": "MessagingClient.ObservationPolicies.RetrieveForConnection"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.observation_policies.retrieve_for_session"
+ "method": "AsyncMessagingClient.observation_policies.retrieve_for_connection"
},
"php": {
"status": "covered",
- "method": "MessagingClient::observationPolicies.retrieveForSession"
+ "method": "MessagingClient::observationPolicies.retrieveForConnection"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.ObservationPolicies.RetrieveForSessionAsync"
+ "method": "MessagingClient.ObservationPolicies.RetrieveForConnectionAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.observation_policies.retrieve_for_session"
+ "method": "MessagingClient.observation_policies.retrieve_for_connection"
}
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/official-groups",
+ "path": "/messaging/{connection}/official-groups",
"operationId": "listOfficialGroups",
- "fingerprint": "76c89bf7832998c32e31e389eedb60cc8c703e19d3c63f3fa69e48234882e9ca",
+ "fingerprint": "30515b3203c13305f1a21e58a5a14253e08ab9a8b304d63b976fbe84e2245dd2",
"typescript": {
"status": "covered",
"method": "MessagingClient.officialGroups.list"
@@ -1838,9 +2036,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/official-groups/{group}",
+ "path": "/messaging/{connection}/official-groups/{group}",
"operationId": "getOfficialGroup",
- "fingerprint": "146d17a6554c5bbdbbf08b642e3e04186d3656f72c5db470d9c9472e34fa3b16",
+ "fingerprint": "efdad672b15221096bc75143a5276d69992d02633d9c44353791fb393ae63845",
"typescript": {
"status": "covered",
"method": "MessagingClient.officialGroups.retrieve"
@@ -1869,9 +2067,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/official-groups/{group}/invite-link",
+ "path": "/messaging/{connection}/official-groups/{group}/invite-link",
"operationId": "getOfficialGroupInviteLink",
- "fingerprint": "326fe2caf6be13f6a0281a66e40a15f7274b7acf310b7a5b13f6714af86ef559",
+ "fingerprint": "8373e76c55ae55c5227b28aea1f6063e5f2c97278e5487cc59ef411579784ca7",
"typescript": {
"status": "covered",
"method": "MessagingClient.officialGroups.getInviteLink"
@@ -1900,9 +2098,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/official-groups/{group}/join-requests",
+ "path": "/messaging/{connection}/official-groups/{group}/join-requests",
"operationId": "listOfficialGroupJoinRequests",
- "fingerprint": "187ff580b4fd6cb0091f1829304097d0d7a3ac96740ae561d683745334c4f3c5",
+ "fingerprint": "71a0e16063a1d33bb8376351fdb8758bf3da39ad17a0d879c9a97604911799f4",
"typescript": {
"status": "covered",
"method": "MessagingClient.officialGroups.listJoinRequests"
@@ -1931,9 +2129,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/operations/{operationId}",
+ "path": "/messaging/{connection}/operations/{operationId}",
"operationId": "getMessageOperation",
- "fingerprint": "ae385fb663357f6c1af1b80479fd887c2c35981f54dd40f7ee132595e01e9536",
+ "fingerprint": "5bfe49266a9891bc25db053ff0eca2f90f86905c48b4f78cb192710850634b9a",
"typescript": {
"status": "covered",
"method": "MessagingClient.messages.operationStatus"
@@ -1962,133 +2160,238 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/pair/qr",
+ "path": "/messaging/{connection}/pair/qr",
"operationId": "getQRCode",
- "fingerprint": "3a863e4c32e76a55b04cdf5df7f4bc2a3cf5782842aac233e70b6afb5aa7d43b",
+ "fingerprint": "bb05b90a5b19e0494a4cb2acebc459923155f2b3e08d9c4436b2900610dd7b63",
"typescript": {
"status": "covered",
- "method": "MessagingClient.sessions.qr"
+ "method": "MessagingClient.connections.qr"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Sessions.QR"
+ "method": "MessagingClient.Connections.QR"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.sessions.qr"
+ "method": "AsyncMessagingClient.connections.qr"
},
"php": {
"status": "covered",
- "method": "MessagingClient.sessions.qr"
+ "method": "MessagingClient.connections.qr"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Sessions.QrAsync"
+ "method": "MessagingClient.Connections.QrAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.sessions.qr"
+ "method": "MessagingClient.connections.qr"
}
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/presence",
- "operationId": "getPresence",
- "fingerprint": "3f6a91fc0eefe8de6a2c592ce119d14ebe7dc1790a7dec7b4fb202a800e9d11c",
+ "path": "/messaging/{connection}/passkey/challenge/{ticketId}",
+ "operationId": "getPasskeyChallenge",
+ "fingerprint": "28ac24ada38cbd4e7dcf03bbd036bff24c46c340f961c8b772f958f5ed585787",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.presence.get"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Presence.Get"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.presence.get"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.presence.get"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Presence.GetAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.presence.get"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/presence/{conversation}",
- "operationId": "getChatPresence",
- "fingerprint": "63d935ce4ba3adbd564467e5b846cc5ac3e63695abde422fb48cc34aca67f7c6",
+ "path": "/messaging/{connection}/passkey/confirmation",
+ "operationId": "getPasskeyConfirmation",
+ "fingerprint": "98df1730513a150cbbc3a18910981ad25d00b78f735aeca7c652f2f79b2dc379",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.presence.getForChat"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Presence.GetForChat"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.presence.get_for_chat"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.presence.getForChat"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Presence.GetForChatAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.presence.get_for_chat"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/privacy",
- "operationId": "getPrivacySettings",
- "fingerprint": "91a6ddf49132e01ea851a2e0cc29e4a4901db38e797cf951db43c1e3698df3d2",
+ "path": "/messaging/{connection}/phone",
+ "operationId": "getTestingPhone",
+ "fingerprint": "733ef1394924090fc70eb13c52c2188c634156c0fec7b44327f2aafefd3103c1",
"typescript": {
"status": "covered",
- "method": "MessagingClient.privacy.get"
+ "method": "MessagingClient.testing.getPhone"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Privacy.Get"
+ "method": "MessagingClient.Testing.GetPhone"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.privacy.get"
+ "method": "AsyncMessagingClient.testing.get_phone"
},
"php": {
"status": "covered",
- "method": "MessagingClient.privacy.get"
+ "method": "MessagingClient::testing.getPhone"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Privacy.GetAsync"
+ "method": "MessagingClient.Testing.GetPhoneAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.privacy.get"
+ "method": "MessagingClient.testing.get_phone"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/{connection}/presence",
+ "operationId": "getPresence",
+ "fingerprint": "cb97b141d65ef28495ee51e3232b81731a23ad9804a882a52058ba7e349d8b8a",
+ "typescript": {
+ "status": "covered",
+ "method": "MessagingClient.presence.get"
+ },
+ "go": {
+ "status": "covered",
+ "method": "MessagingClient.Presence.Get"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncMessagingClient.presence.get"
+ },
+ "php": {
+ "status": "covered",
+ "method": "MessagingClient.presence.get"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "MessagingClient.Presence.GetAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "MessagingClient.presence.get"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/{connection}/presence/{conversation}",
+ "operationId": "getChatPresence",
+ "fingerprint": "a16549a96d2c9db802017b7ac04aa988cfae4c16d5e3c1ffb4b942c82c9aadc7",
+ "typescript": {
+ "status": "covered",
+ "method": "MessagingClient.presence.getForChat"
+ },
+ "go": {
+ "status": "covered",
+ "method": "MessagingClient.Presence.GetForChat"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncMessagingClient.presence.get_for_chat"
+ },
+ "php": {
+ "status": "covered",
+ "method": "MessagingClient.presence.getForChat"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "MessagingClient.Presence.GetForChatAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "MessagingClient.presence.get_for_chat"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/{connection}/privacy",
+ "operationId": "getPrivacySettings",
+ "fingerprint": "a5569e20a9172ddfd4e30beb053957aba972d955e22a4dcfdb5ac4a566524833",
+ "typescript": {
+ "status": "covered",
+ "method": "MessagingClient.privacy.get"
+ },
+ "go": {
+ "status": "covered",
+ "method": "MessagingClient.Privacy.Get"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncMessagingClient.privacy.get"
+ },
+ "php": {
+ "status": "covered",
+ "method": "MessagingClient.privacy.get"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "MessagingClient.Privacy.GetAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "MessagingClient.privacy.get"
}
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/profile",
+ "path": "/messaging/{connection}/profile",
"operationId": "getProfile",
- "fingerprint": "9210b9cdfdd12dce28c01766d33b8517be307d092703bbc0d637e70452aa6545",
+ "fingerprint": "1a37e2ce8fad06e56defc3f2e98d3213b7193457c55b3b3dbdfbb1a76b027bd7",
"typescript": {
"status": "covered",
"method": "MessagingClient.profile.get"
@@ -2117,40 +2420,77 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/safe-mode",
- "operationId": "getSessionSafeMode",
- "fingerprint": "ed679890a7be317145f31c91fb72b150415dcdcc4a3bffeb8093bb863ea90bce",
+ "path": "/messaging/{connection}/safe-mode",
+ "operationId": "getConnectionSafeMode",
+ "fingerprint": "526d6464343b24f9cee31f2b2ee4bebd21e202fa9123e65ae323c35aac9d69f4",
"typescript": {
"status": "covered",
- "method": "MessagingClient.banSafe.getSessionSafeMode"
+ "method": "MessagingClient.banSafe.getConnectionSafeMode"
},
"go": {
"status": "covered",
- "method": "MessagingClient.BanSafe.GetSessionSafeMode"
+ "method": "MessagingClient.BanSafe.GetConnectionSafeMode"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.ban_safe.get_session_safe_mode"
+ "method": "AsyncMessagingClient.ban_safe.get_connection_safe_mode"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$banSafe->getSessionSafeMode"
+ "method": "MessagingClient::$banSafe->getConnectionSafeMode"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.BanSafe.GetSessionSafeModeAsync"
+ "method": "MessagingClient.BanSafe.GetConnectionSafeModeAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.ban_safe.get_session_safe_mode"
+ "method": "MessagingClient.ban_safe.get_connection_safe_mode"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/{connection}/stickers",
+ "operationId": "listStoredStickers",
+ "fingerprint": "a0129ddfa20305a207de3bf3ae4121a6091feb8b71ff6fa8deaf532e66911da4",
+ "typescript": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "go": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "python": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "php": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "dotnet": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "rust": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/templates",
+ "path": "/messaging/{connection}/templates",
"operationId": "listTemplates",
- "fingerprint": "4898e80f0cad2816d059be496c2e6292c14692516636e289cb13d609bdbece9b",
+ "fingerprint": "c49e31ca84e5e37383e19e1b5dc203d4ca31829ec76c988188e90037ccf61ee7",
"typescript": {
"status": "covered",
"method": "MessagingClient.cloudTemplates.list"
@@ -2179,9 +2519,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/templates/{name}",
+ "path": "/messaging/{connection}/templates/{name}",
"operationId": "getTemplate",
- "fingerprint": "ed0b152446027cd20671930bf4e937bcbab3889dfdc9d8a5859e64ef405d47ec",
+ "fingerprint": "57835bc5010ddcbabaea1d32cc74abee177547b2973502c7ee9c9c9631a61295",
"typescript": {
"status": "covered",
"method": "MessagingClient.cloudTemplates.retrieve"
@@ -2210,9 +2550,9 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/users/{id}/security-code",
+ "path": "/messaging/{connection}/users/{id}/security-code",
"operationId": "getUserSecurityCode",
- "fingerprint": "fd7ef58e7f3622ebd3da42971ce27f680202d0abbd553338fc772effd52da04c",
+ "fingerprint": "e31bbbe26584c4854b36e29164523517d848c928e3ea777a166a046f99085fc1",
"typescript": {
"status": "covered",
"method": "MessagingClient.users.getSecurityCode"
@@ -2243,7 +2583,7 @@
"method": "GET",
"path": "/messaging/bridge/route",
"operationId": "getBridgeRoute",
- "fingerprint": "2533e030dd50a5674cd5c8630c4102f88c0ae503f6972d79ec6b207421603b92",
+ "fingerprint": "f6a51abe4d743d10255692fd16d796e3cb668cbd89e7c67583a47836ff7d4fe7",
"typescript": {
"status": "covered",
"method": "BridgeClient.routes.resolve"
@@ -2336,7 +2676,7 @@
"method": "GET",
"path": "/messaging/media/{id}",
"operationId": "downloadMedia",
- "fingerprint": "56b128182affee3f3670d311564aef2320241c35350d2f85e9b058d0e2ecd68d",
+ "fingerprint": "ddcb51f1dba3cbf5d7123d44035cf3f42727dc4f52cec60c0ab76b298d15eaba",
"typescript": {
"status": "covered",
"method": "MessagingClient.media.download"
@@ -2367,7 +2707,7 @@
"method": "GET",
"path": "/messaging/media/{id}/info",
"operationId": "getMediaInfo",
- "fingerprint": "8aba25ee56b4e411116248fb47d2ea11b7dcd54a178fec6ff45d2fdf3ff50554",
+ "fingerprint": "6862837fc894ffddee13f87a3da026b8887978ca225842be469fb1d9978dad6f",
"typescript": {
"status": "covered",
"method": "MessagingClient.media.retrieve"
@@ -2398,7 +2738,7 @@
"method": "GET",
"path": "/messaging/projects/{projectId}/health-policy",
"operationId": "getProjectHealthPolicy",
- "fingerprint": "aa6998dcf875ae3ef0e25c8be0e24290390ee75ab17565874ed3b3ed450a77a6",
+ "fingerprint": "976462a556a136f1ee7c1c5e7f542f42f645cf0dc28b3fd8eb8a077380f23e05",
"typescript": {
"status": "covered",
"method": "MessagingClient.banSafe.getProjectHealthPolicy"
@@ -2429,7 +2769,7 @@
"method": "GET",
"path": "/messaging/projects/{projectId}/insurance-evidence",
"operationId": "getProjectInsuranceEvidence",
- "fingerprint": "0b88119e74f193474ad114b75878a51632d082788a1532efe653e2f2de5dc366",
+ "fingerprint": "35197c1a4e49929942a7a1499a04b2e21f0a8e5fe5962e0a9ac3ce284dc074a6",
"typescript": {
"status": "covered",
"method": "MessagingClient.banSafe.getProjectInsuranceEvidence"
@@ -2460,7 +2800,7 @@
"method": "GET",
"path": "/messaging/projects/{projectId}/observation-policy",
"operationId": "getProjectObservationPolicy",
- "fingerprint": "bb1a78871fc6151e43f5d4b810160783f6990bb3ff29955a11b0a4ee4f8d504c",
+ "fingerprint": "2a737fed44f96c4f2625c545b1a6bad81c792060b4c6f4e9f351d81be94b4530",
"typescript": {
"status": "covered",
"method": "MessagingClient.observationPolicies.retrieveForProject"
@@ -2491,7 +2831,7 @@
"method": "GET",
"path": "/messaging/projects/{projectId}/safe-mode",
"operationId": "getProjectSafeMode",
- "fingerprint": "b60b8a3e94560d0bd0f990b5f018affc6a9e7f6a9f1c3959952614be24489f99",
+ "fingerprint": "bc78817d789c349ba22646d7730b4251ed02eeb9b01a10e9ab07faa2fce8eee1",
"typescript": {
"status": "covered",
"method": "MessagingClient.banSafe.getProjectSafeMode"
@@ -2522,7 +2862,7 @@
"method": "GET",
"path": "/messaging/projects/{projectId}/warmup-plan",
"operationId": "getProjectWarmupPlan",
- "fingerprint": "21e128f38c43876a09cb48c4b681be9b66c603da3cfc8b2b53e6380509f93a85",
+ "fingerprint": "033571c6f487d19d116a0c8d2ba0f91c1d94e9eb847c4d9e6770d1a1b533f79e",
"typescript": {
"status": "covered",
"method": "MessagingClient.banSafe.getProjectWarmupPlan"
@@ -2548,12 +2888,49 @@
"method": "MessagingClient.ban_safe.get_project_warmup_plan"
}
},
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/projects/{projectSlug}/campaign-reply-flows/{id}",
+ "operationId": "getCampaignReplyFlow",
+ "fingerprint": "7ccc3681439f8fe25f6068b22a6d30e1555752b98805922de780dbaf4f2df403",
+ "typescript": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "go": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "python": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "php": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "dotnet": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "rust": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ }
+ },
{
"family": "messaging",
"method": "GET",
"path": "/messaging/projects/{projectSlug}/campaigns",
"operationId": "listCampaigns",
- "fingerprint": "425114c2c9d8dd8e8af61adb899440e786e5627ba559ba24263a8d9a4e779358",
+ "fingerprint": "3564f0b070b87979e5e6bf767a3abb3de58c031acfbecae7d221e3b9a169fede",
"typescript": {
"status": "covered",
"method": "MessagingClient.campaigns.list"
@@ -2584,7 +2961,7 @@
"method": "GET",
"path": "/messaging/projects/{projectSlug}/campaigns/{id}",
"operationId": "getCampaign",
- "fingerprint": "8b5351abdfb61a3335e458af4ccf25aa9ebf0ad7c6cbf01650f9dac1b910b527",
+ "fingerprint": "44dee9844c535f5280f825d2c0e78b4eae825e38e54b233623d857789b599c1c",
"typescript": {
"status": "covered",
"method": "MessagingClient.campaigns.retrieve"
@@ -2615,7 +2992,7 @@
"method": "GET",
"path": "/messaging/projects/{projectSlug}/campaigns/{id}/analytics",
"operationId": "getCampaignAnalytics",
- "fingerprint": "f6dcdf93ecf3451765a7749e4eed7104b8d525f0dfc099bb7c6e9a5e7eb51da2",
+ "fingerprint": "8c79739a95348a7d1da86a2d7c6973bbfa4579a32e1d49d058f56237d6c27e07",
"typescript": {
"status": "covered",
"method": "MessagingClient.campaigns.analytics"
@@ -2641,12 +3018,49 @@
"method": "MessagingClient.campaigns.analytics"
}
},
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/projects/{projectSlug}/campaigns/{id}/links",
+ "operationId": "getProjectCampaignLinks",
+ "fingerprint": "39893769eb584a3d114a9e9bb44a78753a5b32514d592c12594c7a1a145fadbe",
+ "typescript": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "go": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "python": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "php": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "dotnet": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "rust": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ }
+ },
{
"family": "messaging",
"method": "GET",
"path": "/messaging/projects/{projectSlug}/campaigns/{id}/recipients",
"operationId": "listProjectCampaignRecipients",
- "fingerprint": "941cfc8a2fc493e724921506ba0248a8c5eb11b63de3fc1ae1a139b92793cc0a",
+ "fingerprint": "067e7f93640ab195c91ceb4d46b2e87037e57655441f8a95b404b8f43d8c234a",
"typescript": {
"status": "covered",
"method": "MessagingClient.campaigns.listRecipients"
@@ -2672,12 +3086,49 @@
"method": "MessagingClient.campaigns.list_recipients"
}
},
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/projects/{projectSlug}/campaigns/{id}/recipients/export",
+ "operationId": "exportProjectCampaignRecipients",
+ "fingerprint": "92e87830cb31ed3f924809ab9f8659cf009dd3491f8cb66f4bda1801c6ef3ddd",
+ "typescript": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "go": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "python": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "php": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "dotnet": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "rust": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ }
+ },
{
"family": "messaging",
"method": "GET",
"path": "/messaging/projects/{projectSlug}/templates",
"operationId": "listProjectTemplates",
- "fingerprint": "a8fec7a1158c9f08cb271bcd4914b1eff92df3f3623cfc26a85bb81e2d006111",
+ "fingerprint": "bbca9d68e0b4d6211472106226705d68e8d3a70ee74b4ae70952ec468d2927de",
"typescript": {
"status": "covered",
"method": "MessagingClient.templates.list"
@@ -2708,7 +3159,7 @@
"method": "GET",
"path": "/messaging/projects/{projectSlug}/templates/{id}",
"operationId": "getProjectTemplate",
- "fingerprint": "7b0bcda54f5a3effa3cc37cf9d6c3a6df033214f9ddf161c64691133c1015338",
+ "fingerprint": "dbd3d3d8d429e17ed65b8d2cd49c66026f8969ca75a4a8938809919da015142e",
"typescript": {
"status": "covered",
"method": "MessagingClient.templates.retrieve"
@@ -2739,7 +3190,7 @@
"method": "GET",
"path": "/messaging/quicklinks/{id}",
"operationId": "getQuickLink",
- "fingerprint": "5e2f4f29bcd4fc189f0f5bcbe377897856e8b954571d2ab489cac16f4ecdeaac",
+ "fingerprint": "b1aed1b6aeefb2026409caf1b36b751f4b0a44f2bb59ce0e05c073121186e562",
"typescript": {
"status": "covered",
"method": "MessagingClient.quickLinks.retrieve"
@@ -2770,7 +3221,7 @@
"method": "GET",
"path": "/messaging/quicklinks/availability",
"operationId": "getHybridQuickLinkAvailability",
- "fingerprint": "cd02dc01613266f3f5b73ba9cdd1213225ed6812ed8fe8e1acb346dfa6fabedb",
+ "fingerprint": "af490c760b906bc0a1372aadebd9f672b445ed865c4777c3dba8c85c1a68cef0",
"typescript": {
"status": "covered",
"method": "MessagingClient.quickLinks.availability"
@@ -2801,7 +3252,7 @@
"method": "GET",
"path": "/messaging/routing/hybrid",
"operationId": "getHybridRoutingPolicy",
- "fingerprint": "eb9761a18166db03f629d04504498a715999d61b88bcdf8892b4c3cacbce9338",
+ "fingerprint": "143c84de498d047058541d2494c32d73f8716e616e0ae8a2d26634d23e696767",
"typescript": {
"status": "covered",
"method": "MessagingClient.hybridLink.getPolicy"
@@ -2830,31 +3281,62 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/voip/calls/{id}/candidates",
- "operationId": "voipCandidates",
- "fingerprint": "d8f00a0c09594e8a4601af308160da89be1406ae5983ba604d5763fd0270e3ed",
+ "path": "/messaging/test-events/fixtures",
+ "operationId": "listTestEventFixtures",
+ "fingerprint": "a00e7ff772afb3e9d9784cb68f40ae6ecd87f7f8cf8fb4a5ee8718cbc8d5f67a",
"typescript": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API"
+ "status": "covered",
+ "method": "MessagingClient.testing.listEventFixtures"
},
"go": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API"
+ "status": "covered",
+ "method": "MessagingClient.Testing.ListEventFixtures"
},
"python": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.testing.list_event_fixtures"
},
"php": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient::testing.listEventFixtures"
},
"dotnet": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API"
- },
+ "status": "covered",
+ "method": "MessagingClient.Testing.ListEventFixturesAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "MessagingClient.testing.list_event_fixtures"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "GET",
+ "path": "/messaging/voip/calls/{id}/candidates",
+ "operationId": "voipCandidates",
+ "fingerprint": "0e6bb8f2a5ed6e7a74d33deb38ff5585c1d0158a48250425c6578bf79e7413f4",
+ "typescript": {
+ "status": "excluded",
+ "reason": "used internally by the Calls SDK; not part of the public API"
+ },
+ "go": {
+ "status": "excluded",
+ "reason": "used internally by the Calls SDK; not part of the public API"
+ },
+ "python": {
+ "status": "excluded",
+ "reason": "used internally by the Calls SDK; not part of the public API",
+ "milestone": "excluded-contract"
+ },
+ "php": {
+ "status": "excluded",
+ "reason": "used internally by the Calls SDK; not part of the public API",
+ "milestone": "excluded-contract"
+ },
+ "dotnet": {
+ "status": "excluded",
+ "reason": "used internally by the Calls SDK; not part of the public API"
+ },
"rust": {
"status": "excluded",
"reason": "used internally by the Calls SDK; not part of the public API",
@@ -2866,35 +3348,41 @@
"method": "GET",
"path": "/messaging/webhooks",
"operationId": "listWebhooks",
- "fingerprint": "ea30f2ba1bad3260b3ed0db66dbe9e9170a905ef16c2aa65d6b156f591b303b7",
+ "fingerprint": "4ac5cda9d0c855faf96543836e74fe5230085dbc4a7eeeb0e7598997c4fdb1a2",
"typescript": {
"status": "covered",
- "method": "MessagingClient.webhooks.list"
+ "method": "MessagingClient.webhooks.list",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "covered",
"method": "MessagingClient.Webhooks.List",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "untypedResponseFields": ["phoneOfflineStartDay"],
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "covered",
"method": "AsyncMessagingClient.webhooks.list",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "untypedResponseFields": ["phoneOfflineStartDay"],
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"php": {
"status": "covered",
"method": "MessagingClient::webhooks.list",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "untypedResponseFields": ["phoneOfflineStartDay"],
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"dotnet": {
"status": "covered",
"method": "MessagingClient.Webhooks.ListAsync",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "untypedResponseFields": ["phoneOfflineStartDay"],
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "covered",
"method": "MessagingClient.webhooks.list",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "untypedResponseFields": ["phoneOfflineStartDay"],
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
}
},
{
@@ -2902,7 +3390,7 @@
"method": "GET",
"path": "/messaging/webhooks/{id}",
"operationId": "getWebhook",
- "fingerprint": "9028f2a863f8e8929b8302b8e6cb0880ee8ad87da544afca6da5767a3185517a",
+ "fingerprint": "4d56f5f1a5cbb453273e91ef9f843c9de95ad86e352058701af8f364c9cafeef",
"typescript": {
"status": "covered",
"method": "MessagingClient.webhooks.retrieve"
@@ -2969,7 +3457,7 @@
"method": "GET",
"path": "/quicklink/{token}",
"operationId": "getQuickLinkState",
- "fingerprint": "26d2702bfbeb7355849b10e3cfd5ecfc5cf20afe474cfcf8155f4151d27605b8",
+ "fingerprint": "35bc6926d9877e0534df3c90570f3e24656859f79fa563f6d1c40aeeb5c64e04",
"typescript": {
"status": "excluded",
"reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
@@ -3037,9 +3525,9 @@
{
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/business/catalog/cart",
+ "path": "/messaging/{connection}/business/catalog/cart",
"operationId": "setBusinessCartEnabled",
- "fingerprint": "b2aae25e95a706cff73697bb2818521e167a501cf442b5489b3c8c2e3e3f2f23",
+ "fingerprint": "f1b84637b244034777411118f9851f4a38a951157198a26e5e3a3c6fc893be23",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.setCartEnabled"
@@ -3068,9 +3556,9 @@
{
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/business/collections/{collectionId}",
+ "path": "/messaging/{connection}/business/collections/{collectionId}",
"operationId": "updateBusinessCollection",
- "fingerprint": "c63c5bc7b99483c453e79a551ff6182158dc80ecf228915f9613e339494c8292",
+ "fingerprint": "02e26564e8553d8e6f95e82a83e63a5164fea3428dddd58bd23bcc78a36da477",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.updateCollection"
@@ -3099,9 +3587,9 @@
{
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/business/products/{productId}/visibility",
+ "path": "/messaging/{connection}/business/products/{productId}/visibility",
"operationId": "setBusinessProductVisibility",
- "fingerprint": "235c496c26185ed656aba3e84adbfb207fad36d6ebe1e9c1b1931f23e4b12882",
+ "fingerprint": "44023dc898c7c0ea9ce094192e057971729713191a2b354bfbadd71b271b053a",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.setProductVisibility"
@@ -3130,9 +3618,9 @@
{
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/business/profile",
+ "path": "/messaging/{connection}/business/profile",
"operationId": "updateBusinessProfile",
- "fingerprint": "2f008360afef29447f83ff8b03f482f1d8f32f1c49ef08974973dbd923772097",
+ "fingerprint": "83cfd3d2e715373e5604ec53440b402a98f409bd6aa60c5b9adceaa3269020f8",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.updateProfile"
@@ -3161,9 +3649,9 @@
{
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/official-groups/{group}",
+ "path": "/messaging/{connection}/official-groups/{group}",
"operationId": "updateOfficialGroup",
- "fingerprint": "8c8e04c995dfe9f185176236c7f9e7162e147f9fbcfff6e872cd893edb62eef8",
+ "fingerprint": "9f81cd53446192c71b9af475b2172794558ddda65f553abf8245b26c0bfb1731",
"typescript": {
"status": "covered",
"method": "MessagingClient.officialGroups.update"
@@ -3192,9 +3680,9 @@
{
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/templates/{name}",
+ "path": "/messaging/{connection}/templates/{name}",
"operationId": "editTemplate",
- "fingerprint": "9646dc549ba7c5c7f66f77752cfdecb1d795f29811fe10473cfb310488618694",
+ "fingerprint": "dd0f5fc8f1bb5a803f5c35d18cc77464e61259011e099bc5efb4eb1b15e92835",
"typescript": {
"status": "covered",
"method": "MessagingClient.cloudTemplates.update"
@@ -3225,7 +3713,7 @@
"method": "PATCH",
"path": "/messaging/projects/{projectSlug}/campaigns/{id}",
"operationId": "updateProjectCampaign",
- "fingerprint": "dc186f9fe903065780fdbbe2c7d75b6918acda5a48dd9da1005f7969beaca0bb",
+ "fingerprint": "f218e8a9efa8409f948dfe4128fedc941cf7241c6fcabac64d5d392933abc136",
"typescript": {
"status": "covered",
"method": "MessagingClient.campaigns.update"
@@ -3256,7 +3744,7 @@
"method": "PATCH",
"path": "/messaging/projects/{projectSlug}/templates/{id}",
"operationId": "updateProjectTemplate",
- "fingerprint": "f36dc77c75fe0e1ee236ed79c7ca78da38db2144c1e964d85df96e55216cd6ba",
+ "fingerprint": "8701f325309a9bb40497ff8a5db09914eb2d742ffcb3c45d51ef02fd87692449",
"typescript": {
"status": "covered",
"method": "MessagingClient.templates.update"
@@ -3287,7 +3775,7 @@
"method": "PATCH",
"path": "/quicklink/{token}/testing",
"operationId": "customizeQuickLinkTesting",
- "fingerprint": "e2e3bdd6a196eb3d35f69d2299fe6ecb117f341442985da0a20b04d818a317df",
+ "fingerprint": "341da5504e5f28e5b0d572df48ced39bc33a8ed980c63e9c9a7bf394e763c186",
"typescript": {
"status": "excluded",
"reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
@@ -3319,9 +3807,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/catalog",
+ "path": "/messaging/{connection}/business/catalog",
"operationId": "createBusinessCatalog",
- "fingerprint": "e24340842504e87c89931d04cc2e31d2162c6d108991fc2036d7979f7f4a9ee4",
+ "fingerprint": "241786093c96785ca58a9902c04218d0c1c2a4fa5367a2a59ce4d3afd2009fbd",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.createCatalog"
@@ -3350,9 +3838,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/collections",
+ "path": "/messaging/{connection}/business/collections",
"operationId": "createBusinessCollection",
- "fingerprint": "2d8dd0ee67356677e8f2bf309df001e89419952060f1a2dedc15ee2e5a3b1bc4",
+ "fingerprint": "f5a282d31df541d80a17ac3f5aeabebaa97f12efa08e6cbd271a938c8f488b9d",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.createCollection"
@@ -3381,9 +3869,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/collections/{collectionId}/appeal",
+ "path": "/messaging/{connection}/business/collections/{collectionId}/appeal",
"operationId": "appealBusinessCollection",
- "fingerprint": "e5ea2392ba68dc63628a403009a6dce520207d64e971ca02558d7be5f5830be9",
+ "fingerprint": "15ad833e55f58d8f65178693b979684397a72dbdac9270c24af498787b25355b",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.appealCollection"
@@ -3412,9 +3900,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/collections/reorder",
+ "path": "/messaging/{connection}/business/collections/reorder",
"operationId": "reorderBusinessCollections",
- "fingerprint": "e5deef2dc749ec39b51414bfaebc2e79526758943ebaf480c69fe8769b625fd2",
+ "fingerprint": "9c8430653d394d828931eb7ba3637a970bbba0871a4706cfd3a4d2de93c53d70",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.reorderCollections"
@@ -3443,9 +3931,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/orders/{orderId}/lookup",
+ "path": "/messaging/{connection}/business/orders/{orderId}/lookup",
"operationId": "getBusinessOrder",
- "fingerprint": "e0913782500d4dea0c00c972e3ebbb0d8b3eb8e106d3d7afba2a567a59296dd4",
+ "fingerprint": "bb88acb24bb817d6a770fa5ca7dc25d044b728db5424bc6f4d32077d83ff14df",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.getOrder"
@@ -3474,9 +3962,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/products",
+ "path": "/messaging/{connection}/business/products",
"operationId": "createBusinessProduct",
- "fingerprint": "5d6c62d996508d1fbd9ebd285b9eba12d3dfd45dc1567303defaac291acac38c",
+ "fingerprint": "df8c16d201186b6dd4b8223e60d461ac144d95cf3cc3fd2dddf1ba8977d767b3",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.createProduct"
@@ -3505,9 +3993,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/products/{productId}/appeal",
+ "path": "/messaging/{connection}/business/products/{productId}/appeal",
"operationId": "appealBusinessProduct",
- "fingerprint": "8683068c1a301027e82091cd398fbdb95184a8832dc2de3340a40bcdc3898f1d",
+ "fingerprint": "431006749de39a85a44fa7224bcb9f6f70bf93147a447b74c7fcd2118c302c14",
"typescript": {
"status": "covered",
"method": "MessagingClient.business.appealProduct"
@@ -3536,9 +4024,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/quick-replies",
+ "path": "/messaging/{connection}/business/quick-replies",
"operationId": "createBusinessQuickReply",
- "fingerprint": "666e722643ca2e90ac79247b3543a1fb38dce6477987f9a3e95ac64ee2450bfe",
+ "fingerprint": "6ecbc36a3e836266794e994447eb642f51cab8ee28d86fba2c2b4195135ce947",
"typescript": {
"status": "covered",
"method": "MessagingClient.quickReplies.create"
@@ -3567,9 +4055,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/calls/{callId}/reject",
+ "path": "/messaging/{connection}/calls/{callId}/reject",
"operationId": "rejectCall",
- "fingerprint": "61e6ea24cc83018584c8a2cacffd621c3cd7b6437bd06bd977f04b8fea54c190",
+ "fingerprint": "027bc072e1b8b000fe09d50972ac7ba7f8d05deed28881bab3439ce70dc893b2",
"typescript": {
"status": "covered",
"method": "MessagingClient.calls.reject"
@@ -3598,9 +4086,40 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels",
+ "path": "/messaging/{connection}/catalogs/{catalogId}/sync",
+ "operationId": "syncCloudCatalog",
+ "fingerprint": "1f1deadde36a761d01769e6f7aa92dfd84237ec4f180bb9ce00eee828ef5b827",
+ "typescript": {
+ "status": "covered",
+ "method": "MessagingClient.catalogs.sync"
+ },
+ "go": {
+ "status": "covered",
+ "method": "MessagingClient.Catalogs.Sync"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncMessagingClient.catalogs.sync"
+ },
+ "php": {
+ "status": "covered",
+ "method": "MessagingClient.catalogs.sync"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "MessagingClient.Catalogs.SyncAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "MessagingClient.catalogs.sync"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "POST",
+ "path": "/messaging/{connection}/channels",
"operationId": "createChannel",
- "fingerprint": "ec2dd2f3407afebc8f2a0685936db9379e98d7dc0bbbf339187362f5f6a3fdd6",
+ "fingerprint": "f23c0c2ec09a5546d46eeba9f9428fca739b6cdf9218ce60637edf4c6f934585",
"typescript": {
"status": "covered",
"method": "MessagingClient.channels.create"
@@ -3629,9 +4148,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/follow",
+ "path": "/messaging/{connection}/channels/{id}/follow",
"operationId": "followChannel",
- "fingerprint": "8cae51b408a9e61c7251aec100d0ef55f47a2a776bb23e3f7771a74e44c2cd5a",
+ "fingerprint": "016c176f1fd515f857596fbf7e52dea1117fca37c9980d1a35a8b66b9e6c51e4",
"typescript": {
"status": "covered",
"method": "MessagingClient.channels.follow"
@@ -3660,9 +4179,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/live-updates",
+ "path": "/messaging/{connection}/channels/{id}/live-updates",
"operationId": "subscribeChannelLiveUpdates",
- "fingerprint": "06d9e29e04fad4326eb072899f51948a8ee8155f8c979ec85f2bee3a8b9d8247",
+ "fingerprint": "355be1c3fd74d14a0b0000089fe800ba9e335803123b8a70b8f814a3c6a28718",
"typescript": {
"status": "covered",
"method": "MessagingClient.channels.subscribeToLiveUpdates"
@@ -3691,9 +4210,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/messages/{messageId}/reaction",
+ "path": "/messaging/{connection}/channels/{id}/messages/{messageId}/reaction",
"operationId": "reactToChannelMessage",
- "fingerprint": "78667670549abd458a47ac722499608ac39a4ff3cb7b7c73a1b70c400e2fe744",
+ "fingerprint": "a59d9c487ccb3bb47abf8dcefebaabcd1bf95ba8b57e1743b167e9cbbba57d77",
"typescript": {
"status": "covered",
"method": "MessagingClient.channels.reactToMessage"
@@ -3722,9 +4241,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/messages/{messageId}/viewed",
+ "path": "/messaging/{connection}/channels/{id}/messages/{messageId}/viewed",
"operationId": "markChannelMessageViewed",
- "fingerprint": "44340115cdc508d5d232f16fb5fd7c7035120f320cfcf3d698dd5b117a5bc3c9",
+ "fingerprint": "58970013d844dbd30123ae00716a8099e515650c828b0bcb18540ad9d419791c",
"typescript": {
"status": "covered",
"method": "MessagingClient.channels.markMessageViewed"
@@ -3753,9 +4272,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/mute",
+ "path": "/messaging/{connection}/channels/{id}/mute",
"operationId": "muteChannel",
- "fingerprint": "025b70836caeedbd43f432ea4dd4b5a8725034099c3d076d8e16b049aca112fb",
+ "fingerprint": "9a584650219c3201117e8b21ff717ea73fac57cb89e97e8fbe9bbf3c0817e6c3",
"typescript": {
"status": "covered",
"method": "MessagingClient.channels.mute"
@@ -3784,9 +4303,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/unfollow",
+ "path": "/messaging/{connection}/channels/{id}/unfollow",
"operationId": "unfollowChannel",
- "fingerprint": "47b7003bfc7e4af3de06310729a5543429746f85894b95266b666fbb8ffc11d1",
+ "fingerprint": "5c80c58ec9cdd946b73802276d5150a301b4ad408527ced92d0bb3c3ee769fbb",
"typescript": {
"status": "covered",
"method": "MessagingClient.channels.unfollow"
@@ -3815,9 +4334,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/unmute",
+ "path": "/messaging/{connection}/channels/{id}/unmute",
"operationId": "unmuteChannel",
- "fingerprint": "05ebbe2300d6d97697466186ecd7220f8f2b5046c9ec5e096ab1f1b883dda5b1",
+ "fingerprint": "8d543b78e3848fc85caa83599320e04849c7ea2c1868ec4f240036c954aa15a7",
"typescript": {
"status": "covered",
"method": "MessagingClient.channels.unmute"
@@ -3846,9 +4365,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/chats/{conversation}/archive",
+ "path": "/messaging/{connection}/chats/{conversation}/archive",
"operationId": "archiveChat",
- "fingerprint": "096f5312e0eb0e3a9d9eb1ca4649e3d0c205fac831aaf93d18a7927e2635a127",
+ "fingerprint": "e67023603b7b53c47a0a76f3e885d74aae202bac081bd8d320c22700267e0a49",
"typescript": {
"status": "covered",
"method": "MessagingClient.chats.archive"
@@ -3877,9 +4396,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/chats/{conversation}/unarchive",
+ "path": "/messaging/{connection}/chats/{conversation}/unarchive",
"operationId": "unarchiveChat",
- "fingerprint": "89aa3f405ae9026dbe5c8b3c068b23d8ad7eaeefce483b71feab5bcb39d0e8da",
+ "fingerprint": "12ec382010adb8aa29c0a0d325e2a6ff8b0c226a7ccc9dda0f8b18714747b267",
"typescript": {
"status": "covered",
"method": "MessagingClient.chats.unarchive"
@@ -3908,40 +4427,40 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/cloud-credentials/reauthorize",
+ "path": "/messaging/{connection}/cloud-credentials/reauthorize",
"operationId": "reauthorizeCloudCredentials",
- "fingerprint": "8f2c634cdf601eadf58fafeb23fae01872ca5fbcb01b0a47997ab918b9d6d3ef",
+ "fingerprint": "c032d433212273bacadfee8915aea13224921f84db81b03400f10aa6dea36664",
"typescript": {
"status": "covered",
- "method": "MessagingClient.sessions.reauthorizeCloudCredentials"
+ "method": "MessagingClient.connections.reauthorizeCloudCredentials"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Sessions.ReauthorizeCloudCredentials"
+ "method": "MessagingClient.Connections.ReauthorizeCloudCredentials"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.sessions.reauthorize_cloud_credentials"
+ "method": "AsyncMessagingClient.connections.reauthorize_cloud_credentials"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$sessions->reauthorizeCloudCredentials"
+ "method": "MessagingClient::$connections->reauthorizeCloudCredentials"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Sessions.ReauthorizeCloudCredentialsAsync"
+ "method": "MessagingClient.Connections.ReauthorizeCloudCredentialsAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.sessions.reauthorize_cloud_credentials"
+ "method": "MessagingClient.connections.reauthorize_cloud_credentials"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/contacts/{contactId}/block",
+ "path": "/messaging/{connection}/contacts/{contactId}/block",
"operationId": "blockContact",
- "fingerprint": "46868d40d8697f5be334c95aa7c59edb2e692063c72b5b301f0fabdab2b859d4",
+ "fingerprint": "f380c56ca190e56f1fdca01e4954f2f83daa9f5b8f99e9484fa3615f7304a103",
"typescript": {
"status": "covered",
"method": "MessagingClient.contacts.block"
@@ -3970,9 +4489,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/contacts/{contactId}/unblock",
+ "path": "/messaging/{connection}/contacts/{contactId}/unblock",
"operationId": "unblockContact",
- "fingerprint": "0906c7e8a8616b214b889fe263dc5a5f0753cae607e9afd04c4b16ff6778b0b8",
+ "fingerprint": "7f394f8cf2ca36a0a28b86eccabaf3184173540cc91527840786e28aebd0b90a",
"typescript": {
"status": "covered",
"method": "MessagingClient.contacts.unblock"
@@ -4001,9 +4520,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups",
+ "path": "/messaging/{connection}/groups",
"operationId": "createGroup",
- "fingerprint": "0bb81dcb051f4c26824091d1725538c975a8ed5499a5d2fd4428c0799614cd1c",
+ "fingerprint": "69eb70a6d95d55bcf24ace2ba9ee16951cf543c086d4c3af4119fa2849d8b0e3",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.create"
@@ -4032,9 +4551,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/{id}/admin/demote",
+ "path": "/messaging/{connection}/groups/{id}/admin/demote",
"operationId": "demoteGroupAdmin",
- "fingerprint": "d97b86566699a2da18b75a6a94d2ce1d7b5d7f831050d60095408fcb9d87bb5d",
+ "fingerprint": "d501bf3fe1153b6e986c0a2958cfa3a3403881f7690b3ca976eadac021200a5a",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.demoteParticipants"
@@ -4063,9 +4582,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/{id}/admin/promote",
+ "path": "/messaging/{connection}/groups/{id}/admin/promote",
"operationId": "promoteGroupAdmin",
- "fingerprint": "ba1c9c53f66b64cb489a927eab443efa8ce494e6910d0ac4817984d8f0f18290",
+ "fingerprint": "850e6a899c2ed2461529766ef2bdf845cb6acfaafd6e46c91a905c0e5cd05e84",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.promoteParticipants"
@@ -4094,9 +4613,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/{id}/invite-code/revoke",
+ "path": "/messaging/{connection}/groups/{id}/invite-code/revoke",
"operationId": "revokeGroupInviteCode",
- "fingerprint": "6e5d7ea243a0701149d17b3e7280a1a26bff742bdbe0472a4ddd07fe0eb9bb46",
+ "fingerprint": "861a7f7a50f0707b417014548799e62bbee8a39759e29dcb0d801831469198e4",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.revokeInviteCode"
@@ -4125,9 +4644,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/{id}/leave",
+ "path": "/messaging/{connection}/groups/{id}/leave",
"operationId": "leaveGroup",
- "fingerprint": "2ea4db8b11e2db4f97463e1755a5b6a8c74f767ff16be1b632baacb408fb009b",
+ "fingerprint": "16d59d4cc71a7b484c4e22432f875dd3684321512f9e153b2695f51ce1b8b049",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.leave"
@@ -4156,9 +4675,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/{id}/participants/add",
+ "path": "/messaging/{connection}/groups/{id}/participants/add",
"operationId": "addGroupParticipants",
- "fingerprint": "80a38eb964fe4c2714177e8e802bb0616f6dfa91da9e387044448a8a0962db75",
+ "fingerprint": "3740c9940640a6fed8f42fe855f48c8b10451526a57934ad5180eb22ca7281ee",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.addParticipants"
@@ -4187,9 +4706,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/{id}/participants/remove",
+ "path": "/messaging/{connection}/groups/{id}/participants/remove",
"operationId": "removeGroupParticipants",
- "fingerprint": "8a1a7272d3260aa781f2cdc3a1c6c71f0f1f49f69e920f92f7da2dd7cf3d8099",
+ "fingerprint": "83d549c215d836c72ae998281112ced347856edc344cb297ecfbcf1228be012e",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.removeParticipants"
@@ -4218,9 +4737,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/join",
+ "path": "/messaging/{connection}/groups/join",
"operationId": "joinGroup",
- "fingerprint": "f57203342236f7210ff2bed201ab8459198edfd272b1824dd43255c72ee4e916",
+ "fingerprint": "0031796425473d635d88ca9af052db5eab426336073a47ec8eb9a53d6a24d37b",
"typescript": {
"status": "covered",
"method": "MessagingClient.groups.join"
@@ -4249,9 +4768,83 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/labels",
+ "path": "/messaging/{connection}/history/chunks/retry",
+ "operationId": "retryHistoryChunk",
+ "fingerprint": "84b0909428e26954a975754afe701cf3f074dc09623e96f87f55063adcdb2047",
+ "typescript": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "go": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "python": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "php": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "dotnet": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "rust": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "POST",
+ "path": "/messaging/{connection}/history/media/delete",
+ "operationId": "deleteHistoryMedia",
+ "fingerprint": "0fc8d22fa0425915a01dd46ee30ce92e5d116ed6695e45827f5a53948e58e10c",
+ "typescript": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "go": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "python": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "php": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "dotnet": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "rust": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "POST",
+ "path": "/messaging/{connection}/labels",
"operationId": "createLabel",
- "fingerprint": "f79df7bd8186b231a0fd039a93c8a23eb471d8ab0c5107108c508ddd30c6034d",
+ "fingerprint": "574369e215cb1d5ec449f365cb261f2b6b2482abe122235021321b461ea3dc7b",
"typescript": {
"status": "covered",
"method": "MessagingClient.labels.create"
@@ -4280,9 +4873,83 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/react",
+ "path": "/messaging/{connection}/media/upload-grants",
+ "operationId": "createMediaUploadGrant",
+ "fingerprint": "ddcc0d83cf51997b57a201dc44c77192151566eeb5e79db6f430162b7df27d9f",
+ "typescript": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "go": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "python": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "php": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "dotnet": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "rust": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "POST",
+ "path": "/messaging/{connection}/media/uploads",
+ "operationId": "uploadEncryptedMedia",
+ "fingerprint": "7eebe5d9cc7919867ce4b4a172d24eb8b95e0a6b1f9dd874c79aab2e561ce1fe",
+ "typescript": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "go": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "python": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "php": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "dotnet": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "rust": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ }
+ },
+ {
+ "family": "messaging",
+ "method": "POST",
+ "path": "/messaging/{connection}/messages/react",
"operationId": "sendReaction",
- "fingerprint": "092c2f2d8977d938c87c13cf81015caf9a62bc9dc7109a5e5771da4bba3dfdeb",
+ "fingerprint": "2386bdc539b41c2b2133d23329ebb584373159df58ccc1052671e7b9e963357e",
"typescript": {
"status": "covered",
"method": "MessagingClient.messages.react"
@@ -4311,9 +4978,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/seen",
+ "path": "/messaging/{connection}/messages/seen",
"operationId": "sendSeen",
- "fingerprint": "d6015a75d197d5a04667c41aee93b01c04d43cb4807fd591358396966f38513e",
+ "fingerprint": "c81c74f6bf43215a6be13f8ae756dd9d539d73aaabede10c26cf321e91d7e60c",
"typescript": {
"status": "covered",
"method": "MessagingClient.messages.markSeen"
@@ -4342,9 +5009,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/send",
+ "path": "/messaging/{connection}/messages/send",
"operationId": "sendMessage",
- "fingerprint": "815fe4e45d0fe9641f88f906002bde018cedde3ebaeb4b229c81b511d6c2a07b",
+ "fingerprint": "c909c3eb41f2bf398908f62bf39bb75e3ec83caab02d2f2aea9a09b313f1f24e",
"typescript": {
"status": "covered",
"method": "MessagingClient.messages.send",
@@ -4379,9 +5046,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/star",
+ "path": "/messaging/{connection}/messages/star",
"operationId": "starMessage",
- "fingerprint": "faed8d07156f499004732e116d92c94becf973b8d7e8d73351ad35b362ce3c79",
+ "fingerprint": "53fd3761178b42e5f4997ffbc9ac460e5b676124d96ebcfa043a6da9dac1f129",
"typescript": {
"status": "covered",
"method": "MessagingClient.messages.star"
@@ -4410,9 +5077,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/typing",
+ "path": "/messaging/{connection}/messages/typing",
"operationId": "setTyping",
- "fingerprint": "873674c42d6bf0abb952fabaec9f9de5c8a10b9c3b4aa383730f927824120499",
+ "fingerprint": "58d36c9bc9f324dfa3e07e6a1db6f00ef5f9f573b1265c7ad68ce8e4997f8564",
"typescript": {
"status": "covered",
"method": "MessagingClient.messages.setTyping"
@@ -4441,9 +5108,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/official-groups",
+ "path": "/messaging/{connection}/official-groups",
"operationId": "createOfficialGroup",
- "fingerprint": "d2606d37b57ac50bd3e514ff742c23f351a3b61d3790bccc4e291561444e1d12",
+ "fingerprint": "c3b7cb8139893d606aa7f7276c243c80818ddd1a88a9073c14f302a609d09db3",
"typescript": {
"status": "covered",
"method": "MessagingClient.officialGroups.create"
@@ -4472,9 +5139,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/official-groups/{group}/invite-link/reset",
+ "path": "/messaging/{connection}/official-groups/{group}/invite-link/reset",
"operationId": "resetOfficialGroupInviteLink",
- "fingerprint": "585a663edec36b8793ae0291c4389b2d22a026ab3e56b764a549ceb6e55963e1",
+ "fingerprint": "909c029de6f16dfd6204d7c57a52bda305ef61dbdadd091ad06f2f52c4b93ea6",
"typescript": {
"status": "covered",
"method": "MessagingClient.officialGroups.resetInviteLink"
@@ -4503,9 +5170,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/official-groups/{group}/join-requests/approve",
+ "path": "/messaging/{connection}/official-groups/{group}/join-requests/approve",
"operationId": "approveOfficialGroupJoinRequests",
- "fingerprint": "d0806c1c19e773e3048960ebe2207c3d4461f9aad3c88c72a9dc16a6cf4d9db8",
+ "fingerprint": "79e4f750dde5f20cc0ff21b13de9b2acaa5773694d94492bcbc6d186feded833",
"typescript": {
"status": "covered",
"method": "MessagingClient.officialGroups.approveJoinRequests"
@@ -4534,9 +5201,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/official-groups/{group}/join-requests/reject",
+ "path": "/messaging/{connection}/official-groups/{group}/join-requests/reject",
"operationId": "rejectOfficialGroupJoinRequests",
- "fingerprint": "6cb0797e597ef55f19eb849991f38b1c6ad753185d4bc852e2b2d6e898e8abab",
+ "fingerprint": "2e06167f14a18737369ed9f550fe6b35c6b6dd9934624cfd9d1ff6b1cf68728b",
"typescript": {
"status": "covered",
"method": "MessagingClient.officialGroups.rejectJoinRequests"
@@ -4565,9 +5232,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/official-groups/{group}/participants/remove",
+ "path": "/messaging/{connection}/official-groups/{group}/participants/remove",
"operationId": "removeOfficialGroupParticipants",
- "fingerprint": "86d31c1ad23eb60d925edab2f61b37484238cc2b337cd011e4e3ffc596cb0a93",
+ "fingerprint": "cf90ccd082b7c73f54b10077743da9955ae0dcc8612b8b348e09b1275d350cfd",
"typescript": {
"status": "covered",
"method": "MessagingClient.officialGroups.removeParticipants"
@@ -4596,9 +5263,9 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/official-groups/{group}/pins",
+ "path": "/messaging/{connection}/official-groups/{group}/pins",
"operationId": "pinOfficialGroupMessage",
- "fingerprint": "86d1b9f1f6942c0d4070fbf11011b0b8d0bf29d75364e30ad7b3f615f61d14a4",
+ "fingerprint": "3d034f4ffdefc3c5b8bff4771ee59901871527d035eadb53eede35c0e9c4896e",
"typescript": {
"status": "covered",
"method": "MessagingClient.officialGroups.pin"
@@ -4627,3470 +5294,3447 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/pair/code",
+ "path": "/messaging/{connection}/pair/code",
"operationId": "requestPairCode",
- "fingerprint": "797d873e1de1f054cea0436bd888832cdd11b49bae28a31b7c041104037f06b7",
+ "fingerprint": "836e5dd79b78ee052e4105d2f6274b05f159f52d8dc5b80823d3ca4ea1e52e76",
"typescript": {
"status": "covered",
- "method": "MessagingClient.sessions.requestPairingCode"
+ "method": "MessagingClient.connections.requestPairingCode"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Sessions.RequestPairingCode"
+ "method": "MessagingClient.Connections.RequestPairingCode"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.sessions.request_pairing_code"
+ "method": "AsyncMessagingClient.connections.request_pairing_code"
},
"php": {
"status": "covered",
- "method": "MessagingClient.sessions.requestPairingCode"
+ "method": "MessagingClient.connections.requestPairingCode"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Sessions.RequestPairingCodeAsync"
+ "method": "MessagingClient.Connections.RequestPairingCodeAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.sessions.request_pairing_code"
+ "method": "MessagingClient.connections.request_pairing_code"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/presence",
- "operationId": "setPresence",
- "fingerprint": "31bbc7334ba331b25bc514354b14894119dfb0e67e21df212a195be3d4436e80",
+ "path": "/messaging/{connection}/passkey/assertion",
+ "operationId": "submitPasskeyAssertion",
+ "fingerprint": "1392c9ead87d46a52198b8fe8ada867d54b73eef699a8a93339d32394c1d4600",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.presence.set"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Presence.Set"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.presence.set"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.presence.set"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Presence.SetAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.presence.set"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/presence/{conversation}/subscribe",
- "operationId": "subscribePresence",
- "fingerprint": "96a56fe3ac5ed6adbf0983f667a0d307681bf4cde6d7dedaa25abb2102d83ec6",
+ "path": "/messaging/{connection}/passkey/challenge",
+ "operationId": "issuePasskeyChallenge",
+ "fingerprint": "c3c5d4ea164f107f72026c23686b175fb2c4deff916018e5d308c5d795673bed",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.presence.subscribe"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Presence.Subscribe"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.presence.subscribe"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.presence.subscribe"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Presence.SubscribeAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.presence.subscribe"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/templates",
- "operationId": "createTemplate",
- "fingerprint": "c8088c3ad3d0d2d3e3780299c7618ebe03578909c718a164b99b255f60eee9b4",
+ "path": "/messaging/{connection}/passkey/confirmation",
+ "operationId": "confirmPasskey",
+ "fingerprint": "cd258e69886f1962b2a4952853f02a6b144048b0b96e02273f9f6e4abde336dd",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.cloudTemplates.create"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.CloudTemplates.Create"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.cloud_templates.create"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "MessagingClient::cloudTemplates.create"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.CloudTemplates.CreateAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.cloud_templates.create"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/cloud-api/embedded-signup",
- "operationId": "embeddedSignup",
- "fingerprint": "ffeff01ff04f0a8dc76783e2abe8dd0357def1803a341822f7120510fced2538",
+ "path": "/messaging/{connection}/phone/devices/{deviceId}/unlink",
+ "operationId": "unlinkTestingPhoneDevice",
+ "fingerprint": "84195bbcee46fd0b5ab4aa8fcfa66223c10351f43545076459a39eb43837c30d",
"typescript": {
"status": "covered",
- "method": "MessagingClient.cloudOnboarding.advance"
+ "method": "MessagingClient.testing.unlinkPhoneDevice"
},
"go": {
"status": "covered",
- "method": "MessagingClient.CloudOnboarding.Advance"
+ "method": "MessagingClient.Testing.UnlinkPhoneDevice"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.cloud_onboarding.advance"
+ "method": "AsyncMessagingClient.testing.unlink_phone_device"
},
"php": {
"status": "covered",
- "method": "MessagingClient::cloudOnboarding.advance"
+ "method": "MessagingClient::testing.unlinkPhoneDevice"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.CloudOnboarding.AdvanceAsync"
+ "method": "MessagingClient.Testing.UnlinkPhoneDeviceAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.cloud_onboarding.advance"
+ "method": "MessagingClient.testing.unlink_phone_device"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/features/evaluate",
- "operationId": "evaluateFeatures",
- "fingerprint": "61621e29c51c05cff49be39184ab44b75d8470b8f9264c4af7ae44a22f96c51d",
+ "path": "/messaging/{connection}/phone/messages",
+ "operationId": "sendTestingPhoneMessage",
+ "fingerprint": "de36e426633e9beb3b9cc51591312a2630ab4e06f960830415206fd5318ae45e",
"typescript": {
- "status": "excluded",
- "reason": "Host-runtime feature evaluation is not a customer messaging operation in this SDK."
+ "status": "covered",
+ "method": "MessagingClient.testing.sendPhoneMessage"
},
"go": {
- "status": "excluded",
- "reason": "Host-runtime feature evaluation is not a customer messaging operation in this SDK."
+ "status": "covered",
+ "method": "MessagingClient.Testing.SendPhoneMessage"
},
"python": {
- "status": "excluded",
- "reason": "Host-runtime feature evaluation is not a customer messaging operation in this SDK.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.testing.send_phone_message"
},
"php": {
- "status": "excluded",
- "reason": "Host-runtime feature evaluation is not a customer messaging operation in this SDK.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient::testing.sendPhoneMessage"
},
"dotnet": {
- "status": "excluded",
- "reason": "Host-runtime feature evaluation is not a customer messaging operation in this SDK."
+ "status": "covered",
+ "method": "MessagingClient.Testing.SendPhoneMessageAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Host-runtime feature evaluation is not a customer messaging operation in this SDK.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.testing.send_phone_message"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/media/{id}/download-and-save",
- "operationId": "downloadAndSaveMedia",
- "fingerprint": "dee71dba0d46bb40ef525083df8d9e2092ef42dd0670a9c5a2e6fbe0838cfbcb",
+ "path": "/messaging/{connection}/presence",
+ "operationId": "setPresence",
+ "fingerprint": "8b7ea157f88f4b1b687180b427aa40ea971a8f5383271fb157268857d664a140",
"typescript": {
"status": "covered",
- "method": "MessagingClient.media.persist"
+ "method": "MessagingClient.presence.set"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Media.Persist"
+ "method": "MessagingClient.Presence.Set"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.media.persist"
+ "method": "AsyncMessagingClient.presence.set"
},
"php": {
"status": "covered",
- "method": "MessagingClient::media.persist"
+ "method": "MessagingClient.presence.set"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Media.PersistAsync"
+ "method": "MessagingClient.Presence.SetAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.media.persist"
+ "method": "MessagingClient.presence.set"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/campaigns",
- "operationId": "createCampaign",
- "fingerprint": "380541cba858938a1965e280f56dfa801f9a50f3f46815b7e81135a24a38a603",
+ "path": "/messaging/{connection}/presence/{conversation}/subscribe",
+ "operationId": "subscribePresence",
+ "fingerprint": "e7faeb71995f05bdcbc78fc117aafa3726e3a7bd0dd5c3c9405fb7c6153828a2",
"typescript": {
"status": "covered",
- "method": "MessagingClient.campaigns.create"
+ "method": "MessagingClient.presence.subscribe"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Campaigns.Create"
+ "method": "MessagingClient.Presence.Subscribe"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.campaigns.create"
+ "method": "AsyncMessagingClient.presence.subscribe"
},
"php": {
"status": "covered",
- "method": "MessagingClient::campaigns.create"
+ "method": "MessagingClient.presence.subscribe"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Campaigns.CreateAsync"
+ "method": "MessagingClient.Presence.SubscribeAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.campaigns.create"
+ "method": "MessagingClient.presence.subscribe"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/campaigns/{id}/launch",
- "operationId": "launchCampaign",
- "fingerprint": "d56e7b5d9cb21cbc9c6204bdc7c7ee8c2a1b6bc0ad7573a41ea03dfdc4e3c3e8",
+ "path": "/messaging/{connection}/stickers/recents/bootstrap",
+ "operationId": "bootstrapRecentStickers",
+ "fingerprint": "1382a1f4958c261320fdeea1ed1c00ecc7637603c0c7c6ec4a156f4f04303194",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.campaigns.launch"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Campaigns.Launch"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.campaigns.launch"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "MessagingClient::campaigns.launch"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Campaigns.LaunchAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.campaigns.launch"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/campaigns/{id}/pause",
- "operationId": "pauseCampaign",
- "fingerprint": "d5ff323c7e370581bc3144545429cce10ff9fc33e5dfbf91608236594c544064",
+ "path": "/messaging/{connection}/stickers/recents/remove",
+ "operationId": "removeRecentSticker",
+ "fingerprint": "982d6fb3a2315617934b8e58f733d843ac8dbef77e1a2da15831f0fb1fe3157d",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.campaigns.pause"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Campaigns.Pause"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.campaigns.pause"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "MessagingClient::campaigns.pause"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Campaigns.PauseAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.campaigns.pause"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/campaigns/{id}/recipients",
- "operationId": "addProjectCampaignRecipients",
- "fingerprint": "07677fae2f0134acc4286756813589357ff762133f64d43e03058097fcd833c0",
+ "path": "/messaging/{connection}/stickers/reuploads",
+ "operationId": "requestStickerReupload",
+ "fingerprint": "9f51422a0dea82ecb3e5b262f9f2b1e0c334b8201fa0ba22751bea13bca20e73",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.campaigns.addRecipients"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Campaigns.AddRecipients"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.campaigns.add_recipients"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "MessagingClient::campaigns.addRecipients"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Campaigns.AddRecipientsAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.campaigns.add_recipients"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/campaigns/{id}/requeue",
- "operationId": "requeueCampaign",
- "fingerprint": "4d250ec43361be7f01d9f1379a6c216f58b897b35862e4493e28bf8fba183c9f",
+ "path": "/messaging/{connection}/templates",
+ "operationId": "createTemplate",
+ "fingerprint": "d7ca4decdf0eee9c985f815ffbd239613d6489dbb020c31bbe3492b4e00fe3a9",
"typescript": {
"status": "covered",
- "method": "MessagingClient.campaigns.requeue"
+ "method": "MessagingClient.cloudTemplates.create"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Campaigns.Requeue"
+ "method": "MessagingClient.CloudTemplates.Create"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.campaigns.requeue"
+ "method": "AsyncMessagingClient.cloud_templates.create"
},
"php": {
"status": "covered",
- "method": "MessagingClient::campaigns.requeue"
+ "method": "MessagingClient::cloudTemplates.create"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Campaigns.RequeueAsync"
+ "method": "MessagingClient.CloudTemplates.CreateAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.campaigns.requeue"
+ "method": "MessagingClient.cloud_templates.create"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/campaigns/{id}/reschedule",
- "operationId": "rescheduleCampaign",
- "fingerprint": "eda4f216d72d455614c8b64eec298f0f770dd9b0eb0ad7a233bebc0538eb5ada",
+ "path": "/messaging/{connection}/test-events",
+ "operationId": "triggerTestEvent",
+ "fingerprint": "64a9be1d4fb1f4e87c0cafd709e08f0dee027ad5eba1bddc97e5daa0b3a6015a",
"typescript": {
"status": "covered",
- "method": "MessagingClient.campaigns.reschedule"
+ "method": "MessagingClient.testing.triggerEvent"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Campaigns.Reschedule"
+ "method": "MessagingClient.Testing.TriggerEvent"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.campaigns.reschedule"
+ "method": "AsyncMessagingClient.testing.trigger_event"
},
"php": {
"status": "covered",
- "method": "MessagingClient::campaigns.reschedule"
+ "method": "MessagingClient::testing.triggerEvent"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Campaigns.RescheduleAsync"
+ "method": "MessagingClient.Testing.TriggerEventAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.campaigns.reschedule"
+ "method": "MessagingClient.testing.trigger_event"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/campaigns/{id}/resume",
- "operationId": "resumeCampaign",
- "fingerprint": "28113fff865d14fbf2b16cd61df182c742ab5ff6f1de8c513f9034d593441b69",
+ "path": "/messaging/cloud-api/embedded-signup",
+ "operationId": "embeddedSignup",
+ "fingerprint": "6a23d56214b28ac0b353e7293acf9936a6620d3b65ad2b2f3a16c1b54a0c7863",
"typescript": {
"status": "covered",
- "method": "MessagingClient.campaigns.resume"
+ "method": "MessagingClient.cloudOnboarding.advance"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Campaigns.Resume"
+ "method": "MessagingClient.CloudOnboarding.Advance"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.campaigns.resume"
+ "method": "AsyncMessagingClient.cloud_onboarding.advance"
},
"php": {
"status": "covered",
- "method": "MessagingClient::campaigns.resume"
+ "method": "MessagingClient::cloudOnboarding.advance"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Campaigns.ResumeAsync"
+ "method": "MessagingClient.CloudOnboarding.AdvanceAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.campaigns.resume"
+ "method": "MessagingClient.cloud_onboarding.advance"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/campaigns/{id}/stop",
- "operationId": "stopCampaign",
- "fingerprint": "4a1baa556a0c58ffdcef53ce6394cf40d9c397fe1ffdd37af58bacc85158c32f",
+ "path": "/messaging/customer-pairing/exchange",
+ "operationId": "exchangeCustomerPairingLink",
+ "fingerprint": "974162521796edc5083f0bd249d8f9cfd06dd05f3ab5baed14d2da20637d579c",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.campaigns.stop"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Campaigns.Stop"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.campaigns.stop"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "MessagingClient::campaigns.stop"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Campaigns.StopAsync"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.campaigns.stop"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/templates",
- "operationId": "createProjectTemplate",
- "fingerprint": "2833b18fc30e745b45a54e4af798fdd0008cd7ca03ca3e62e3e24568e8312079",
+ "path": "/messaging/features/evaluate",
+ "operationId": "evaluateFeatures",
+ "fingerprint": "fc488200c4648602ffd988dd9a5ee0cd725ef4145b66ea8c1ca50d0dfe849d3e",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.templates.create"
+ "status": "excluded",
+ "reason": "Host-runtime feature evaluation is not a customer messaging operation in this SDK."
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Templates.Create"
+ "status": "excluded",
+ "reason": "Host-runtime feature evaluation is not a customer messaging operation in this SDK."
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.templates.create"
+ "status": "excluded",
+ "reason": "Host-runtime feature evaluation is not a customer messaging operation in this SDK.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "MessagingClient::templates.create"
+ "status": "excluded",
+ "reason": "Host-runtime feature evaluation is not a customer messaging operation in this SDK.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Templates.CreateAsync"
+ "status": "excluded",
+ "reason": "Host-runtime feature evaluation is not a customer messaging operation in this SDK."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.templates.create"
+ "status": "excluded",
+ "reason": "Host-runtime feature evaluation is not a customer messaging operation in this SDK.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/templates/{id}/preview",
- "operationId": "previewProjectTemplate",
- "fingerprint": "7d58df32b389f51afab5734e5780964cabf68833d630993cdda0f4b0b922c52e",
+ "path": "/messaging/media/{id}/download-and-save",
+ "operationId": "downloadAndSaveMedia",
+ "fingerprint": "13de1b143e7d821bd4cb6999cc089cfb97694692962458e87fe3b041655af652",
"typescript": {
"status": "covered",
- "method": "MessagingClient.templates.preview"
+ "method": "MessagingClient.media.persist"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Templates.Preview"
+ "method": "MessagingClient.Media.Persist"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.templates.preview"
+ "method": "AsyncMessagingClient.media.persist"
},
"php": {
"status": "covered",
- "method": "MessagingClient::templates.preview"
+ "method": "MessagingClient::media.persist"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Templates.PreviewAsync"
+ "method": "MessagingClient.Media.PersistAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.templates.preview"
+ "method": "MessagingClient.media.persist"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/templates/{id}/submit",
- "operationId": "submitProjectTemplateToMeta",
- "fingerprint": "e285ba7f8feb11d1ddfbe9f5a3c8ea9f8fe3faafab68d150355741752707ef85",
+ "path": "/messaging/projects/{projectId}/test-history-fixtures",
+ "operationId": "createTestingHistoryFixture",
+ "fingerprint": "a899f25f72023d689772e1fb00bd17ad5f39114711ec87871886f5f362e53882",
"typescript": {
"status": "covered",
- "method": "MessagingClient.templates.submit"
+ "method": "MessagingClient.testing.createHistoryFixture"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Templates.Submit"
+ "method": "MessagingClient.Testing.CreateHistoryFixture"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.templates.submit"
+ "method": "AsyncMessagingClient.testing.create_history_fixture"
},
"php": {
"status": "covered",
- "method": "MessagingClient::templates.submit"
+ "method": "MessagingClient::testing.createHistoryFixture"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Templates.SubmitAsync"
+ "method": "MessagingClient.Testing.CreateHistoryFixtureAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.templates.submit"
+ "method": "MessagingClient.testing.create_history_fixture"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/quicklinks",
- "operationId": "createQuickLink",
- "fingerprint": "c2cb0b2e461e5b1bc08ede1583aed4662e2ab5f4676dc27a0c3694b73f3ceea0",
+ "path": "/messaging/projects/{projectSlug}/campaign-reply-flows",
+ "operationId": "createCampaignReplyFlow",
+ "fingerprint": "ab20b84792f50f1bd8b1107a1c65fd54c4620b5468083c3fd0025dfebb903787",
"typescript": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (primaryPlatform) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (primaryPlatform) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (primaryPlatform) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (primaryPlatform) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (primaryPlatform) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (primaryPlatform) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/call-links",
- "operationId": "voipCreateCallLink",
- "fingerprint": "ac6f712d33b1e95ec8f566cfc453617745d346b599fbd63ce9f16726b78d4426",
+ "path": "/messaging/projects/{projectSlug}/campaigns",
+ "operationId": "createCampaign",
+ "fingerprint": "0ed95053c8c179b2cc0d543bd2ce2f2aff10593ae37d24078c79b59284afb7c0",
"typescript": {
"status": "covered",
- "method": "MessagingClient.voip.createCallLink"
+ "method": "MessagingClient.campaigns.create"
},
"go": {
"status": "covered",
- "method": "MessagingClient.VoIP.CreateCallLink"
+ "method": "MessagingClient.Campaigns.Create"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.voip.create_call_link"
+ "method": "AsyncMessagingClient.campaigns.create"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$voip->createCallLink"
+ "method": "MessagingClient::campaigns.create"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Calls.CreateCallLinkAsync"
+ "method": "MessagingClient.Campaigns.CreateAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.voip.create_call_link"
+ "method": "MessagingClient.campaigns.create"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/call-links/preview",
- "operationId": "voipPreviewCallLink",
- "fingerprint": "a92c3f5ad6dc1e55abc5426066db0c1b5eca8eade00504c6c29c89193ae1a4ab",
+ "path": "/messaging/projects/{projectSlug}/campaigns/{id}/enrollments",
+ "operationId": "enrollProjectCampaignContact",
+ "fingerprint": "f125c8d4e823a12197c5e43e05db692a39d240dac89321fecbc46f09ccbaa858",
"typescript": {
"status": "covered",
- "method": "MessagingClient.voip.previewCallLink"
+ "method": "MessagingClient.campaigns.enroll"
},
"go": {
"status": "covered",
- "method": "MessagingClient.VoIP.PreviewCallLink"
+ "method": "MessagingClient.Campaigns().Enroll"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.voip.preview_call_link"
+ "method": "AsyncMessagingClient.campaigns.enroll"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$voip->previewCallLink"
+ "method": "MessagingClient::campaigns.enroll"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Calls.PreviewCallLinkAsync"
+ "method": "MessagingClient.Campaigns.EnrollAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.voip.preview_call_link"
+ "method": "MessagingClient.campaigns().enroll"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/calls",
- "operationId": "voipPlaceCall",
- "fingerprint": "563384afb0b853034d6d7f9b2bf530b3ffacc248d864c3d15401a42afacd9ff2",
+ "path": "/messaging/projects/{projectSlug}/campaigns/{id}/launch",
+ "operationId": "launchCampaign",
+ "fingerprint": "c12bc6cb7238f1b6683742dded75a0d81e034b97279fef4b0871d8422144fd80",
"typescript": {
"status": "covered",
- "method": "MessagingClient.voip.place"
+ "method": "MessagingClient.campaigns.launch"
},
"go": {
"status": "covered",
- "method": "MessagingClient.VoIP.Place"
+ "method": "MessagingClient.Campaigns.Launch"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.voip.place"
+ "method": "AsyncMessagingClient.campaigns.launch"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$voip->place"
+ "method": "MessagingClient::campaigns.launch"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Calls.PlaceAsync"
+ "method": "MessagingClient.Campaigns.LaunchAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.voip.place"
+ "method": "MessagingClient.campaigns.launch"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/calls/{id}/accept",
- "operationId": "voipAcceptCall",
- "fingerprint": "8f7ec4dcacb804f09b5225dfc2dab5fa91b87eb75d801d7d571469bd5ed6027f",
+ "path": "/messaging/projects/{projectSlug}/campaigns/{id}/pause",
+ "operationId": "pauseCampaign",
+ "fingerprint": "59500bee8fecce9513b74a257ed5dac59ccef767e214886f0e5802168c8a8547",
"typescript": {
"status": "covered",
- "method": "MessagingClient.voip.accept"
+ "method": "MessagingClient.campaigns.pause"
},
"go": {
"status": "covered",
- "method": "MessagingClient.VoIP.Accept"
+ "method": "MessagingClient.Campaigns.Pause"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.voip.accept"
+ "method": "AsyncMessagingClient.campaigns.pause"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$voip->accept"
+ "method": "MessagingClient::campaigns.pause"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Calls.AcceptAsync"
+ "method": "MessagingClient.Campaigns.PauseAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.voip.accept"
+ "method": "MessagingClient.campaigns.pause"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/calls/{id}/candidate",
- "operationId": "voipCandidate",
- "fingerprint": "48b071284443748dd3b072ff99e8954c5c197bae29321bc1fb2ece82a1a9137c",
+ "path": "/messaging/projects/{projectSlug}/campaigns/{id}/recipients",
+ "operationId": "addProjectCampaignRecipients",
+ "fingerprint": "d1848efc1ace92949619f6999f7c1ddcb6174e64736553764d8241bca620b23e",
"typescript": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API"
+ "status": "covered",
+ "method": "MessagingClient.campaigns.addRecipients"
},
"go": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API"
+ "status": "covered",
+ "method": "MessagingClient.Campaigns.AddRecipients"
},
"python": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.campaigns.add_recipients"
},
"php": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient::campaigns.addRecipients"
},
"dotnet": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API"
+ "status": "covered",
+ "method": "MessagingClient.Campaigns.AddRecipientsAsync"
},
"rust": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.campaigns.add_recipients"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/calls/{id}/hand",
- "operationId": "setCallHandRaised",
- "fingerprint": "346a34634615beb59a30928dd358e3e3ca65c891a97b46caa4a692610782642a",
+ "path": "/messaging/projects/{projectSlug}/campaigns/{id}/requeue",
+ "operationId": "requeueCampaign",
+ "fingerprint": "ec66de0129ef99523f694138f9dd423aeb0fccbcc7ef4bc2cbf1c0c1d1f3a368",
"typescript": {
"status": "covered",
- "method": "MessagingClient.voip.setHandRaised"
+ "method": "MessagingClient.campaigns.requeue"
},
"go": {
"status": "covered",
- "method": "MessagingClient.VoIP.SetHandRaised"
+ "method": "MessagingClient.Campaigns.Requeue"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.voip.set_hand_raised"
+ "method": "AsyncMessagingClient.campaigns.requeue"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$voip->setHandRaised"
+ "method": "MessagingClient::campaigns.requeue"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Calls.SetHandRaisedAsync"
+ "method": "MessagingClient.Campaigns.RequeueAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.voip.set_hand_raised"
+ "method": "MessagingClient.campaigns.requeue"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/calls/{id}/leave",
- "operationId": "voipLeaveCall",
- "fingerprint": "3098758e010b2b67c94e38d9dd802bb8fbaddce3793e3dcadd4fb1f3ea615c9e",
+ "path": "/messaging/projects/{projectSlug}/campaigns/{id}/reschedule",
+ "operationId": "rescheduleCampaign",
+ "fingerprint": "001258c5c0ca31068a2bb04e9562e5352a71626ceafeb3bfcf29a55dc8de2f18",
"typescript": {
"status": "covered",
- "method": "MessagingClient.voip.leave"
+ "method": "MessagingClient.campaigns.reschedule"
},
"go": {
"status": "covered",
- "method": "MessagingClient.VoIP.Leave"
+ "method": "MessagingClient.Campaigns.Reschedule"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.voip.leave"
+ "method": "AsyncMessagingClient.campaigns.reschedule"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$voip->leave"
+ "method": "MessagingClient::campaigns.reschedule"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Calls.LeaveAsync"
+ "method": "MessagingClient.Campaigns.RescheduleAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.voip.leave"
+ "method": "MessagingClient.campaigns.reschedule"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/calls/{id}/offer",
- "operationId": "voipOffer",
- "fingerprint": "0cd8d8f8acea545676ca337514027352cf6a25c95485cb1bc9b48bd0943f89c1",
+ "path": "/messaging/projects/{projectSlug}/campaigns/{id}/resume",
+ "operationId": "resumeCampaign",
+ "fingerprint": "a0d7159efbc53dbafaf3c704fd06ccc57247b80b4c0b5e4b683226753074c712",
"typescript": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API"
+ "status": "covered",
+ "method": "MessagingClient.campaigns.resume"
},
"go": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API"
+ "status": "covered",
+ "method": "MessagingClient.Campaigns.Resume"
},
"python": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.campaigns.resume"
},
"php": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient::campaigns.resume"
},
"dotnet": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API"
+ "status": "covered",
+ "method": "MessagingClient.Campaigns.ResumeAsync"
},
"rust": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.campaigns.resume"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/calls/{id}/participants",
- "operationId": "voipAddParticipant",
- "fingerprint": "cf1f53ded35a7c8df3bd3d863540903c533cda2aa5baa6e7f368e7d611a4de35",
+ "path": "/messaging/projects/{projectSlug}/campaigns/{id}/stop",
+ "operationId": "stopCampaign",
+ "fingerprint": "0174a7bd3c86d4cddcf69c4f6d67e516e5565f645393086e7c85e473e74a8bc7",
"typescript": {
"status": "covered",
- "method": "MessagingClient.voip.addParticipant"
+ "method": "MessagingClient.campaigns.stop"
},
"go": {
"status": "covered",
- "method": "MessagingClient.VoIP.AddParticipant"
+ "method": "MessagingClient.Campaigns.Stop"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.voip.add_participant"
+ "method": "AsyncMessagingClient.campaigns.stop"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$voip->addParticipant"
+ "method": "MessagingClient::campaigns.stop"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Calls.AddParticipantAsync"
+ "method": "MessagingClient.Campaigns.StopAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.voip.add_participant"
+ "method": "MessagingClient.campaigns.stop"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/calls/{id}/participants/ring",
- "operationId": "voipRingParticipant",
- "fingerprint": "98ef04a7e338dc1fe3804d51a4e6ceda47d9dd449f54db5c2d07cf2f069573ef",
+ "path": "/messaging/projects/{projectSlug}/campaigns/{id}/test-send",
+ "operationId": "testSendCampaign",
+ "fingerprint": "e6fc48b1545d1d9c39e3823c14f515d53102073932770db96a8f59c38da9dc4e",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.voip.ringParticipant"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.VoIP.RingParticipant"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.voip.ring_participant"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "MessagingClient::$voip->ringParticipant"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Calls.RingParticipantAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.voip.ring_participant"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/calls/{id}/reaction",
- "operationId": "sendCallReaction",
- "fingerprint": "288d00634b38116a3489a390d0a13a788288cbf23b95181109c3d6601c575dd1",
+ "path": "/messaging/projects/{projectSlug}/templates",
+ "operationId": "createProjectTemplate",
+ "fingerprint": "d209be6f9885f6bacd7321f685aa21f991549a00da9f2ec9e332a8f0709bd587",
"typescript": {
"status": "covered",
- "method": "MessagingClient.voip.sendReaction"
+ "method": "MessagingClient.templates.create"
},
"go": {
"status": "covered",
- "method": "MessagingClient.VoIP.SendReaction"
+ "method": "MessagingClient.Templates.Create"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.voip.send_reaction"
+ "method": "AsyncMessagingClient.templates.create"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$voip->sendReaction"
+ "method": "MessagingClient::templates.create"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Calls.SendReactionAsync"
+ "method": "MessagingClient.Templates.CreateAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.voip.send_reaction"
+ "method": "MessagingClient.templates.create"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/calls/{id}/reject",
- "operationId": "voipRejectCall",
- "fingerprint": "2270d0dd85a250d12462468fa70281cd4402d0d01b469220f424f59ff425c93a",
+ "path": "/messaging/projects/{projectSlug}/templates/{id}/preview",
+ "operationId": "previewProjectTemplate",
+ "fingerprint": "e3ab33196b86f058522180695601be6807a5626963efdcfe0dc43997bac19e0f",
"typescript": {
"status": "covered",
- "method": "MessagingClient.voip.reject"
+ "method": "MessagingClient.templates.preview"
},
"go": {
"status": "covered",
- "method": "MessagingClient.VoIP.Reject"
+ "method": "MessagingClient.Templates.Preview"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.voip.reject"
+ "method": "AsyncMessagingClient.templates.preview"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$voip->reject"
+ "method": "MessagingClient::templates.preview"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Calls.RejectAsync"
+ "method": "MessagingClient.Templates.PreviewAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.voip.reject"
+ "method": "MessagingClient.templates.preview"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/calls/{id}/renegotiate",
- "operationId": "voipRenegotiate",
- "fingerprint": "157cf8e9e6d7c24d1918c8e6edda40345df129cc69f2a6b5eee5b619223bde6f",
+ "path": "/messaging/projects/{projectSlug}/templates/{id}/submit",
+ "operationId": "submitProjectTemplateToMeta",
+ "fingerprint": "58ed1a1d23cc43b438f6d25f96ef2e0416c4e2b4089301f408e3529f653de59e",
"typescript": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API"
+ "status": "covered",
+ "method": "MessagingClient.templates.submit"
},
"go": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API"
+ "status": "covered",
+ "method": "MessagingClient.Templates.Submit"
},
"python": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.templates.submit"
},
"php": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient::templates.submit"
},
"dotnet": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API"
+ "status": "covered",
+ "method": "MessagingClient.Templates.SubmitAsync"
},
"rust": {
- "status": "excluded",
- "reason": "used internally by the Calls SDK; not part of the public API",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.templates.submit"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/calls/{id}/reports",
- "operationId": "voipReportCallDiagnostics",
- "fingerprint": "e8f63734877779308e165c3bf2db0c9a73b71db088a740000eb305d285299fd9",
+ "path": "/messaging/quicklinks",
+ "operationId": "createQuickLink",
+ "fingerprint": "f3509fc8698654af371d86c7d373a261ae1082132ca5f5089f4554ce9d821efb",
"typescript": {
"status": "covered",
- "method": "MessagingClient.voip.report"
+ "method": "MessagingClient.quickLinks.create"
},
"go": {
"status": "covered",
- "method": "MessagingClient.VoIP.Report"
+ "method": "MessagingClient.QuickLinks.Create"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.voip.report"
+ "method": "AsyncMessagingClient.quick_links.create"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$voip->report"
+ "method": "MessagingClient::quickLinks.create"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Calls.ReportAsync"
+ "method": "MessagingClient.QuickLinks.CreateAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.voip.report"
+ "method": "MessagingClient.quick_links.create"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/voip/calls/check",
- "operationId": "checkCall",
- "fingerprint": "2ffb20ad498809a8509b9531653e11611123ec8608be5fe3bfca8a1d2809b26a",
+ "path": "/messaging/voip/call-links",
+ "operationId": "voipCreateCallLink",
+ "fingerprint": "0332d266d51891cd13eb43f2897d0c0e1dd6325c4ed2fde20166631d637c59f8",
"typescript": {
"status": "covered",
- "method": "MessagingClient.voip.check"
+ "method": "MessagingClient.voip.createCallLink"
},
"go": {
"status": "covered",
- "method": "MessagingClient.VoIP.Check"
+ "method": "MessagingClient.VoIP.CreateCallLink"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.voip.check"
+ "method": "AsyncMessagingClient.voip.create_call_link"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$voip->check"
+ "method": "MessagingClient::$voip->createCallLink"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Calls.CheckAsync"
+ "method": "MessagingClient.Calls.CreateCallLinkAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.voip.check"
+ "method": "MessagingClient.voip.create_call_link"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/webhooks",
- "operationId": "createWebhook",
- "fingerprint": "0048fb59aabe84ab9f4888e409675a931d02c4fc6aec6aad957459e2592bf45e",
+ "path": "/messaging/voip/call-links/preview",
+ "operationId": "voipPreviewCallLink",
+ "fingerprint": "8b1d5dda0b0565b0a82e5b524d30781644dae2eb74cc5c7bfa55d6f4d7cc331e",
"typescript": {
"status": "covered",
- "method": "MessagingClient.webhooks.create"
+ "method": "MessagingClient.voip.previewCallLink"
},
"go": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "MessagingClient.VoIP.PreviewCallLink"
},
"python": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncMessagingClient.voip.preview_call_link"
},
"php": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "MessagingClient::$voip->previewCallLink"
},
"dotnet": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "MessagingClient.Calls.PreviewCallLinkAsync"
},
"rust": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "MessagingClient.voip.preview_call_link"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/quicklink/{token}/cancel",
- "operationId": "cancelQuickLinkByToken",
- "fingerprint": "01e0c1827929a3a5c5baf2ed7abadf859d36159dc257a20c98df1d9b6f3e2f8b",
+ "path": "/messaging/voip/calls",
+ "operationId": "voipPlaceCall",
+ "fingerprint": "deaad2d57a440d8423c7f55bf2a9dcbcc8537dccb89d7d0ee1209c1ebaea5d34",
"typescript": {
- "status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.voip.place"
},
"go": {
- "status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs."
+ "status": "covered",
+ "method": "MessagingClient.VoIP.Place"
},
"python": {
- "status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "AsyncMessagingClient.voip.place"
},
"php": {
- "status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient::$voip->place"
},
"dotnet": {
- "status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs."
+ "status": "covered",
+ "method": "MessagingClient.Calls.PlaceAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.voip.place"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/quicklink/{token}/cloud",
- "operationId": "completeQuickLinkCloudSignup",
- "fingerprint": "4737cd1a70237a10a2fd46b339cefde693e064644b61e0d2874f8ae2e7060bb1",
+ "path": "/messaging/voip/calls/{id}/accept",
+ "operationId": "voipAcceptCall",
+ "fingerprint": "a496933c4e2b1472eb0ff4100b558e79d68302f506cc511d389641e45e6ac04c",
"typescript": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
+ "status": "covered",
+ "method": "MessagingClient.voip.accept"
},
"go": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
- },
+ "status": "covered",
+ "method": "MessagingClient.VoIP.Accept"
+ },
"python": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.voip.accept"
},
"php": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient::$voip->accept"
},
"dotnet": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
+ "status": "covered",
+ "method": "MessagingClient.Calls.AcceptAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.voip.accept"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/quicklink/{token}/code",
- "operationId": "requestQuickLinkCode",
- "fingerprint": "4760de4a52464d5f9b6c524694dd57798fef13fed80e4be28810021573cbedb9",
+ "path": "/messaging/voip/calls/{id}/candidate",
+ "operationId": "voipCandidate",
+ "fingerprint": "c6fa747907beeaa1d895102c967e34c81f1c633859819cb5d8c849c9da3255d3",
"typescript": {
"status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
- "milestone": "not-server-sdk"
+ "reason": "used internally by the Calls SDK; not part of the public API"
},
"go": {
"status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs."
+ "reason": "used internally by the Calls SDK; not part of the public API"
},
"python": {
"status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
- "milestone": "not-server-sdk"
+ "reason": "used internally by the Calls SDK; not part of the public API",
+ "milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
- "milestone": "not-server-sdk"
+ "reason": "used internally by the Calls SDK; not part of the public API",
+ "milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs."
+ "reason": "used internally by the Calls SDK; not part of the public API"
},
"rust": {
"status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
+ "reason": "used internally by the Calls SDK; not part of the public API",
"milestone": "not-server-sdk"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/quicklink/{token}/confirm",
- "operationId": "confirmQuickLink",
- "fingerprint": "91be047b4af0855599d1e0c80c57511e6e771fb71a5cb33ca3a5bb86b7f91a2b",
+ "path": "/messaging/voip/calls/{id}/hand",
+ "operationId": "setCallHandRaised",
+ "fingerprint": "eff20ed0407a5baacb85e380fbfc4e61f7242af9f699eb0c7e3d23419b1ebc0d",
"typescript": {
- "status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.voip.setHandRaised"
},
"go": {
- "status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs."
+ "status": "covered",
+ "method": "MessagingClient.VoIP.SetHandRaised"
},
"python": {
- "status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "AsyncMessagingClient.voip.set_hand_raised"
},
"php": {
- "status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient::$voip->setHandRaised"
},
"dotnet": {
- "status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs."
+ "status": "covered",
+ "method": "MessagingClient.Calls.SetHandRaisedAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.voip.set_hand_raised"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/quicklink/{token}/connection",
- "operationId": "selectQuickLinkConnection",
- "fingerprint": "c33269e7e8020f5a24d7edea80025c27c6cbd72a8fae197e6a604a40e9f3c92e",
+ "path": "/messaging/voip/calls/{id}/leave",
+ "operationId": "voipLeaveCall",
+ "fingerprint": "977512ec0c7ba8e1a2197095f00e5aa2de5ce5a8e72bf75174af44adf9c02381",
"typescript": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
+ "status": "covered",
+ "method": "MessagingClient.voip.leave"
},
"go": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
+ "status": "covered",
+ "method": "MessagingClient.VoIP.Leave"
},
"python": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.voip.leave"
},
"php": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient::$voip->leave"
},
"dotnet": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
+ "status": "covered",
+ "method": "MessagingClient.Calls.LeaveAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.voip.leave"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/quicklink/{token}/history",
- "operationId": "chooseQuickLinkHistory",
- "fingerprint": "20594daad6f57e8f4ae995f9c56f495850994b37b717bb8652e9ce675634a590",
+ "path": "/messaging/voip/calls/{id}/offer",
+ "operationId": "voipOffer",
+ "fingerprint": "47ad9603654912dab7906e73696cf64a4f17c5996f374a89d80eec25d934731c",
"typescript": {
"status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
+ "reason": "used internally by the Calls SDK; not part of the public API"
},
"go": {
"status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
+ "reason": "used internally by the Calls SDK; not part of the public API"
},
"python": {
"status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "reason": "used internally by the Calls SDK; not part of the public API",
"milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "reason": "used internally by the Calls SDK; not part of the public API",
"milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
+ "reason": "used internally by the Calls SDK; not part of the public API"
},
"rust": {
"status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "reason": "used internally by the Calls SDK; not part of the public API",
"milestone": "not-server-sdk"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/quicklink/{token}/phone",
- "operationId": "confirmQuickLinkPhone",
- "fingerprint": "4a28673d52f6b1a93649c08e94e930e4d6d6b57898b2fd8d7e16200c5221208c",
+ "path": "/messaging/voip/calls/{id}/participants",
+ "operationId": "voipAddParticipant",
+ "fingerprint": "a17541391ef2eb7b3082394bdf0d5ed69e68bcb467068df11a8832ea4dfd8715",
"typescript": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
+ "status": "covered",
+ "method": "MessagingClient.voip.addParticipant"
},
"go": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
+ "status": "covered",
+ "method": "MessagingClient.VoIP.AddParticipant"
},
"python": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.voip.add_participant"
},
"php": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient::$voip->addParticipant"
},
"dotnet": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
+ "status": "covered",
+ "method": "MessagingClient.Calls.AddParticipantAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.voip.add_participant"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/quicklink/{token}/phone/reset",
- "operationId": "resetQuickLinkPhone",
- "fingerprint": "ce13c7b679d3cd62f740ff8231e3f682020d2f86f053a246b489050b22aeecaf",
+ "path": "/messaging/voip/calls/{id}/participants/ring",
+ "operationId": "voipRingParticipant",
+ "fingerprint": "063ee828bdd050a4eda438474e9c514e9c5a23a7aa99ee715eceacc4d2fed854",
"typescript": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
+ "status": "covered",
+ "method": "MessagingClient.voip.ringParticipant"
},
"go": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
+ "status": "covered",
+ "method": "MessagingClient.VoIP.RingParticipant"
},
"python": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.voip.ring_participant"
},
"php": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient::$voip->ringParticipant"
},
"dotnet": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
+ "status": "covered",
+ "method": "MessagingClient.Calls.RingParticipantAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.voip.ring_participant"
}
},
{
"family": "messaging",
"method": "POST",
- "path": "/quicklink/{token}/testing/start",
- "operationId": "startQuickLinkTesting",
- "fingerprint": "efb9ae3ddbd489f92f7db999036740f7a5e8e6a150bada7d6efeec89b140e93d",
+ "path": "/messaging/voip/calls/{id}/reaction",
+ "operationId": "sendCallReaction",
+ "fingerprint": "bfea4d547712af4c4c9868c73a2cb4a01e79592ece3a6018273676ac18a5ff7c",
"typescript": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
+ "status": "covered",
+ "method": "MessagingClient.voip.sendReaction"
},
"go": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
+ "status": "covered",
+ "method": "MessagingClient.VoIP.SendReaction"
},
"python": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.voip.send_reaction"
},
"php": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient::$voip->sendReaction"
},
"dotnet": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
+ "status": "covered",
+ "method": "MessagingClient.Calls.SendReactionAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.voip.send_reaction"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/business/compliance",
- "operationId": "setBusinessMerchantCompliance",
- "fingerprint": "64df26dbfe9b36460499f6d06877c45142c3a9e883efc8f5edaf762a648df1e7",
+ "method": "POST",
+ "path": "/messaging/voip/calls/{id}/reject",
+ "operationId": "voipRejectCall",
+ "fingerprint": "202b9147c2999aca12c33252f4eda206940ac95d74357a2000842a3042375fcc",
"typescript": {
"status": "covered",
- "method": "MessagingClient.business.setMerchantCompliance"
+ "method": "MessagingClient.voip.reject"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Business.SetMerchantCompliance"
+ "method": "MessagingClient.VoIP.Reject"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.business.set_merchant_compliance"
+ "method": "AsyncMessagingClient.voip.reject"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$business->setMerchantCompliance"
+ "method": "MessagingClient::$voip->reject"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Business.SetMerchantComplianceAsync"
+ "method": "MessagingClient.Calls.RejectAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.business.set_merchant_compliance"
+ "method": "MessagingClient.voip.reject"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/business/products/{productId}",
- "operationId": "updateBusinessProduct",
- "fingerprint": "aeb45a2fee2a3901b26406503bf1405a0736779c138e3269cbef0ffba71f8a67",
+ "method": "POST",
+ "path": "/messaging/voip/calls/{id}/renegotiate",
+ "operationId": "voipRenegotiate",
+ "fingerprint": "4a94e93b4c719ce041ad253516c42119d39f6e4553c102ff2a1d9d9b2eb962e5",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.business.updateProduct"
+ "status": "excluded",
+ "reason": "used internally by the Calls SDK; not part of the public API"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Business.UpdateProduct"
+ "status": "excluded",
+ "reason": "used internally by the Calls SDK; not part of the public API"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.business.update_product"
+ "status": "excluded",
+ "reason": "used internally by the Calls SDK; not part of the public API",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "MessagingClient::$business->updateProduct"
+ "status": "excluded",
+ "reason": "used internally by the Calls SDK; not part of the public API",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Business.UpdateProductAsync"
+ "status": "excluded",
+ "reason": "used internally by the Calls SDK; not part of the public API"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.business.update_product"
+ "status": "excluded",
+ "reason": "used internally by the Calls SDK; not part of the public API",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/business/profile/cover-photo",
- "operationId": "setBusinessCoverPhoto",
- "fingerprint": "297c2279ff80cc05662ef86e925dd2a24dd3c22ab230a22fc8f5fc7568d025cc",
+ "method": "POST",
+ "path": "/messaging/voip/calls/{id}/reports",
+ "operationId": "voipReportCallDiagnostics",
+ "fingerprint": "5abac6e723ca83d566b3e942368bd6bca27a5ad210cfcd4731c75490f8c7071e",
"typescript": {
"status": "covered",
- "method": "MessagingClient.business.setCoverPhoto"
+ "method": "MessagingClient.voip.report"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Business.SetCoverPhoto"
+ "method": "MessagingClient.VoIP.Report"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.business.set_cover_photo"
+ "method": "AsyncMessagingClient.voip.report"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$business->setCoverPhoto"
+ "method": "MessagingClient::$voip->report"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Business.SetCoverPhotoAsync"
+ "method": "MessagingClient.Calls.ReportAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.business.set_cover_photo"
+ "method": "MessagingClient.voip.report"
}
},
{
- "family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/business/quick-replies/{quickReplyId}",
- "operationId": "setBusinessQuickReply",
- "fingerprint": "14fa9828983d086730f4b7d20c19951fff496843a0a113280a6a65363e87b982",
"typescript": {
"status": "covered",
- "method": "MessagingClient.quickReplies.replace"
+ "method": "MessagingClient.voip.moderateWaitingRoom"
},
"go": {
"status": "covered",
- "method": "MessagingClient.QuickReplies.Replace"
+ "method": "MessagingClient.VoIP.ModerateWaitingRoom"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.quick_replies.replace"
+ "method": "AsyncMessagingClient.voip.moderate_waiting_room"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$quickReplies->replace"
+ "method": "MessagingClient::$voip->moderateWaitingRoom"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.QuickReplies.ReplaceAsync"
+ "method": "MessagingClient.Calls.ModerateWaitingRoomAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.quick_replies.replace"
- }
+ "method": "MessagingClient.voip.moderate_waiting_room"
+ },
+ "family": "messaging",
+ "method": "POST",
+ "path": "/messaging/voip/calls/{id}/waiting-room",
+ "operationId": "controlCallWaitingRoom",
+ "fingerprint": "0ac31c2dae631ac7a59b681b79391505622433230a25ea82557c52a59d1d48ca"
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/chats/{conversation}/disappearing",
- "operationId": "setChatDisappearingTimer",
- "fingerprint": "70c493613b8a738a20ad71aff2caa076d1c36d4cf58695f9bbd4e96d555bbd3c",
+ "method": "POST",
+ "path": "/messaging/voip/calls/check",
+ "operationId": "checkCall",
+ "fingerprint": "156532f9a32af70c0753d3fb6989db7d2f88949dba1014a2945686f941ceeac5",
"typescript": {
"status": "covered",
- "method": "MessagingClient.chats.setDisappearingTimer"
+ "method": "MessagingClient.voip.check"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Chats.SetDisappearingTimer"
+ "method": "MessagingClient.VoIP.Check"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.chats.set_disappearing_timer"
+ "method": "AsyncMessagingClient.voip.check"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$chats->setDisappearingTimer"
+ "method": "MessagingClient::$voip->check"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Chats.SetDisappearingTimerAsync"
+ "method": "MessagingClient.Calls.CheckAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.chats.set_disappearing_timer"
+ "method": "MessagingClient.voip.check"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/chats/{conversation}/messages/{messageId}",
- "operationId": "editMessage",
- "fingerprint": "56da016a995acb6e9f0d1ed563f58f86a5e73a7704a92b8c9b509b22367fc4ef",
+ "method": "POST",
+ "path": "/messaging/webhooks",
+ "operationId": "createWebhook",
+ "fingerprint": "93c8e5db9df0d784eb2ca5ae8ef01f411f62d071563bcabd878756a2c86b623d",
"typescript": {
"status": "covered",
- "method": "MessagingClient.chats.editMessage"
+ "method": "MessagingClient.webhooks.create",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Chats.EditMessage"
+ "status": "partial",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.chats.edit_message"
+ "status": "partial",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "MessagingClient::$chats->editMessage"
+ "status": "partial",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Chats.EditMessageAsync"
+ "status": "partial",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.chats.edit_message"
+ "status": "partial",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/groups/{id}/description",
- "operationId": "setGroupDescription",
- "fingerprint": "c48137ff98b46b63ad71060d344317313f13e9a690241e6f5b1b4287f47a814b",
+ "method": "POST",
+ "path": "/passkey/verify",
+ "operationId": "verifyExtensionPasskeyTicket",
+ "fingerprint": "58eeca312cfb4336e2def5c8deb2de9fde86bfc6b111ce7ed535017a36431edb",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.groups.setDescription"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetDescription"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.groups.set_description"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.groups.setDescription"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetDescriptionAsync"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.groups.set_description"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/groups/{id}/picture",
- "operationId": "setGroupPicture",
- "fingerprint": "34484c1abbf22a76e7d8a7b39b16fe1691f068d01f4a648d9bd91d366c2ef006",
+ "method": "POST",
+ "path": "/quicklink/{token}/cancel",
+ "operationId": "cancelQuickLinkByToken",
+ "fingerprint": "01e0c1827929a3a5c5baf2ed7abadf859d36159dc257a20c98df1d9b6f3e2f8b",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.groups.setPicture"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetPicture"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs."
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.groups.set_picture"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.groups.setPicture"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetPictureAsync"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.groups.set_picture"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/groups/{id}/settings/info-edit",
- "operationId": "setGroupInfoEditing",
- "fingerprint": "b01ece59af2ffb832a7bc49e9b90efaff6230699e59e0ccd2df44b09a11665c7",
+ "method": "POST",
+ "path": "/quicklink/{token}/cloud",
+ "operationId": "completeQuickLinkCloudSignup",
+ "fingerprint": "4737cd1a70237a10a2fd46b339cefde693e064644b61e0d2874f8ae2e7060bb1",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.groups.setInfoEditing"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetInfoEditing"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.groups.set_info_editing"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.groups.setInfoEditing"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetInfoEditingAsync"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.groups.set_info_editing"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/groups/{id}/settings/join-approval",
- "operationId": "setGroupJoinApproval",
- "fingerprint": "4cf32c4a46fbf59e1754a1bffc93565f46d4bc51b576f3d62e388428108c0f18",
+ "method": "POST",
+ "path": "/quicklink/{token}/code",
+ "operationId": "requestQuickLinkCode",
+ "fingerprint": "4760de4a52464d5f9b6c524694dd57798fef13fed80e4be28810021573cbedb9",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.groups.setJoinApproval"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetJoinApproval"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs."
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.groups.set_join_approval"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.groups.setJoinApproval"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetJoinApprovalAsync"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.groups.set_join_approval"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/groups/{id}/settings/member-add",
- "operationId": "setGroupMemberAddMode",
- "fingerprint": "0b2365d9709c6c67a9c9c2aa8f4e1b7ada45339ec52032aa419b59af5f4fd360",
+ "method": "POST",
+ "path": "/quicklink/{token}/confirm",
+ "operationId": "confirmQuickLink",
+ "fingerprint": "91be047b4af0855599d1e0c80c57511e6e771fb71a5cb33ca3a5bb86b7f91a2b",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.groups.setMemberAddMode"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetMemberAddMode"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs."
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.groups.set_member_add_mode"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.groups.setMemberAddMode"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetMemberAddModeAsync"
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.groups.set_member_add_mode"
- }
+ "status": "excluded",
+ "reason": "Credential-free public QuickLink participant route used only by the hosted QuickLink page, not the SDKs.",
+ "milestone": "not-server-sdk"
+ }
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/groups/{id}/settings/messages",
- "operationId": "setGroupMessaging",
- "fingerprint": "0fb326e00fd3bfeef011068c1622ee6111ec64c43fb3ed5716fb7e160698b96f",
+ "method": "POST",
+ "path": "/quicklink/{token}/history",
+ "operationId": "chooseQuickLinkHistory",
+ "fingerprint": "df1a8a8459d127e264cfddf8270cb47335948d200cee760c0b68e80f2664a355",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.groups.setMessaging"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetMessaging"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.groups.set_messaging"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.groups.setMessaging"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetMessagingAsync"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.groups.set_messaging"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/groups/{id}/subject",
- "operationId": "setGroupSubject",
- "fingerprint": "f62590e61ef4656ac51e9ea12f9bde1d1d26b5d43b6f25d630cdf1a7b61e5985",
+ "method": "POST",
+ "path": "/quicklink/{token}/method",
+ "operationId": "selectQuickLinkMethod",
+ "fingerprint": "66b51c9a3e98900e0d20eecf277e6fc80ab48af802fd062969df1d55760312f4",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.groups.setSubject"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetSubject"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.groups.set_subject"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.groups.setSubject"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Groups.SetSubjectAsync"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.groups.set_subject"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/hybrid-link",
- "operationId": "setHybridLinkPaused",
- "fingerprint": "89e18f5928adb159d29725c14a5a6a67826f45faa1e7a7b778c705297a220386",
+ "method": "POST",
+ "path": "/quicklink/{token}/passkey",
+ "operationId": "submitQuickLinkPasskey",
+ "fingerprint": "d59f704223168e1315f7563690b05f1c88338dcf43075723b4a1478c4d82f557",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.hybridLink.setPaused"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.HybridLink.SetPaused"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.hybrid_link.set_paused"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "MessagingClient::hybridLink.setPaused"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.HybridLink.SetPausedAsync"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.hybrid_link.set_paused"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/labels/{labelId}",
- "operationId": "updateLabel",
- "fingerprint": "955cb30b0255e72a088f8efea4c149ef269f6cc808b888dac3ba62d1bd410c39",
+ "method": "POST",
+ "path": "/quicklink/{token}/passkey/confirmation",
+ "operationId": "confirmQuickLinkPasskey",
+ "fingerprint": "95696ff9a6f73a050923e327d0c7025a9aedfea13801669a66f28373c1132afd",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.labels.update"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Labels.Update"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.labels.update"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.labels.update"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Labels.UpdateAsync"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.labels.update"
+ "status": "excluded",
+ "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/labels/chats/{conversation}",
- "operationId": "setChatLabels",
- "fingerprint": "d9863d52900f6d96421de0458fb92a5c59b944cd0052a713e5af727d88f3f6ee",
+ "method": "POST",
+ "path": "/quicklink/{token}/phone",
+ "operationId": "confirmQuickLinkPhone",
+ "fingerprint": "8e35e3beb7c44e2f1b9959837e8f73c6619c749d13273a19961b2cb7b6b464ed",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.labels.replaceForChat"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Labels.ReplaceForChat"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.labels.replace_for_chat"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.labels.replaceForChat"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Labels.ReplaceForChatAsync"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.labels.replace_for_chat"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/privacy/{setting}",
- "operationId": "setPrivacySetting",
- "fingerprint": "933fb8ec32443b81e58fc16bd3ba024ad8c620c8a3e3f8bc21dd2d7f585d0bc1",
+ "method": "POST",
+ "path": "/quicklink/{token}/phone/reset",
+ "operationId": "resetQuickLinkPhone",
+ "fingerprint": "ce13c7b679d3cd62f740ff8231e3f682020d2f86f053a246b489050b22aeecaf",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.privacy.set"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Privacy.Set"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.privacy.set"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.privacy.set"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Privacy.SetAsync"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.privacy.set"
+ "status": "excluded",
+ "reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/privacy/disappearing/default",
- "operationId": "setDefaultDisappearingTimer",
- "fingerprint": "bcd3b92702cd9e1e469e6f1a06ffe5e13583968b1967f3589fb17ae96a527705",
+ "method": "POST",
+ "path": "/quicklink/{token}/testing/start",
+ "operationId": "startQuickLinkTesting",
+ "fingerprint": "4b8e3769e4037f88945ba9cfc0ca97bffdd6ec35aea6ccfef832a444d42b87de",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.privacy.setDefaultDisappearingTimer"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Privacy.SetDefaultDisappearingTimer"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.privacy.set_default_disappearing_timer"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "MessagingClient.privacy.setDefaultDisappearingTimer"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "MessagingClient.Privacy.SetDefaultDisappearingTimerAsync"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.privacy.set_default_disappearing_timer"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/profile/name",
- "operationId": "setProfileName",
- "fingerprint": "c9502392f378e64532b232a7ae1ff217f96ffacb5502573177cce9e250ea8dd6",
+ "path": "/messaging/{connection}/business/compliance",
+ "operationId": "setBusinessMerchantCompliance",
+ "fingerprint": "f839e2535bc4d8640b1c67c7c1438ad613af16fd4c42f1b3a40bf718c9b0dc2d",
"typescript": {
"status": "covered",
- "method": "MessagingClient.profile.setName"
+ "method": "MessagingClient.business.setMerchantCompliance"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Profile.SetName"
+ "method": "MessagingClient.Business.SetMerchantCompliance"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.profile.set_name"
+ "method": "AsyncMessagingClient.business.set_merchant_compliance"
},
"php": {
"status": "covered",
- "method": "MessagingClient.profile.setName"
+ "method": "MessagingClient::$business->setMerchantCompliance"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Profile.SetNameAsync"
+ "method": "MessagingClient.Business.SetMerchantComplianceAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.profile.set_name"
+ "method": "MessagingClient.business.set_merchant_compliance"
}
},
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/profile/picture",
- "operationId": "setProfilePicture",
- "fingerprint": "4ae4d83b581779b4e6173a3bf25fab05a3653b00154c84a3685b9389d725c146",
+ "path": "/messaging/{connection}/business/products/{productId}",
+ "operationId": "updateBusinessProduct",
+ "fingerprint": "46f9e85c019a6d6c3a7ec034cd4953dbe0748956918e82e09c737fe1857448f3",
"typescript": {
"status": "covered",
- "method": "MessagingClient.profile.setPicture"
+ "method": "MessagingClient.business.updateProduct"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Profile.SetPicture"
+ "method": "MessagingClient.Business.UpdateProduct"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.profile.set_picture"
+ "method": "AsyncMessagingClient.business.update_product"
},
"php": {
"status": "covered",
- "method": "MessagingClient.profile.setPicture"
+ "method": "MessagingClient::$business->updateProduct"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Profile.SetPictureAsync"
+ "method": "MessagingClient.Business.UpdateProductAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.profile.set_picture"
+ "method": "MessagingClient.business.update_product"
}
},
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/profile/status",
- "operationId": "setProfileStatus",
- "fingerprint": "451a61cc0e5f227502f294fd20e7a4bb64f14451443aa9d319c913a620dbd01d",
+ "path": "/messaging/{connection}/business/profile/cover-photo",
+ "operationId": "setBusinessCoverPhoto",
+ "fingerprint": "32d0fd6c11b7c7cfd57d337d8aecece2e5343226e5159ca0283f38ea6d31c1f3",
"typescript": {
"status": "covered",
- "method": "MessagingClient.profile.setStatus"
+ "method": "MessagingClient.business.setCoverPhoto"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Profile.SetStatus"
+ "method": "MessagingClient.Business.SetCoverPhoto"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.profile.set_status"
+ "method": "AsyncMessagingClient.business.set_cover_photo"
},
"php": {
"status": "covered",
- "method": "MessagingClient.profile.setStatus"
+ "method": "MessagingClient::$business->setCoverPhoto"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Profile.SetStatusAsync"
+ "method": "MessagingClient.Business.SetCoverPhotoAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.profile.set_status"
+ "method": "MessagingClient.business.set_cover_photo"
}
},
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/safe-mode",
- "operationId": "updateSessionSafeMode",
- "fingerprint": "a745c6d95c9d6bc9f4e53c802068b4ffdbfd035f2488ef0906b730876966563f",
+ "path": "/messaging/{connection}/business/quick-replies/{quickReplyId}",
+ "operationId": "setBusinessQuickReply",
+ "fingerprint": "14685090ef94392c0381a525a2bc12256fcbbacb61ec6ff54c1771d365fff354",
"typescript": {
"status": "covered",
- "method": "MessagingClient.banSafe.updateSessionSafeMode"
+ "method": "MessagingClient.quickReplies.replace"
},
"go": {
"status": "covered",
- "method": "MessagingClient.BanSafe.UpdateSessionSafeMode"
+ "method": "MessagingClient.QuickReplies.Replace"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.ban_safe.update_session_safe_mode"
+ "method": "AsyncMessagingClient.quick_replies.replace"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$banSafe->updateSessionSafeMode"
+ "method": "MessagingClient::$quickReplies->replace"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.BanSafe.UpdateSessionSafeModeAsync"
+ "method": "MessagingClient.QuickReplies.ReplaceAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.ban_safe.update_session_safe_mode"
+ "method": "MessagingClient.quick_replies.replace"
}
},
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/projects/{projectId}/health-policy",
- "operationId": "updateProjectHealthPolicy",
- "fingerprint": "e044dc69a6f61f3d7d12db5509844d07cbd195a3ef95c74d37547b2103b7bc99",
+ "path": "/messaging/{connection}/chats/{conversation}/disappearing",
+ "operationId": "setChatDisappearingTimer",
+ "fingerprint": "ffb0bcc92d05d9b09f9db29b91da5e25c7f944135921e40aeabf5fb53fef5879",
"typescript": {
"status": "covered",
- "method": "MessagingClient.banSafe.updateProjectHealthPolicy"
+ "method": "MessagingClient.chats.setDisappearingTimer"
},
"go": {
"status": "covered",
- "method": "MessagingClient.BanSafe.UpdateProjectHealthPolicy"
+ "method": "MessagingClient.Chats.SetDisappearingTimer"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.ban_safe.update_project_health_policy"
+ "method": "AsyncMessagingClient.chats.set_disappearing_timer"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$banSafe->updateProjectHealthPolicy"
+ "method": "MessagingClient::$chats->setDisappearingTimer"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.BanSafe.UpdateProjectHealthPolicyAsync"
+ "method": "MessagingClient.Chats.SetDisappearingTimerAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.ban_safe.update_project_health_policy"
+ "method": "MessagingClient.chats.set_disappearing_timer"
}
},
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/projects/{projectId}/insurance-evidence",
- "operationId": "updateProjectInsuranceEvidence",
- "fingerprint": "0e23b9ff2809101212d48adda61d93d837d685543296fe1655945283ed948405",
+ "path": "/messaging/{connection}/chats/{conversation}/messages/{messageId}",
+ "operationId": "editMessage",
+ "fingerprint": "b4373327112c1018cc09c90e09a323ef09953b3a9e6227ea4b2f6aa0b480b1cd",
"typescript": {
"status": "covered",
- "method": "MessagingClient.banSafe.updateProjectInsuranceEvidence"
+ "method": "MessagingClient.chats.editMessage"
},
"go": {
"status": "covered",
- "method": "MessagingClient.BanSafe.UpdateProjectInsuranceEvidence"
+ "method": "MessagingClient.Chats.EditMessage"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.ban_safe.update_project_insurance_evidence"
+ "method": "AsyncMessagingClient.chats.edit_message"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$banSafe->updateProjectInsuranceEvidence"
+ "method": "MessagingClient::$chats->editMessage"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.BanSafe.UpdateProjectInsuranceEvidenceAsync"
+ "method": "MessagingClient.Chats.EditMessageAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.ban_safe.update_project_insurance_evidence"
+ "method": "MessagingClient.chats.edit_message"
}
},
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/projects/{projectId}/safe-mode",
- "operationId": "updateProjectSafeMode",
- "fingerprint": "6801abfc9dc9c3b6397840895759d9d8120a9afccd4215ac5f82e1475740e8c0",
+ "path": "/messaging/{connection}/groups/{id}/description",
+ "operationId": "setGroupDescription",
+ "fingerprint": "8b3033a5f082222af1d30e31139864cfc68c320733c7ad4d7c36863cd4d46749",
"typescript": {
"status": "covered",
- "method": "MessagingClient.banSafe.updateProjectSafeMode"
+ "method": "MessagingClient.groups.setDescription"
},
"go": {
"status": "covered",
- "method": "MessagingClient.BanSafe.UpdateProjectSafeMode"
+ "method": "MessagingClient.Groups.SetDescription"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.ban_safe.update_project_safe_mode"
+ "method": "AsyncMessagingClient.groups.set_description"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$banSafe->updateProjectSafeMode"
+ "method": "MessagingClient.groups.setDescription"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.BanSafe.UpdateProjectSafeModeAsync"
+ "method": "MessagingClient.Groups.SetDescriptionAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.ban_safe.update_project_safe_mode"
+ "method": "MessagingClient.groups.set_description"
}
},
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/projects/{projectId}/warmup-plan",
- "operationId": "updateProjectWarmupPlan",
- "fingerprint": "b2a8a4bf42bef2aff0274b3a1c8accc6dd28a4a1b6316ee3833a94cbcc1ce9c2",
+ "path": "/messaging/{connection}/groups/{id}/picture",
+ "operationId": "setGroupPicture",
+ "fingerprint": "ba7f1bb7edc7b02e82c26f62047dfebd7932e91ab697bcc810df037cb8a968c9",
"typescript": {
"status": "covered",
- "method": "MessagingClient.banSafe.updateProjectWarmupPlan"
+ "method": "MessagingClient.groups.setPicture"
},
"go": {
"status": "covered",
- "method": "MessagingClient.BanSafe.UpdateProjectWarmupPlan"
+ "method": "MessagingClient.Groups.SetPicture"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.ban_safe.update_project_warmup_plan"
+ "method": "AsyncMessagingClient.groups.set_picture"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$banSafe->updateProjectWarmupPlan"
+ "method": "MessagingClient.groups.setPicture"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.BanSafe.UpdateProjectWarmupPlanAsync"
+ "method": "MessagingClient.Groups.SetPictureAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.ban_safe.update_project_warmup_plan"
+ "method": "MessagingClient.groups.set_picture"
}
},
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/routing/hybrid",
- "operationId": "setHybridRoutingPolicy",
- "fingerprint": "170b6b4dd04af74cc57cebc3791d935787a97e33f4ac2a0b9e242e94c45e085c",
+ "path": "/messaging/{connection}/groups/{id}/settings/info-edit",
+ "operationId": "setGroupInfoEditing",
+ "fingerprint": "bc32881e41789a523b74a448c0d60926c9a8b77710f295800774238a9753e5a1",
"typescript": {
"status": "covered",
- "method": "MessagingClient.hybridLink.setPolicy"
+ "method": "MessagingClient.groups.setInfoEditing"
},
"go": {
"status": "covered",
- "method": "MessagingClient.HybridLink.SetPolicy"
+ "method": "MessagingClient.Groups.SetInfoEditing"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.hybrid_link.set_policy"
+ "method": "AsyncMessagingClient.groups.set_info_editing"
},
"php": {
"status": "covered",
- "method": "MessagingClient::hybridLink.setPolicy"
+ "method": "MessagingClient.groups.setInfoEditing"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.HybridLink.SetPolicyAsync"
+ "method": "MessagingClient.Groups.SetInfoEditingAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.hybrid_link.set_policy"
+ "method": "MessagingClient.groups.set_info_editing"
}
},
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/webhooks/{id}",
- "operationId": "updateWebhook",
- "fingerprint": "8959b0a4230ce27a87fbc701f6ab4ca79793cfe194db422fbe2c3ce5aee7a1ef",
+ "path": "/messaging/{connection}/groups/{id}/settings/join-approval",
+ "operationId": "setGroupJoinApproval",
+ "fingerprint": "51a803462f9f0616acbf4b4357f46b6ac26d0d93cace6cfd2fcf782d3758ac7a",
"typescript": {
"status": "covered",
- "method": "MessagingClient.webhooks.update"
+ "method": "MessagingClient.groups.setJoinApproval"
},
"go": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "MessagingClient.Groups.SetJoinApproval"
},
"python": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncMessagingClient.groups.set_join_approval"
},
"php": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "MessagingClient.groups.setJoinApproval"
},
"dotnet": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "MessagingClient.Groups.SetJoinApprovalAsync"
},
"rust": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "MessagingClient.groups.set_join_approval"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/api/account/meta-app",
- "operationId": "revokeTeamMetaApp",
- "fingerprint": "1de38d1a37c94e3598ab62313fcc15d005caac990f78e93032b4b28244c0e83e",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/groups/{id}/settings/member-add",
+ "operationId": "setGroupMemberAddMode",
+ "fingerprint": "34126c6ef77a2394b230de707d7b7b7f6e11919c99806aa7e9d988fe042623c8",
"typescript": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "MessagingClient.groups.setMemberAddMode"
},
"go": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "MessagingClient.Groups.SetMemberAddMode"
},
"python": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.groups.set_member_add_mode"
},
"php": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient.groups.setMemberAddMode"
},
"dotnet": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "MessagingClient.Groups.SetMemberAddModeAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.groups.set_member_add_mode"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/console/auth/factors/{factorId}",
- "operationId": "deleteUserProfileAuthFactor",
- "fingerprint": "aaea3d427d51533564b32a3a0c09b8e985c5686d5a37985cf26d348276bfe007",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/groups/{id}/settings/messages",
+ "operationId": "setGroupMessaging",
+ "fingerprint": "0e5e229e5da3c2e2ae3b3889d04b5e16f0ac31c9cfb0573733d9f7c8bebfed99",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.groups.setMessaging"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Groups.SetMessaging"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.groups.set_messaging"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient.groups.setMessaging"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Groups.SetMessagingAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.groups.set_messaging"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/console/auth/providers/{provider}",
- "operationId": "disconnectProviderUserProfile",
- "fingerprint": "d72362e6dccd856bfea9f6641a3ec2d75582dbf7bd8b614ffd555ae2b0266c96",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/groups/{id}/subject",
+ "operationId": "setGroupSubject",
+ "fingerprint": "9137105fcf62bd727bce5c9e8fd1f567a01e3de17487a586fbfa90f2ec945ab7",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.groups.setSubject"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Groups.SetSubject"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.groups.set_subject"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient.groups.setSubject"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Groups.SetSubjectAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.groups.set_subject"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/console/call-opt-outs/{optOutId}",
- "operationId": "deleteConsoleCallOptOut",
- "fingerprint": "6fe3a8fae4c82c0e7ac90d2531cd0958de57a3acce1488c596127832b3b24b09",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/hybrid-link",
+ "operationId": "setHybridLinkPaused",
+ "fingerprint": "de65dc34a0349a662d4473646276a6f8e58b9635c4a47c82520a9ab4e46fed89",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.hybridLink.setPaused"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.HybridLink.SetPaused"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.hybrid_link.set_paused"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient::hybridLink.setPaused"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.HybridLink.SetPausedAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.hybrid_link.set_paused"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/console/calls/{callId}",
- "operationId": "terminateCall",
- "fingerprint": "d076de824e5b26affd9578c585a4f73cc4fe63cb90102fdf9dfbb5726cf85c0f",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/labels/{labelId}",
+ "operationId": "updateLabel",
+ "fingerprint": "e43f16c899cf73db333bb528cc9e7decfb26464db586d75de2c6e6b2d0bfa023",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.labels.update"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Labels.Update"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.labels.update"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient.labels.update"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Labels.UpdateAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.labels.update"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/console/members/{memberId}",
- "operationId": "deleteMember",
- "fingerprint": "12ae3ac5199298d06b898e726d63f6d2e32953b4f37bd4997c7c8bcee0d7f9a9",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/labels/chats/{conversation}",
+ "operationId": "setChatLabels",
+ "fingerprint": "b45641d6ba73031145dc34a0a017d2721728802cb1662e2a88c8929ca6851f2a",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.labels.replaceForChat"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Labels.ReplaceForChat"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.labels.replace_for_chat"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient.labels.replaceForChat"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Labels.ReplaceForChatAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.labels.replace_for_chat"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/console/team/avatar",
- "operationId": "removeAvatarTeam",
- "fingerprint": "0afa39320cc19be6ef10a22641afaf42381e7ec96801f51c0215f924239c9568",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/official-groups/{group}/picture",
+ "operationId": "setOfficialGroupPicture",
+ "fingerprint": "2df7a0bdd7939df87c0b9336459c0df2922f646b861cc4113c55e39ed009f3aa",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.officialGroups.setPicture"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.OfficialGroups.SetPicture"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.official_groups.set_picture"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient.officialGroups.setPicture"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.OfficialGroups.SetPictureAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.official_groups.set_picture"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/console/profile/avatar",
- "operationId": "removeAvatarUserProfile",
- "fingerprint": "4da888a7fc2dbff835bc98bcd4802e97961addd6eee92bd0d7a11cb715c9f267",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/phone/account-mode",
+ "operationId": "setTestingAccountMode",
+ "fingerprint": "027fc1dc4b29920001dbb141ee99c2462a316dcf3569bac993c9660b4358b330",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/console/quicklink/logo",
- "operationId": "removeLogoQuickLinkSettings",
- "fingerprint": "98a23d28a945fa223b407f5967b44d8a68ba362ca3d649a7f6aa9b9132884852",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/privacy/{setting}",
+ "operationId": "setPrivacySetting",
+ "fingerprint": "9031f9f8a5ef61c256a5c8644d5b30c337ff90fb15c7f5e603edbcf635329629",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.privacy.set"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Privacy.Set"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.privacy.set"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient.privacy.set"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Privacy.SetAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.privacy.set"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/console/sip-trunks/{trunkId}",
- "operationId": "deleteConsoleSipTrunk",
- "fingerprint": "5f0491a3fff3ce9bb38a0eddaa51fb47e9bcfa7dea4416d23e85af288621ea4c",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/privacy/disappearing/default",
+ "operationId": "setDefaultDisappearingTimer",
+ "fingerprint": "53a5ca7ca9dde6cea76282296def711ceedc068b3b42a2e19f9ed0d6830850fb",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.privacy.setDefaultDisappearingTimer"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Privacy.SetDefaultDisappearingTimer"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.privacy.set_default_disappearing_timer"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient.privacy.setDefaultDisappearingTimer"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Privacy.SetDefaultDisappearingTimerAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.privacy.set_default_disappearing_timer"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/console/voice/audio/{assetId}",
- "operationId": "deleteConsoleVoiceAudio",
- "fingerprint": "24d0f5672d296e3ec01200766686f8a75718910f222af41813390aaf39d563b5",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/profile/name",
+ "operationId": "setProfileName",
+ "fingerprint": "67b3b6d40a056cb8d4f9bb2e525653afaddfc8ab00e761ee8c38dce0a6898c4d",
"typescript": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "MessagingClient.profile.setName"
},
"go": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "MessagingClient.Profile.SetName"
},
"python": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.profile.set_name"
},
"php": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient.profile.setName"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "MessagingClient.Profile.SetNameAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.profile.set_name"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/console/voice/provider-credentials/{credentialId}",
- "operationId": "deleteConsoleVoiceProviderCredential",
- "fingerprint": "871bba4e75c36aa3d2a8726a724d393409ee4c7bb761daa8ae3bfa902ce28d7b",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/profile/picture",
+ "operationId": "setProfilePicture",
+ "fingerprint": "c85f4c25b96f2e7195a4f0da6b341ce95172a29509dbef58a9eb08ca680072f4",
"typescript": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "MessagingClient.profile.setPicture"
},
"go": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "MessagingClient.Profile.SetPicture"
},
"python": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.profile.set_picture"
},
"php": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient.profile.setPicture"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "MessagingClient.Profile.SetPictureAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.profile.set_picture"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/console/webhooks/{webhookId}",
- "operationId": "deleteWebhook",
- "fingerprint": "d76f969463dce14c63de7dabe1f917f15736121eb84903deb1f2cac43d85c0b4",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/profile/status",
+ "operationId": "setProfileStatus",
+ "fingerprint": "21cf77f40aa15e3229dc0f848b8e2399127be780aeb08f65e015d7aa256c1d2b",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.profile.setStatus"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Profile.SetStatus"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.profile.set_status"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient.profile.setStatus"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.Profile.SetStatusAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.profile.set_status"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/audiences/{listId}",
- "operationId": "deleteAudience",
- "fingerprint": "295b1d0c97e9a0f2a98fac0005a9108e109352a33b632b69edb895474fdaee5a",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/safe-mode",
+ "operationId": "updateConnectionSafeMode",
+ "fingerprint": "c914a73fd5ac7f67098f18633c3a18dee4865f3a02e3461542f6989551258093",
"typescript": {
"status": "covered",
- "method": "Client.audiences.delete"
+ "method": "MessagingClient.banSafe.updateConnectionSafeMode"
},
"go": {
"status": "covered",
- "method": "TeamClient.Audiences.Delete"
+ "method": "MessagingClient.BanSafe.UpdateConnectionSafeMode"
},
"python": {
"status": "covered",
- "method": "AsyncClient.audiences.delete"
+ "method": "AsyncMessagingClient.ban_safe.update_connection_safe_mode"
},
"php": {
"status": "covered",
- "method": "Client::audiences.delete"
+ "method": "MessagingClient::$banSafe->updateConnectionSafeMode"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Audiences.DeleteAsync"
+ "method": "MessagingClient.BanSafe.UpdateConnectionSafeModeAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.audiences.delete"
+ "method": "MessagingClient.ban_safe.update_connection_safe_mode"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/audiences/{listId}/members/{phone}",
- "operationId": "deleteAudienceMember",
- "fingerprint": "1f306813b98d4a00e4ae3d8f41bb86dc2a3b1a2be5fc8e29f53ae7018e681780",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/{connection}/stickers/favorite",
+ "operationId": "setStickerFavorite",
+ "fingerprint": "9cf362ee3e17cf46d63c6ea79e190f27acc0aabb4c41d58a778eda725fdd14e8",
"typescript": {
- "status": "covered",
- "method": "Client.audiences.deleteMember"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Audiences.DeleteMember"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.audiences.delete_member"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "Client::audiences.deleteMember"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Audiences.DeleteMemberAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.audiences.delete_member"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/call-opt-outs/{optOutId}",
- "operationId": "deleteCallOptOut",
- "fingerprint": "6b89feece728770953f00bee10e370d15c50f90812d901b939b6d7ec48e41619",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/projects/{projectId}/health-policy",
+ "operationId": "updateProjectHealthPolicy",
+ "fingerprint": "e29bc8bb070a3f95fc08c6220e0d088eb70dde226d04d5ce12d159338f8868f4",
"typescript": {
"status": "covered",
- "method": "Client.callOptOuts.delete"
+ "method": "MessagingClient.banSafe.updateProjectHealthPolicy"
},
"go": {
"status": "covered",
- "method": "TeamClient.CallOptOuts.Delete"
+ "method": "MessagingClient.BanSafe.UpdateProjectHealthPolicy"
},
"python": {
"status": "covered",
- "method": "AsyncClient.call_opt_outs.delete"
+ "method": "AsyncMessagingClient.ban_safe.update_project_health_policy"
},
"php": {
"status": "covered",
- "method": "Client::callOptOuts.delete"
+ "method": "MessagingClient::$banSafe->updateProjectHealthPolicy"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.CallOptOuts.DeleteAsync"
+ "method": "MessagingClient.BanSafe.UpdateProjectHealthPolicyAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.call_opt_outs.delete"
+ "method": "MessagingClient.ban_safe.update_project_health_policy"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/campaigns/{campaignId}",
- "operationId": "deleteCampaign",
- "fingerprint": "a2bf6c724c51911784ed1d5873d2bb6f80602dde56806fdb6de431fbb2d30ffd",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/projects/{projectId}/insurance-evidence",
+ "operationId": "updateProjectInsuranceEvidence",
+ "fingerprint": "fe68dfcf92437463ab598b1f31bd4c24227528145e4356f4e0babf4442454d0c",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.delete"
+ "method": "MessagingClient.banSafe.updateProjectInsuranceEvidence"
},
"go": {
"status": "covered",
- "method": "TeamClient.Campaigns.Delete"
+ "method": "MessagingClient.BanSafe.UpdateProjectInsuranceEvidence"
},
"python": {
"status": "covered",
- "method": "AsyncClient.campaigns.delete"
+ "method": "AsyncMessagingClient.ban_safe.update_project_insurance_evidence"
},
"php": {
"status": "covered",
- "method": "Client::campaigns.delete"
+ "method": "MessagingClient::$banSafe->updateProjectInsuranceEvidence"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Campaigns.DeleteAsync"
+ "method": "MessagingClient.BanSafe.UpdateProjectInsuranceEvidenceAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.campaigns.delete"
+ "method": "MessagingClient.ban_safe.update_project_insurance_evidence"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/customers/{customerId}/pairing-links/{pairingLinkId}",
- "operationId": "revokeCustomerPairingLink",
- "fingerprint": "6b5001dcaf42b64f67572f564c52920a4875667ff1cc776fd83de92749761b51",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/projects/{projectId}/safe-mode",
+ "operationId": "updateProjectSafeMode",
+ "fingerprint": "a0866cfde9325072ed2eef14cb51c458529c1e9a6e0f4fba114f4f435b07201f",
"typescript": {
"status": "covered",
- "method": "Client.customers.revokePairingLink"
+ "method": "MessagingClient.banSafe.updateProjectSafeMode"
},
"go": {
"status": "covered",
- "method": "TeamClient.Customers.RevokePairingLink"
+ "method": "MessagingClient.BanSafe.UpdateProjectSafeMode"
},
"python": {
"status": "covered",
- "method": "AsyncClient.customers.revoke_pairing_link"
+ "method": "AsyncMessagingClient.ban_safe.update_project_safe_mode"
},
"php": {
"status": "covered",
- "method": "Client::customers.revokePairingLink"
+ "method": "MessagingClient::$banSafe->updateProjectSafeMode"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Customers.RevokePairingLinkAsync"
+ "method": "MessagingClient.BanSafe.UpdateProjectSafeModeAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.customers.revoke_pairing_link"
+ "method": "MessagingClient.ban_safe.update_project_safe_mode"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/flows/{flowId}",
- "operationId": "deleteFlow",
- "fingerprint": "ffc069696f54fda7549a689fcbdec9dc74cd8270e37c66a0a822f36eab360556",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/projects/{projectId}/warmup-plan",
+ "operationId": "updateProjectWarmupPlan",
+ "fingerprint": "cf11dcf463a0c074c5bd034ffff84ee04c367a6da75a27188738b5f3610a2211",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).flows.delete"
+ "method": "MessagingClient.banSafe.updateProjectWarmupPlan"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Flows.Delete"
+ "method": "MessagingClient.BanSafe.UpdateProjectWarmupPlan"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.flows.delete"
+ "method": "AsyncMessagingClient.ban_safe.update_project_warmup_plan"
},
"php": {
"status": "covered",
- "method": "ProjectClient::flows.delete"
+ "method": "MessagingClient::$banSafe->updateProjectWarmupPlan"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Flows.DeleteAsync"
+ "method": "MessagingClient.BanSafe.UpdateProjectWarmupPlanAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.flows.delete"
+ "method": "MessagingClient.ban_safe.update_project_warmup_plan"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/flows/{flowId}/endpoint",
- "operationId": "deleteFlowEndpoint",
- "fingerprint": "67f4bd12559223fa95d755162046b048ef3c4109c83dc1abf6c2cc5beb9b60dd",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/projects/{projectSlug}/campaigns/{id}/reply-flow",
+ "operationId": "setCampaignReplyFlow",
+ "fingerprint": "f62689539f841b5e9c995ccbcbd26e2dec01ddca06319d189a4cf7d3cfbc2351",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).flows.deleteEndpoint"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Flows.DeleteEndpoint"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.flows.delete_endpoint"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::flows.deleteEndpoint"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Flows.DeleteEndpointAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.flows.delete_endpoint"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/functions/{functionId}",
- "operationId": "deleteFunction",
- "fingerprint": "af3cbeb41b8e0bd00517939256e97025ff98a0299e28730d9dfca06204d16f52",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/routing/hybrid",
+ "operationId": "setHybridRoutingPolicy",
+ "fingerprint": "44abb4c494b94389ec183dfd4195387305eeacffbb730d80a54eac6b40d18e65",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).functions.delete"
+ "method": "MessagingClient.hybridLink.setPolicy"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Functions.Delete"
+ "method": "MessagingClient.HybridLink.SetPolicy"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.functions.delete"
+ "method": "AsyncMessagingClient.hybrid_link.set_policy"
},
"php": {
"status": "covered",
- "method": "ProjectClient::functions.delete"
+ "method": "MessagingClient::hybridLink.setPolicy"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Functions.DeleteAsync"
+ "method": "MessagingClient.HybridLink.SetPolicyAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.functions.delete"
+ "method": "MessagingClient.hybrid_link.set_policy"
}
},
{
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/functions/{functionId}/secrets/{versionId}",
- "operationId": "deleteFunctionSecret",
- "fingerprint": "62a2309673aea98231c17ee384d152e2ce3ccaf467f669b8eb1759f9d86c37d8",
+ "family": "messaging",
+ "method": "PUT",
+ "path": "/messaging/webhooks/{id}",
+ "operationId": "updateWebhook",
+ "fingerprint": "d245895295d6b0ca568f686596a9d9c7a5630174706d3d189b31abd54ecf6ce9",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).functions.secrets.revoke"
+ "method": "MessagingClient.webhooks.update",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Functions.Secrets.Revoke"
+ "status": "partial",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.functions.secrets.revoke"
+ "status": "partial",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::functions.secrets.revoke"
+ "status": "partial",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Functions.Secrets.RevokeAsync"
+ "status": "partial",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.functions.secrets.revoke"
+ "status": "partial",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
"method": "DELETE",
- "path": "/platform/media/{mediaId}",
- "operationId": "deleteMedia",
- "fingerprint": "5761e4e7fa4397a95605cfc355c9c8b4aa39734b21bda2d4a4ba4047d3e3d010",
+ "path": "/api/account/meta-app",
+ "operationId": "revokeTeamMetaApp",
+ "fingerprint": "1de38d1a37c94e3598ab62313fcc15d005caac990f78e93032b4b28244c0e83e",
"typescript": {
- "status": "covered",
- "method": "Client.media.delete"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Media.Delete"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.media.delete"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::media.delete"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Media.DeleteAsync"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.media.delete"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "DELETE",
- "path": "/platform/optouts/{phone}",
- "operationId": "deleteOptOut",
- "fingerprint": "39841fdbc2b41877d95d4ed6328b6ff1d350b1fe14f3b56a2d72d48d3d67c3c9",
+ "path": "/console/auth/factors/{factorId}",
+ "operationId": "deleteUserProfileAuthFactor",
+ "fingerprint": "aaea3d427d51533564b32a3a0c09b8e985c5686d5a37985cf26d348276bfe007",
"typescript": {
- "status": "covered",
- "method": "Client.optOuts.delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.OptOuts.Delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.opt_outs.delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::optOuts.delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.OptOuts.DeleteAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.opt_outs.delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "DELETE",
- "path": "/platform/projects/{projectId}/webhooks/{webhookId}",
- "operationId": "deleteProjectWebhook",
- "fingerprint": "fc02b96f57259e05bd2257f172c561ab4d2d2002b79825988e04e59b6d05320d",
+ "path": "/console/auth/providers/{provider}",
+ "operationId": "disconnectProviderUserProfile",
+ "fingerprint": "d72362e6dccd856bfea9f6641a3ec2d75582dbf7bd8b614ffd555ae2b0266c96",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).webhooks.delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Webhooks.Delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.webhooks.delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::webhooks.delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Webhooks.DeleteAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.webhooks.delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "DELETE",
- "path": "/platform/sessions/{session}/client-rules",
- "operationId": "deleteClientRules",
- "fingerprint": "c8c8fda3d51d3fbc335f57a9130e5d57363613718ed9966506573a99bc714810",
+ "path": "/console/call-opt-outs/{optOutId}",
+ "operationId": "deleteConsoleCallOptOut",
+ "fingerprint": "6fe3a8fae4c82c0e7ac90d2531cd0958de57a3acce1488c596127832b3b24b09",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.clientTokens.deleteRules"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "MessagingClient.ClientTokens.DeleteRules"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.client_tokens.delete_rules"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "MessagingClient::$clientTokens->deleteRules"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.ClientTokens.DeleteRulesAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.client_tokens.delete_rules"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "DELETE",
- "path": "/platform/sessions/{sessionId}",
- "operationId": "deletePlatformSession",
- "fingerprint": "7ca2a507cff0858f9ab1e2cfb254312c591534a533159f38e34a4d13a303837a",
+ "path": "/console/calls/{callId}",
+ "operationId": "terminateCall",
+ "fingerprint": "d076de824e5b26affd9578c585a4f73cc4fe63cb90102fdf9dfbb5726cf85c0f",
"typescript": {
- "status": "covered",
- "method": "Client.sessions.delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Sessions.Delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.sessions.delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::sessions.delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Sessions.DeleteAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.sessions.delete"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "DELETE",
- "path": "/platform/sip-trunks/{trunkId}",
- "operationId": "deleteSipTrunk",
- "fingerprint": "ad0da63a9acd1d207ec3d06a189ff74659a334030115c486678a0f5895bf5779",
+ "path": "/console/keys/{keyId}",
+ "operationId": "deactivateApiKey",
+ "fingerprint": "a877c66fc0828c659a860826c6e993bb955ec42ffbcf9b474032aed714aaad08",
"typescript": {
- "status": "covered",
- "method": "Client.sipTrunks.delete"
+ "status": "excluded",
+ "reason": "Moved from DELETE /platform/keys/{keyId} to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "TeamClient.SIPTrunks.Delete"
+ "status": "excluded",
+ "reason": "Moved from DELETE /platform/keys/{keyId} to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.sip_trunks.delete"
+ "status": "excluded",
+ "reason": "Moved from DELETE /platform/keys/{keyId} to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "Client::sipTrunks.delete"
+ "status": "excluded",
+ "reason": "Moved from DELETE /platform/keys/{keyId} to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.SipTrunks.DeleteAsync"
+ "status": "excluded",
+ "reason": "Moved from DELETE /platform/keys/{keyId} to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.sip_trunks.delete"
+ "status": "excluded",
+ "reason": "Moved from DELETE /platform/keys/{keyId} to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "DELETE",
- "path": "/platform/templates/{templateId}",
- "operationId": "deleteMessageTemplate",
- "fingerprint": "f58df23aaca586f433553c7c96777b81d0b75dcbe46539db6f4d17e91a7dfda8",
+ "path": "/console/members/{memberId}",
+ "operationId": "deleteMember",
+ "fingerprint": "12ae3ac5199298d06b898e726d63f6d2e32953b4f37bd4997c7c8bcee0d7f9a9",
"typescript": {
"status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
- },
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
+ },
"php": {
"status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
- }
- },
- {
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/voice/audio/{assetId}",
- "operationId": "deleteVoiceAudio",
- "fingerprint": "923dcc9994d2bd773e5a77b7695f7e06ccaa1032c0c819744e406702175922a8",
- "typescript": {
- "status": "covered",
- "method": "Client.voice.audio.delete"
- },
- "go": {
- "status": "covered",
- "method": "TeamClient.Voice.Audio.Delete"
- },
- "python": {
- "status": "covered",
- "method": "AsyncClient.voice.audio.delete"
- },
- "php": {
- "status": "covered",
- "method": "Client::voice.audio.delete"
- },
- "dotnet": {
- "status": "covered",
- "method": "TeamClient.Voice.Audio.DeleteAsync"
- },
- "rust": {
- "status": "covered",
- "method": "TeamClient.voice.audio.delete"
- }
- },
- {
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/voice/provider-credentials/{credentialId}",
- "operationId": "deleteVoiceProviderCredential",
- "fingerprint": "8382eef354f1956b245e0b87378b9eeb85412bd0fa273ac9ac027e2513356dcd",
- "typescript": {
- "status": "covered",
- "method": "Client.voice.providerCredentials.delete"
- },
- "go": {
- "status": "covered",
- "method": "TeamClient.Voice.ProviderCredentials.Delete"
- },
- "python": {
- "status": "covered",
- "method": "AsyncClient.voice.provider_credentials.delete"
- },
- "php": {
- "status": "covered",
- "method": "Client::voice.providerCredentials.delete"
- },
- "dotnet": {
- "status": "covered",
- "method": "TeamClient.Voice.ProviderCredentials.DeleteAsync"
- },
- "rust": {
- "status": "covered",
- "method": "TeamClient.voice.provider_credentials.delete"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "DELETE",
- "path": "/platform/webhooks/{webhookId}",
- "operationId": "deleteTeamWebhook",
- "fingerprint": "d9072f39f779290faa072cc2eddd63fa4daeaccbb8bc1c0e9870db6b33333061",
- "typescript": {
- "status": "covered",
- "method": "Client.webhooks.delete"
- },
- "go": {
- "status": "covered",
- "method": "TeamClient.Webhooks.Delete"
- },
- "python": {
- "status": "covered",
- "method": "AsyncClient.webhooks.delete"
- },
- "php": {
- "status": "covered",
- "method": "Client::webhooks.delete"
- },
- "dotnet": {
- "status": "covered",
- "method": "TeamClient.Webhooks.DeleteAsync"
- },
- "rust": {
- "status": "covered",
- "method": "TeamClient.webhooks.delete"
- }
- },
- {
- "family": "platform",
- "method": "GET",
- "path": "/api/account/cloud-health",
- "operationId": "getAccountCloudHealth",
- "fingerprint": "0ebba7bb1af575364cc71667e7d2e167dc03c60729902b0cb298d17ad1cacf89",
+ "path": "/console/profile/avatar",
+ "operationId": "removeAvatarUserProfile",
+ "fingerprint": "4da888a7fc2dbff835bc98bcd4802e97961addd6eee92bd0d7a11cb715c9f267",
"typescript": {
"status": "excluded",
- "reason": "Console-only redacted account health requires dashboard identity; not available to SDK credentials."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Console-only redacted account health requires dashboard identity; not available to SDK credentials."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Console-only redacted account health requires dashboard identity; not available to SDK credentials.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Console-only redacted account health requires dashboard identity; not available to SDK credentials.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only redacted account health requires dashboard identity; not available to SDK credentials."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Console-only redacted account health requires dashboard identity; not available to SDK credentials.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/api/account/cloud-health/export",
- "operationId": "exportAccountCloudHealth",
- "fingerprint": "9e02b8190c246878a88cea9dbcb22f3c4ca65591c9ebe26e9c61a3da22b273aa",
+ "method": "DELETE",
+ "path": "/console/projects/{projectId}/regional-data/access/{accessId}",
+ "operationId": "revokeRegionalDataAccess",
+ "fingerprint": "0d00bd6f062112ed258de365d0be1bb6689397c4f98a8029e2e78471a5e83f9c",
"typescript": {
"status": "excluded",
- "reason": "Console-only redacted account health export requires dashboard identity; not available to SDK credentials."
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
"status": "excluded",
- "reason": "Console-only redacted account health export requires dashboard identity; not available to SDK credentials."
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
"status": "excluded",
- "reason": "Console-only redacted account health export requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
"status": "excluded",
- "reason": "Console-only redacted account health export requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only redacted account health export requires dashboard identity; not available to SDK credentials."
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
"status": "excluded",
- "reason": "Console-only redacted account health export requires dashboard identity; not available to SDK credentials.",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/api/account/meta-app",
- "operationId": "getTeamMetaApp",
- "fingerprint": "ddf2db2a91596fdb6fb8bd1d1951eefa43dfad45ea220967c1847d163cae2208",
+ "method": "DELETE",
+ "path": "/console/quicklink/logo",
+ "operationId": "removeLogoQuickLinkSettings",
+ "fingerprint": "98a23d28a945fa223b407f5967b44d8a68ba362ca3d649a7f6aa9b9132884852",
"typescript": {
"status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/audit",
- "operationId": "getConsoleAuditLogs",
- "fingerprint": "3b120461e715a916bf67b2f5254f6c3f6b6ccf5c9b84380707fc1f305eca42f7",
+ "method": "DELETE",
+ "path": "/console/sip-trunks/{trunkId}",
+ "operationId": "deleteConsoleSipTrunk",
+ "fingerprint": "5f0491a3fff3ce9bb38a0eddaa51fb47e9bcfa7dea4416d23e85af288621ea4c",
"typescript": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/auth/methods",
- "operationId": "getUserProfileAuthMethods",
- "fingerprint": "b762ccf12f9f8c051e898fc20d6c229ca31a6cd887b5b29cba14a2482d567632",
+ "method": "DELETE",
+ "path": "/console/team/avatar",
+ "operationId": "removeAvatarTeam",
+ "fingerprint": "0afa39320cc19be6ef10a22641afaf42381e7ec96801f51c0215f924239c9568",
"typescript": {
"status": "excluded",
"reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
@@ -8121,78 +8765,78 @@
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/auth/providers",
- "operationId": "getUserProfileProviderConnectionUrl",
- "fingerprint": "488f7c8bf4ee6a05a9f01b31f641fa9bc85a4e9e8505f765ce1ae2558fa2aee4",
+ "method": "DELETE",
+ "path": "/console/voice/audio/{assetId}",
+ "operationId": "deleteConsoleVoiceAudio",
+ "fingerprint": "24d0f5672d296e3ec01200766686f8a75718910f222af41813390aaf39d563b5",
"typescript": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"go": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"python": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
"milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
"milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"rust": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/call-opt-outs",
- "operationId": "listConsoleCallOptOuts",
- "fingerprint": "5a97a7ca27627b4780d92d07d9f9d35bc32de5b092180dbce6372a0b18cc1885",
+ "method": "DELETE",
+ "path": "/console/voice/provider-credentials/{credentialId}",
+ "operationId": "deleteConsoleVoiceProviderCredential",
+ "fingerprint": "871bba4e75c36aa3d2a8726a724d393409ee4c7bb761daa8ae3bfa902ce28d7b",
"typescript": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"go": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"python": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
"milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
"milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"rust": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/call-policy",
- "operationId": "getConsoleCallPolicy",
- "fingerprint": "c9e607b1c85d1c68c7908beb835edc72a3c975b9ceb759f76101049593d8d87e",
+ "method": "DELETE",
+ "path": "/console/webhooks/{webhookId}",
+ "operationId": "deleteWebhook",
+ "fingerprint": "d76f969463dce14c63de7dabe1f917f15736121eb84903deb1f2cac43d85c0b4",
"typescript": {
"status": "excluded",
"reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
@@ -8223,1030 +8867,986 @@
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/call-retention",
- "operationId": "getTeamCallRetention",
- "fingerprint": "7c17cb354c82949b3e7d25ce0b58c8cec26c3e1b4d186bebf50732d8b2093cfe",
+ "method": "DELETE",
+ "path": "/platform/audience-profile-imports/{jobId}",
+ "operationId": "cancelAudienceProfileImport",
+ "fingerprint": "f7bb8a60d4caa59ac19f47ce496129c397fdee705d7c0e07cbfeaebfe4b0a3b7",
"typescript": {
- "status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method.",
- "milestone": "excluded-contract"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method.",
- "milestone": "excluded-contract"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method.",
- "milestone": "not-server-sdk"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/call-settings/{sessionId}",
- "operationId": "getSessionCallSettings",
- "fingerprint": "e3fd00c808e941a2c672c60a071552e611d817476d001a5118795caeee7f93a4",
+ "method": "DELETE",
+ "path": "/platform/audience-profiles/{phone}",
+ "operationId": "deleteAudienceProfile",
+ "fingerprint": "3baf1e380e2b9092315000a17daba39826cbf30514326a03b80c0f4332372855",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/calls",
- "operationId": "listCalls",
- "fingerprint": "507de2a3911b7dfb347cd5fdcac62c3c6fadc5db0edf55a1e274721cc35851a1",
+ "method": "DELETE",
+ "path": "/platform/audience-segments/{segmentId}",
+ "operationId": "deleteAudienceSegment",
+ "fingerprint": "a02ed13e77da026ef0402df1ef32376297afc606a04baedca4744a756b805e25",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.audienceSegments.delete"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.AudienceSegments().Delete"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.audience_segments.delete"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::audienceSegments.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.AudienceSegments.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.audience_segments().delete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/calls/{callId}",
- "operationId": "getCall",
- "fingerprint": "bccb9a382bbfa1128144debddea5630baa924e2baf8c789d073e9bcc9d5e9589",
+ "method": "DELETE",
+ "path": "/platform/audiences/{listId}",
+ "operationId": "deleteAudience",
+ "fingerprint": "295b1d0c97e9a0f2a98fac0005a9108e109352a33b632b69edb895474fdaee5a",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.audiences.delete"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Audiences.Delete"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.audiences.delete"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::audiences.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Audiences.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.audiences.delete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/deployments",
- "operationId": "listDeployments",
- "fingerprint": "11fa9f7d182bee769f344bf735ab4903e0b0cb040a133336d7f49431ff2938fa",
+ "method": "DELETE",
+ "path": "/platform/audiences/{listId}/members/{phone}",
+ "operationId": "deleteAudienceMember",
+ "fingerprint": "1f306813b98d4a00e4ae3d8f41bb86dc2a3b1a2be5fc8e29f53ae7018e681780",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.audiences.deleteMember"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Audiences.DeleteMember"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.audiences.delete_member"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::audiences.deleteMember"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Audiences.DeleteMemberAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.audiences.delete_member"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/insights/analytics",
- "operationId": "analyticsInsight",
- "fingerprint": "7834b3e6cd337016d555f7e4eafc140b2028ff4546deed080677c832d1163732",
+ "method": "DELETE",
+ "path": "/platform/call-opt-outs/{optOutId}",
+ "operationId": "deleteCallOptOut",
+ "fingerprint": "a04af77a44b0e6f18d5fec53c9893ced93e2f5e4325df1107c2e1e07ee579592",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.callOptOuts.delete"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.CallOptOuts.Delete"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.call_opt_outs.delete"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::callOptOuts.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.CallOptOuts.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.call_opt_outs.delete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/insights/log-calendar",
- "operationId": "getLogCalendar",
- "fingerprint": "89880747a6f4d5054db4196753faa76c56cbdaa58b042d44281830ed35aa9fb1",
+ "method": "DELETE",
+ "path": "/platform/campaigns/{campaignId}",
+ "operationId": "deleteCampaign",
+ "fingerprint": "a2bf6c724c51911784ed1d5873d2bb6f80602dde56806fdb6de431fbb2d30ffd",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "Client.campaigns.delete"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.Delete"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.campaigns.delete"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::campaigns.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.campaigns.delete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/insights/logs",
- "operationId": "logsInsight",
- "fingerprint": "fec2830eec8d926385073280cfcc70343b3ca91969babbeb3e3bd2aff373445e",
+ "method": "DELETE",
+ "path": "/platform/connections/{connection}/client-rules",
+ "operationId": "deleteClientRules",
+ "fingerprint": "5e7becb16c29e4f4fb335d870f7c16c45d449c1993f749563b944fdfc9c6ebfa",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.clientTokens.deleteRules"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "MessagingClient.ClientTokens.DeleteRules"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncMessagingClient.client_tokens.delete_rules"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "MessagingClient::$clientTokens->deleteRules"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.ClientTokens.DeleteRulesAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.client_tokens.delete_rules"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/insights/number-options",
- "operationId": "listConsoleNumberOptions",
- "fingerprint": "8d1ae13c7dd9e3d5f6b2cff94779d58ad256fc57a6669e25e24688467a35b3c7",
+ "method": "DELETE",
+ "path": "/platform/connections/{connectionId}",
+ "operationId": "deletePlatformConnection",
+ "fingerprint": "f3b22984cddfa246d5352921f8956936847e38dface7525810b5d9b8bb2dc4e2",
"typescript": {
- "status": "excluded",
- "reason": "Private Console selector requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "Client.connections.delete"
},
"go": {
- "status": "excluded",
- "reason": "Private Console selector requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "TeamClient.Connections.Delete"
},
"python": {
- "status": "excluded",
- "reason": "Private Console selector requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.connections.delete"
},
"php": {
- "status": "excluded",
- "reason": "Private Console selector requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::connections.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Private Console selector requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "TeamClient.Connections.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Private Console selector requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "MessagingClient.connections.delete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/insights/preferences",
- "operationId": "getInsightPreferences",
- "fingerprint": "1030cd6f5db78977173f52e388c8455b43eeeae65ccc93f12b793c052d1d57be",
+ "method": "DELETE",
+ "path": "/platform/customers/{customerId}/pairing-links/{pairingLinkId}",
+ "operationId": "revokeCustomerPairingLink",
+ "fingerprint": "ce87f370902543f6f83b0e0ad79006aa62f599e81e527f406806ca4492d1eb02",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.customers.revokePairingLink"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Customers.RevokePairingLink"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.customers.revoke_pairing_link"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::customers.revokePairingLink"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Customers.RevokePairingLinkAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.customers.revoke_pairing_link"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/insights/usage",
- "operationId": "usageInsight",
- "fingerprint": "6ca3fdcc1b9fee8f6b32566ab86ec0934425e1ab86ddbea4444d60fa907dddba",
+ "method": "DELETE",
+ "path": "/platform/flows/{flowId}",
+ "operationId": "deleteFlow",
+ "fingerprint": "ffc069696f54fda7549a689fcbdec9dc74cd8270e37c66a0a822f36eab360556",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).flows.delete"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Flows.Delete"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.flows.delete"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "ProjectClient::flows.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Flows.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.flows.delete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/notifications",
- "operationId": "listNotificationInbox",
- "fingerprint": "621ec78b7bd2fcc2e0980d8cf46d15c4eec41a269fc612194668c817117a4572",
+ "method": "DELETE",
+ "path": "/platform/flows/{flowId}/endpoint",
+ "operationId": "deleteFlowEndpoint",
+ "fingerprint": "72220fc0547dd1f99dc647a9ee97827b0f109fb856c617570c29263fc8e9843c",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).flows.deleteEndpoint"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Flows.DeleteEndpoint"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.flows.delete_endpoint"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "ProjectClient::flows.deleteEndpoint"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Flows.DeleteEndpointAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.flows.delete_endpoint"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/notifications/archived",
- "operationId": "listNotificationArchived",
- "fingerprint": "c4eef9aea9b392a5cf6622a6af1f75e39ee5d3892b2aff3f4918d2b2d8d81f73",
+ "method": "DELETE",
+ "path": "/platform/functions/{functionId}",
+ "operationId": "deleteFunction",
+ "fingerprint": "af3cbeb41b8e0bd00517939256e97025ff98a0299e28730d9dfca06204d16f52",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).functions.delete"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Functions.Delete"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.functions.delete"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "ProjectClient::functions.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Functions.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.functions.delete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/notifications/count",
- "operationId": "unreadCountNotification",
- "fingerprint": "cdf2e84afa4056c0eb47691d92e76b19d9c55735fd25c6ef048fa4e14fdc2876",
+ "method": "DELETE",
+ "path": "/platform/functions/{functionId}/secrets/{versionId}",
+ "operationId": "deleteFunctionSecret",
+ "fingerprint": "62a2309673aea98231c17ee384d152e2ce3ccaf467f669b8eb1759f9d86c37d8",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).functions.secrets.revoke"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Functions.Secrets.Revoke"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.functions.secrets.revoke"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "ProjectClient::functions.secrets.revoke"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Functions.Secrets.RevokeAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.functions.secrets.revoke"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/notifications/preferences",
- "operationId": "getNotificationPreferences",
- "fingerprint": "a25d37d05368813e99e64db82b3d738a2a4741c77698472fa77ec42779bac33d",
+ "method": "DELETE",
+ "path": "/platform/media/{mediaId}",
+ "operationId": "deleteMedia",
+ "fingerprint": "5761e4e7fa4397a95605cfc355c9c8b4aa39734b21bda2d4a4ba4047d3e3d010",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.media.delete"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Media.Delete"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.media.delete"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::media.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Media.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.media.delete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/teams/{slug}",
- "operationId": "getTeamBySlug",
- "fingerprint": "4926a43b92d9882976ee1ced2424c5309734a84dd5c6afffd3e64c00af521276",
+ "method": "DELETE",
+ "path": "/platform/optouts/{phone}",
+ "operationId": "deleteOptOut",
+ "fingerprint": "39841fdbc2b41877d95d4ed6328b6ff1d350b1fe14f3b56a2d72d48d3d67c3c9",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.optOuts.delete"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.OptOuts.Delete"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.opt_outs.delete"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::optOuts.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.OptOuts.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.opt_outs.delete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/profile",
- "operationId": "getUserProfile",
- "fingerprint": "a3119530a4ae365c205068bf47177b7ca766733e6c6674238c11774af86789bf",
+ "method": "DELETE",
+ "path": "/platform/projects/{projectId}/webhooks/{webhookId}",
+ "operationId": "deleteProjectWebhook",
+ "fingerprint": "fc02b96f57259e05bd2257f172c561ab4d2d2002b79825988e04e59b6d05320d",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).webhooks.delete"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Webhooks.Delete"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.webhooks.delete"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::webhooks.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Webhooks.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.webhooks.delete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/projects/{projectId}/logging",
- "operationId": "getProjectLogging",
- "fingerprint": "15ebad74c0b2acee94e8d4b241beb499ab166d872d7a45080b079a46166ed829",
+ "method": "DELETE",
+ "path": "/platform/sip-trunks/{trunkId}",
+ "operationId": "deleteSipTrunk",
+ "fingerprint": "60ed0761d77877ff20fefb3254bcc524bbcc9954ec19976639ba6df49aa5043c",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "Client.sipTrunks.delete"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "TeamClient.SIPTrunks.Delete"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.sip_trunks.delete"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::sipTrunks.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "TeamClient.SipTrunks.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.sip_trunks.delete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/projects/{projectId}/setup",
- "operationId": "getProjectSetup",
- "fingerprint": "8599af2785923f44c1d8abb9e9e76bb361e1b434648c191bc377a3f6c347d416",
+ "method": "DELETE",
+ "path": "/platform/templates/{templateId}",
+ "operationId": "deleteMessageTemplate",
+ "fingerprint": "f58df23aaca586f433553c7c96777b81d0b75dcbe46539db6f4d17e91a7dfda8",
"typescript": {
"status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"go": {
"status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
+ "reason": "This dashboard-only route does not accept the team server API key used by Client."
},
"python": {
"status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
- "milestone": "excluded-contract"
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"php": {
"status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
- "milestone": "excluded-contract"
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
+ "reason": "This dashboard-only route does not accept the team server API key used by Client."
},
"rust": {
"status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
- "milestone": "not-server-sdk"
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/sandbox/pool",
- "operationId": "getSandboxProjectPool",
- "fingerprint": "6b45e6d6774594bbaffb99f586ef0347b403ac23b74b7ffdce268a64f578b165",
+ "method": "DELETE",
+ "path": "/platform/voice/audio/{assetId}",
+ "operationId": "deleteVoiceAudio",
+ "fingerprint": "6ae2460925a5c975b678c036082073d8691f0dce589346390bc9121d64454d3e",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.voice.audio.delete"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Voice.Audio.Delete"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.voice.audio.delete"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::voice.audio.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Voice.Audio.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.voice.audio.delete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/session-configuration/{sessionId}",
- "operationId": "getSessionConfiguration",
- "fingerprint": "51ed84e17b2be84c74c2d0138658b71625770955e6074d05b52c5fbaf8361256",
+ "method": "DELETE",
+ "path": "/platform/voice/provider-credentials/{credentialId}",
+ "operationId": "deleteVoiceProviderCredential",
+ "fingerprint": "7fe9783bac8e47faa64ec7385e16763e1de959a929d2229a75b913d8625410d6",
"typescript": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
+ "status": "covered",
+ "method": "Client.voice.providerCredentials.delete"
},
"go": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
+ "status": "covered",
+ "method": "TeamClient.Voice.ProviderCredentials.Delete"
},
"python": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.voice.provider_credentials.delete"
},
"php": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::voice.providerCredentials.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
+ "status": "covered",
+ "method": "TeamClient.Voice.ProviderCredentials.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.voice.provider_credentials.delete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/sip-trunks",
- "operationId": "listConsoleSipTrunks",
- "fingerprint": "f3e4cd261f54b006f90b127c2225b813798f8d29a7c25d0102a7c21ef8d5bb5a",
+ "method": "DELETE",
+ "path": "/platform/webhooks/{webhookId}",
+ "operationId": "deleteTeamWebhook",
+ "fingerprint": "d9072f39f779290faa072cc2eddd63fa4daeaccbb8bc1c0e9870db6b33333061",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.webhooks.delete"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Webhooks.Delete"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.webhooks.delete"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::webhooks.delete"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Webhooks.DeleteAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.webhooks.delete"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/console/sip-trunks/{trunkId}",
- "operationId": "getConsoleSipTrunk",
- "fingerprint": "767fdc0ff3cdae84d5430dcea4a0faf05b53f20eb21307dc983ef804487f58bc",
+ "path": "/api/account/cloud-health",
+ "operationId": "getAccountCloudHealth",
+ "fingerprint": "510bb34e3083be0c72f7fccddc98d5f4933fdf15b121d62aa2e438bce549590d",
"typescript": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "Console-only redacted account health requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "Console-only redacted account health requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "reason": "Console-only redacted account health requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "reason": "Console-only redacted account health requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "Console-only redacted account health requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "reason": "Console-only redacted account health requires dashboard identity; not available to SDK credentials.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/console/sip/endpoint",
- "operationId": "getConsoleSipEndpoint",
- "fingerprint": "28b5fdaae1f83ddb008ac29b0742c7b616d9c303a34ba123f7b3ebe0f898a999",
+ "path": "/api/account/cloud-health/export",
+ "operationId": "exportAccountCloudHealth",
+ "fingerprint": "1dd5bcb6d745134932aca035c4e692c21c82aab79154f489d8f366e1e0d43006",
"typescript": {
"status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method."
+ "reason": "Console-only redacted account health export requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method."
+ "reason": "Console-only redacted account health export requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method.",
+ "reason": "Console-only redacted account health export requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method.",
+ "reason": "Console-only redacted account health export requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method."
+ "reason": "Console-only redacted account health export requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method.",
+ "reason": "Console-only redacted account health export requires dashboard identity; not available to SDK credentials.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/console/teams",
- "operationId": "listUserProfileTeams",
- "fingerprint": "3f10b561c2b82691ddec5cf48cebfab363ff27f89fdd84539b78fe0569b5fa4b",
+ "path": "/api/account/feature-terms",
+ "operationId": "accountListFeatureTerms",
+ "fingerprint": "9e8df47153ea1a42666f6100b20b5eccf0cae9746f2bb97cc54a04787de3b37b",
"typescript": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/console/voice/audio",
- "operationId": "listConsoleVoiceAudio",
- "fingerprint": "df8f53ac67eb9d15efce9a6e0633fa9e0ec974505c19fb165a4d0fdbb70650ae",
+ "path": "/api/account/legal",
+ "operationId": "getAccountLegalStatus",
+ "fingerprint": "6e95bdacb3c7da99f0af483d5c5fda375fe769408f76507a2419fe3634d2bd08",
"typescript": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/console/voice/audio/{assetId}",
- "operationId": "getConsoleVoiceAudio",
- "fingerprint": "6e6ec7beb35cd1f0b22d1139b1347eb2e51315fc931daa89d65578c88961c415",
+ "path": "/api/account/meta-app",
+ "operationId": "getTeamMetaApp",
+ "fingerprint": "ddf2db2a91596fdb6fb8bd1d1951eefa43dfad45ea220967c1847d163cae2208",
"typescript": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"go": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"python": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
"milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
"milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"rust": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/console/voice/audio/{assetId}/preview",
- "operationId": "getConsoleVoiceAudioPreview",
- "fingerprint": "2b1bf2c241f68052777cb8297fdd16f845a4997239151e024a408b77bc36c18a",
+ "path": "/console/audit",
+ "operationId": "getConsoleAuditLogs",
+ "fingerprint": "3b120461e715a916bf67b2f5254f6c3f6b6ccf5c9b84380707fc1f305eca42f7",
"typescript": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"go": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"python": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
"milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
"milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"rust": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/console/voice/provider-credentials",
- "operationId": "listConsoleVoiceProviderCredentials",
- "fingerprint": "21b21b22cbcbd4c81b5bd5ea2c73e631e91e9c7dacd456f640a8c3f014b62672",
+ "path": "/console/auth/methods",
+ "operationId": "getUserProfileAuthMethods",
+ "fingerprint": "b762ccf12f9f8c051e898fc20d6c229ca31a6cd887b5b29cba14a2482d567632",
"typescript": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/console/voice/provider-credentials/{credentialId}",
- "operationId": "getConsoleVoiceProviderCredential",
- "fingerprint": "acb5e524a4e8393224028552d2d63e8ecf515d44c61e4905de24a110d34cf6d9",
+ "path": "/console/auth/providers",
+ "operationId": "getUserProfileProviderConnectionUrl",
+ "fingerprint": "488f7c8bf4ee6a05a9f01b31f641fa9bc85a4e9e8505f765ce1ae2558fa2aee4",
"typescript": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/console/webhooks",
- "operationId": "listWebhooks",
- "fingerprint": "786c3787716e374fadb13016351c5749c8cb1d29f729b5a09194925c46f246fc",
+ "path": "/console/call-opt-outs",
+ "operationId": "listConsoleCallOptOuts",
+ "fingerprint": "5a97a7ca27627b4780d92d07d9f9d35bc32de5b092180dbce6372a0b18cc1885",
"typescript": {
"status": "excluded",
"reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
@@ -9278,2774 +9878,3077 @@
{
"family": "platform",
"method": "GET",
- "path": "/platform/audiences",
- "operationId": "listAudiences",
- "fingerprint": "0bcf61a493e28bb4a607d266df2965063f9822d6d6d10af99a3f0cc1cdc6cd8d",
+ "path": "/console/call-policy",
+ "operationId": "getConsoleCallPolicy",
+ "fingerprint": "c9e607b1c85d1c68c7908beb835edc72a3c975b9ceb759f76101049593d8d87e",
"typescript": {
- "status": "covered",
- "method": "Client.audiences.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Audiences.List"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.audiences.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::audiences.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Audiences.ListAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.audiences.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/audiences/{listId}",
- "operationId": "getAudience",
- "fingerprint": "d2389de3b10ee78e93da968a05da62c3f0efa4dc70f3ae11cbd881dc11235114",
+ "path": "/console/call-retention",
+ "operationId": "getTeamCallRetention",
+ "fingerprint": "7c17cb354c82949b3e7d25ce0b58c8cec26c3e1b4d186bebf50732d8b2093cfe",
"typescript": {
- "status": "covered",
- "method": "Client.audiences.retrieve"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Audiences.Retrieve"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.audiences.retrieve"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::audiences.retrieve"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Audiences.RetrieveAsync"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.audiences.retrieve"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/audiences/{listId}/members",
- "operationId": "listAudienceMembers",
- "fingerprint": "0c5a0f8a0a2c0d1a21008588dd4fdc1dc1bb80796d5f0bb95df1ab14549ffe68",
+ "path": "/console/call-settings/{connectionId}",
+ "operationId": "getConnectionCallSettings",
+ "fingerprint": "b501d61dc23b4428fc15590cb2c6a81a78e24e82f9d3924b3609698a5353304a",
"typescript": {
- "status": "covered",
- "method": "Client.audiences.listMembers"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Audiences.ListMembers"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.audiences.list_members"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::audiences.listMembers"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Audiences.ListMembersAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.audiences.list_members"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/audit",
- "operationId": "listAuditLogs",
- "fingerprint": "de5a08fef7b8f39bce497af903e8589d6699022c26bf5eca6e3a10a0971cc885",
+ "path": "/console/calls",
+ "operationId": "listCalls",
+ "fingerprint": "cf335fe16bee48db66d69d39810436068a54481388a5cfb361400ab82a2f9dc5",
"typescript": {
- "status": "covered",
- "method": "Client.auditLogs.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.AuditLogs.List"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.audit_logs.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::auditLogs.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.AuditLogs.ListAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.audit_logs.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bans",
- "operationId": "listSessionBans",
- "fingerprint": "c072cf1d026db12a91bbb2a6019d6b6f9170d131b61c8b35dda3caeca5db4fe0",
+ "path": "/console/calls/{callId}",
+ "operationId": "getCall",
+ "fingerprint": "953c24cd974e44b0bbfbdd5846142b567e1367119bbeaa6a37091b6c49ac85a3",
"typescript": {
- "status": "covered",
- "method": "Client.sessionBans.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.SessionBans.List"
- },
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ },
"python": {
- "status": "covered",
- "method": "AsyncClient.session_bans.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::sessionBans.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.SessionBans.ListAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.session_bans.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bans/active",
- "operationId": "listActiveSessionBans",
- "fingerprint": "60dd491cc4ef6826d9960a7528d6d8a701a233eccc15b02a7a41c3a586f73d93",
+ "path": "/console/connection-configuration/{connectionId}",
+ "operationId": "getConnectionConfiguration",
+ "fingerprint": "b9c18797d7265b316e6a2ba9a9cac2cd2c5bdf754c92c3a0c4d8ed67f383eefa",
"typescript": {
- "status": "covered",
- "method": "Client.sessionBans.listActive"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
"go": {
- "status": "covered",
- "method": "TeamClient.SessionBans.ListActive"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.session_bans.list_active"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::sessionBans.listActive"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.SessionBans.ListActiveAsync"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.session_bans.list_active"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/claims",
- "operationId": "listBanSafeClaims",
- "fingerprint": "547cafffd3656df68db38672850c69c92f1fd66cf1f56c025e485a0132955a9c",
+ "path": "/console/deployments",
+ "operationId": "listDeployments",
+ "fingerprint": "11fa9f7d182bee769f344bf735ab4903e0b0cb040a133336d7f49431ff2938fa",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.listClaims",
- "untypedResponseFields": ["linkedDeviceInteractive"]
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListClaims",
- "untypedResponseFields": ["linkedDeviceInteractive"]
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.list_claims",
- "untypedResponseFields": ["linkedDeviceInteractive"]
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.listClaims",
- "untypedResponseFields": ["linkedDeviceInteractive"]
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListClaimsAsync",
- "untypedResponseFields": ["linkedDeviceInteractive"]
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.list_claims",
- "untypedResponseFields": ["linkedDeviceInteractive"]
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/claims/{claimId}",
- "operationId": "getBanSafeClaim",
- "fingerprint": "222ac18481517f1007f8149c8862d4c5b90235631aabcd492227b0df9951dfe0",
+ "path": "/console/insights/analytics",
+ "operationId": "analyticsInsight",
+ "fingerprint": "f95d908ee073b4299622ceee4c5633edc97b8d5f4a0b046b03c1139d34c3e3f9",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.getClaim",
- "untypedResponseFields": ["linkedDeviceInteractive"]
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.GetClaim",
- "untypedResponseFields": ["linkedDeviceInteractive"]
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.get_claim",
- "untypedResponseFields": ["linkedDeviceInteractive"]
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.getClaim",
- "untypedResponseFields": ["linkedDeviceInteractive"]
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.GetClaimAsync",
- "untypedResponseFields": ["linkedDeviceInteractive"]
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.get_claim",
- "untypedResponseFields": ["linkedDeviceInteractive"]
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/collection",
- "operationId": "listBanSafeCollection",
- "fingerprint": "32dda574c36a6cc066b739921a2eae6c8cf1718e37e71fc28bab578ea4265fc2",
+ "path": "/console/insights/connection-options",
+ "operationId": "listConsoleConnectionOptions",
+ "fingerprint": "f444c99fbf70d74d2405484594e125ba18c405d99c5d70ef4c861eb9e625bbf5",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.listCollection"
+ "status": "excluded",
+ "reason": "Private Console selector requires dashboard identity; team API keys and project tokens are not accepted."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListCollection"
+ "status": "excluded",
+ "reason": "Private Console selector requires dashboard identity; team API keys and project tokens are not accepted."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.list_collection"
+ "status": "excluded",
+ "reason": "Private Console selector requires dashboard identity; team API keys and project tokens are not accepted.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.listCollection"
+ "status": "excluded",
+ "reason": "Private Console selector requires dashboard identity; team API keys and project tokens are not accepted.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListCollectionAsync"
+ "status": "excluded",
+ "reason": "Private Console selector requires dashboard identity; team API keys and project tokens are not accepted."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.list_collection"
+ "status": "excluded",
+ "reason": "Private Console selector requires dashboard identity; team API keys and project tokens are not accepted.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/enforcement",
- "operationId": "listBanSafeEnforcement",
- "fingerprint": "a31d5176c223e71f8410f18933d193b1c5d3471ca6a3ac2603b0e7fb8b0b529c",
+ "path": "/console/insights/log-calendar",
+ "operationId": "getLogCalendar",
+ "fingerprint": "89880747a6f4d5054db4196753faa76c56cbdaa58b042d44281830ed35aa9fb1",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.listEnforcement"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListEnforcement"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.list_enforcement"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.listEnforcement"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListEnforcementAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.list_enforcement"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/findings",
- "operationId": "listBanSafeFindings",
- "fingerprint": "f68b7dee3a151af6e8d30bcbebc857f788664071bba55f51c83b7147324dc91d",
+ "path": "/console/insights/logs",
+ "operationId": "logsInsight",
+ "fingerprint": "033eeb94f89b26d6f8e518f508078ccc2792c62b737536e2ff9d4a2d1409b4d6",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.listFindings"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListFindings"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.list_findings"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.listFindings"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListFindingsAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.list_findings"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/health",
- "operationId": "listBanSafeHealth",
- "fingerprint": "7b66a82631f1fc1ff4ccfc2a580f70fc467c9e09928bfc735d2953b0c6059aba",
+ "path": "/console/insights/preferences",
+ "operationId": "getInsightPreferences",
+ "fingerprint": "1030cd6f5db78977173f52e388c8455b43eeeae65ccc93f12b793c052d1d57be",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.listHealth"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListHealth"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.list_health"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.listHealth"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListHealthAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.list_health"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/health-actions",
- "operationId": "listBanSafeHealthActions",
- "fingerprint": "7b93f822df91ecf20148b6f4315c98bf295d7d385d6e945398c3833ddf4db872",
+ "path": "/console/insights/usage",
+ "operationId": "usageInsight",
+ "fingerprint": "733e105c479d31dfaa84184886698d4474d9cd8f58176af376fff48c42807f20",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.listHealthActions"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListHealthActions"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.list_health_actions"
- },
- "php": {
- "status": "covered",
- "method": "Client::banSafe.listHealthActions"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
+ },
+ "php": {
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListHealthActionsAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.list_health_actions"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/health/{session}",
- "operationId": "getBanSafeHealth",
- "fingerprint": "5959b7cc01a9e2ef7efbcf5765a9cfb8636797c4a32e93e4c1deb2bf7ea7399f",
+ "path": "/console/insights/vitals",
+ "operationId": "getConsoleErrorVitals",
+ "fingerprint": "46d3924eb00a9fa4af60474852ff6770bad72ad8c6b8863f6ae6182a5bd1df84",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.getHealth"
+ "status": "excluded",
+ "reason": "Dashboard-only operational error vitals require a live Console identity; server API keys do not grant this authority."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.GetHealth"
+ "status": "excluded",
+ "reason": "Dashboard-only operational error vitals require a live Console identity; server API keys do not grant this authority."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.get_health"
+ "status": "excluded",
+ "reason": "Dashboard-only operational error vitals require a live Console identity; server API keys do not grant this authority.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.getHealth"
+ "status": "excluded",
+ "reason": "Dashboard-only operational error vitals require a live Console identity; server API keys do not grant this authority.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.GetHealthAsync"
+ "status": "excluded",
+ "reason": "Dashboard-only operational error vitals require a live Console identity; server API keys do not grant this authority."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.get_health"
+ "status": "excluded",
+ "reason": "Dashboard-only operational error vitals require a live Console identity; server API keys do not grant this authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/health/{session}/history",
- "operationId": "listBanSafeHealthHistory",
- "fingerprint": "963bdb13f4415e9fedc2c45dd6cc7a663acf5d90df31d0e335455b9e102a36ab",
+ "path": "/console/keys",
+ "operationId": "listApiKeys",
+ "fingerprint": "94f9cc526993082d9cabf095f4780123f3a9f7b2e646be2dcfcdbbf536ccf325",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.listHealthHistory"
+ "status": "excluded",
+ "reason": "Moved from GET /platform/keys to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListHealthHistory"
+ "status": "excluded",
+ "reason": "Moved from GET /platform/keys to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.list_health_history"
+ "status": "excluded",
+ "reason": "Moved from GET /platform/keys to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.listHealthHistory"
+ "status": "excluded",
+ "reason": "Moved from GET /platform/keys to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListHealthHistoryAsync"
+ "status": "excluded",
+ "reason": "Moved from GET /platform/keys to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.list_health_history"
+ "status": "excluded",
+ "reason": "Moved from GET /platform/keys to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/incidents",
- "operationId": "listBanSafeIncidents",
- "fingerprint": "dab2a07508fdc290f49dd8e6e79b37deb0bbf6f9db68848511370eb80365d4be",
+ "path": "/console/notifications",
+ "operationId": "listNotificationInbox",
+ "fingerprint": "621ec78b7bd2fcc2e0980d8cf46d15c4eec41a269fc612194668c817117a4572",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.listIncidents"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListIncidents"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.list_incidents"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.listIncidents"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListIncidentsAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.list_incidents"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/signals",
- "operationId": "listBanSafeSignals",
- "fingerprint": "904aaf05a4f81bbd4fe7664851fb812a6c0b32008f81ec157554e9d539aaf0f6",
+ "path": "/console/notifications/archived",
+ "operationId": "listNotificationArchived",
+ "fingerprint": "c4eef9aea9b392a5cf6622a6af1f75e39ee5d3892b2aff3f4918d2b2d8d81f73",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.listSignals"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListSignals"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.list_signals"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.listSignals"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListSignalsAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.list_signals"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/telemetry/{session}",
- "operationId": "getBanSafeTelemetry",
- "fingerprint": "415227d60ac2ddeee8fba8e6eefc7b79149323a7db605ed15a35bb1c9b194d89",
+ "path": "/console/notifications/count",
+ "operationId": "unreadCountNotification",
+ "fingerprint": "cdf2e84afa4056c0eb47691d92e76b19d9c55735fd25c6ef048fa4e14fdc2876",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.getTelemetry"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.GetTelemetry"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.get_telemetry"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.getTelemetry"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.GetTelemetryAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.get_telemetry"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/telemetry/{session}/history",
- "operationId": "listBanSafeTelemetryHistory",
- "fingerprint": "2ac701c78cf3ab24183fdabad2e62801ff25f3fd75615504641246b4ae2acf9b",
+ "path": "/console/notifications/preferences",
+ "operationId": "getNotificationPreferences",
+ "fingerprint": "a25d37d05368813e99e64db82b3d738a2a4741c77698472fa77ec42779bac33d",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.listTelemetryHistory"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListTelemetryHistory"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.list_telemetry_history"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.listTelemetryHistory"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.ListTelemetryHistoryAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.list_telemetry_history"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/billing",
- "operationId": "getBilling",
- "fingerprint": "acdbea4e8342b90483e3a53cb102cef658d4535d1b503bccd0dfa508ec63b3cd",
+ "path": "/console/profile",
+ "operationId": "getUserProfile",
+ "fingerprint": "a3119530a4ae365c205068bf47177b7ca766733e6c6674238c11774af86789bf",
"typescript": {
- "status": "covered",
- "method": "Client.billing.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Billing.Retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.billing.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::billing.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Billing.RetrieveAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.billing.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/billing/controls/{scope}/{resourceId}",
- "operationId": "getResourceBillingControls",
- "fingerprint": "5c24285450b7bdd33cf96a24a99f37d0ac0ce9cb10a56d7bc145c6d22b2128e0",
+ "path": "/console/projects/{projectId}/connections/{connection}/catalogs",
+ "operationId": "listConsoleCloudCatalogs",
+ "fingerprint": "124debcf1fbf39387395e05bc2b3ddd4bcafa9993c75fbfd59cb09fc12a947ee",
"typescript": {
- "status": "covered",
- "method": "Client.billing.getResourceControls"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Billing.GetResourceControls"
- },
- "python": {
- "status": "covered",
- "method": "AsyncClient.billing.get_resource_controls"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
+ },
+ "python": {
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "Client::billing.getResourceControls"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Billing.GetResourceControlsAsync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.billing.get_resource_controls"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/billing/limits",
- "operationId": "getBillingLimits",
- "fingerprint": "f07bbc27ebf590d3c1ac2aca37d4beba65642df96f2d55bdf080d578ea29a166",
+ "path": "/console/projects/{projectId}/connections/{connection}/catalogs/{catalogId}",
+ "operationId": "getConsoleCloudCatalog",
+ "fingerprint": "9ca5be0d7b2001250a87f1e7b6fa20d3cd1b6f89ba30f37a243266d3e855f9a3",
"typescript": {
- "status": "covered",
- "method": "Client.billing.getLimits"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Billing.GetLimits"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.billing.get_limits"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "Client::billing.getLimits"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Billing.GetLimitsAsync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.billing.get_limits"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/billing/pricing",
- "operationId": "listTierPricing",
- "fingerprint": "3f2c77d7aff08e7b3a469d43d8796d0c75b9c9bdad55e7ee4ccf5cdd61b85b98",
+ "path": "/console/projects/{projectId}/connections/{connection}/catalogs/{catalogId}/products",
+ "operationId": "listConsoleCloudCatalogProducts",
+ "fingerprint": "de71b3e9e041ab3bdccd5bda18d2c25b2f6f4f7a9a9238bf17768c08a0f1e361",
"typescript": {
- "status": "covered",
- "method": "Client.billing.listPricing"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Billing.ListPricing"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.billing.list_pricing"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "Client::billing.listPricing"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Billing.ListPricingAsync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.billing.list_pricing"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/billing/priorities",
- "operationId": "getBillingPriorities",
- "fingerprint": "6d46481f3178d52397a3bc3ed0db8e8e055b180fb656685370aa5fba60500225",
+ "path": "/console/projects/{projectId}/logging",
+ "operationId": "getProjectLogging",
+ "fingerprint": "3aedbc0de0a41a1919da064fd4a4f0ff42df78fd8ccaf551f2f32b966ff825ab",
"typescript": {
- "status": "covered",
- "method": "Client.billing.getPriorities"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Billing.GetPriorities"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.billing.get_priorities"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::billing.getPriorities"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Billing.GetPrioritiesAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.billing.get_priorities"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/billing/transactions",
- "operationId": "listBillingTransactions",
- "fingerprint": "451d197c0dbea693096ec208d078806550d372d2277027f28fb4e07a665ae460",
+ "path": "/console/projects/{projectId}/regional-data/settings",
+ "operationId": "getRegionalDataSettings",
+ "fingerprint": "525319cc5c100626e169c567e177cad3c905b8b68dd91ec6f1754fdeeed3956e",
"typescript": {
- "status": "covered",
- "method": "Client.billing.listTransactions"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Billing.ListTransactions"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.billing.list_transactions"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "Client::billing.listTransactions"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Billing.ListTransactionsAsync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.billing.list_transactions"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/billing/usage",
- "operationId": "listUsageMeters",
- "fingerprint": "e7a4a59276d21ab57c910f8b685d618d81791193c414bcb88cd40cc7b000d68c",
+ "path": "/console/projects/{projectId}/setup",
+ "operationId": "getProjectSetup",
+ "fingerprint": "eb72429c0cf84402aed10bf2bd511be3ea70021519ead978ad6bef3a47189e95",
"typescript": {
- "status": "covered",
- "method": "Client.billing.usage"
+ "status": "excluded",
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Billing.Usage"
+ "status": "excluded",
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.billing.usage"
+ "status": "excluded",
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::billing.usage"
+ "status": "excluded",
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Billing.UsageAsync"
+ "status": "excluded",
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.billing.usage"
+ "status": "excluded",
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/call-opt-outs",
- "operationId": "listCallOptOuts",
- "fingerprint": "df68fb2dc23c588b488ddc697f8e04d42a1426fc4d88f5a9e2d6856531ab1cbe",
+ "path": "/console/sandbox/pool",
+ "operationId": "getSandboxProjectPool",
+ "fingerprint": "6b45e6d6774594bbaffb99f586ef0347b403ac23b74b7ffdce268a64f578b165",
"typescript": {
- "status": "covered",
- "method": "Client.callOptOuts.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.CallOptOuts.List"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.call_opt_outs.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::callOptOuts.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.CallOptOuts.ListAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.call_opt_outs.list"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/call-policy",
- "operationId": "getCallPolicy",
- "fingerprint": "142a6cc9ae7956231fd1c32ced14f96c8e0642785ebc7deaa5041db2428a9089",
+ "path": "/console/sip-trunks",
+ "operationId": "listConsoleSipTrunks",
+ "fingerprint": "b84984f96a28aecd4b0f2b0e0b33d4a3e19e2593e047d7277c6e90e6a0aa63af",
"typescript": {
- "status": "covered",
- "method": "Client.callPolicy.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.CallPolicy.Retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.call_policy.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::callPolicy.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.CallPolicy.RetrieveAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.call_policy.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/call-retention",
- "operationId": "getCallRetention",
- "fingerprint": "bfdc69d665bd92ddc1de112605148e8975b79d69543573dd30ce2cacaffe9b7c",
- "typescript": {
- "status": "covered",
- "method": "Client.callRetention.retrieve"
+ "path": "/console/sip-trunks/{trunkId}",
+ "operationId": "getConsoleSipTrunk",
+ "fingerprint": "2b30ca7b082a943491304c5d94a584063b1ef8a58f819ad9ec5f33838e06f4fa",
+ "typescript": {
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.CallRetention.Retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.call_retention.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::callRetention.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.CallRetention.RetrieveAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.call_retention.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/calls",
- "operationId": "listCallRecords",
- "fingerprint": "e84ca88fe577168c7b0ada08a518c7f327f8f0003d1748b02f88acefe53086a6",
+ "path": "/console/sip/endpoint",
+ "operationId": "getConsoleSipEndpoint",
+ "fingerprint": "28b5fdaae1f83ddb008ac29b0742c7b616d9c303a34ba123f7b3ebe0f898a999",
"typescript": {
- "status": "covered",
- "method": "Client.calls.list"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Calls.List"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.calls.list"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::calls.list"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Calls.ListAsync"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.calls.list"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/calls/{callId}",
- "operationId": "getCallRecord",
- "fingerprint": "169aaec1a764bb425fbe1b731fbb471d1a46224e71319dbb3994bf2afcc2a990",
+ "path": "/console/teams",
+ "operationId": "listUserProfileTeams",
+ "fingerprint": "3f10b561c2b82691ddec5cf48cebfab363ff27f89fdd84539b78fe0569b5fa4b",
"typescript": {
- "status": "covered",
- "method": "Client.calls.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Calls.Retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.calls.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::calls.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Calls.RetrieveAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.calls.retrieve"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/calls/export",
- "operationId": "exportCallRecords",
- "fingerprint": "80168dc6b0cea925bccdce6d6e66926f4fa21e7340f3f55cfc13dca84f4d9563",
+ "path": "/console/teams/{slug}",
+ "operationId": "getTeamBySlug",
+ "fingerprint": "4926a43b92d9882976ee1ced2424c5309734a84dd5c6afffd3e64c00af521276",
"typescript": {
- "status": "covered",
- "method": "Client.calls.export"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Calls.Export"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.calls.export"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::calls.export"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Calls.ExportAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.calls.export"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/calls/stats",
- "operationId": "getCallStats",
- "fingerprint": "f7aa4da74774d6345277af6058efb515481a25780fc92b8077cb2c411bd32ba3",
+ "path": "/console/voice/audio",
+ "operationId": "listConsoleVoiceAudio",
+ "fingerprint": "df8f53ac67eb9d15efce9a6e0633fa9e0ec974505c19fb165a4d0fdbb70650ae",
"typescript": {
- "status": "covered",
- "method": "Client.calls.stats"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Calls.Stats"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.calls.stats"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::calls.stats"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Calls.StatsAsync"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.calls.stats"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/campaigns",
- "operationId": "listPlatformCampaigns",
- "fingerprint": "a9b76fa437cd76b12c2bc8a806212d20d3f889e3795c04e6b313de2b6f8524fc",
+ "path": "/console/voice/audio/{assetId}",
+ "operationId": "getConsoleVoiceAudio",
+ "fingerprint": "6e6ec7beb35cd1f0b22d1139b1347eb2e51315fc931daa89d65578c88961c415",
"typescript": {
- "status": "covered",
- "method": "Client.campaigns.list"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Campaigns.List"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.campaigns.list"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::campaigns.list"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Campaigns.ListAsync"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.campaigns.list"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/campaigns/{campaignId}",
- "operationId": "getPlatformCampaign",
- "fingerprint": "ba50cea1ef1611971aade6e4df2ea0348e61b9ff9d31e439a362660c1c5b0c7c",
+ "path": "/console/voice/audio/{assetId}/preview",
+ "operationId": "getConsoleVoiceAudioPreview",
+ "fingerprint": "2b1bf2c241f68052777cb8297fdd16f845a4997239151e024a408b77bc36c18a",
"typescript": {
- "status": "covered",
- "method": "Client.campaigns.retrieve"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Campaigns.Retrieve"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.campaigns.retrieve"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::campaigns.retrieve"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Campaigns.RetrieveAsync"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.campaigns.retrieve"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/campaigns/{campaignId}/analytics",
- "operationId": "getPlatformCampaignAnalytics",
- "fingerprint": "bd7f6a846c0427c49f5cc040aa395fef9d8239a4e61f55725b49ded1f2e07473",
+ "path": "/console/voice/provider-credentials",
+ "operationId": "listConsoleVoiceProviderCredentials",
+ "fingerprint": "21b21b22cbcbd4c81b5bd5ea2c73e631e91e9c7dacd456f640a8c3f014b62672",
"typescript": {
- "status": "covered",
- "method": "Client.campaigns.analytics"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Campaigns.Analytics"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.campaigns.analytics"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::campaigns.analytics"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Campaigns.AnalyticsAsync"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.campaigns.analytics"
- }
- },
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "not-server-sdk"
+ }
+ },
{
"family": "platform",
"method": "GET",
- "path": "/platform/campaigns/{campaignId}/conversions",
- "operationId": "getCampaignConversions",
- "fingerprint": "cdbc69370673658fe0bc4d1728eef8ec0402606d4325aeccb762acf7bb347407",
+ "path": "/console/voice/provider-credentials/{credentialId}",
+ "operationId": "getConsoleVoiceProviderCredential",
+ "fingerprint": "acb5e524a4e8393224028552d2d63e8ecf515d44c61e4905de24a110d34cf6d9",
"typescript": {
- "status": "covered",
- "method": "Client.campaigns.conversions"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Campaigns.Conversions"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.campaigns.conversions"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::campaigns.conversions"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Campaigns.ConversionsAsync"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.campaigns.conversions"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/campaigns/{campaignId}/events",
- "operationId": "listCampaignEvents",
- "fingerprint": "8db06923fb939273cca49b4eed0f36796ce93ecad8e99ccee14cbd4d7f593825",
+ "path": "/console/webhooks",
+ "operationId": "listWebhooks",
+ "fingerprint": "786c3787716e374fadb13016351c5749c8cb1d29f729b5a09194925c46f246fc",
"typescript": {
- "status": "covered",
- "method": "Client.campaigns.events"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Campaigns.Events"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.campaigns.events"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::campaigns.events"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Campaigns.EventsAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.campaigns.events"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/campaigns/{campaignId}/recipients",
- "operationId": "listCampaignRecipients",
- "fingerprint": "477dc00fc49fee9ba0c6f387f1115cc10539a1b0412231128991d529ee9de145",
+ "path": "/platform/analytics",
+ "operationId": "getWhatsAppAnalytics",
+ "fingerprint": "ad8d862308e817f14cbed758ec0464c2b2f2270c9f66a20acae50990136fec27",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.recipients"
+ "method": "Client.analytics.get"
},
+ "sourceContractSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
+ "sourceCommit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
+ "sdkContractSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
"go": {
"status": "covered",
- "method": "TeamClient.Campaigns.Recipients"
+ "method": "TeamClient.Analytics.Get"
},
"python": {
"status": "covered",
- "method": "AsyncClient.campaigns.recipients"
+ "method": "AsyncClient.analytics.get"
},
"php": {
"status": "covered",
- "method": "Client::campaigns.recipients"
+ "method": "Client::analytics.get"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Campaigns.RecipientsAsync"
+ "method": "TeamClient.Analytics.GetAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.campaigns.recipients"
+ "method": "TeamClient.analytics.get"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/customers",
- "operationId": "listCustomers",
- "fingerprint": "cc8311024c38b7f5dfea1baf4fb1892052f9212eeabbd8a7e89092e9792b1470",
+ "path": "/platform/analytics/metrics",
+ "operationId": "exportWhatsAppAnalyticsMetrics",
"typescript": {
"status": "covered",
- "method": "Client.customers.list"
+ "method": "Client.analytics.metrics"
},
+ "fingerprint": "f72d53a45f5203425f79948424a3c247cdc5f7c581acee91ac3a2d42c17c18ee",
+ "sourceContractSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
+ "sdkContractSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
+ "sourceCommit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
"go": {
"status": "covered",
- "method": "TeamClient.Customers.List"
+ "method": "TeamClient.Analytics.Metrics"
},
"python": {
"status": "covered",
- "method": "AsyncClient.customers.list"
+ "method": "AsyncClient.analytics.metrics"
},
"php": {
"status": "covered",
- "method": "Client::customers.list"
+ "method": "Client::analytics.metrics"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Customers.ListAsync"
+ "method": "TeamClient.Analytics.MetricsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.customers.list"
+ "method": "TeamClient.analytics.metrics"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/customers/{customerId}",
- "operationId": "getCustomer",
- "fingerprint": "ac6939c47d22d5577430874830fc8d99d69ea5d992e27838078df539d86ec1f2",
+ "path": "/platform/audience-profile-imports/{jobId}",
+ "operationId": "getAudienceProfileImport",
+ "fingerprint": "8855e87ca16906f5ec54d80164b86e4625fc322f3e4499fffd2a77d6247b2d22",
"typescript": {
- "status": "covered",
- "method": "Client.customers.retrieve"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Customers.Retrieve"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.customers.retrieve"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "Client::customers.retrieve"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Customers.RetrieveAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.customers.retrieve"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/customers/{customerId}/events",
- "operationId": "listCustomerEvents",
- "fingerprint": "feb0e7ded3827397dc9cc3d82c1b3d5c04a4e47426007d5339379b924bc73534",
+ "path": "/platform/audience-profiles",
+ "operationId": "listAudienceProfiles",
+ "fingerprint": "fb9d8ecc9bb9f7063ffca5c76a5494ac7f358ef9870389b97ceb07250bdb7257",
"typescript": {
- "status": "covered",
- "method": "Client.customers.listEvents"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Customers.ListEvents"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.customers.list_events"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "Client::customers.listEvents"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Customers.ListEventsAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.customers.list_events"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/customers/{customerId}/numbers",
- "operationId": "listCustomerNumbers",
- "fingerprint": "31443cfd8af5b519fe6d510240f45abeae1dc8b1c80ca4e9e63c03dcfe079762",
+ "path": "/platform/audience-profiles/{phone}",
+ "operationId": "getAudienceProfile",
+ "fingerprint": "d5f962936dc574aecc2a7529238dc350c227228971f539e908efeee3ca418897",
"typescript": {
- "status": "covered",
- "method": "Client.customers.listNumbers"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Customers.ListNumbers"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.customers.list_numbers"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "Client::customers.listNumbers"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Customers.ListNumbersAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.customers.list_numbers"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/customers/{customerId}/pairing-links",
- "operationId": "listCustomerPairingLinks",
- "fingerprint": "ca53bee670a4b9470b2d1e56596e357874594271562d39ca32bf51ead8c4bd3d",
+ "path": "/platform/audience-profiles/{phone}/consent",
+ "operationId": "listAudienceProfileConsent",
+ "fingerprint": "750098cc130885bc9b4fa6cc68d9d47eb8b6279cfd0f385e19f96272124abf53",
"typescript": {
- "status": "covered",
- "method": "Client.customers.listPairingLinks"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Customers.ListPairingLinks"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.customers.list_pairing_links"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "Client::customers.listPairingLinks"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Customers.ListPairingLinksAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.customers.list_pairing_links"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/events",
- "operationId": "listTeamEvents",
- "fingerprint": "18edeb21548b93272fbca5c6f0dbf61bfb236b7d4f83e171d46d9cebc651b7d8",
+ "path": "/platform/audience-segments",
+ "operationId": "listAudienceSegments",
+ "fingerprint": "bc4cb882402e6f03332d74d4f20074f4e89634820221daa8aa58f46411e5314e",
"typescript": {
"status": "covered",
- "method": "Client.events.list"
+ "method": "Client.audienceSegments.list"
},
"go": {
"status": "covered",
- "method": "TeamClient.Events.List"
+ "method": "TeamClient.AudienceSegments().List"
},
"python": {
"status": "covered",
- "method": "AsyncClient.events.list"
+ "method": "AsyncClient.audience_segments.list"
},
"php": {
"status": "covered",
- "method": "Client::events.list"
+ "method": "Client::audienceSegments.list"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Events.ListAsync"
+ "method": "TeamClient.AudienceSegments.ListAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.events.list"
+ "method": "TeamClient.audience_segments().list"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/events/{eventId}",
- "operationId": "getTeamEvent",
- "fingerprint": "845d8b399fec0983931fa1c6b6cc56914d2ed5bf0e1d3d87b8a864d18656eaa3",
+ "path": "/platform/audience-segments/{segmentId}",
+ "operationId": "getAudienceSegment",
+ "fingerprint": "cf112314ad1fd7b59305eac8efcff804485de8411c3cbe287add969e6060b147",
"typescript": {
"status": "covered",
- "method": "Client.events.retrieve"
+ "method": "Client.audienceSegments.retrieve"
},
"go": {
"status": "covered",
- "method": "TeamClient.Events.Retrieve"
+ "method": "TeamClient.AudienceSegments().Retrieve"
},
"python": {
"status": "covered",
- "method": "AsyncClient.events.retrieve"
+ "method": "AsyncClient.audience_segments.retrieve"
},
"php": {
"status": "covered",
- "method": "Client::events.retrieve"
+ "method": "Client::audienceSegments.retrieve"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Events.RetrieveAsync"
+ "method": "TeamClient.AudienceSegments.RetrieveAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.events.retrieve_with_payload"
+ "method": "TeamClient.audience_segments().retrieve"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/flow-encryption-keys",
- "operationId": "getFlowEncryptionKey",
- "fingerprint": "1dde5912ffc53d8e5df36560aecbec327a8f333942fb00e9558ceb8b23d40801",
+ "path": "/platform/audience-segments/{segmentId}/preview",
+ "operationId": "previewAudienceSegment",
+ "fingerprint": "8576e9fba36c050e04bb209309a2a3f851be43021e721c02ae20085c174dbf90",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).flows.encryptionKey"
+ "method": "Client.audienceSegments.preview"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Flows.EncryptionKey"
+ "method": "TeamClient.AudienceSegments().Preview"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.flows.encryption_key"
+ "method": "AsyncClient.audience_segments.preview"
},
"php": {
"status": "covered",
- "method": "ProjectClient::flows.encryptionKey"
+ "method": "Client::audienceSegments.preview"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Flows.EncryptionKeyAsync"
+ "method": "TeamClient.AudienceSegments.PreviewAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.flows.encryption_key"
+ "method": "TeamClient.audience_segments().preview"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/flows",
- "operationId": "listFlows",
- "fingerprint": "dcb4bce4ce93fd3c6856d5c3f6ace6d8c54a2a6e97f1788a39aa1487ca3ae0cf",
+ "path": "/platform/audiences",
+ "operationId": "listAudiences",
+ "fingerprint": "0bcf61a493e28bb4a607d266df2965063f9822d6d6d10af99a3f0cc1cdc6cd8d",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).flows.list"
+ "method": "Client.audiences.list"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Flows.List"
+ "method": "TeamClient.Audiences.List"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.flows.list"
+ "method": "AsyncClient.audiences.list"
},
"php": {
"status": "covered",
- "method": "ProjectClient::flows.list"
+ "method": "Client::audiences.list"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Flows.ListAsync"
+ "method": "TeamClient.Audiences.ListAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.flows.list"
+ "method": "TeamClient.audiences.list"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/flows/{flowId}",
- "operationId": "getFlow",
- "fingerprint": "fb0f3b6d525d416b0c1352341ccb51b753e7818b77d69be30cb9bc34da5c9459",
+ "path": "/platform/audiences/{listId}",
+ "operationId": "getAudience",
+ "fingerprint": "d2389de3b10ee78e93da968a05da62c3f0efa4dc70f3ae11cbd881dc11235114",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).flows.retrieve"
+ "method": "Client.audiences.retrieve"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Flows.Retrieve"
+ "method": "TeamClient.Audiences.Retrieve"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.flows.retrieve"
+ "method": "AsyncClient.audiences.retrieve"
},
"php": {
"status": "covered",
- "method": "ProjectClient::flows.retrieve"
+ "method": "Client::audiences.retrieve"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Flows.RetrieveAsync"
+ "method": "TeamClient.Audiences.RetrieveAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.flows.retrieve"
+ "method": "TeamClient.audiences.retrieve"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/flows/{flowId}/endpoint",
- "operationId": "getFlowEndpoint",
- "fingerprint": "1919a98c2f73eaafd1b1bd27b78d4ab27f0c9426cc880147a04ea07d3fd2e5f5",
+ "path": "/platform/audiences/{listId}/members",
+ "operationId": "listAudienceMembers",
+ "fingerprint": "0c5a0f8a0a2c0d1a21008588dd4fdc1dc1bb80796d5f0bb95df1ab14549ffe68",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).flows.endpoint"
+ "method": "Client.audiences.listMembers"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Flows.Endpoint"
+ "method": "TeamClient.Audiences.ListMembers"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.flows.endpoint"
+ "method": "AsyncClient.audiences.list_members"
},
"php": {
"status": "covered",
- "method": "ProjectClient::flows.endpoint"
+ "method": "Client::audiences.listMembers"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Flows.EndpointAsync"
+ "method": "TeamClient.Audiences.ListMembersAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.flows.endpoint"
+ "method": "TeamClient.audiences.list_members"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/flows/{flowId}/endpoint/receipts",
- "operationId": "listFlowEndpointReceipts",
- "fingerprint": "bbb14ba98d316d2ea0cfae3b23f7ed47f2f1db1d21766a92bba9062862f5c324",
+ "path": "/platform/audit",
+ "operationId": "listAuditLogs",
+ "fingerprint": "de5a08fef7b8f39bce497af903e8589d6699022c26bf5eca6e3a10a0971cc885",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).flows.endpointReceipts"
+ "method": "Client.auditLogs.list"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Flows.EndpointReceipts"
+ "method": "TeamClient.AuditLogs.List"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.flows.endpoint_receipts"
+ "method": "AsyncClient.audit_logs.list"
},
"php": {
"status": "covered",
- "method": "ProjectClient::flows.endpointReceipts"
+ "method": "Client::auditLogs.list"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Flows.EndpointReceiptsAsync"
+ "method": "TeamClient.AuditLogs.ListAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.flows.endpoint_receipts"
+ "method": "TeamClient.audit_logs.list"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/flows/{flowId}/receipts",
- "operationId": "listFlowOperations",
- "fingerprint": "47af01457342592d44e053b7d4c2d8048238ddef3a9c55959fa9e1ee7bcff967",
+ "path": "/platform/bans",
+ "operationId": "listConnectionBans",
+ "fingerprint": "c072cf1d026db12a91bbb2a6019d6b6f9170d131b61c8b35dda3caeca5db4fe0",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).flows.receipts"
+ "method": "Client.connectionBans.list"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Flows.Receipts"
+ "method": "TeamClient.ConnectionBans.List"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.flows.receipts"
+ "method": "AsyncClient.connection_bans.list"
},
"php": {
"status": "covered",
- "method": "ProjectClient::flows.receipts"
+ "method": "Client::connectionBans.list"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Flows.ReceiptsAsync"
+ "method": "TeamClient.ConnectionBans.ListAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.flows.receipts"
+ "method": "TeamClient.connection_bans.list"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/functions",
- "operationId": "listFunctions",
- "fingerprint": "0f80215a41699cb11532613d970f2383c3928bca5bcc7a5bca7adb380beb0c39",
+ "path": "/platform/bans/active",
+ "operationId": "listActiveConnectionBans",
+ "fingerprint": "60dd491cc4ef6826d9960a7528d6d8a701a233eccc15b02a7a41c3a586f73d93",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).functions.list"
+ "method": "Client.connectionBans.listActive"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Functions.List"
+ "method": "TeamClient.ConnectionBans.ListActive"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.functions.list"
+ "method": "AsyncClient.connection_bans.list_active"
},
"php": {
"status": "covered",
- "method": "ProjectClient::functions.list"
+ "method": "Client::connectionBans.listActive"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Functions.ListAsync"
+ "method": "TeamClient.ConnectionBans.ListActiveAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.functions.list"
+ "method": "TeamClient.connection_bans.list_active"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/functions/{functionId}",
- "operationId": "getFunction",
- "fingerprint": "9cf44d97935978873515a83aa747532350d10265668af8203b7aa7a828c9204d",
+ "path": "/platform/bansafe/claims",
+ "operationId": "listBanSafeClaims",
+ "fingerprint": "12a1f0c195a1283f61366239dc9ed2cb772c7d6be0ddba3e1b3ee80acfb720dc",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).functions.retrieve"
+ "method": "Client.banSafe.listClaims",
+ "untypedResponseFields": ["linkedDeviceInteractive"]
},
"go": {
"status": "covered",
- "method": "ProjectClient.Functions.Retrieve"
+ "method": "TeamClient.BanSafe.ListClaims",
+ "untypedResponseFields": ["linkedDeviceInteractive"]
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.functions.retrieve"
+ "method": "AsyncClient.ban_safe.list_claims",
+ "untypedResponseFields": ["linkedDeviceInteractive"]
},
"php": {
"status": "covered",
- "method": "ProjectClient::functions.retrieve"
+ "method": "Client::banSafe.listClaims",
+ "untypedResponseFields": ["linkedDeviceInteractive"]
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Functions.RetrieveAsync"
+ "method": "TeamClient.BanSafe.ListClaimsAsync",
+ "untypedResponseFields": ["linkedDeviceInteractive"]
},
"rust": {
"status": "covered",
- "method": "ProjectClient.functions.retrieve"
+ "method": "TeamClient.ban_safe.list_claims",
+ "untypedResponseFields": ["linkedDeviceInteractive"]
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/functions/{functionId}/deployments",
- "operationId": "listFunctionDeployments",
- "fingerprint": "e17a718fb9857b0bdd23a8afa9c945ae4ef643a957052c437112fe0c51e09dd9",
+ "path": "/platform/bansafe/claims/{claimId}",
+ "operationId": "getBanSafeClaim",
+ "fingerprint": "d31a3ae135c8dbdc9aa0a1caa2ebdbbc59f0a1865769101ffac28d0c6cf183cb",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).functions.deployments.list"
+ "method": "Client.banSafe.getClaim",
+ "untypedResponseFields": ["linkedDeviceInteractive"]
},
"go": {
"status": "covered",
- "method": "ProjectClient.Functions.Deployments.List"
+ "method": "TeamClient.BanSafe.GetClaim",
+ "untypedResponseFields": ["linkedDeviceInteractive"]
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.functions.deployments.list"
+ "method": "AsyncClient.ban_safe.get_claim",
+ "untypedResponseFields": ["linkedDeviceInteractive"]
},
"php": {
"status": "covered",
- "method": "ProjectClient::functions.deployments.list"
+ "method": "Client::banSafe.getClaim",
+ "untypedResponseFields": ["linkedDeviceInteractive"]
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Functions.Deployments.ListAsync"
+ "method": "TeamClient.BanSafe.GetClaimAsync",
+ "untypedResponseFields": ["linkedDeviceInteractive"]
},
"rust": {
"status": "covered",
- "method": "ProjectClient.functions.deployments.list"
+ "method": "TeamClient.ban_safe.get_claim",
+ "untypedResponseFields": ["linkedDeviceInteractive"]
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/functions/{functionId}/deployments/{deploymentId}",
- "operationId": "getFunctionDeployment",
- "fingerprint": "2e1ec6be6de34b49c75f7a8ee281f2717e67490d06e21ff7207712d1371acc1c",
+ "path": "/platform/bansafe/collection",
+ "operationId": "listBanSafeCollection",
+ "fingerprint": "b2128ff8d43263c096e9ed067424fd603e00874971e95e58d8d3638c5e844d23",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).functions.deployments.retrieve"
+ "method": "Client.banSafe.listCollection"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Functions.Deployments.Retrieve"
+ "method": "TeamClient.BanSafe.ListCollection"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.functions.deployments.retrieve"
+ "method": "AsyncClient.ban_safe.list_collection"
},
"php": {
"status": "covered",
- "method": "ProjectClient::functions.deployments.retrieve"
+ "method": "Client::banSafe.listCollection"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Functions.Deployments.RetrieveAsync"
+ "method": "TeamClient.BanSafe.ListCollectionAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.functions.deployments.retrieve"
+ "method": "TeamClient.ban_safe.list_collection"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/functions/{functionId}/invocations",
- "operationId": "listFunctionInvocations",
- "fingerprint": "f3837b2b2e1fea81d90b77b9bbab7747c2abaef7f815493b4a68448b1c12aaf0",
+ "path": "/platform/bansafe/enforcement",
+ "operationId": "listBanSafeEnforcement",
+ "fingerprint": "4f78db829053c911313c4efd5b78efd95cc5b19fee06cba277c9d57e6f854cc2",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).functions.invocations.list"
+ "method": "Client.banSafe.listEnforcement"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Functions.Invocations.List"
+ "method": "TeamClient.BanSafe.ListEnforcement"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.functions.invocations.list"
+ "method": "AsyncClient.ban_safe.list_enforcement"
},
"php": {
"status": "covered",
- "method": "ProjectClient::functions.invocations.list"
+ "method": "Client::banSafe.listEnforcement"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Functions.Invocations.ListAsync"
+ "method": "TeamClient.BanSafe.ListEnforcementAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.functions.invocations.list"
+ "method": "TeamClient.ban_safe.list_enforcement"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/functions/{functionId}/invocations/{invocationId}",
- "operationId": "getFunctionInvocation",
- "fingerprint": "63e615a48b7ac8912995f5aebb314b245081002eaf53dae3b45864277a266ac4",
+ "path": "/platform/bansafe/findings",
+ "operationId": "listBanSafeFindings",
+ "fingerprint": "d5e574e2fe833a2495ea639f5c7e56e551cee890fccc72ae0a1510d2b5caee82",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).functions.invocations.retrieve"
+ "method": "Client.banSafe.listFindings"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Functions.Invocations.Retrieve"
+ "method": "TeamClient.BanSafe.ListFindings"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.functions.invocations.retrieve"
+ "method": "AsyncClient.ban_safe.list_findings"
},
"php": {
"status": "covered",
- "method": "ProjectClient::functions.invocations.retrieve"
+ "method": "Client::banSafe.listFindings"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Functions.Invocations.RetrieveAsync"
+ "method": "TeamClient.BanSafe.ListFindingsAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.functions.invocations.retrieve"
+ "method": "TeamClient.ban_safe.list_findings"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/functions/{functionId}/secrets",
- "operationId": "listFunctionSecrets",
- "fingerprint": "134852b2c4e99c5559e5107b764c1d75efe6ba0e3f7e9d6fadfd373a1d221ad2",
+ "path": "/platform/bansafe/health",
+ "operationId": "listBanSafeHealth",
+ "fingerprint": "0a304f5e43ec8df41430d218960c851db9beb92041dafd0dd2fea59a5e6c9859",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).functions.secrets.list"
+ "method": "Client.banSafe.listHealth"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Functions.Secrets.List"
+ "method": "TeamClient.BanSafe.ListHealth"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.functions.secrets.list"
+ "method": "AsyncClient.ban_safe.list_health"
},
"php": {
"status": "covered",
- "method": "ProjectClient::functions.secrets.list"
+ "method": "Client::banSafe.listHealth"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Functions.Secrets.ListAsync"
+ "method": "TeamClient.BanSafe.ListHealthAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.functions.secrets.list"
+ "method": "TeamClient.ban_safe.list_health"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/gates",
- "operationId": "listUsageGates",
- "fingerprint": "a704b95dfc9d0792c2e28e0825964d04bb7a3fa49188b84ccb0a35ec59254ed0",
+ "path": "/platform/bansafe/health-actions",
+ "operationId": "listBanSafeHealthActions",
+ "fingerprint": "c5802a4b1bca2e238536b651827f1c8af4b94162868317b5551fbfc740743862",
"typescript": {
"status": "covered",
- "method": "Client.usage.listGates"
+ "method": "Client.banSafe.listHealthActions"
},
"go": {
"status": "covered",
- "method": "TeamClient.Usage.ListGates"
+ "method": "TeamClient.BanSafe.ListHealthActions"
},
"python": {
"status": "covered",
- "method": "AsyncClient.usage.list_gates"
+ "method": "AsyncClient.ban_safe.list_health_actions"
},
"php": {
"status": "covered",
- "method": "Client::usage.listGates"
+ "method": "Client::banSafe.listHealthActions"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Usage.ListGatesAsync"
+ "method": "TeamClient.BanSafe.ListHealthActionsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.usage.list_gates"
+ "method": "TeamClient.ban_safe.list_health_actions"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/incidents",
- "operationId": "listSecurityIncidents",
- "fingerprint": "8c4b9bbda261f8ac588aad81b26a76c96b1d02c4e422a7081e46fbd5eafe9888",
+ "path": "/platform/bansafe/health/{connection}",
+ "operationId": "getBanSafeHealth",
+ "fingerprint": "a02ef5e5c099d3238258524da6f88c4fcd0aa9eea34b0a50b588185044180b00",
"typescript": {
"status": "covered",
- "method": "Client.securityIncidents.list"
+ "method": "Client.banSafe.getHealth"
},
"go": {
"status": "covered",
- "method": "TeamClient.SecurityIncidents.List"
+ "method": "TeamClient.BanSafe.GetHealth"
},
"python": {
"status": "covered",
- "method": "AsyncClient.security_incidents.list"
+ "method": "AsyncClient.ban_safe.get_health"
},
"php": {
"status": "covered",
- "method": "Client::securityIncidents.list"
+ "method": "Client::banSafe.getHealth"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.SecurityIncidents.ListAsync"
+ "method": "TeamClient.BanSafe.GetHealthAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.security_incidents.list"
+ "method": "TeamClient.ban_safe.get_health"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/media/{mediaId}",
- "operationId": "getMediaUrl",
- "fingerprint": "f87cdcba78f38582c51de0a144c6671b5c21766b61f90f4308c84c27a4c480a9",
+ "path": "/platform/bansafe/health/{connection}/history",
+ "operationId": "listBanSafeHealthHistory",
+ "fingerprint": "6b710926edf4fdc8d68e58c375e162760146a87fab4ae0ba3f57e4a94aa3385a",
"typescript": {
"status": "covered",
- "method": "Client.media.retrieve"
+ "method": "Client.banSafe.listHealthHistory"
},
"go": {
"status": "covered",
- "method": "TeamClient.Media.Retrieve"
+ "method": "TeamClient.BanSafe.ListHealthHistory"
},
"python": {
"status": "covered",
- "method": "AsyncClient.media.retrieve"
+ "method": "AsyncClient.ban_safe.list_health_history"
},
"php": {
"status": "covered",
- "method": "Client::media.retrieve"
+ "method": "Client::banSafe.listHealthHistory"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Media.RetrieveAsync"
+ "method": "TeamClient.BanSafe.ListHealthHistoryAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.media.retrieve"
+ "method": "TeamClient.ban_safe.list_health_history"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/members",
- "operationId": "listMembers",
- "fingerprint": "5ef6b2becea4dc96bb5a2a98fb6aec1000a32e657e14194acd388f1297569b8e",
+ "path": "/platform/bansafe/incidents",
+ "operationId": "listBanSafeIncidents",
+ "fingerprint": "0b6e04073f8dddf42a736b241504deb65b143d59eff089f49f13fcd15d9d9b60",
"typescript": {
"status": "covered",
- "method": "Client.members.list"
+ "method": "Client.banSafe.listIncidents"
},
"go": {
"status": "covered",
- "method": "TeamClient.Members.List"
+ "method": "TeamClient.BanSafe.ListIncidents"
},
"python": {
"status": "covered",
- "method": "AsyncClient.members.list"
+ "method": "AsyncClient.ban_safe.list_incidents"
},
"php": {
"status": "covered",
- "method": "Client::members.list"
+ "method": "Client::banSafe.listIncidents"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Members.ListAsync"
+ "method": "TeamClient.BanSafe.ListIncidentsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.members.list"
+ "method": "TeamClient.ban_safe.list_incidents"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/operations",
- "operationId": "listPlatformOperations",
- "fingerprint": "d512354326b930d24403ba1305827eaa0e8be9f547b35106911878bf6fcf6bec",
+ "path": "/platform/bansafe/signals",
+ "operationId": "listBanSafeSignals",
+ "fingerprint": "904aaf05a4f81bbd4fe7664851fb812a6c0b32008f81ec157554e9d539aaf0f6",
"typescript": {
"status": "covered",
- "method": "Client.operations.list"
+ "method": "Client.banSafe.listSignals"
},
"go": {
"status": "covered",
- "method": "TeamClient.Operations.List"
+ "method": "TeamClient.BanSafe.ListSignals"
},
"python": {
"status": "covered",
- "method": "AsyncClient.operations.list"
+ "method": "AsyncClient.ban_safe.list_signals"
},
"php": {
"status": "covered",
- "method": "Client::operations.list"
+ "method": "Client::banSafe.listSignals"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Operations.ListAsync"
+ "method": "TeamClient.BanSafe.ListSignalsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.operations.list"
+ "method": "TeamClient.ban_safe.list_signals"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/operations/{operationId}",
- "operationId": "getPlatformOperation",
- "fingerprint": "9c5983fda8a738a7953ba59afc9499b0d75d8b103387878b7c830139db936847",
+ "path": "/platform/bansafe/telemetry/{connection}",
+ "operationId": "getBanSafeTelemetry",
+ "fingerprint": "8d8405db7b5d21729c3d8d4ca35c2242583f0171a9d6d09651085d0968a9706f",
"typescript": {
"status": "covered",
- "method": "Client.operations.get"
+ "method": "Client.banSafe.getTelemetry"
},
"go": {
"status": "covered",
- "method": "TeamClient.Operations.Get"
+ "method": "TeamClient.BanSafe.GetTelemetry"
},
"python": {
"status": "covered",
- "method": "AsyncClient.operations.get"
+ "method": "AsyncClient.ban_safe.get_telemetry"
},
"php": {
"status": "covered",
- "method": "Client::operations.retrieve"
+ "method": "Client::banSafe.getTelemetry"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Operations.GetAsync"
+ "method": "TeamClient.BanSafe.GetTelemetryAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.operations.get"
+ "method": "TeamClient.ban_safe.get_telemetry"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/operations/{operationId}/transitions",
- "operationId": "listPlatformOperationTransitions",
- "fingerprint": "5f34f6daf67b0d4b134078c488080913630b6746ed52b3714c335de60719ad38",
+ "path": "/platform/bansafe/telemetry/{connection}/history",
+ "operationId": "listBanSafeTelemetryHistory",
+ "fingerprint": "8ee6268d40a1b9bfcb338c4d7950818ab4d04f518e4dc3287bfeefc46be89f54",
"typescript": {
"status": "covered",
- "method": "Client.operations.listTransitions"
+ "method": "Client.banSafe.listTelemetryHistory"
},
"go": {
"status": "covered",
- "method": "TeamClient.Operations.ListTransitions"
+ "method": "TeamClient.BanSafe.ListTelemetryHistory"
},
"python": {
"status": "covered",
- "method": "AsyncClient.operations.list_transitions"
+ "method": "AsyncClient.ban_safe.list_telemetry_history"
},
"php": {
"status": "covered",
- "method": "Client::operations.listTransitions"
+ "method": "Client::banSafe.listTelemetryHistory"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Operations.ListTransitionsAsync"
+ "method": "TeamClient.BanSafe.ListTelemetryHistoryAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.operations.list_transitions"
+ "method": "TeamClient.ban_safe.list_telemetry_history"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/optouts",
- "operationId": "listOptOuts",
- "fingerprint": "0c2af19d2c0aa2d7b414fa359f764ea3dcec98067158e2c1f7a471f51942cf6b",
+ "path": "/platform/billing",
+ "operationId": "getBilling",
+ "fingerprint": "acdbea4e8342b90483e3a53cb102cef658d4535d1b503bccd0dfa508ec63b3cd",
"typescript": {
"status": "covered",
- "method": "Client.optOuts.list"
+ "method": "Client.billing.retrieve"
},
"go": {
"status": "covered",
- "method": "TeamClient.OptOuts.List"
+ "method": "TeamClient.Billing.Retrieve"
},
"python": {
"status": "covered",
- "method": "AsyncClient.opt_outs.list"
+ "method": "AsyncClient.billing.retrieve"
},
"php": {
"status": "covered",
- "method": "Client::optOuts.list"
+ "method": "Client::billing.retrieve"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.OptOuts.ListAsync"
+ "method": "TeamClient.Billing.RetrieveAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.opt_outs.list"
+ "method": "TeamClient.billing.retrieve"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/optouts/settings",
- "operationId": "getOptOutSettings",
- "fingerprint": "febd3c9d24cc0074808de4b1df6f204204ebfa02a58cf1e6b9b61ec86ac79a99",
+ "path": "/platform/billing/controls/{scope}/{resourceId}",
+ "operationId": "getResourceBillingControls",
+ "fingerprint": "17900398c263b0cb9cccb915c96e1d89e6a390f9b9a8dc85b8cba8a577b31a5c",
"typescript": {
"status": "covered",
- "method": "Client.optOuts.getSettings"
+ "method": "Client.billing.getResourceControls"
},
"go": {
"status": "covered",
- "method": "TeamClient.OptOuts.GetSettings"
+ "method": "TeamClient.Billing.GetResourceControls"
},
"python": {
"status": "covered",
- "method": "AsyncClient.opt_outs.get_settings"
+ "method": "AsyncClient.billing.get_resource_controls"
},
"php": {
"status": "covered",
- "method": "Client::optOuts.getSettings"
+ "method": "Client::billing.getResourceControls"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.OptOuts.GetSettingsAsync"
+ "method": "TeamClient.Billing.GetResourceControlsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.opt_outs.get_settings"
+ "method": "TeamClient.billing.get_resource_controls"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects",
- "operationId": "listProjects",
- "fingerprint": "40dc96e59739cfec291df46e98cc2e3f2b90aae1367d0dca99ab0e0e896a5cdb",
+ "path": "/platform/billing/limits",
+ "operationId": "getBillingLimits",
+ "fingerprint": "21dfa463d8679d2c5fd8bf62f3c99ee1827a896838ca2cf117e331660a0128ba",
"typescript": {
"status": "covered",
- "method": "Client.projects.list"
+ "method": "Client.billing.getLimits"
},
"go": {
"status": "covered",
- "method": "TeamClient.Projects.List"
+ "method": "TeamClient.Billing.GetLimits"
},
"python": {
"status": "covered",
- "method": "AsyncClient.projects.list"
+ "method": "AsyncClient.billing.get_limits"
},
"php": {
"status": "covered",
- "method": "Client::projects.list"
+ "method": "Client::billing.getLimits"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Projects.ListAsync"
+ "method": "TeamClient.Billing.GetLimitsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.projects.list"
+ "method": "TeamClient.billing.get_limits"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/customers/status",
- "operationId": "getCustomersStatus",
- "fingerprint": "845610507153203132b6d960c7be1aba0a28455504dcca95482cb23fdc3fc6e4",
+ "path": "/platform/billing/pricing",
+ "operationId": "listTierPricing",
+ "fingerprint": "3f2c77d7aff08e7b3a469d43d8796d0c75b9c9bdad55e7ee4ccf5cdd61b85b98",
"typescript": {
"status": "covered",
- "method": "Client.customers.status"
+ "method": "Client.billing.listPricing"
},
"go": {
"status": "covered",
- "method": "TeamClient.Customers.Status"
+ "method": "TeamClient.Billing.ListPricing"
},
"python": {
"status": "covered",
- "method": "AsyncClient.customers.status"
+ "method": "AsyncClient.billing.list_pricing"
},
"php": {
"status": "covered",
- "method": "Client::customers.status"
+ "method": "Client::billing.listPricing"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Customers.StatusAsync"
+ "method": "TeamClient.Billing.ListPricingAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.customers.status"
+ "method": "TeamClient.billing.list_pricing"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/events",
- "operationId": "listProjectEvents",
- "fingerprint": "48b7d28e11d3879890ca1841c506972f4be235cc89878d854ecf7027adf46c69",
+ "path": "/platform/billing/priorities",
+ "operationId": "getBillingPriorities",
+ "fingerprint": "a54d181058b369a3dbf762e8d09a939bb7f8138de9ff4a244a3767eb417ea190",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).events.list"
+ "method": "Client.billing.getPriorities"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Events.List"
+ "method": "TeamClient.Billing.GetPriorities"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.events.list"
+ "method": "AsyncClient.billing.get_priorities"
},
"php": {
"status": "covered",
- "method": "Client::events.list"
+ "method": "Client::billing.getPriorities"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Events.ListAsync"
+ "method": "TeamClient.Billing.GetPrioritiesAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.events.list"
+ "method": "TeamClient.billing.get_priorities"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/events/{eventId}",
- "operationId": "getProjectEvent",
- "fingerprint": "8f199535efd485afd74e9703d62adfbcf36d0d74740415c347eba4d4e4e8fa7f",
+ "path": "/platform/billing/transactions",
+ "operationId": "listBillingTransactions",
+ "fingerprint": "451d197c0dbea693096ec208d078806550d372d2277027f28fb4e07a665ae460",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).events.retrieve"
+ "method": "Client.billing.listTransactions"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Events.Stream"
+ "method": "TeamClient.Billing.ListTransactions"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.events.retrieve"
+ "method": "AsyncClient.billing.list_transactions"
},
"php": {
"status": "covered",
- "method": "Client::events.retrieve"
+ "method": "Client::billing.listTransactions"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Events.RetrieveAsync"
+ "method": "TeamClient.Billing.ListTransactionsAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.events.retrieve_with_payload"
+ "method": "TeamClient.billing.list_transactions"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/events/stream",
- "operationId": "streamProjectEvents",
- "fingerprint": "f6f6ca62f56a74c6105eeb92de4ba98210b8831657fd6854d613c4e3752cba5b",
+ "path": "/platform/billing/usage",
+ "operationId": "listUsageMeters",
+ "fingerprint": "e7a4a59276d21ab57c910f8b685d618d81791193c414bcb88cd40cc7b000d68c",
"typescript": {
"status": "covered",
- "method": "Client.events.stream"
+ "method": "Client.billing.usage"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Events.Stream"
+ "method": "TeamClient.Billing.Usage"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.events.stream"
+ "method": "AsyncClient.billing.usage"
},
"php": {
"status": "covered",
- "method": "Client::events.stream"
+ "method": "Client::billing.usage"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Events.Stream"
+ "method": "TeamClient.Billing.UsageAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.events.stream"
+ "method": "TeamClient.billing.usage"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/health-policy",
- "operationId": "getProjectHealthPolicySettings",
- "fingerprint": "d4923a389c45432e30f4b8a7956f9a7f50de336cbbb98f1c35154eebafec6385",
+ "path": "/platform/call-opt-outs",
+ "operationId": "listCallOptOuts",
+ "fingerprint": "a1ba0c65469bd0bd01a3f54e14609039d7d175791f9afe4e5f57844c05f0d2c8",
"typescript": {
"status": "covered",
- "method": "Client.projects.getHealthPolicy"
+ "method": "Client.callOptOuts.list"
},
"go": {
"status": "covered",
- "method": "TeamClient.Projects.GetHealthPolicy"
+ "method": "TeamClient.CallOptOuts.List"
},
"python": {
"status": "covered",
- "method": "AsyncClient.projects.get_health_policy"
+ "method": "AsyncClient.call_opt_outs.list"
},
"php": {
"status": "covered",
- "method": "Client::$projects->getHealthPolicy"
+ "method": "Client::callOptOuts.list"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Projects.GetHealthPolicyAsync"
+ "method": "TeamClient.CallOptOuts.ListAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.projects.get_health_policy"
+ "method": "TeamClient.call_opt_outs.list"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/hybrid-merge-candidates",
- "operationId": "listHybridMergeCandidates",
- "fingerprint": "5263f80739a14983148c32bfc80c3aeac97a0ad457854c181d9cf2dc3e43c395",
+ "path": "/platform/call-policy",
+ "operationId": "getCallPolicy",
+ "fingerprint": "355b9466b6e08df00f18315b12f0b9565f601fae1b6fb1963ab9c1f0abf468af",
"typescript": {
"status": "covered",
- "method": "Client.projects.listHybridMergeCandidates"
+ "method": "Client.callPolicy.retrieve"
},
"go": {
"status": "covered",
- "method": "TeamClient.Projects.ListHybridMergeCandidates"
+ "method": "TeamClient.CallPolicy.Retrieve"
},
"python": {
"status": "covered",
- "method": "AsyncClient.projects.list_hybrid_merge_candidates"
+ "method": "AsyncClient.call_policy.retrieve"
},
"php": {
"status": "covered",
- "method": "Client::projects.listHybridMergeCandidates"
+ "method": "Client::callPolicy.retrieve"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Projects.ListHybridMergeCandidatesAsync"
+ "method": "TeamClient.CallPolicy.RetrieveAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.projects.list_hybrid_merge_candidates"
+ "method": "TeamClient.call_policy.retrieve"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/insurance-evidence",
- "operationId": "getInsuranceEvidenceSettings",
- "fingerprint": "7cf70a0a72f18d6a63b9a0dcbd292f995b22d240a9013ad9b12e7dd643e7433b",
+ "path": "/platform/call-retention",
+ "operationId": "getCallRetention",
+ "fingerprint": "90b32eb81d3b10f76b85256b4fc9bbe8e064e26736dd9e74932707b671375925",
"typescript": {
"status": "covered",
- "method": "Client.projects.getInsuranceEvidence"
+ "method": "Client.callRetention.retrieve"
},
"go": {
"status": "covered",
- "method": "TeamClient.Projects.GetInsuranceEvidence"
+ "method": "TeamClient.CallRetention.Retrieve"
},
"python": {
"status": "covered",
- "method": "AsyncClient.projects.get_insurance_evidence"
+ "method": "AsyncClient.call_retention.retrieve"
},
"php": {
"status": "covered",
- "method": "Client::$projects->getInsuranceEvidence"
+ "method": "Client::callRetention.retrieve"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Projects.GetInsuranceEvidenceAsync"
+ "method": "TeamClient.CallRetention.RetrieveAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.projects.get_insurance_evidence"
+ "method": "TeamClient.call_retention.retrieve"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/operations",
- "operationId": "listProjectOperations",
- "fingerprint": "70e9110000bbba82bf237d9d3af43218309945892417b38a09b7e1c4f48d663b",
+ "path": "/platform/calls",
+ "operationId": "listCallRecords",
+ "fingerprint": "24798f380477f0a600dd26933d19b46b196fbdad2a02bd86233436031199093b",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).operations.list"
+ "method": "Client.calls.list"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Operations.List"
+ "method": "TeamClient.Calls.List"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.operations.list"
+ "method": "AsyncClient.calls.list"
},
"php": {
"status": "covered",
- "method": "Client::operations.list"
+ "method": "Client::calls.list"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Operations.ListAsync"
+ "method": "TeamClient.Calls.ListAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.operations.list"
+ "method": "TeamClient.calls.list"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/operations/{operationId}",
- "operationId": "getProjectOperation",
- "fingerprint": "d0fad26e2960648f7c671d5e56dcd8fdd2973a2af07f295087fb0dcbb4e48f87",
+ "path": "/platform/calls/{callId}",
+ "operationId": "getCallRecord",
+ "fingerprint": "aa3784c6f02d7ca0cedad9c7fb26be848f3cac775e51aa0daeb5e44b7724ea1c",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).operations.get"
+ "method": "Client.calls.retrieve"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Operations.Get"
+ "method": "TeamClient.Calls.Retrieve"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.operations.get"
+ "method": "AsyncClient.calls.retrieve"
},
"php": {
"status": "covered",
- "method": "Client::operations.retrieve"
+ "method": "Client::calls.retrieve"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Operations.GetAsync"
+ "method": "TeamClient.Calls.RetrieveAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.operations.get"
+ "method": "TeamClient.calls.retrieve"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/operations/{operationId}/transitions",
- "operationId": "listProjectOperationTransitions",
- "fingerprint": "cd153091298796c588a5db602255f25e25638d23dada8c8068b695a677cf93c1",
+ "path": "/platform/calls/export",
+ "operationId": "exportCallRecords",
+ "fingerprint": "108744da26cf6446bf2c084a6294ade7398139ae7cc4dc8a98eeccdf5d704a62",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).operations.listTransitions"
+ "method": "Client.calls.export"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Operations.ListTransitions"
+ "method": "TeamClient.Calls.Export"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.operations.list_transitions"
+ "method": "AsyncClient.calls.export"
},
"php": {
"status": "covered",
- "method": "Client::operations.listTransitions"
+ "method": "Client::calls.export"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Operations.ListTransitionsAsync"
+ "method": "TeamClient.Calls.ExportAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.operations.list_transitions"
+ "method": "TeamClient.calls.export"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/safe-mode",
- "operationId": "getProjectSafeModeCeiling",
- "fingerprint": "4e0d2e49d3dc2176b8834898f2b04bba5e3dda1869bd7484c3667223950d0e1d",
+ "path": "/platform/calls/stats",
+ "operationId": "getCallStats",
+ "fingerprint": "b1941eeae3ff26fe8781ca119a3f7eb542d40a921dafc3b1d00582a3ce0d7e80",
"typescript": {
"status": "covered",
- "method": "Client.projects.getSafeMode"
+ "method": "Client.calls.stats"
},
"go": {
"status": "covered",
- "method": "TeamClient.Projects.GetSafeMode"
+ "method": "TeamClient.Calls.Stats"
},
"python": {
"status": "covered",
- "method": "AsyncClient.projects.get_safe_mode"
+ "method": "AsyncClient.calls.stats"
},
"php": {
"status": "covered",
- "method": "Client::$projects->getSafeMode"
+ "method": "Client::calls.stats"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Projects.GetSafeModeAsync"
+ "method": "TeamClient.Calls.StatsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.projects.get_safe_mode"
+ "method": "TeamClient.calls.stats"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/warmup-plan",
- "operationId": "getProjectWarmupPlanSettings",
- "fingerprint": "47bbe413c4824bd85b6a50271facc22e3d9b253cecb4d0bb53dcd6e011a0a937",
+ "path": "/platform/campaign-reply-flows/{replyFlowId}",
+ "operationId": "getPlatformCampaignReplyFlow",
+ "fingerprint": "3996942bca4d772240dd92f1cad88cf4e460bba0995a82039362ba7d8a3b2020",
"typescript": {
- "status": "covered",
- "method": "Client.projects.getWarmupPlan"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Projects.GetWarmupPlan"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.projects.get_warmup_plan"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "Client::$projects->getWarmupPlan"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Projects.GetWarmupPlanAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.projects.get_warmup_plan"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/webhook-deliveries",
- "operationId": "listProjectWebhookDeliveries",
- "fingerprint": "e0dc0e2a73e455929b87acbe499a1003c11268826a98eb0df227a9e55597643e",
+ "path": "/platform/campaign-settings",
+ "operationId": "getCampaignSettings",
+ "fingerprint": "b91ca61874b0ee0f91d37c7da0296bb674f25fa873cc2b73fc3f120b4b07a6df",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).webhookDeliveries.list"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "ProjectClient.WebhookDeliveries.List"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.webhook_deliveries.list"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "Client::webhookDeliveries.list"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.WebhookDeliveries.ListAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.webhook_deliveries.list"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/webhook-deliveries/{deliveryId}",
- "operationId": "getProjectWebhookDelivery",
- "fingerprint": "0c8687cd878380f92854ae6c58388c7f66e543a184bdaf4446b3898e1dbd6892",
+ "path": "/platform/campaign-settings/frequency-cap",
+ "operationId": "getCampaignFrequencyCap",
+ "fingerprint": "113086d23bd8cf9835379a940c8e7c8207a17bba205b8a14fae1e1f9c1ab39a0",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).webhookDeliveries.retrieve"
+ "method": "Client.campaigns.getFrequencyCap"
},
"go": {
"status": "covered",
- "method": "ProjectClient.WebhookDeliveries.Retrieve"
+ "method": "TeamClient.Campaigns().GetFrequencyCap"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.webhook_deliveries.retrieve"
+ "method": "AsyncClient.campaigns.get_frequency_cap"
},
"php": {
"status": "covered",
- "method": "Client::webhookDeliveries.retrieve"
+ "method": "Client::campaigns.getFrequencyCap"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.WebhookDeliveries.RetrieveAsync"
+ "method": "TeamClient.Campaigns.GetFrequencyCapAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.webhook_deliveries.retrieve"
+ "method": "TeamClient.campaigns().get_frequency_cap"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/webhook-deliveries/{deliveryId}/attempts",
- "operationId": "listProjectWebhookDeliveryAttempts",
- "fingerprint": "f973fc52d737e511dc7f0aaf70bed739aba59515a3a5bde4512a64a0daea9357",
+ "path": "/platform/campaigns",
+ "operationId": "listPlatformCampaigns",
+ "fingerprint": "a9b76fa437cd76b12c2bc8a806212d20d3f889e3795c04e6b313de2b6f8524fc",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).webhookDeliveries.listAttempts"
+ "method": "Client.campaigns.list"
},
"go": {
"status": "covered",
- "method": "ProjectClient.WebhookDeliveries.ListAttempts"
+ "method": "TeamClient.Campaigns.List"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.webhook_deliveries.list_attempts"
+ "method": "AsyncClient.campaigns.list"
},
"php": {
"status": "covered",
- "method": "Client::webhookDeliveries.listAttempts"
+ "method": "Client::campaigns.list"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.WebhookDeliveries.ListAttemptsAsync"
+ "method": "TeamClient.Campaigns.ListAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.webhook_deliveries.list_attempts"
+ "method": "TeamClient.campaigns.list"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/webhook-deliveries/{deliveryId}/attempts/{attemptId}",
- "operationId": "getProjectWebhookDeliveryAttempt",
- "fingerprint": "24f3a608adfdb971443575f3d5d25c208580e602d6873c03f4cd59494ffa9d88",
+ "path": "/platform/campaigns/{campaignId}",
+ "operationId": "getPlatformCampaign",
+ "fingerprint": "ba50cea1ef1611971aade6e4df2ea0348e61b9ff9d31e439a362660c1c5b0c7c",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).webhookDeliveries.retrieveAttempt"
+ "method": "Client.campaigns.retrieve"
},
"go": {
"status": "covered",
- "method": "ProjectClient.WebhookDeliveries.RetrieveAttempt"
+ "method": "TeamClient.Campaigns.Retrieve"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.webhook_deliveries.retrieve_attempt"
+ "method": "AsyncClient.campaigns.retrieve"
},
"php": {
"status": "covered",
- "method": "Client::webhookDeliveries.retrieveAttempt"
+ "method": "Client::campaigns.retrieve"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.WebhookDeliveries.RetrieveAttemptAsync"
+ "method": "TeamClient.Campaigns.RetrieveAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.webhook_deliveries.retrieve_attempt"
+ "method": "TeamClient.campaigns.retrieve"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/webhooks",
- "operationId": "listProjectWebhooks",
- "fingerprint": "3e8dafec17574e8bf60011f56178907e06046c5ebc7f2bd5a761470e0f9be170",
+ "path": "/platform/campaigns/{campaignId}/analytics",
+ "operationId": "getPlatformCampaignAnalytics",
+ "fingerprint": "bd7f6a846c0427c49f5cc040aa395fef9d8239a4e61f55725b49ded1f2e07473",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).webhooks.list"
+ "method": "Client.campaigns.analytics"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Webhooks.List",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "TeamClient.Campaigns.Analytics"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.webhooks.list",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "AsyncClient.campaigns.analytics"
},
"php": {
"status": "covered",
- "method": "Client::webhooks.list",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "Client::campaigns.analytics"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Webhooks.ListAsync",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "TeamClient.Campaigns.AnalyticsAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.webhooks.list",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "TeamClient.campaigns.analytics"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/projects/{projectId}/webhooks/{webhookId}",
- "operationId": "getProjectWebhook",
- "fingerprint": "beb5a46109c3184248e4ac592885dd7af0133815060be5866a098a937f6e1c04",
+ "path": "/platform/campaigns/{campaignId}/approvals",
+ "operationId": "listCampaignLaunchApprovals",
+ "fingerprint": "b08465f0c1bdb7d6a831bbef97400c5c58c0791bede04e942c2f9b469e418eb4",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).webhooks.retrieve"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Webhooks.Retrieve",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.webhooks.retrieve",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "Client::webhooks.retrieve",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Webhooks.RetrieveAsync",
- "untypedResponseFields": ["phoneOfflineStartDay"]
- },
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
"rust": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ }
+ },
+ {
+ "family": "platform",
+ "method": "GET",
+ "path": "/platform/campaigns/{campaignId}/conversions",
+ "operationId": "getCampaignConversions",
+ "fingerprint": "cdbc69370673658fe0bc4d1728eef8ec0402606d4325aeccb762acf7bb347407",
+ "typescript": {
"status": "covered",
- "method": "ProjectClient.webhooks.retrieve",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "Client.campaigns.conversions"
+ },
+ "go": {
+ "status": "covered",
+ "method": "TeamClient.Campaigns.Conversions"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncClient.campaigns.conversions"
+ },
+ "php": {
+ "status": "covered",
+ "method": "Client::campaigns.conversions"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "TeamClient.Campaigns.ConversionsAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "TeamClient.campaigns.conversions"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/quicklink",
- "operationId": "getQuickLinkSettings",
- "fingerprint": "1fb919c40176468c78ccda182ed9a3fede80afab37067287cf3a858cbf75f96b",
+ "path": "/platform/campaigns/{campaignId}/events",
+ "operationId": "listCampaignEvents",
+ "fingerprint": "8db06923fb939273cca49b4eed0f36796ce93ecad8e99ccee14cbd4d7f593825",
"typescript": {
"status": "covered",
- "method": "Client.quickLinkSettings.retrieve"
+ "method": "Client.campaigns.events"
},
"go": {
"status": "covered",
- "method": "TeamClient.QuickLinkSettings.Retrieve"
+ "method": "TeamClient.Campaigns.Events"
},
"python": {
"status": "covered",
- "method": "AsyncClient.quick_link_settings.retrieve"
+ "method": "AsyncClient.campaigns.events"
},
"php": {
"status": "covered",
- "method": "Client::quickLinkSettings.retrieve"
+ "method": "Client::campaigns.events"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.QuickLinkSettings.RetrieveAsync"
+ "method": "TeamClient.Campaigns.EventsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.quick_link_settings.retrieve"
+ "method": "TeamClient.campaigns.events"
+ }
+ },
+ {
+ "family": "platform",
+ "method": "GET",
+ "path": "/platform/campaigns/{campaignId}/links",
+ "operationId": "getCampaignLinks",
+ "fingerprint": "1ef89c59be3c2b9d0ba6763dae4ac705a78bb8f9ce0911c54ff6ee89220c3e66",
+ "typescript": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "go": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "python": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "php": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "dotnet": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "rust": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ }
+ },
+ {
+ "family": "platform",
+ "method": "GET",
+ "path": "/platform/campaigns/{campaignId}/recipients",
+ "operationId": "listCampaignRecipients",
+ "fingerprint": "b565d662e37e2ab676816c9ed5deba7deb52377223028d39f77759f83cbf1d67",
+ "typescript": {
+ "status": "covered",
+ "method": "Client.campaigns.recipients"
+ },
+ "go": {
+ "status": "covered",
+ "method": "TeamClient.Campaigns.Recipients"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncClient.campaigns.recipients"
+ },
+ "php": {
+ "status": "covered",
+ "method": "Client::campaigns.recipients"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "TeamClient.Campaigns.RecipientsAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "TeamClient.campaigns.recipients"
+ }
+ },
+ {
+ "family": "platform",
+ "method": "GET",
+ "path": "/platform/campaigns/{campaignId}/recipients/export",
+ "operationId": "exportCampaignRecipients",
+ "fingerprint": "1c9619d1fae7c00d1513465f33242862fc402adb0ba9b496ad9366b9295fca7b",
+ "typescript": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "go": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "python": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "php": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "dotnet": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "rust": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/session-configuration",
- "operationId": "getSessionConfigurationDefaults",
- "fingerprint": "3e20e5314bd7050e161bb6edc3e3826dff0a8077cf33f8306649c754af0df599",
+ "path": "/platform/connection-configuration",
+ "operationId": "getConnectionConfigurationDefaults",
+ "fingerprint": "e2f1e5101f00f94e136d5bf70faee1d626df9830dd2277b5afe53e355f26cb0d",
"typescript": {
"status": "covered",
- "method": "Client.sessionConfiguration.retrieve"
+ "method": "Client.connectionConfiguration.retrieve"
},
"go": {
"status": "covered",
- "method": "TeamClient.SessionConfiguration.Retrieve"
+ "method": "TeamClient.ConnectionConfiguration.Retrieve"
},
"python": {
"status": "covered",
- "method": "AsyncClient.session_configuration.retrieve"
+ "method": "AsyncClient.connection_configuration.retrieve"
},
"php": {
"status": "covered",
- "method": "Client::sessionConfiguration.retrieve"
+ "method": "Client::connectionConfiguration.retrieve"
},
"dotnet": {
"status": "covered",
@@ -12053,52 +12956,52 @@
},
"rust": {
"status": "covered",
- "method": "TeamClient.session_configuration.retrieve"
+ "method": "TeamClient.connection_configuration.retrieve"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions",
- "operationId": "listPlatformSessions",
- "fingerprint": "42961f70bafb0a48b63950baf1d7e411cef60b1008395742e456d6b6d6571b2e",
+ "path": "/platform/connections",
+ "operationId": "listPlatformConnections",
+ "fingerprint": "2e71df39712ccfcb358d0542dce83972e36387ca513ab0107b0a6158886716c6",
"typescript": {
"status": "covered",
- "method": "Client.sessions.list",
+ "method": "Client.connections.list",
"untypedResponseFields": ["inspector"]
},
"go": {
"status": "covered",
- "method": "TeamClient.Sessions.List",
+ "method": "TeamClient.Connections.List",
"untypedResponseFields": ["inspector"]
},
"python": {
"status": "covered",
- "method": "AsyncClient.sessions.list",
+ "method": "AsyncClient.connections.list",
"untypedResponseFields": ["inspector"]
},
"php": {
"status": "covered",
- "method": "Client::sessions.list",
+ "method": "Client::connections.list",
"untypedResponseFields": ["inspector"]
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Sessions.ListAsync",
+ "method": "TeamClient.Connections.ListAsync",
"untypedResponseFields": ["inspector"]
},
"rust": {
"status": "covered",
- "method": "MessagingClient.sessions.list",
+ "method": "MessagingClient.connections.list",
"untypedResponseFields": ["inspector"]
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{session}/call-settings",
+ "path": "/platform/connections/{connection}/call-settings",
"operationId": "getCallSettings",
- "fingerprint": "337ec7c66804a18e0b30e943b0d4ee2a9d3032dc757960d850067828515ff927",
+ "fingerprint": "dbb40a70c0019fc8b2822a50016362fb802c2c7c16aa6fd59488567c6c367690",
"typescript": {
"status": "covered",
"method": "MessagingClient.voip.retrieveCallSettings"
@@ -12127,9 +13030,9 @@
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{session}/client-rules",
+ "path": "/platform/connections/{connection}/client-rules",
"operationId": "getClientRules",
- "fingerprint": "48c6a2b5fc27ced2c9fe71203733cdf307fd4f4e812cf790fdfd2fc3894d1570",
+ "fingerprint": "9bc31953710c63590af20d516e141688951eeeff9050bd69239df34fc73b4dd0",
"typescript": {
"status": "covered",
"method": "MessagingClient.clientTokens.retrieveRules"
@@ -12158,6230 +13061,6224 @@
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{sessionId}",
- "operationId": "getSession",
- "fingerprint": "565de382ce5494501975fdc1cb76ed2c1a425cc6cf10cfe55b9f46a87e3b8a2d",
+ "path": "/platform/connections/{connectionId}",
+ "operationId": "getConnection",
+ "fingerprint": "d35bd4f5bc922d1926d71f7b6df058a4cea5b45e2cc517922058c4fa5e8ea2b4",
"typescript": {
"status": "covered",
- "method": "Client.sessions.retrieve",
+ "method": "Client.connections.retrieve",
"untypedResponseFields": ["inspector"]
},
"go": {
"status": "covered",
- "method": "TeamClient.Sessions.Retrieve",
+ "method": "TeamClient.Connections.Retrieve",
"untypedResponseFields": ["inspector"]
},
"python": {
"status": "covered",
- "method": "AsyncClient.sessions.retrieve",
+ "method": "AsyncClient.connections.retrieve",
"untypedResponseFields": ["inspector"]
},
"php": {
"status": "covered",
- "method": "Client::sessions.retrieve",
+ "method": "Client::connections.retrieve",
"untypedResponseFields": ["inspector"]
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Sessions.RetrieveAsync",
+ "method": "TeamClient.Connections.RetrieveAsync",
"untypedResponseFields": ["inspector"]
},
"rust": {
"status": "covered",
- "method": "MessagingClient.sessions.retrieve",
+ "method": "MessagingClient.connections.retrieve",
"untypedResponseFields": ["inspector"]
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{sessionId}/capabilities",
- "operationId": "getSessionCapabilities",
- "fingerprint": "7c738933cb84b67c0620bfdddc22455654a248589b6123918ccf8a4847f79223",
+ "path": "/platform/connections/{connectionId}/capabilities",
+ "operationId": "getConnectionCapabilities",
+ "fingerprint": "c1fac0a5d83c461c33af4963b14855949235af3cb451482f8b87677b9202c56c",
"typescript": {
"status": "covered",
- "method": "Client.sessions.getCapabilities"
+ "method": "Client.connections.getCapabilities"
},
"go": {
"status": "covered",
- "method": "TeamClient.Sessions.GetCapabilities"
+ "method": "TeamClient.Connections.GetCapabilities"
},
"python": {
"status": "covered",
- "method": "AsyncClient.sessions.get_capabilities"
+ "method": "AsyncClient.connections.get_capabilities"
},
"php": {
"status": "covered",
- "method": "Client::sessions.getCapabilities"
+ "method": "Client::connections.getCapabilities"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Sessions.GetCapabilitiesAsync"
+ "method": "TeamClient.Connections.GetCapabilitiesAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.sessions.get_capabilities"
+ "method": "TeamClient.connections.get_capabilities"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{sessionId}/me",
- "operationId": "getSessionAccount",
- "fingerprint": "dd9957fba3f344b0e67b738c783f06e52d3ebead6826ff53717d805f03d95fb1",
+ "path": "/platform/connections/{connectionId}/me",
+ "operationId": "getConnectionAccount",
+ "fingerprint": "4094ca6119b15028207b3d5bb235f170edbdf59d4592c2314491070a69c7c37a",
"typescript": {
"status": "covered",
- "method": "MessagingClient.sessions.account"
+ "method": "MessagingClient.connections.account"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Sessions.Account"
+ "method": "MessagingClient.Connections.Account"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.sessions.account"
+ "method": "AsyncMessagingClient.connections.account"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$sessions->account"
+ "method": "MessagingClient::$connections->account"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Sessions.AccountAsync"
+ "method": "TeamClient.Connections.AccountAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.sessions.account"
+ "method": "MessagingClient.connections.account"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{sessionId}/safe-mode",
- "operationId": "getNumberSafeMode",
- "fingerprint": "d5c4962f90760c6dac09d9fa16f8a2881410561e6d6253cdfbd16a7f2a910c78",
+ "path": "/platform/connections/{connectionId}/safe-mode",
+ "operationId": "getPlatformConnectionSafeMode",
+ "fingerprint": "754307d1be3f20b924cdee0a20892ddf09f40d7e07b0c06f0fff6b3ee6f3ffa7",
"typescript": {
"status": "covered",
- "method": "Client.sessions.getSafeMode"
+ "method": "Client.connections.getSafeMode"
},
"go": {
"status": "covered",
- "method": "TeamClient.Sessions.GetSafeMode"
+ "method": "TeamClient.Connections.GetSafeMode"
},
"python": {
"status": "covered",
- "method": "AsyncClient.sessions.get_safe_mode"
+ "method": "AsyncClient.connections.get_safe_mode"
},
"php": {
"status": "covered",
- "method": "Client::$sessions->getSafeMode"
+ "method": "Client::$connections->getSafeMode"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Sessions.GetSafeModeAsync"
+ "method": "TeamClient.Connections.GetSafeModeAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.sessions.get_safe_mode"
+ "method": "TeamClient.connections.get_safe_mode"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{sessionId}/tier-quotes/{quoteId}",
- "operationId": "getSessionTierChange",
- "fingerprint": "322d3adde2aec8d12b52bac3db395d140d84acab1d2516a529c11e2652606af8",
+ "path": "/platform/connections/{connectionId}/tier-quotes/{quoteId}",
+ "operationId": "getConnectionTierChange",
+ "fingerprint": "fc5513f42344b082b96a0dcced982d84c22dd63c26709873bee1eed003bbdfa0",
"typescript": {
"status": "covered",
- "method": "Client.sessions.retrieveTierChange"
+ "method": "Client.connections.retrieveTierChange"
},
"go": {
"status": "covered",
- "method": "TeamClient.Sessions.RetrieveTierChange"
+ "method": "TeamClient.Connections.RetrieveTierChange"
},
"python": {
"status": "covered",
- "method": "AsyncClient.sessions.retrieve_tier_change"
+ "method": "AsyncClient.connections.retrieve_tier_change"
},
"php": {
"status": "covered",
- "method": "Client::sessions.retrieveTierChange"
+ "method": "Client::connections.retrieveTierChange"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Sessions.RetrieveTierChangeAsync"
+ "method": "TeamClient.Connections.RetrieveTierChangeAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.sessions.retrieve_tier_change"
+ "method": "TeamClient.connections.retrieve_tier_change"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sip-trunks",
- "operationId": "listSipTrunks",
- "fingerprint": "c37824a040bd4adee1d1126af27bb250ce296bdca13ac808b2deb6a853c46d6c",
+ "path": "/platform/customers",
+ "operationId": "listCustomers",
+ "fingerprint": "c110165dc90ad33826a680a849b64a790ccd9f2989c5d5f638c1243c8ce1444c",
"typescript": {
"status": "covered",
- "method": "Client.sipTrunks.list"
+ "method": "Client.customers.list"
},
"go": {
"status": "covered",
- "method": "TeamClient.SIPTrunks.List"
+ "method": "TeamClient.Customers.List"
},
"python": {
"status": "covered",
- "method": "AsyncClient.sip_trunks.list"
+ "method": "AsyncClient.customers.list"
},
"php": {
"status": "covered",
- "method": "Client::sipTrunks.list"
+ "method": "Client::customers.list"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.SipTrunks.ListAsync"
+ "method": "TeamClient.Customers.ListAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.sip_trunks.list"
+ "method": "TeamClient.customers.list"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sip-trunks/{trunkId}",
- "operationId": "getSipTrunk",
- "fingerprint": "efc1d56df1e379595ff02a0d928f46d162a15177568beb30996aebcb50da8119",
+ "path": "/platform/customers/{customerId}",
+ "operationId": "getCustomer",
+ "fingerprint": "ac6939c47d22d5577430874830fc8d99d69ea5d992e27838078df539d86ec1f2",
"typescript": {
"status": "covered",
- "method": "Client.sipTrunks.retrieve"
+ "method": "Client.customers.retrieve"
},
"go": {
"status": "covered",
- "method": "TeamClient.SIPTrunks.Retrieve"
+ "method": "TeamClient.Customers.Retrieve"
},
"python": {
"status": "covered",
- "method": "AsyncClient.sip_trunks.retrieve"
+ "method": "AsyncClient.customers.retrieve"
},
"php": {
"status": "covered",
- "method": "Client::sipTrunks.retrieve"
+ "method": "Client::customers.retrieve"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.SipTrunks.RetrieveAsync"
+ "method": "TeamClient.Customers.RetrieveAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.sip_trunks.retrieve"
+ "method": "TeamClient.customers.retrieve"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sip/endpoint",
- "operationId": "getSipEndpoint",
- "fingerprint": "d9ad92aab98667e3282a3cd3e3f5b76b5e2906a0c9e80c5d2f66d47f6a6b7e63",
+ "path": "/platform/customers/{customerId}/connections",
+ "operationId": "listCustomerConnections",
+ "fingerprint": "056d4e93b934c54a087fc2a345dd369ce98b08d24edb319e301b9742f7fa4788",
"typescript": {
"status": "covered",
- "method": "Client.sipTrunks.endpoint"
+ "method": "Client.customers.listConnections"
},
"go": {
"status": "covered",
- "method": "TeamClient.SIPTrunks.Endpoint"
+ "method": "TeamClient.Customers.ListConnections"
},
"python": {
"status": "covered",
- "method": "AsyncClient.sip_trunks.endpoint"
+ "method": "AsyncClient.customers.list_connections"
},
"php": {
"status": "covered",
- "method": "Client::sipTrunks.endpoint"
+ "method": "Client::customers.listConnections"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.SipTrunks.EndpointAsync"
+ "method": "TeamClient.Customers.ListConnectionsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.sip_trunks.endpoint"
+ "method": "TeamClient.customers.list_connections"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/team",
- "operationId": "getTeam",
- "fingerprint": "d4af12d9edeaa7d34e263aaf535267e80a2f4b09777f4b3c0cf8a321d7210a0d",
+ "path": "/platform/customers/{customerId}/events",
+ "operationId": "listCustomerEvents",
+ "fingerprint": "d53bc908da130a91d7dde149843a57d54a19a851153fe60eb14a8f7141315902",
"typescript": {
"status": "covered",
- "method": "Client.teams.retrieve"
+ "method": "Client.customers.listEvents"
},
"go": {
"status": "covered",
- "method": "TeamClient.Teams.Retrieve"
+ "method": "TeamClient.Customers.ListEvents"
},
"python": {
"status": "covered",
- "method": "AsyncClient.teams.retrieve"
+ "method": "AsyncClient.customers.list_events"
},
"php": {
"status": "covered",
- "method": "Client::teams.retrieve"
+ "method": "Client::customers.listEvents"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Teams.RetrieveAsync"
+ "method": "TeamClient.Customers.ListEventsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.teams.retrieve"
+ "method": "TeamClient.customers.list_events"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/templates",
- "operationId": "listMessageTemplates",
- "fingerprint": "6cf8333480110a08af25186da570f15ee30033e01602e8d78820936586a25a53",
+ "path": "/platform/customers/{customerId}/pairing-links",
+ "operationId": "listCustomerPairingLinks",
+ "fingerprint": "2cb95b40a694879d86759dde4ab23f145b58968d433970048747fb6ecbd3b821",
"typescript": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "covered",
+ "method": "Client.customers.listPairingLinks"
},
"go": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client."
+ "status": "covered",
+ "method": "TeamClient.Customers.ListPairingLinks"
},
"python": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "covered",
+ "method": "AsyncClient.customers.list_pairing_links"
},
"php": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "covered",
+ "method": "Client::customers.listPairingLinks"
},
"dotnet": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client."
+ "status": "covered",
+ "method": "TeamClient.Customers.ListPairingLinksAsync"
},
"rust": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "covered",
+ "method": "TeamClient.customers.list_pairing_links"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/templates/{templateId}",
- "operationId": "getMessageTemplate",
- "fingerprint": "b2ead012a584bfa67983b6c0e0b20b18aaa615cb592cd5a2d556d9fb225ed2c8",
- "typescript": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "path": "/platform/events",
+ "operationId": "listTeamEvents",
+ "fingerprint": "18edeb21548b93272fbca5c6f0dbf61bfb236b7d4f83e171d46d9cebc651b7d8",
+ "typescript": {
+ "status": "covered",
+ "method": "Client.events.list"
},
"go": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client."
+ "status": "covered",
+ "method": "TeamClient.Events.List"
},
"python": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "covered",
+ "method": "AsyncClient.events.list"
},
"php": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "covered",
+ "method": "Client::events.list"
},
"dotnet": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client."
+ "status": "covered",
+ "method": "TeamClient.Events.ListAsync"
},
"rust": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "covered",
+ "method": "TeamClient.events.list"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/usage",
- "operationId": "getUsageSummary",
- "fingerprint": "05e1098387da4a1f1d308c1c57ce3f5b2bcaa267093314d03d5a10d1da1c1735",
+ "path": "/platform/events/{eventId}",
+ "operationId": "getTeamEvent",
+ "fingerprint": "845d8b399fec0983931fa1c6b6cc56914d2ed5bf0e1d3d87b8a864d18656eaa3",
"typescript": {
"status": "covered",
- "method": "Client.usage.summary"
+ "method": "Client.events.retrieve"
},
"go": {
"status": "covered",
- "method": "TeamClient.Usage.Summary"
+ "method": "TeamClient.Events.Retrieve"
},
"python": {
"status": "covered",
- "method": "AsyncClient.usage.summary"
+ "method": "AsyncClient.events.retrieve"
},
"php": {
"status": "covered",
- "method": "Client::usage.summary"
+ "method": "Client::events.retrieve"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Usage.SummaryAsync"
+ "method": "TeamClient.Events.RetrieveAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.usage.summary"
+ "method": "TeamClient.events.retrieve_with_payload"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/usage/records",
- "operationId": "listUsageRecords",
- "fingerprint": "5a60eda75db6467d2c5a9256a70916d5b54de0f46fdef540a3bb8cd395e882e1",
+ "path": "/platform/feature-terms",
+ "operationId": "listFeatureTerms",
+ "fingerprint": "0a7e1934f587afc1c981d5f0a78c8f1728a7d5967010cb056eb55c332f84293e",
"typescript": {
- "status": "covered",
- "method": "Client.usage.listRecords"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Usage.ListRecords"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.usage.list_records"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "Client::usage.listRecords"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Usage.ListRecordsAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.usage.list_records"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/voice/audio",
- "operationId": "listVoiceAudio",
- "fingerprint": "ae0b278627a83958e04e282ee776cd8a9a67a5dd94c9da577b2243bc9322d392",
+ "path": "/platform/flow-encryption-keys",
+ "operationId": "getFlowEncryptionKey",
+ "fingerprint": "a17584c28287177aaa94a715edbd34d96fb40f7754c59468b183550f85621bc9",
"typescript": {
"status": "covered",
- "method": "Client.voice.audio.list"
+ "method": "Client.project(projectId).flows.encryptionKey"
},
"go": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.List"
+ "method": "ProjectClient.Flows.EncryptionKey"
},
"python": {
"status": "covered",
- "method": "AsyncClient.voice.audio.list"
+ "method": "AsyncProjectClient.flows.encryption_key"
},
"php": {
"status": "covered",
- "method": "Client::voice.audio.list"
+ "method": "ProjectClient::flows.encryptionKey"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.ListAsync"
+ "method": "ProjectClient.Flows.EncryptionKeyAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.voice.audio.list"
+ "method": "ProjectClient.flows.encryption_key"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/voice/audio/{assetId}",
- "operationId": "getVoiceAudio",
- "fingerprint": "2ba151b5495eb5bf0ba92ea6ef1d5a899f3af45c3ecca02c789639a5d13ac21d",
+ "path": "/platform/flows",
+ "operationId": "listFlows",
+ "fingerprint": "4488882e17987c1c5c511f3533d33b1fde90b4eef5d0ae914fe4a65e1f855198",
"typescript": {
"status": "covered",
- "method": "Client.voice.audio.retrieve"
+ "method": "Client.project(projectId).flows.list"
},
"go": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.Retrieve"
+ "method": "ProjectClient.Flows.List"
},
"python": {
"status": "covered",
- "method": "AsyncClient.voice.audio.retrieve"
+ "method": "AsyncProjectClient.flows.list"
},
"php": {
"status": "covered",
- "method": "Client::voice.audio.retrieve"
+ "method": "ProjectClient::flows.list"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.RetrieveAsync"
+ "method": "ProjectClient.Flows.ListAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.voice.audio.retrieve"
+ "method": "ProjectClient.flows.list"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/voice/audio/{assetId}/preview",
- "operationId": "getVoiceAudioPreview",
- "fingerprint": "8de81cb3442bc6f293c6bc31dc4d1066e101ff92130239b9d170c72719dbc528",
+ "path": "/platform/flows/{flowId}",
+ "operationId": "getFlow",
+ "fingerprint": "d43c1a9ce8e64611eda872d1d2cba8cadcb61bc556586e9b8f35efb8fb7f44d5",
"typescript": {
"status": "covered",
- "method": "Client.voice.audio.previewUrl"
+ "method": "Client.project(projectId).flows.retrieve"
},
"go": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.PreviewURL"
+ "method": "ProjectClient.Flows.Retrieve"
},
"python": {
"status": "covered",
- "method": "AsyncClient.voice.audio.preview_url"
+ "method": "AsyncProjectClient.flows.retrieve"
},
"php": {
"status": "covered",
- "method": "Client::voice.audio.previewUrl"
+ "method": "ProjectClient::flows.retrieve"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.PreviewUrlAsync"
+ "method": "ProjectClient.Flows.RetrieveAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.voice.audio.preview_url"
+ "method": "ProjectClient.flows.retrieve"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/voice/provider-credentials",
- "operationId": "listVoiceProviderCredentials",
- "fingerprint": "2865a8985d33ed86df2b39a81b6efa68029fe3b8585dbeb3aa42c45f1b642fa3",
+ "path": "/platform/flows/{flowId}/endpoint",
+ "operationId": "getFlowEndpoint",
+ "fingerprint": "fea68c216f67f293ecf9bd662c81b22e314b643db9e87b86e00e8ff79b871cd6",
"typescript": {
"status": "covered",
- "method": "Client.voice.providerCredentials.list"
+ "method": "Client.project(projectId).flows.endpoint"
},
"go": {
"status": "covered",
- "method": "TeamClient.Voice.ProviderCredentials.List"
+ "method": "ProjectClient.Flows.Endpoint"
},
"python": {
"status": "covered",
- "method": "AsyncClient.voice.provider_credentials.list"
+ "method": "AsyncProjectClient.flows.endpoint"
},
"php": {
"status": "covered",
- "method": "Client::voice.providerCredentials.list"
+ "method": "ProjectClient::flows.endpoint"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Voice.ProviderCredentials.ListAsync"
+ "method": "ProjectClient.Flows.EndpointAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.voice.provider_credentials"
+ "method": "ProjectClient.flows.endpoint"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/voice/provider-credentials/{credentialId}",
- "operationId": "getVoiceProviderCredential",
- "fingerprint": "2721a722222029c9abba9965008fceb0ec5d833fa0f1cac4f398ac322782d770",
+ "path": "/platform/flows/{flowId}/endpoint/receipts",
+ "operationId": "listFlowEndpointReceipts",
+ "fingerprint": "a441c9fcbfaec07d0b43226e6a6d6a8bb7b9fa9213686ba38f3f49eb0f37eb2e",
"typescript": {
"status": "covered",
- "method": "Client.voice.providerCredentials.retrieve"
+ "method": "Client.project(projectId).flows.endpointReceipts"
},
"go": {
"status": "covered",
- "method": "TeamClient.Voice.ProviderCredentials.Retrieve"
+ "method": "ProjectClient.Flows.EndpointReceipts"
},
"python": {
"status": "covered",
- "method": "AsyncClient.voice.provider_credentials.retrieve"
+ "method": "AsyncProjectClient.flows.endpoint_receipts"
},
"php": {
"status": "covered",
- "method": "Client::voice.providerCredentials.retrieve"
+ "method": "ProjectClient::flows.endpointReceipts"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Voice.ProviderCredentials.RetrieveAsync"
+ "method": "ProjectClient.Flows.EndpointReceiptsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.voice.provider_credentials.retrieve"
+ "method": "ProjectClient.flows.endpoint_receipts"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/webhook-deliveries",
- "operationId": "listTeamWebhookDeliveries",
- "fingerprint": "dea8e827f2915a6e9965b3a316269b44a4fe3057543b0b32dc1804f74c8a101d",
+ "path": "/platform/flows/{flowId}/receipts",
+ "operationId": "listFlowOperations",
+ "fingerprint": "7b700474619a89a81c11f00096c794c7bfd4a888d345cd3166df52f863f83b13",
"typescript": {
"status": "covered",
- "method": "Client.webhookDeliveries.list"
+ "method": "Client.project(projectId).flows.receipts"
},
"go": {
"status": "covered",
- "method": "TeamClient.WebhookDeliveries.List"
+ "method": "ProjectClient.Flows.Receipts"
},
"python": {
"status": "covered",
- "method": "AsyncClient.webhook_deliveries.list"
+ "method": "AsyncProjectClient.flows.receipts"
},
"php": {
"status": "covered",
- "method": "Client::webhookDeliveries.list"
+ "method": "ProjectClient::flows.receipts"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.WebhookDeliveries.ListAsync"
+ "method": "ProjectClient.Flows.ReceiptsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.webhook_deliveries.list"
+ "method": "ProjectClient.flows.receipts"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/webhook-deliveries/{deliveryId}",
- "operationId": "getTeamWebhookDelivery",
- "fingerprint": "71089544cd42711f5a0e23a59d9de8be36e066be31736b589bccd7d338d3e114",
+ "path": "/platform/functions",
+ "operationId": "listFunctions",
+ "fingerprint": "0f80215a41699cb11532613d970f2383c3928bca5bcc7a5bca7adb380beb0c39",
"typescript": {
"status": "covered",
- "method": "Client.webhookDeliveries.retrieve"
+ "method": "Client.project(projectId).functions.list"
},
"go": {
"status": "covered",
- "method": "TeamClient.WebhookDeliveries.Retrieve"
+ "method": "ProjectClient.Functions.List"
},
"python": {
"status": "covered",
- "method": "AsyncClient.webhook_deliveries.retrieve"
+ "method": "AsyncProjectClient.functions.list"
},
"php": {
"status": "covered",
- "method": "Client::webhookDeliveries.retrieve"
+ "method": "ProjectClient::functions.list"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.WebhookDeliveries.RetrieveAsync"
+ "method": "ProjectClient.Functions.ListAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.webhook_deliveries.retrieve"
+ "method": "ProjectClient.functions.list"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/webhook-deliveries/{deliveryId}/attempts",
- "operationId": "listTeamWebhookDeliveryAttempts",
- "fingerprint": "ecd27f92e5a853bc1cf4c9186582d8e0b86aaca8fbe7cfceed76d6e695f564b9",
+ "path": "/platform/functions/{functionId}",
+ "operationId": "getFunction",
+ "fingerprint": "9cf44d97935978873515a83aa747532350d10265668af8203b7aa7a828c9204d",
"typescript": {
"status": "covered",
- "method": "Client.webhookDeliveries.listAttempts"
+ "method": "Client.project(projectId).functions.retrieve"
},
"go": {
"status": "covered",
- "method": "TeamClient.WebhookDeliveries.ListAttempts"
+ "method": "ProjectClient.Functions.Retrieve"
},
"python": {
"status": "covered",
- "method": "AsyncClient.webhook_deliveries.list_attempts"
+ "method": "AsyncProjectClient.functions.retrieve"
},
"php": {
"status": "covered",
- "method": "Client::webhookDeliveries.listAttempts"
+ "method": "ProjectClient::functions.retrieve"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.WebhookDeliveries.ListAttemptsAsync"
+ "method": "ProjectClient.Functions.RetrieveAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.webhook_deliveries.list_attempts"
+ "method": "ProjectClient.functions.retrieve"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/webhook-deliveries/{deliveryId}/attempts/{attemptId}",
- "operationId": "getTeamWebhookDeliveryAttempt",
- "fingerprint": "44d9d26d90e7215b5c3ce70a77c89249e1cc0ecdcccd476b042a9af6ff0d0918",
+ "path": "/platform/functions/{functionId}/deployments",
+ "operationId": "listFunctionDeployments",
+ "fingerprint": "e17a718fb9857b0bdd23a8afa9c945ae4ef643a957052c437112fe0c51e09dd9",
"typescript": {
"status": "covered",
- "method": "Client.webhookDeliveries.retrieveAttempt"
+ "method": "Client.project(projectId).functions.deployments.list"
},
"go": {
"status": "covered",
- "method": "TeamClient.WebhookDeliveries.RetrieveAttempt"
+ "method": "ProjectClient.Functions.Deployments.List"
},
"python": {
"status": "covered",
- "method": "AsyncClient.webhook_deliveries.retrieve_attempt"
+ "method": "AsyncProjectClient.functions.deployments.list"
},
"php": {
"status": "covered",
- "method": "Client::webhookDeliveries.retrieveAttempt"
+ "method": "ProjectClient::functions.deployments.list"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.WebhookDeliveries.RetrieveAttemptAsync"
+ "method": "ProjectClient.Functions.Deployments.ListAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.webhook_deliveries.retrieve_attempt"
+ "method": "ProjectClient.functions.deployments.list"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/webhooks",
- "operationId": "listTeamWebhooks",
- "fingerprint": "ec8192a7856f9410b12b918cc52fc060fe809730e6c142b50d953379d3c38fad",
+ "path": "/platform/functions/{functionId}/deployments/{deploymentId}",
+ "operationId": "getFunctionDeployment",
+ "fingerprint": "2e1ec6be6de34b49c75f7a8ee281f2717e67490d06e21ff7207712d1371acc1c",
"typescript": {
"status": "covered",
- "method": "Client.webhooks.list"
+ "method": "Client.project(projectId).functions.deployments.retrieve"
},
"go": {
"status": "covered",
- "method": "TeamClient.Webhooks.List",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "ProjectClient.Functions.Deployments.Retrieve"
},
"python": {
"status": "covered",
- "method": "AsyncClient.webhooks.list",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "AsyncProjectClient.functions.deployments.retrieve"
},
"php": {
"status": "covered",
- "method": "Client::webhooks.list",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "ProjectClient::functions.deployments.retrieve"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Webhooks.ListAsync",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "ProjectClient.Functions.Deployments.RetrieveAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.webhooks.list",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "ProjectClient.functions.deployments.retrieve"
}
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/webhooks/{webhookId}",
- "operationId": "getTeamWebhook",
- "fingerprint": "0e91d7603e7b42e7e4640675a503889592cce72312022115234091640eca7a6b",
+ "path": "/platform/functions/{functionId}/invocations",
+ "operationId": "listFunctionInvocations",
+ "fingerprint": "f3837b2b2e1fea81d90b77b9bbab7747c2abaef7f815493b4a68448b1c12aaf0",
"typescript": {
"status": "covered",
- "method": "Client.webhooks.retrieve"
+ "method": "Client.project(projectId).functions.invocations.list"
},
"go": {
"status": "covered",
- "method": "TeamClient.Webhooks.Retrieve",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "ProjectClient.Functions.Invocations.List"
},
"python": {
"status": "covered",
- "method": "AsyncClient.webhooks.retrieve",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "AsyncProjectClient.functions.invocations.list"
},
"php": {
"status": "covered",
- "method": "Client::webhooks.retrieve",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "ProjectClient::functions.invocations.list"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Webhooks.RetrieveAsync",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "ProjectClient.Functions.Invocations.ListAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.webhooks.retrieve",
- "untypedResponseFields": ["phoneOfflineStartDay"]
+ "method": "ProjectClient.functions.invocations.list"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/console/members/{memberId}",
- "operationId": "updateMemberRole",
- "fingerprint": "f5f1cb5ee626894341c9cbf993fea4fa089349c054a7b8261e53e5b1397771ee",
+ "method": "GET",
+ "path": "/platform/functions/{functionId}/invocations/{invocationId}",
+ "operationId": "getFunctionInvocation",
+ "fingerprint": "63e615a48b7ac8912995f5aebb314b245081002eaf53dae3b45864277a266ac4",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).functions.invocations.retrieve"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Functions.Invocations.Retrieve"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.functions.invocations.retrieve"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "ProjectClient::functions.invocations.retrieve"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Functions.Invocations.RetrieveAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.functions.invocations.retrieve"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/console/team",
- "operationId": "updateTeam",
- "fingerprint": "1d780cf25bdfd9e4af811346c795dbb87364dc5933e51f5063d576ee87ddaf0c",
+ "method": "GET",
+ "path": "/platform/functions/{functionId}/secrets",
+ "operationId": "listFunctionSecrets",
+ "fingerprint": "134852b2c4e99c5559e5107b764c1d75efe6ba0e3f7e9d6fadfd373a1d221ad2",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).functions.secrets.list"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Functions.Secrets.List"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.functions.secrets.list"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "ProjectClient::functions.secrets.list"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Functions.Secrets.ListAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.functions.secrets.list"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/console/profile",
- "operationId": "updateUserProfileField",
- "fingerprint": "44d6a602f4ff81eb69ea2dd6fb67210cc884cc80d9a8dbbcccacdf2b40686b05",
+ "method": "GET",
+ "path": "/platform/gates",
+ "operationId": "listUsageGates",
+ "fingerprint": "72d60d5773cbf510dd18e4d3623bc52438e548e2d847edd4b78cc139b344b862",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.usage.listGates"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Usage.ListGates"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.usage.list_gates"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::usage.listGates"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Usage.ListGatesAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.usage.list_gates"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/console/projects/{projectId}",
- "operationId": "updateProject",
- "fingerprint": "2a67db2aabf87aa80dcdc0d93b53d558dafb3b91862b7d93d34714bbe1928173",
+ "method": "GET",
+ "path": "/platform/incidents",
+ "operationId": "listSecurityIncidents",
+ "fingerprint": "8c4b9bbda261f8ac588aad81b26a76c96b1d02c4e422a7081e46fbd5eafe9888",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.securityIncidents.list"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.SecurityIncidents.List"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.security_incidents.list"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::securityIncidents.list"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.SecurityIncidents.ListAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.security_incidents.list"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/console/sip-trunks/{trunkId}",
- "operationId": "updateConsoleSipTrunk",
- "fingerprint": "868db0cb62650de976db3d57e844200fc64bf646c4dabba2e243314a92b63813",
+ "method": "GET",
+ "path": "/platform/media/{mediaId}",
+ "operationId": "getMediaUrl",
+ "fingerprint": "f87cdcba78f38582c51de0a144c6671b5c21766b61f90f4308c84c27a4c480a9",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.media.retrieve"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Media.Retrieve"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.media.retrieve"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::media.retrieve"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Media.RetrieveAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.media.retrieve"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/console/voice/audio/{assetId}",
- "operationId": "updateConsoleVoiceAudio",
- "fingerprint": "b09c19c1c2dc34d643d68dc7e7746d7c8536310c6c6d12bb542cddc322c3b070",
+ "method": "GET",
+ "path": "/platform/members",
+ "operationId": "listMembers",
+ "fingerprint": "5ef6b2becea4dc96bb5a2a98fb6aec1000a32e657e14194acd388f1297569b8e",
"typescript": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "Client.members.list"
},
"go": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "TeamClient.Members.List"
},
"python": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.members.list"
},
"php": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::members.list"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "TeamClient.Members.ListAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.members.list"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/console/webhooks/{webhookId}",
- "operationId": "updateWebhook",
- "fingerprint": "f73335936e4b8d00a5256c2a0beaf9cf21974de7b89c5ad4c6962e8272c3d3c7",
+ "method": "GET",
+ "path": "/platform/operations",
+ "operationId": "listPlatformOperations",
+ "fingerprint": "4066b3a1b334acc69bac874df67e75b624db873ba91f5abeb9d37d8b246d06ce",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.operations.list"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Operations.List"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.operations.list"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::operations.list"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Operations.ListAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.operations.list"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/platform/campaigns/{campaignId}",
- "operationId": "updateCampaign",
- "fingerprint": "a506b1b892d6b2c000c860cf038d33830c2da23af33557f8c2a009e07a11b3a2",
+ "method": "GET",
+ "path": "/platform/operations/{operationId}",
+ "operationId": "getPlatformOperation",
+ "fingerprint": "a5f6c4dea9f1350bf143527f3fd4e9baa5f65dc4335fd898179fd47b9b25fc0e",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.update"
+ "method": "Client.operations.get"
},
"go": {
"status": "covered",
- "method": "TeamClient.Campaigns.Update"
+ "method": "TeamClient.Operations.Get"
},
"python": {
"status": "covered",
- "method": "AsyncClient.campaigns.update"
+ "method": "AsyncClient.operations.get"
},
"php": {
"status": "covered",
- "method": "Client::campaigns.update"
+ "method": "Client::operations.retrieve"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Campaigns.UpdateAsync"
+ "method": "TeamClient.Operations.GetAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.campaigns.update"
+ "method": "TeamClient.operations.get"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/platform/customers/{customerId}",
- "operationId": "updateCustomer",
- "fingerprint": "359b58d67ac40dcf3945ca6fee94dbeb6fe066691f5b1df54a4eb2b4e5ca9455",
+ "method": "GET",
+ "path": "/platform/operations/{operationId}/transitions",
+ "operationId": "listPlatformOperationTransitions",
+ "fingerprint": "5f34f6daf67b0d4b134078c488080913630b6746ed52b3714c335de60719ad38",
"typescript": {
"status": "covered",
- "method": "Client.customers.update"
+ "method": "Client.operations.listTransitions"
},
"go": {
"status": "covered",
- "method": "TeamClient.Customers.Update"
+ "method": "TeamClient.Operations.ListTransitions"
},
"python": {
"status": "covered",
- "method": "AsyncClient.customers.update"
+ "method": "AsyncClient.operations.list_transitions"
},
"php": {
"status": "covered",
- "method": "Client::customers.update"
+ "method": "Client::operations.listTransitions"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Customers.UpdateAsync"
+ "method": "TeamClient.Operations.ListTransitionsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.customers.update"
+ "method": "TeamClient.operations.list_transitions"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/platform/flows/{flowId}",
- "operationId": "updateFlow",
- "fingerprint": "fdfe0fb0c2fab2c0bc18f9993a132daaaac93cd60c2af2850826eb2cec296176",
+ "method": "GET",
+ "path": "/platform/optouts",
+ "operationId": "listOptOuts",
+ "fingerprint": "0c2af19d2c0aa2d7b414fa359f764ea3dcec98067158e2c1f7a471f51942cf6b",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).flows.update"
+ "method": "Client.optOuts.list"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Flows.Update"
+ "method": "TeamClient.OptOuts.List"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.flows.update"
+ "method": "AsyncClient.opt_outs.list"
},
"php": {
"status": "covered",
- "method": "ProjectClient::flows.update"
+ "method": "Client::optOuts.list"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Flows.UpdateAsync"
+ "method": "TeamClient.OptOuts.ListAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.flows.update"
+ "method": "TeamClient.opt_outs.list"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/platform/functions/{functionId}",
- "operationId": "updateFunction",
- "fingerprint": "626ae33b8ec0773fc7a8a696df0178c1e4d14049a6eff0adaaf79994e017c878",
+ "method": "GET",
+ "path": "/platform/optouts/confirmation-settings",
+ "operationId": "getStopConfirmationSettings",
+ "fingerprint": "c5a536320d66a439737c9409f24c19a38eb1d04c1c2f3f0c61b20e572e199416",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).functions.update"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Functions.Update"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.functions.update"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::functions.update"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Functions.UpdateAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.functions.update"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/platform/projects/{projectId}/webhooks/{webhookId}",
- "operationId": "updateProjectWebhook",
- "fingerprint": "69b37ee47fd63d2d99eca7906634a11ca27f6580d3047c0a600a12c5ea843aa5",
+ "method": "GET",
+ "path": "/platform/optouts/confirmation-summary",
+ "operationId": "getStopConfirmationSummary",
+ "fingerprint": "49f357d86d3c7eece9ee42abcd3053907929aedd7de3adebe9e068b6be78ab38",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).webhooks.update"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/platform/sessions/{sessionId}",
- "operationId": "setSessionTierOverride",
- "fingerprint": "8b542d6377489ae008298f124f6e83a32fe2e36b07108eb61c6957e830eb3730",
+ "method": "GET",
+ "path": "/platform/optouts/settings",
+ "operationId": "getOptOutSettings",
+ "fingerprint": "febd3c9d24cc0074808de4b1df6f204204ebfa02a58cf1e6b9b61ec86ac79a99",
"typescript": {
"status": "covered",
- "method": "Client.sessions.setTierOverride"
+ "method": "Client.optOuts.getSettings"
},
"go": {
"status": "covered",
- "method": "TeamClient.Sessions.SetTierOverride"
+ "method": "TeamClient.OptOuts.GetSettings"
},
"python": {
"status": "covered",
- "method": "AsyncClient.sessions.set_tier_override"
+ "method": "AsyncClient.opt_outs.get_settings"
},
"php": {
"status": "covered",
- "method": "Client::sessions.setTierOverride"
+ "method": "Client::optOuts.getSettings"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Sessions.SetTierOverrideAsync"
+ "method": "TeamClient.OptOuts.GetSettingsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.sessions.set_tier_override"
+ "method": "TeamClient.opt_outs.get_settings"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/platform/sip-trunks/{trunkId}",
- "operationId": "updateSipTrunk",
- "fingerprint": "56c6cb9d987fcbee3416ee2dc9c0a9bd07b50e7d926039712b836bb58b8914f1",
+ "method": "GET",
+ "path": "/platform/projects",
+ "operationId": "listProjects",
+ "fingerprint": "40dc96e59739cfec291df46e98cc2e3f2b90aae1367d0dca99ab0e0e896a5cdb",
"typescript": {
"status": "covered",
- "method": "Client.sipTrunks.update"
+ "method": "Client.projects.list"
},
"go": {
"status": "covered",
- "method": "TeamClient.SIPTrunks.Update"
+ "method": "TeamClient.Projects.List"
},
"python": {
"status": "covered",
- "method": "AsyncClient.sip_trunks.update"
+ "method": "AsyncClient.projects.list"
},
"php": {
"status": "covered",
- "method": "Client::sipTrunks.update"
+ "method": "Client::projects.list"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.SipTrunks.UpdateAsync"
+ "method": "TeamClient.Projects.ListAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.sip_trunks.update"
+ "method": "TeamClient.projects.list"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/platform/templates/{templateId}",
- "operationId": "updateMessageTemplate",
- "fingerprint": "18e230e4b1150c3665d20d26287123541c21abf3b602fc9fa09b7adb07c6e87a",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/analytics",
+ "operationId": "getProjectWhatsAppAnalytics",
+ "fingerprint": "c379d363f6bad9c00fe8a707cfdef2b5b3197d0864e15a0d2868c492428dc938",
"typescript": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "covered",
+ "method": "Client.analytics.get"
},
+ "sourceContractSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
+ "sourceCommit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
+ "sdkContractSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
"go": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client."
+ "status": "covered",
+ "method": "ProjectClient.Analytics.Get"
},
"python": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "covered",
+ "method": "AsyncProjectClient.analytics.get"
},
"php": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "covered",
+ "method": "ProjectClient::analytics.get"
},
"dotnet": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client."
+ "status": "covered",
+ "method": "ProjectClient.Analytics.GetAsync"
},
"rust": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "covered",
+ "method": "ProjectClient.analytics.get"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/platform/voice/audio/{assetId}",
- "operationId": "updateVoiceAudio",
- "fingerprint": "f89e26fae9cd5b527425c392c66f2ebc927ffe59e232d785ef01074fe488df3d",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/analytics/metrics",
+ "operationId": "exportProjectWhatsAppAnalyticsMetrics",
"typescript": {
"status": "covered",
- "method": "Client.voice.audio.update"
+ "method": "Client.analytics.metrics"
},
+ "fingerprint": "7884e3c2c3c7cb07bc04a96e188019435ecfef5d66f72ff0684d15d8c0adb781",
+ "sourceContractSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
+ "sdkContractSha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559",
+ "sourceCommit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
"go": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.Update"
+ "method": "ProjectClient.Analytics.Metrics"
},
"python": {
"status": "covered",
- "method": "AsyncClient.voice.audio.update"
+ "method": "AsyncProjectClient.analytics.metrics"
},
"php": {
"status": "covered",
- "method": "Client::voice.audio.update"
+ "method": "ProjectClient::analytics.metrics"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.UpdateAsync"
+ "method": "ProjectClient.Analytics.MetricsAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.voice.audio.update"
+ "method": "ProjectClient.analytics.metrics"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/platform/webhooks/{webhookId}",
- "operationId": "updateTeamWebhook",
- "fingerprint": "b3459c3750869b8703ff0d18a588e3b58ce6479e0f7a21fb59af201710e268df",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/customers/{customerId}/signal-custody",
+ "operationId": "getCustomerSignalCustody",
+ "fingerprint": "3e5f662a1f4d1128287869955778045650bad447c44b3f1aabf0bceed378f8b8",
"typescript": {
- "status": "covered",
- "method": "Client.webhooks.update"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/api/account/features/enrollment",
- "operationId": "setFeatureEnrollment",
- "fingerprint": "e1151c397687075ee4658eda4b0e4f3a1f27003449aeeb127d2f425fd8f1ebc8",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/customers/status",
+ "operationId": "getCustomersStatus",
+ "fingerprint": "845610507153203132b6d960c7be1aba0a28455504dcca95482cb23fdc3fc6e4",
"typescript": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "Client.customers.status"
},
"go": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "TeamClient.Customers.Status"
},
"python": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.customers.status"
},
"php": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::customers.status"
},
"dotnet": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "TeamClient.Customers.StatusAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.customers.status"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/api/account/features/evaluate",
- "operationId": "evaluateAccountFeatures",
- "fingerprint": "4afc782993ccafa41dd2a0c346902e113b33b5275c92feb21bc595c1bcea92e0",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/events",
+ "operationId": "listProjectEvents",
+ "fingerprint": "48b7d28e11d3879890ca1841c506972f4be235cc89878d854ecf7027adf46c69",
"typescript": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "Client.project(projectId).events.list"
},
"go": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "ProjectClient.Events.List"
},
"python": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.events.list"
},
"php": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::events.list"
},
"dotnet": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "ProjectClient.Events.ListAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.events.list"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/api/account/features/exposure",
- "operationId": "recordFeatureExposure",
- "fingerprint": "465a9cd6ab3b8e697bea2dc3bdafd0cea7ae817ad092757b7465fd5b1faf69f2",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/events/{eventId}",
+ "operationId": "getProjectEvent",
+ "fingerprint": "8f199535efd485afd74e9703d62adfbcf36d0d74740415c347eba4d4e4e8fa7f",
"typescript": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "Client.project(projectId).events.retrieve"
},
"go": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "ProjectClient.Events.Stream"
},
"python": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.events.retrieve"
},
"php": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::events.retrieve"
},
"dotnet": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "ProjectClient.Events.RetrieveAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.events.retrieve_with_payload"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/auth/totp",
- "operationId": "enrollTotpUserProfile",
- "fingerprint": "e530e7997de14836260260087e59bc5015986171309dce09015ff9693ea85c49",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/events/stream",
+ "operationId": "streamProjectEvents",
+ "fingerprint": "af02013697634fd4500c9cb71bd60976209fcb6f7b2fa48120af060007a85483",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.events.stream"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Events.Stream"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.events.stream"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::events.stream"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Events.Stream"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.events.stream"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/auth/totp/verify",
- "operationId": "verifyTotpUserProfile",
- "fingerprint": "01022467e8a187b5631cef2f04ddace121ddc44e3fbc106940a17d9cad50e557",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/health-policy",
+ "operationId": "getProjectHealthPolicySettings",
+ "fingerprint": "0c7b9199ae7330e551074aee6e85de3f5cc30e9464b5bea6f925b206dab2b997",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.projects.getHealthPolicy"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Projects.GetHealthPolicy"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.projects.get_health_policy"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::$projects->getHealthPolicy"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Projects.GetHealthPolicyAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.projects.get_health_policy"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/bansafe/enforcement/{session}/appeal",
- "operationId": "appealBanSafeEnforcement",
- "fingerprint": "076d7a6b3bd467c2845ba9b5134349a00c54398fb485ed1fa22c230e94917ab1",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/hybrid-merge-candidates",
+ "operationId": "listHybridMergeCandidates",
+ "fingerprint": "e9ae24ad53b58370f209691a92f8022a01438349327249f02bee0314d3ff280e",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.projects.listHybridMergeCandidates"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Projects.ListHybridMergeCandidates"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.projects.list_hybrid_merge_candidates"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::projects.listHybridMergeCandidates"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Projects.ListHybridMergeCandidatesAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.projects.list_hybrid_merge_candidates"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/bansafe/findings/{findingId}/acknowledge",
- "operationId": "acknowledgeBanSafeFinding",
- "fingerprint": "f975307b12815032f160037e7ae3b93299bafb7196c4d756bd2b56eb94476310",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/insurance-evidence",
+ "operationId": "getInsuranceEvidenceSettings",
+ "fingerprint": "7cf70a0a72f18d6a63b9a0dcbd292f995b22d240a9013ad9b12e7dd643e7433b",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.projects.getInsuranceEvidence"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Projects.GetInsuranceEvidence"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.projects.get_insurance_evidence"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::$projects->getInsuranceEvidence"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Projects.GetInsuranceEvidenceAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.projects.get_insurance_evidence"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/billing/topup",
- "operationId": "topUpBilling",
- "fingerprint": "c52697f6b2843048dba07a53677131a008eed9dbdc78176ab23b1a2f40a7cbda",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/operations",
+ "operationId": "listProjectOperations",
+ "fingerprint": "59c2d19e5bcadd485a3e40ed4eb05585675b5dceb11abd1febf1214e7376e08f",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).operations.list"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Operations.List"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
- },
+ "status": "covered",
+ "method": "AsyncProjectClient.operations.list"
+ },
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::operations.list"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Operations.ListAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.operations.list"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/call-opt-outs",
- "operationId": "createConsoleCallOptOut",
- "fingerprint": "cfb484a34398f9cc3df441a97a15660a7fe99ce208af2b44f04a1338ac940e8d",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/operations/{operationId}",
+ "operationId": "getProjectOperation",
+ "fingerprint": "3f61b8174b4f34c6497713204526acb972dc54fdddbd1d446d70b3dda428dce6",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).operations.get"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Operations.Get"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.operations.get"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::operations.retrieve"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Operations.GetAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.operations.get"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/call-opt-outs/import",
- "operationId": "importConsoleCallOptOuts",
- "fingerprint": "98aba1ad87884bfe337862ba266bf6e1b42fcecbf563e9c84ffc5241235aa503",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/operations/{operationId}/transitions",
+ "operationId": "listProjectOperationTransitions",
+ "fingerprint": "cd153091298796c588a5db602255f25e25638d23dada8c8068b695a677cf93c1",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).operations.listTransitions"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Operations.ListTransitions"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.operations.list_transitions"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::operations.listTransitions"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Operations.ListTransitionsAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.operations.list_transitions"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/calls/{callId}/connections/{connectionId}/remove",
- "operationId": "removeCallConnection",
- "fingerprint": "b9e7ad4d3b7b6c3db5883688564f8e670094cda5feaa1807c56536a1b10e781e",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/request-logs",
+ "operationId": "listProjectRequestLogs",
+ "fingerprint": "632688e5a1f8ff95251782d439643d189b3a957f93562ecc30ae5013f6930952",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/keys",
- "operationId": "mintForConsoleApiKey",
- "fingerprint": "78c4289519862906b3529cc604544633539f1e95a647d68f812de4431a58577d",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/safe-mode",
+ "operationId": "getProjectSafeModeCeiling",
+ "fingerprint": "4e0d2e49d3dc2176b8834898f2b04bba5e3dda1869bd7484c3667223950d0e1d",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.projects.getSafeMode"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Projects.GetSafeMode"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.projects.get_safe_mode"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::$projects->getSafeMode"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Projects.GetSafeModeAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.projects.get_safe_mode"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/members/invites",
- "operationId": "inviteMember",
- "fingerprint": "0578e949c2b6012b29765675981c9127d55967f991d56f25880be16e421c8fe0",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/signal-custody",
+ "operationId": "getProjectSignalCustody",
+ "fingerprint": "c09bb2706a193ee426582aa8782a8a312b53efdcaf836c062eb49453dbebea8c",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/notifications/{notificationId}/archive",
- "operationId": "archiveNotification",
- "fingerprint": "c4488c3638b710e0d29573cccd157abec2e712ff7a8d1eb3f7a9690bd3d4f823",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/warmup-plan",
+ "operationId": "getProjectWarmupPlanSettings",
+ "fingerprint": "47bbe413c4824bd85b6a50271facc22e3d9b253cecb4d0bb53dcd6e011a0a937",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.projects.getWarmupPlan"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Projects.GetWarmupPlan"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.projects.get_warmup_plan"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::$projects->getWarmupPlan"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Projects.GetWarmupPlanAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.projects.get_warmup_plan"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/notifications/{notificationId}/read",
- "operationId": "markReadNotification",
- "fingerprint": "eb93d46b0f769fc46fef8bb00279ea16dd356d5fd8b5629e2391bb872820fe01",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/webhook-deliveries",
+ "operationId": "listProjectWebhookDeliveries",
+ "fingerprint": "e0dc0e2a73e455929b87acbe499a1003c11268826a98eb0df227a9e55597643e",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).webhookDeliveries.list"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.WebhookDeliveries.List"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.webhook_deliveries.list"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::webhookDeliveries.list"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.WebhookDeliveries.ListAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.webhook_deliveries.list"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/notifications/archive",
- "operationId": "archiveAllNotification",
- "fingerprint": "1526d9717193b33a1d29afb64b1d4c6f3f5445558713aef5c646ef6fcdd5ff79",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/webhook-deliveries/{deliveryId}",
+ "operationId": "getProjectWebhookDelivery",
+ "fingerprint": "0c8687cd878380f92854ae6c58388c7f66e543a184bdaf4446b3898e1dbd6892",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).webhookDeliveries.retrieve"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.WebhookDeliveries.Retrieve"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.webhook_deliveries.retrieve"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::webhookDeliveries.retrieve"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.WebhookDeliveries.RetrieveAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.webhook_deliveries.retrieve"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/notifications/read",
- "operationId": "markAllReadNotification",
- "fingerprint": "1b9a4757cf225b9c66dfbafe993e88dc6e140dc68b17374a9c59a5d30bb4b20d",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/webhook-deliveries/{deliveryId}/attempts",
+ "operationId": "listProjectWebhookDeliveryAttempts",
+ "fingerprint": "f973fc52d737e511dc7f0aaf70bed739aba59515a3a5bde4512a64a0daea9357",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).webhookDeliveries.listAttempts"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.WebhookDeliveries.ListAttempts"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.webhook_deliveries.list_attempts"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::webhookDeliveries.listAttempts"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.WebhookDeliveries.ListAttemptsAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.webhook_deliveries.list_attempts"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/notifications/test",
- "operationId": "sendTestNotificationEmail",
- "fingerprint": "79541941828326ea78d1677d323441ac1932f239dec526b25702993e8ed05621",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/webhook-deliveries/{deliveryId}/attempts/{attemptId}",
+ "operationId": "getProjectWebhookDeliveryAttempt",
+ "fingerprint": "24f3a608adfdb971443575f3d5d25c208580e602d6873c03f4cd59494ffa9d88",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).webhookDeliveries.retrieveAttempt"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.WebhookDeliveries.RetrieveAttempt"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.webhook_deliveries.retrieve_attempt"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::webhookDeliveries.retrieveAttempt"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.WebhookDeliveries.RetrieveAttemptAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.webhook_deliveries.retrieve_attempt"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/team-invitations/{invitationId}/accept",
- "operationId": "acceptTeamInvitation",
- "fingerprint": "b9ac80fc2ccea1727102a990f672791e423114e3dc2f3e8735a5c72ef703c93a",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/webhooks",
+ "operationId": "listProjectWebhooks",
+ "fingerprint": "3e8dafec17574e8bf60011f56178907e06046c5ebc7f2bd5a761470e0f9be170",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).webhooks.list"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Webhooks.List",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.webhooks.list",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::webhooks.list",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Webhooks.ListAsync",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.webhooks.list",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/team/avatar/uploads",
- "operationId": "generateTeamAvatarUploadUrl",
- "fingerprint": "514ed6d1af39d25d9b45b7574f284e8e5dcec7da55838661ae8c1478efa1c7b4",
+ "method": "GET",
+ "path": "/platform/projects/{projectId}/webhooks/{webhookId}",
+ "operationId": "getProjectWebhook",
+ "fingerprint": "beb5a46109c3184248e4ac592885dd7af0133815060be5866a098a937f6e1c04",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.project(projectId).webhooks.retrieve"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Webhooks.Retrieve",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncProjectClient.webhooks.retrieve",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::webhooks.retrieve",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.Webhooks.RetrieveAsync",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "ProjectClient.webhooks.retrieve",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/teams/ensure",
- "operationId": "ensureForCurrentUserTeam",
- "fingerprint": "edcfb26006b92e230056a06a1292a8fe5038a9cbc1e2a170f956c679b878a213",
+ "method": "GET",
+ "path": "/platform/quicklink",
+ "operationId": "getQuickLinkSettings",
+ "fingerprint": "1fb919c40176468c78ccda182ed9a3fede80afab37067287cf3a858cbf75f96b",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.quickLinkSettings.retrieve"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.QuickLinkSettings.Retrieve"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.quick_link_settings.retrieve"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::quickLinkSettings.retrieve"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "ProjectClient.QuickLinkSettings.RetrieveAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.quick_link_settings.retrieve"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/profile/avatar/uploads",
- "operationId": "generateUserProfileAvatarUploadUrl",
- "fingerprint": "246a37b87a93b0d18e13a6948e1abcffb7aae58eb9cafbfcf9f30f7ef9158948",
+ "method": "GET",
+ "path": "/platform/sip-trunks",
+ "operationId": "listSipTrunks",
+ "fingerprint": "3f6f981bd8b8b2034a8ca712dc9cec742fd8436dc3fb9993a15bd242ed7bf910",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.sipTrunks.list"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.SIPTrunks.List"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
- },
+ "status": "covered",
+ "method": "AsyncClient.sip_trunks.list"
+ },
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::sipTrunks.list"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.SipTrunks.ListAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.sip_trunks.list"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/profile/ensure",
- "operationId": "ensureProfileUserProfile",
- "fingerprint": "80d1ecd3337a4c42c09d9e372ecf255149c63d4a5aaeb611f37d064191a43794",
+ "method": "GET",
+ "path": "/platform/sip-trunks/{trunkId}",
+ "operationId": "getSipTrunk",
+ "fingerprint": "0f3b4cc58a162ecee6c697334e940789f9e5b9eee0519e745b94af00ee5af13d",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.sipTrunks.retrieve"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.SIPTrunks.Retrieve"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.sip_trunks.retrieve"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::sipTrunks.retrieve"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.SipTrunks.RetrieveAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.sip_trunks.retrieve"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/projects/{projectId}/icon",
- "operationId": "generateProjectUploadUrl",
- "fingerprint": "1d6e033b04fc60a7ee01ede98075e087e317bd80e859aee18bbba58988e094c3",
+ "method": "GET",
+ "path": "/platform/sip/endpoint",
+ "operationId": "getSipEndpoint",
+ "fingerprint": "5f2e36f2cdefb26215780b89195b9055113d800dbeda7047f9edd8cc3e6d2b9e",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.sipTrunks.endpoint"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.SIPTrunks.Endpoint"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.sip_trunks.endpoint"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::sipTrunks.endpoint"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.SipTrunks.EndpointAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.sip_trunks.endpoint"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/projects/{projectId}/setup/usage",
- "operationId": "recordProjectSetupUsage",
- "fingerprint": "ab0796e1c943a26d8a08a77f234709bd71c33d53016a5a3b964d97974ee61049",
+ "method": "GET",
+ "path": "/platform/team",
+ "operationId": "getTeam",
+ "fingerprint": "d4af12d9edeaa7d34e263aaf535267e80a2f4b09777f4b3c0cf8a321d7210a0d",
"typescript": {
- "status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
+ "status": "covered",
+ "method": "Client.teams.retrieve"
},
"go": {
- "status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Teams.Retrieve"
},
"python": {
- "status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.teams.retrieve"
},
"php": {
- "status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::teams.retrieve"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Teams.RetrieveAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.teams.retrieve"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/quicklink/logo/team",
- "operationId": "useTeamLogoQuickLinkSettings",
- "fingerprint": "f9b0713448982a21acbaee5b4da388aeafa55b947bb749315f4e335da65c5a72",
+ "method": "GET",
+ "path": "/platform/templates",
+ "operationId": "listMessageTemplates",
+ "fingerprint": "6cf8333480110a08af25186da570f15ee30033e01602e8d78820936586a25a53",
"typescript": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"go": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "This dashboard-only route does not accept the team server API key used by Client."
},
"python": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"php": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "This dashboard-only route does not accept the team server API key used by Client."
},
"rust": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/quicklink/logo/project",
- "operationId": "useProjectIconQuickLinkSettings",
- "fingerprint": "d48fac41939598054da137cff798f2f85683fa994aab20c9aa52f7527f5440e2",
+ "method": "GET",
+ "path": "/platform/templates/{templateId}",
+ "operationId": "getMessageTemplate",
+ "fingerprint": "b2ead012a584bfa67983b6c0e0b20b18aaa615cb592cd5a2d556d9fb225ed2c8",
"typescript": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"go": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "This dashboard-only route does not accept the team server API key used by Client."
},
"python": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"php": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"dotnet": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "reason": "This dashboard-only route does not accept the team server API key used by Client."
},
"rust": {
"status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/quicklink/logo/uploads",
- "operationId": "generateQuickLinkSettingsLogoUploadUrl",
- "fingerprint": "5c0b34d2cfa41ce4cd9ca504b2a97bcd9c86ede4664115e8c0d1a2b1cb975fc7",
+ "method": "GET",
+ "path": "/platform/usage",
+ "operationId": "getUsageSummary",
+ "fingerprint": "0d6ec241d3fc473c007b4d79db1f75ff121cb3fa763310d2d61fe93d095baada",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.usage.summary"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Usage.Summary"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.usage.summary"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::usage.summary"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Usage.SummaryAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.usage.summary"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/sip-trunks",
- "operationId": "createConsoleSipTrunk",
- "fingerprint": "2786c0553036eaa0eab7c5c30f6804e292980c9122b094fd7175cfca4ff4b3a4",
+ "method": "GET",
+ "path": "/platform/usage/records",
+ "operationId": "listUsageRecords",
+ "fingerprint": "470b7f83e95a30ded37b8a1d8c0d5389071a7e4c5617f4efdacf52443c3d4e4f",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.usage.listRecords"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Usage.ListRecords"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.usage.list_records"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::usage.listRecords"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Usage.ListRecordsAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.usage.list_records"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/sip-trunks/{trunkId}/credentials",
- "operationId": "rotateConsoleSipTrunkCredentials",
- "fingerprint": "dbb1379fe9f22e160857efe1b2469f79a88de8ee03f9d4a124c4ae8daa873fef",
+ "method": "GET",
+ "path": "/platform/voice/audio",
+ "operationId": "listVoiceAudio",
+ "fingerprint": "bd762a6e97d763afb2000947aaa63f508e07fb1a70b297329fcc2b13fa245060",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.voice.audio.list"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Voice.Audio.List"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.voice.audio.list"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::voice.audio.list"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Voice.Audio.ListAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.voice.audio.list"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/teams/{teamId}/delete",
- "operationId": "deleteUserProfileTeam",
- "fingerprint": "2a0939b2d5beb75f7b85d4cadcc0a5ab2f7709e8b961db8a375d5dd9b82361da",
+ "method": "GET",
+ "path": "/platform/voice/audio/{assetId}",
+ "operationId": "getVoiceAudio",
+ "fingerprint": "c32620483266221ddc31c717b85c323940a17c0b5537e60447cf1e2100401444",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.voice.audio.retrieve"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Voice.Audio.Retrieve"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.voice.audio.retrieve"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::voice.audio.retrieve"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Voice.Audio.RetrieveAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.voice.audio.retrieve"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/teams/leave",
- "operationId": "leaveTeamUserProfile",
- "fingerprint": "182b578fd497ce09cd9ea77ada1324d5e87d9f5917e359c5b31347622327d071",
+ "method": "GET",
+ "path": "/platform/voice/audio/{assetId}/preview",
+ "operationId": "getVoiceAudioPreview",
+ "fingerprint": "22736d2e225f95749216f92a7a3d75ebe84ebfd471cf40bfc3af8d76385ddc01",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.voice.audio.previewUrl"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Voice.Audio.PreviewURL"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.voice.audio.preview_url"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::voice.audio.previewUrl"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Voice.Audio.PreviewUrlAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.voice.audio.preview_url"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/voice/audio",
- "operationId": "createConsoleVoiceAudioUpload",
- "fingerprint": "6d0004ab0b421098574b1eea06e01cea2bf32639676582f47902f0d7602c3252",
+ "method": "GET",
+ "path": "/platform/voice/provider-credentials",
+ "operationId": "listVoiceProviderCredentials",
+ "fingerprint": "b5a540a619ff09ff5e23c94674b14a09fbb7690e4378191bd7291759eb2eca6e",
"typescript": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "Client.voice.providerCredentials.list"
},
"go": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "TeamClient.Voice.ProviderCredentials.List"
},
"python": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.voice.provider_credentials.list"
},
"php": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::voice.providerCredentials.list"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "TeamClient.Voice.ProviderCredentials.ListAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.voice.provider_credentials"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/voice/audio/{assetId}/complete",
- "operationId": "completeConsoleVoiceAudioUpload",
- "fingerprint": "f03c5560deefe3f6473df195a645d05ff9986931edb4a317909fe964e6dcfa15",
+ "method": "GET",
+ "path": "/platform/voice/provider-credentials/{credentialId}",
+ "operationId": "getVoiceProviderCredential",
+ "fingerprint": "f84b48307e958f3b05f042d7c393915c3fd325b674fbb9bea1bef80677a4757f",
"typescript": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "Client.voice.providerCredentials.retrieve"
},
"go": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "TeamClient.Voice.ProviderCredentials.Retrieve"
},
"python": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.voice.provider_credentials.retrieve"
},
"php": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::voice.providerCredentials.retrieve"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "TeamClient.Voice.ProviderCredentials.RetrieveAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.voice.provider_credentials.retrieve"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/voice/audio/tts",
- "operationId": "synthesizeConsoleVoiceAudio",
- "fingerprint": "f6ca3ab6be286ebf8402bb89f27cac7dd29814848c009a6596385973e7ce40f4",
+ "method": "GET",
+ "path": "/platform/webhook-deliveries",
+ "operationId": "listTeamWebhookDeliveries",
+ "fingerprint": "dea8e827f2915a6e9965b3a316269b44a4fe3057543b0b32dc1804f74c8a101d",
"typescript": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "Client.webhookDeliveries.list"
},
"go": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "TeamClient.WebhookDeliveries.List"
},
"python": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.webhook_deliveries.list"
},
"php": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::webhookDeliveries.list"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "TeamClient.WebhookDeliveries.ListAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.webhook_deliveries.list"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/voice/provider-credentials",
- "operationId": "createConsoleVoiceProviderCredential",
- "fingerprint": "44e47ae907c56c3bede0c0b76342a0ada0dbb9a84222d34bca578c342305d166",
+ "method": "GET",
+ "path": "/platform/webhook-deliveries/{deliveryId}",
+ "operationId": "getTeamWebhookDelivery",
+ "fingerprint": "71089544cd42711f5a0e23a59d9de8be36e066be31736b589bccd7d338d3e114",
"typescript": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "Client.webhookDeliveries.retrieve"
},
"go": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "TeamClient.WebhookDeliveries.Retrieve"
},
"python": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.webhook_deliveries.retrieve"
},
"php": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::webhookDeliveries.retrieve"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "TeamClient.WebhookDeliveries.RetrieveAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.webhook_deliveries.retrieve"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/voice/provider-credentials/{credentialId}/verify",
- "operationId": "verifyConsoleVoiceProviderCredential",
- "fingerprint": "a8fdcbda55cdcf9bf802bd6d1c5aa0bb61c0f54eb91260270d8f319e1e47d8b0",
+ "method": "GET",
+ "path": "/platform/webhook-deliveries/{deliveryId}/attempts",
+ "operationId": "listTeamWebhookDeliveryAttempts",
+ "fingerprint": "ecd27f92e5a853bc1cf4c9186582d8e0b86aaca8fbe7cfceed76d6e695f564b9",
"typescript": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "Client.webhookDeliveries.listAttempts"
},
"go": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "TeamClient.WebhookDeliveries.ListAttempts"
},
"python": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.webhook_deliveries.list_attempts"
},
"php": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::webhookDeliveries.listAttempts"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
+ "status": "covered",
+ "method": "TeamClient.WebhookDeliveries.ListAttemptsAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.webhook_deliveries.list_attempts"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/webhooks",
- "operationId": "createWebhook",
- "fingerprint": "ef9825c860655c458c15e1c54a9cbd22206d5c797c14eeb5ce9239291f62fc8b",
+ "method": "GET",
+ "path": "/platform/webhook-deliveries/{deliveryId}/attempts/{attemptId}",
+ "operationId": "getTeamWebhookDeliveryAttempt",
+ "fingerprint": "44d9d26d90e7215b5c3ce70a77c89249e1cc0ecdcccd476b042a9af6ff0d0918",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.webhookDeliveries.retrieveAttempt"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.WebhookDeliveries.RetrieveAttempt"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.webhook_deliveries.retrieve_attempt"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::webhookDeliveries.retrieveAttempt"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.WebhookDeliveries.RetrieveAttemptAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.webhook_deliveries.retrieve_attempt"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/audiences",
- "operationId": "createAudience",
- "fingerprint": "cbd112b62e83a7f363317cbb052a9f42bd450b59889ad43aaa8aba05e5bf2ef6",
+ "method": "GET",
+ "path": "/platform/webhooks",
+ "operationId": "listTeamWebhooks",
+ "fingerprint": "ec8192a7856f9410b12b918cc52fc060fe809730e6c142b50d953379d3c38fad",
"typescript": {
"status": "covered",
- "method": "Client.audiences.create"
+ "method": "Client.webhooks.list"
},
"go": {
"status": "covered",
- "method": "TeamClient.Audiences.Create"
+ "method": "TeamClient.Webhooks.List",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"python": {
"status": "covered",
- "method": "AsyncClient.audiences.create"
+ "method": "AsyncClient.webhooks.list",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"php": {
"status": "covered",
- "method": "Client::audiences.create"
+ "method": "Client::webhooks.list",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Audiences.CreateAsync"
+ "method": "TeamClient.Webhooks.ListAsync",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"rust": {
"status": "covered",
- "method": "TeamClient.audiences.create"
+ "method": "TeamClient.webhooks.list",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/audiences/{listId}/members",
- "operationId": "addAudienceMembers",
- "fingerprint": "e744311d136345c2cbb9a07486356225d20593f9ea5b34b1b8db658cb3342549",
+ "method": "GET",
+ "path": "/platform/webhooks/{webhookId}",
+ "operationId": "getTeamWebhook",
+ "fingerprint": "0e91d7603e7b42e7e4640675a503889592cce72312022115234091640eca7a6b",
"typescript": {
"status": "covered",
- "method": "Client.audiences.addMembers"
+ "method": "Client.webhooks.retrieve"
},
"go": {
"status": "covered",
- "method": "TeamClient.Audiences.AddMembers"
+ "method": "TeamClient.Webhooks.Retrieve",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"python": {
"status": "covered",
- "method": "AsyncClient.audiences.add_members"
+ "method": "AsyncClient.webhooks.retrieve",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"php": {
"status": "covered",
- "method": "Client::audiences.addMembers"
+ "method": "Client::webhooks.retrieve",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Audiences.AddMembersAsync"
+ "method": "TeamClient.Webhooks.RetrieveAsync",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
},
"rust": {
"status": "covered",
- "method": "TeamClient.audiences.add_members"
+ "method": "TeamClient.webhooks.retrieve",
+ "untypedResponseFields": ["phoneOfflineStartDay"]
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/audiences/uploads",
- "operationId": "createAudienceUploadUrl",
- "fingerprint": "4842c0813d1ae2d28470723a77ec1bead89116815c1cd253f38588c9244c29fb",
+ "method": "PATCH",
+ "path": "/console/members/{memberId}",
+ "operationId": "updateMemberRole",
+ "fingerprint": "f5f1cb5ee626894341c9cbf993fea4fa089349c054a7b8261e53e5b1397771ee",
"typescript": {
- "status": "covered",
- "method": "Client.audiences.createUpload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Audiences.CreateUpload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.audiences.create_upload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::audiences.createUpload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Audiences.CreateUploadAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.audiences.create_upload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/bansafe/incidents",
- "operationId": "createBanSafeIncident",
- "fingerprint": "d0bb920faded0c70b8aef14c5bc6fc76e3c9475e029c6abff9d568e9b311da3b",
+ "method": "PATCH",
+ "path": "/console/profile",
+ "operationId": "updateUserProfileField",
+ "fingerprint": "44d6a602f4ff81eb69ea2dd6fb67210cc884cc80d9a8dbbcccacdf2b40686b05",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.createIncident"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.CreateIncident"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.create_incident"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.createIncident"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.CreateIncidentAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.create_incident"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/bansafe/incidents/{incidentId}/retract",
- "operationId": "retractBanSafeIncident",
- "fingerprint": "f28eb3eb8d88aea939b05adf9a144f8d9bdbcdf285350674da28acba518cddf9",
+ "method": "PATCH",
+ "path": "/console/projects/{projectId}",
+ "operationId": "updateProject",
+ "fingerprint": "2a67db2aabf87aa80dcdc0d93b53d558dafb3b91862b7d93d34714bbe1928173",
"typescript": {
- "status": "covered",
- "method": "Client.banSafe.retractIncident"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.BanSafe.RetractIncident"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.ban_safe.retract_incident"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::banSafe.retractIncident"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.BanSafe.RetractIncidentAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.ban_safe.retract_incident"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/call-opt-outs",
- "operationId": "createCallOptOut",
- "fingerprint": "cb8f66f145d7ebe2f3b7adc629771ab0a23ec2b6fdfbf48c08e7dc4ba5fa2490",
+ "method": "PATCH",
+ "path": "/console/sip-trunks/{trunkId}",
+ "operationId": "updateConsoleSipTrunk",
+ "fingerprint": "0df11416da667e67038271062c3fa17da1e69dfc13c30a250cbad5c25df26ca8",
"typescript": {
- "status": "covered",
- "method": "Client.callOptOuts.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.CallOptOuts.Create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.call_opt_outs.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::callOptOuts.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.CallOptOuts.CreateAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.call_opt_outs.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/call-opt-outs/import",
- "operationId": "importCallOptOuts",
- "fingerprint": "23f35edbbbb8294f7c4001852db56a32f38358f9482bb6643581066bfcbcc16e",
+ "method": "PATCH",
+ "path": "/console/team",
+ "operationId": "updateTeam",
+ "fingerprint": "1d780cf25bdfd9e4af811346c795dbb87364dc5933e51f5063d576ee87ddaf0c",
"typescript": {
- "status": "covered",
- "method": "Client.callOptOuts.import"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.CallOptOuts.Import"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.call_opt_outs.import_entries"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::callOptOuts.import"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.CallOptOuts.ImportAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.call_opt_outs.import"
- }
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
+ }
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaigns",
- "operationId": "createPlatformCampaign",
- "fingerprint": "e4163ed4226af508ec352d89bed00d65fde0a0b048cf5882b862e91fc965c70b",
+ "method": "PATCH",
+ "path": "/console/voice/audio/{assetId}",
+ "operationId": "updateConsoleVoiceAudio",
+ "fingerprint": "b09c19c1c2dc34d643d68dc7e7746d7c8536310c6c6d12bb542cddc322c3b070",
"typescript": {
- "status": "covered",
- "method": "Client.campaigns.create"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Campaigns.Create"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.campaigns.create"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::campaigns.create"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Campaigns.CreateAsync"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.campaigns.create"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaigns/{campaignId}/archive",
- "operationId": "archiveCampaign",
- "fingerprint": "94584b75f071c8e0ab6a58f383c44a6f9a0e1370ae367b9b5f0cfe4c2f155ad6",
+ "method": "PATCH",
+ "path": "/console/webhooks/{webhookId}",
+ "operationId": "updateWebhook",
+ "fingerprint": "f73335936e4b8d00a5256c2a0beaf9cf21974de7b89c5ad4c6962e8272c3d3c7",
"typescript": {
- "status": "covered",
- "method": "Client.campaigns.archive"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Campaigns.Archive"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.campaigns.archive"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::campaigns.archive"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Campaigns.ArchiveAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.campaigns.archive"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaigns/{campaignId}/conversions",
- "operationId": "recordCampaignConversion",
- "fingerprint": "f2fa5db94a7942d22d540d8db650a91f6f4f0df0377f0333c0ed9677b3dfdb1a",
+ "method": "PATCH",
+ "path": "/platform/audience-segments/{segmentId}",
+ "operationId": "updateAudienceSegment",
+ "fingerprint": "e491c82bc7e9cdd1b310b5eacd7eaa184ba97f3b60fcb582a21a4c61d11cf7d8",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.recordConversion"
+ "method": "Client.audienceSegments.update"
},
"go": {
"status": "covered",
- "method": "TeamClient.Campaigns.RecordConversion"
+ "method": "TeamClient.AudienceSegments().Update"
},
"python": {
"status": "covered",
- "method": "AsyncClient.campaigns.record_conversion"
+ "method": "AsyncClient.audience_segments.update"
},
"php": {
"status": "covered",
- "method": "Client::campaigns.recordConversion"
+ "method": "Client::audienceSegments.update"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Campaigns.RecordConversionAsync"
+ "method": "TeamClient.AudienceSegments.UpdateAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.campaigns.record_conversion"
+ "method": "TeamClient.audience_segments().update"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaigns/{campaignId}/duplicate",
- "operationId": "duplicateCampaign",
- "fingerprint": "28113a7936630e45d994a7e8f99ff2d69ab4bc7dc2efcbd96c835870370e6895",
+ "method": "PATCH",
+ "path": "/platform/campaigns/{campaignId}",
+ "operationId": "updateCampaign",
+ "fingerprint": "a506b1b892d6b2c000c860cf038d33830c2da23af33557f8c2a009e07a11b3a2",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.duplicate"
+ "method": "Client.campaigns.update"
},
"go": {
"status": "covered",
- "method": "TeamClient.Campaigns.Duplicate"
+ "method": "TeamClient.Campaigns.Update"
},
"python": {
"status": "covered",
- "method": "AsyncClient.campaigns.duplicate"
+ "method": "AsyncClient.campaigns.update"
},
"php": {
"status": "covered",
- "method": "Client::campaigns.duplicate"
+ "method": "Client::campaigns.update"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Campaigns.DuplicateAsync"
+ "method": "TeamClient.Campaigns.UpdateAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.campaigns.duplicate"
+ "method": "TeamClient.campaigns.update"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaigns/{campaignId}/launch",
- "operationId": "launchPlatformCampaign",
- "fingerprint": "73e42cc4e7d50389e283d3da594e6ec4b346310d176fecfab6310a92a81c0baf",
+ "method": "PATCH",
+ "path": "/platform/connections/{connectionId}",
+ "operationId": "setConnectionTierOverride",
+ "fingerprint": "e4b05b4800dbd4cbfb9f06a67d787956f4026e6311577cc2bf72a09bbf9b76aa",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.launch"
+ "method": "Client.connections.setTierOverride"
},
"go": {
"status": "covered",
- "method": "TeamClient.Campaigns.Launch"
+ "method": "TeamClient.Connections.SetTierOverride"
},
"python": {
"status": "covered",
- "method": "AsyncClient.campaigns.launch"
+ "method": "AsyncClient.connections.set_tier_override"
},
"php": {
"status": "covered",
- "method": "Client::campaigns.launch"
+ "method": "Client::connections.setTierOverride"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Campaigns.LaunchAsync"
+ "method": "TeamClient.Connections.SetTierOverrideAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.campaigns.launch"
+ "method": "TeamClient.connections.set_tier_override"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaigns/{campaignId}/pause",
- "operationId": "pausePlatformCampaign",
- "fingerprint": "04be44e585eaa626863c3976e666a947fd8be70bc80cdc3854f8feb6cc1183da",
+ "method": "PATCH",
+ "path": "/platform/customers/{customerId}",
+ "operationId": "updateCustomer",
+ "fingerprint": "359b58d67ac40dcf3945ca6fee94dbeb6fe066691f5b1df54a4eb2b4e5ca9455",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.pause"
+ "method": "Client.customers.update"
},
"go": {
"status": "covered",
- "method": "TeamClient.Campaigns.Pause"
+ "method": "TeamClient.Customers.Update"
},
"python": {
"status": "covered",
- "method": "AsyncClient.campaigns.pause"
+ "method": "AsyncClient.customers.update"
},
"php": {
"status": "covered",
- "method": "Client::campaigns.pause"
+ "method": "Client::customers.update"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Campaigns.PauseAsync"
+ "method": "TeamClient.Customers.UpdateAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.campaigns.pause"
+ "method": "TeamClient.customers.update"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaigns/{campaignId}/recipients",
- "operationId": "addCampaignRecipients",
- "fingerprint": "31c8731a6c5df6c0818d5ccb0dd58be22e2b74b836826ed93e68d23fed8648c3",
+ "method": "PATCH",
+ "path": "/platform/flows/{flowId}",
+ "operationId": "updateFlow",
+ "fingerprint": "6fa08905f3b0f66dfa247df8fab0645f1dcf0984e917ba90d7614613c5bb5841",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.addRecipients"
+ "method": "Client.project(projectId).flows.update"
},
"go": {
"status": "covered",
- "method": "TeamClient.Campaigns.AddRecipients"
+ "method": "ProjectClient.Flows.Update"
},
"python": {
"status": "covered",
- "method": "AsyncClient.campaigns.add_recipients"
+ "method": "AsyncProjectClient.flows.update"
},
"php": {
"status": "covered",
- "method": "Client::campaigns.addRecipients"
+ "method": "ProjectClient::flows.update"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Campaigns.AddRecipientsAsync"
+ "method": "ProjectClient.Flows.UpdateAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.campaigns.add_recipients"
+ "method": "ProjectClient.flows.update"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaigns/{campaignId}/requeue",
- "operationId": "requeueFailedCampaign",
- "fingerprint": "ba71b24cf4cde9aef7363e00112a598b093705809742696dcddafd69f2402512",
+ "method": "PATCH",
+ "path": "/platform/functions/{functionId}",
+ "operationId": "updateFunction",
+ "fingerprint": "626ae33b8ec0773fc7a8a696df0178c1e4d14049a6eff0adaaf79994e017c878",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.requeue"
+ "method": "Client.project(projectId).functions.update"
},
"go": {
"status": "covered",
- "method": "TeamClient.Campaigns.Requeue"
+ "method": "ProjectClient.Functions.Update"
},
"python": {
"status": "covered",
- "method": "AsyncClient.campaigns.requeue"
+ "method": "AsyncProjectClient.functions.update"
},
"php": {
"status": "covered",
- "method": "Client::campaigns.requeue"
+ "method": "ProjectClient::functions.update"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Campaigns.RequeueAsync"
+ "method": "ProjectClient.Functions.UpdateAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.campaigns.requeue"
+ "method": "ProjectClient.functions.update"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaigns/{campaignId}/reschedule",
- "operationId": "reschedulePlatformCampaign",
- "fingerprint": "03de3e68c10ec28bcf68437997cbf51083903f91a29f4acca6a7d4c4f5daf879",
+ "method": "PATCH",
+ "path": "/platform/projects/{projectId}/webhooks/{webhookId}",
+ "operationId": "updateProjectWebhook",
+ "fingerprint": "69b37ee47fd63d2d99eca7906634a11ca27f6580d3047c0a600a12c5ea843aa5",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.reschedule"
+ "method": "Client.project(projectId).webhooks.update"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Campaigns.Reschedule"
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.campaigns.reschedule"
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "Client::campaigns.reschedule"
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Campaigns.RescheduleAsync"
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.campaigns.reschedule"
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaigns/{campaignId}/resume",
- "operationId": "resumePlatformCampaign",
- "fingerprint": "725f2e878135a947a04e0bfb9eb0f0f305374681883281563757d97318b230a8",
+ "method": "PATCH",
+ "path": "/platform/sip-trunks/{trunkId}",
+ "operationId": "updateSipTrunk",
+ "fingerprint": "85333402f90f0218b811f104d1b210ea22d60144e06a9ea9929cd212c03591df",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.resume"
+ "method": "Client.sipTrunks.update"
},
"go": {
"status": "covered",
- "method": "TeamClient.Campaigns.Resume"
+ "method": "TeamClient.SIPTrunks.Update"
},
"python": {
"status": "covered",
- "method": "AsyncClient.campaigns.resume"
+ "method": "AsyncClient.sip_trunks.update"
},
"php": {
"status": "covered",
- "method": "Client::campaigns.resume"
+ "method": "Client::sipTrunks.update"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Campaigns.ResumeAsync"
+ "method": "TeamClient.SipTrunks.UpdateAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.campaigns.resume"
+ "method": "TeamClient.sip_trunks.update"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaigns/{campaignId}/stop",
- "operationId": "stopPlatformCampaign",
- "fingerprint": "f1ea68ebe7c6891db792287d60e248e1ad774217591bf65f356029e71a16719e",
+ "method": "PATCH",
+ "path": "/platform/templates/{templateId}",
+ "operationId": "updateMessageTemplate",
+ "fingerprint": "18e230e4b1150c3665d20d26287123541c21abf3b602fc9fa09b7adb07c6e87a",
"typescript": {
- "status": "covered",
- "method": "Client.campaigns.stop"
+ "status": "excluded",
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Campaigns.Stop"
+ "status": "excluded",
+ "reason": "This dashboard-only route does not accept the team server API key used by Client."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.campaigns.stop"
+ "status": "excluded",
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"php": {
- "status": "covered",
- "method": "Client::campaigns.stop"
+ "status": "excluded",
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Campaigns.StopAsync"
+ "status": "excluded",
+ "reason": "This dashboard-only route does not accept the team server API key used by Client."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.campaigns.stop"
+ "status": "excluded",
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/client-tokens",
- "operationId": "mintClientToken",
- "fingerprint": "90a2062a30fd3a175d31eeefd2948d5c6b12d19cebb66abcd497253df98aa0e9",
+ "method": "PATCH",
+ "path": "/platform/voice/audio/{assetId}",
+ "operationId": "updateVoiceAudio",
+ "fingerprint": "e9850fd87139fab76ecd09904ccbfd850ecb839f6b4f140aae7381fc36760b45",
"typescript": {
"status": "covered",
- "method": "MessagingClient.clientTokens.mint"
+ "method": "Client.voice.audio.update"
},
"go": {
"status": "covered",
- "method": "MessagingClient.ClientTokens.Mint"
+ "method": "TeamClient.Voice.Audio.Update"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.client_tokens.mint"
+ "method": "AsyncClient.voice.audio.update"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$clientTokens->mint"
+ "method": "Client::voice.audio.update"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.ClientTokens.MintAsync"
+ "method": "TeamClient.Voice.Audio.UpdateAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.client_tokens.mint"
+ "method": "TeamClient.voice.audio.update"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/customers",
- "operationId": "createCustomer",
- "fingerprint": "56dd6cf08e209da609fc78650a32abb261d4a6ea6c86c84d1883b441f68024d8",
+ "method": "PATCH",
+ "path": "/platform/webhooks/{webhookId}",
+ "operationId": "updateTeamWebhook",
+ "fingerprint": "b3459c3750869b8703ff0d18a588e3b58ce6479e0f7a21fb59af201710e268df",
"typescript": {
"status": "covered",
- "method": "Client.customers.create"
+ "method": "Client.webhooks.update"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Customers.Create"
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.customers.create"
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "Client::customers.create"
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Customers.CreateAsync"
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.customers.create"
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/customers/{customerId}/archive",
- "operationId": "archiveCustomer",
- "fingerprint": "13ce7838955c2d97174bc4b1309f3d62da03f3005f0e2a056db4003f6a10df42",
+ "path": "/api/account/feature-terms/{key}/accept",
+ "operationId": "accountAcceptFeatureTerms",
+ "fingerprint": "f4019656b04189de235b80eafaea315aa89df3f73583e0a9b0ca223d448ab6a9",
"typescript": {
- "status": "covered",
- "method": "Client.customers.archive"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Customers.Archive"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.customers.archive"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "Client::customers.archive"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Customers.ArchiveAsync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.customers.archive"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/customers/{customerId}/numbers/{sessionId}/transfer",
- "operationId": "transferCustomerNumber",
- "fingerprint": "48f057ce893f7b15d85b0a690eda7d1b85075a2f0c43f4b5188a41942c9567d4",
+ "path": "/api/account/feature-terms/{key}/withdraw",
+ "operationId": "accountWithdrawFeatureTerms",
+ "fingerprint": "884edf740072494cf352091d8dc50a81b70195ade79a4c4346f75bd670923caa",
"typescript": {
- "status": "covered",
- "method": "Client.customers.transferNumber"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Customers.TransferNumber"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.customers.transfer_number"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "Client::customers.transferNumber"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Customers.TransferNumberAsync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.customers.transfer_number"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/customers/{customerId}/pairing-links",
- "operationId": "createCustomerPairingLink",
- "fingerprint": "f179a6a810ec0df003b8989a9d59c59d94f5f432d8b472e3948053699c5e1de0",
+ "path": "/api/account/features/enrollment",
+ "operationId": "setFeatureEnrollment",
+ "fingerprint": "e1151c397687075ee4658eda4b0e4f3a1f27003449aeeb127d2f425fd8f1ebc8",
"typescript": {
- "status": "covered",
- "method": "Client.customers.createPairingLink"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Customers.CreatePairingLink"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.customers.create_pairing_link"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::customers.createPairingLink"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Customers.CreatePairingLinkAsync"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.customers.create_pairing_link"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/customers/{customerId}/restore",
- "operationId": "restoreCustomer",
- "fingerprint": "d41b7d7f84da27f0e51f7c5ac8d8025cb04633edfe69592ed862b42d949c94ed",
+ "path": "/api/account/features/evaluate",
+ "operationId": "evaluateAccountFeatures",
+ "fingerprint": "4afc782993ccafa41dd2a0c346902e113b33b5275c92feb21bc595c1bcea92e0",
"typescript": {
- "status": "covered",
- "method": "Client.customers.restore"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Customers.Restore"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.customers.restore"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::customers.restore"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Customers.RestoreAsync"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.customers.restore"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/events/{eventId}/replays",
- "operationId": "replayTeamEvent",
- "fingerprint": "5bbc8270c7615f6ea6184b0cd0bd9276aa9d9c600c044b6cc4c52aa7a53b8684",
+ "path": "/api/account/features/exposure",
+ "operationId": "recordFeatureExposure",
+ "fingerprint": "465a9cd6ab3b8e697bea2dc3bdafd0cea7ae817ad092757b7465fd5b1faf69f2",
"typescript": {
- "status": "covered",
- "method": "Client.events.replay"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Events.Replay"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.events.replay"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::events.replay"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Events.ReplayAsync"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.events.replay"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/flow-encryption-keys/rotate",
- "operationId": "rotateFlowEncryptionKey",
- "fingerprint": "daf3e8d6e9c5f023de1884cf9e9aebe6cbdc718e6fcb178a70533cf291ae70b6",
+ "path": "/api/account/legal/accept",
+ "operationId": "acceptAccountLegalTerms",
+ "fingerprint": "f881c93708c62110d676df2b031e34c27ef616152a829f44ca6564a835d3cd15",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).flows.rotateEncryptionKey"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Flows.RotateEncryptionKey"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.flows.rotate_encryption_key"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::flows.rotateEncryptionKey"
- },
- "dotnet": {
- "status": "covered",
- "method": "ProjectClient.Flows.RotateEncryptionKeyAsync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
+ },
+ "dotnet": {
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.flows.rotate_encryption_key"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/flows",
- "operationId": "createFlow",
- "fingerprint": "06eab844d89e211ae1dc94dc66a232bd6ad7c07fcf148ee6fbd1baa13881f47c",
+ "path": "/console/auth/totp",
+ "operationId": "enrollTotpUserProfile",
+ "fingerprint": "e530e7997de14836260260087e59bc5015986171309dce09015ff9693ea85c49",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).flows.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Flows.Create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.flows.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::flows.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Flows.CreateAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.flows.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/flows/{flowId}/deprecate",
- "operationId": "deprecateFlow",
- "fingerprint": "03fababd698dfd3f641b7f3c5b55a1109b126616eef51a79cb88b2f85355e066",
+ "path": "/console/auth/totp/verify",
+ "operationId": "verifyTotpUserProfile",
+ "fingerprint": "01022467e8a187b5631cef2f04ddace121ddc44e3fbc106940a17d9cad50e557",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).flows.deprecate"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Flows.Deprecate"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.flows.deprecate"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::flows.deprecate"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Flows.DeprecateAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.flows.deprecate"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/flows/{flowId}/discard",
- "operationId": "discardFlow",
- "fingerprint": "21bb76ec8c6415b0025dbc270a4aaec14e2ef4346ed1093cf515d5b401579274",
+ "path": "/console/bansafe/enforcement/{connection}/appeal",
+ "operationId": "appealBanSafeEnforcement",
+ "fingerprint": "46a9a1753226185d876c0ef9a864f304191f8863fd19ce2e59252331ffb2dd15",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).flows.discard"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Flows.Discard"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.flows.discard"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::flows.discard"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Flows.DiscardAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.flows.discard"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/flows/{flowId}/publish",
- "operationId": "publishFlow",
- "fingerprint": "3cfb424e2712bfdbf7cfd57459fad566e81f53b6443b31bd5349e65ef8f7c8bf",
+ "path": "/console/bansafe/findings/{findingId}/acknowledge",
+ "operationId": "acknowledgeBanSafeFinding",
+ "fingerprint": "2c0124a4f674d3dc6b687ababa33a43a5d684158eab3bda6cb94735c7b3b0362",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).flows.publish"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Flows.Publish"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.flows.publish"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::flows.publish"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Flows.PublishAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.flows.publish"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/flows/{flowId}/sync",
- "operationId": "syncFlow",
- "fingerprint": "d0f2d5e0d9c719d18bd977796325501c1c754eb265aed72af1151a3e70124fb3",
+ "path": "/console/billing/topup",
+ "operationId": "topUpBilling",
+ "fingerprint": "c52697f6b2843048dba07a53677131a008eed9dbdc78176ab23b1a2f40a7cbda",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).flows.sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Flows.Sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.flows.sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::flows.sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Flows.SyncAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.flows.sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/flows/{flowId}/upload",
- "operationId": "uploadFlow",
- "fingerprint": "f958ff7b72cffb01d27f88e54db0a09351ee2910197836b4666dcf2f16eed734",
+ "path": "/console/call-opt-outs",
+ "operationId": "createConsoleCallOptOut",
+ "fingerprint": "cfb484a34398f9cc3df441a97a15660a7fe99ce208af2b44f04a1338ac940e8d",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).flows.upload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Flows.Upload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.flows.upload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::flows.upload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Flows.UploadAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.flows.upload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/functions",
- "operationId": "createFunction",
- "fingerprint": "8208a572af52e4e614bae919d34f22dba70ab2fd9f2516d8832e97ecda09e90d",
+ "path": "/console/call-opt-outs/import",
+ "operationId": "importConsoleCallOptOuts",
+ "fingerprint": "98aba1ad87884bfe337862ba266bf6e1b42fcecbf563e9c84ffc5241235aa503",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).functions.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Functions.Create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.functions.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::functions.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Functions.CreateAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.functions.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/functions/{functionId}/deployments",
- "operationId": "createFunctionDeployment",
- "fingerprint": "bb089e1d298059801ec5de981ab01740e3fb1419ab92920c72ca19784fa674eb",
+ "path": "/console/calls/{callId}/connections/{connectionId}/remove",
+ "operationId": "removeCallConnection",
+ "fingerprint": "b9e7ad4d3b7b6c3db5883688564f8e670094cda5feaa1807c56536a1b10e781e",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).functions.deployments.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Functions.Deployments.Create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.functions.deployments.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::functions.deployments.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Functions.Deployments.CreateAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.functions.deployments.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/functions/{functionId}/invocations",
- "operationId": "createFunctionInvocation",
- "fingerprint": "357fea45933e3d38f8f4e984e99b09b84f83954844fec71d9b21025c413f2425",
+ "path": "/console/campaigns/{campaignId}/approvals/{approvalId}/approve",
+ "operationId": "approveCampaignLaunch",
+ "fingerprint": "51fa19f4cf04ea22efef0c989e9524dc7ca0b56de0628eef471554a6f94d9393",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).functions.invocations.create"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Functions.Invocations.Create"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.functions.invocations.create"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::functions.invocations.create"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Functions.Invocations.CreateAsync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.functions.invocations.create"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/functions/{functionId}/secrets",
- "operationId": "createFunctionSecret",
- "fingerprint": "446eb6af30700b46c27358ad721256030f08824e38c1034de9520d8cd713fe96",
+ "path": "/console/campaigns/{campaignId}/approvals/{approvalId}/reject",
+ "operationId": "rejectCampaignLaunch",
+ "fingerprint": "872d7cd7121e654134e5abe325867d7ef57d09ce354b44ed7a66b5dd7cc4abe6",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).functions.secrets.create"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Functions.Secrets.Create"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.functions.secrets.create"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::functions.secrets.create"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Functions.Secrets.CreateAsync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.functions.secrets.create"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/incidents/{incidentId}/acknowledge",
- "operationId": "acknowledgeSecurityIncident",
- "fingerprint": "15fbf19bde762dde938e6fc30220ae4815ef21180579ae645151ec8c424fa468",
+ "path": "/console/keys",
+ "operationId": "mintForConsoleApiKey",
+ "fingerprint": "78c4289519862906b3529cc604544633539f1e95a647d68f812de4431a58577d",
"typescript": {
- "status": "covered",
- "method": "Client.securityIncidents.acknowledge"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.SecurityIncidents.Acknowledge"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.security_incidents.acknowledge"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::securityIncidents.acknowledge"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.SecurityIncidents.AcknowledgeAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.security_incidents.acknowledge"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/media/uploads",
- "operationId": "createMediaUploadUrl",
- "fingerprint": "df9a99427c2f268c4ce78e0295f5d3c9a477ceb238996665ba25210bd0700bc2",
+ "path": "/console/members/invites",
+ "operationId": "inviteMember",
+ "fingerprint": "0578e949c2b6012b29765675981c9127d55967f991d56f25880be16e421c8fe0",
"typescript": {
- "status": "covered",
- "method": "Client.media.createUpload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Media.CreateUpload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.media.create_upload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::media.createUpload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Media.CreateUploadAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.media.create_upload"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/operations/{operationId}/cancel",
- "operationId": "cancelPlatformOperation",
- "fingerprint": "72288b9542daca88590fbb150cab23fda91524c664c9bd655fbaadc7bcb19274",
+ "path": "/console/notifications/{notificationId}/archive",
+ "operationId": "archiveNotification",
+ "fingerprint": "c4488c3638b710e0d29573cccd157abec2e712ff7a8d1eb3f7a9690bd3d4f823",
"typescript": {
- "status": "covered",
- "method": "Client.operations.cancel"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Operations.Cancel"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.operations.cancel"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::operations.cancel"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Operations.CancelAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.operations.cancel"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/optouts",
- "operationId": "createOptOut",
- "fingerprint": "1f34c7db4335800796426db26e6cc54a99ebb3bd3fbe0c6b90f2ecbc2eb27be5",
+ "path": "/console/notifications/{notificationId}/read",
+ "operationId": "markReadNotification",
+ "fingerprint": "eb93d46b0f769fc46fef8bb00279ea16dd356d5fd8b5629e2391bb872820fe01",
"typescript": {
- "status": "covered",
- "method": "Client.optOuts.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.OptOuts.Create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.opt_outs.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::optOuts.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.OptOuts.CreateAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.opt_outs.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/optouts/batch",
- "operationId": "createOptOuts",
- "fingerprint": "ae3384a887dd31a5437a5208dc908126698a9b7dc4c0c690db7e65e7d3c51123",
+ "path": "/console/notifications/archive",
+ "operationId": "archiveAllNotification",
+ "fingerprint": "1526d9717193b33a1d29afb64b1d4c6f3f5445558713aef5c646ef6fcdd5ff79",
"typescript": {
- "status": "covered",
- "method": "Client.optOuts.createBatch"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.OptOuts.CreateBatch"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.opt_outs.create_batch"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::optOuts.createBatch"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.OptOuts.CreateBatchAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.opt_outs.create_batch"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/projects",
- "operationId": "createProject",
- "fingerprint": "e071637fd953c0a4845bd8844f59d19084594d402ab1a3dd10fb39bca592ba12",
+ "path": "/console/notifications/read",
+ "operationId": "markAllReadNotification",
+ "fingerprint": "1b9a4757cf225b9c66dfbafe993e88dc6e140dc68b17374a9c59a5d30bb4b20d",
"typescript": {
- "status": "covered",
- "method": "Client.projects.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Projects.Create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.projects.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::projects.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Projects.CreateAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.projects.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/projects/{projectId}/customers/enable",
- "operationId": "enableCustomers",
- "fingerprint": "8614fa1ff30e601eb7e7322db52b45c09c05f4fbb7fc5f96d99b920126353278",
+ "path": "/console/notifications/test",
+ "operationId": "sendTestNotificationEmail",
+ "fingerprint": "79541941828326ea78d1677d323441ac1932f239dec526b25702993e8ed05621",
"typescript": {
- "status": "covered",
- "method": "Client.customers.enable"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Customers.Enable"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.customers.enable"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::customers.enable"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Customers.EnableAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.customers.enable"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/projects/{projectId}/events/{eventId}/replays",
- "operationId": "replayProjectEvent",
- "fingerprint": "fd8738d01fe9336178cd84470ec72261bdc078a5a5a4f5c1a1be4da8abace2ff",
+ "path": "/console/profile/avatar/uploads",
+ "operationId": "generateUserProfileAvatarUploadUrl",
+ "fingerprint": "246a37b87a93b0d18e13a6948e1abcffb7aae58eb9cafbfcf9f30f7ef9158948",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).events.replay"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Events.Replay"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.events.replay"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::events.replay"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Events.ReplayAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.events.replay"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/projects/{projectId}/events/stream/{streamId}/ack",
- "operationId": "acknowledgeProjectEventStream",
- "fingerprint": "575d031054c7377345e572a80fa149daf417a0669e6a01fb78891395ec6296eb",
+ "path": "/console/profile/ensure",
+ "operationId": "ensureProfileUserProfile",
+ "fingerprint": "80d1ecd3337a4c42c09d9e372ecf255149c63d4a5aaeb611f37d064191a43794",
"typescript": {
- "status": "covered",
- "method": "Client.events.acknowledgeStream"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Events.AcknowledgeStream"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.events.acknowledge_stream"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::events.acknowledgeStream"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Events.AcknowledgeStreamAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.events.acknowledge_stream"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/projects/{projectId}/operations/{operationId}/cancel",
- "operationId": "cancelProjectOperation",
- "fingerprint": "669837690f541537fd9e6f9f845f3c45705350ea5edca2bcba06fa2abffb8ba0",
+ "path": "/console/projects/{projectId}/connections/{connection}/catalogs/{catalogId}/sync",
+ "operationId": "syncConsoleCloudCatalog",
+ "fingerprint": "24f9f1cb32ebf0ab1133584a3bda9ed8a5ac9fde3532226858231dfe99d19b99",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).operations.cancel"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Operations.Cancel"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.operations.cancel"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "Client::operations.cancel"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Operations.CancelAsync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.operations.cancel"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/projects/{projectId}/production-enrollments/{operationId}/approve",
- "operationId": "approveProductionEnrollment",
- "fingerprint": "6737fb824d1dd4304872ebfb8a2f228b3ed3263705ae7ba00d84e80e0cddcdc1",
+ "path": "/console/projects/{projectId}/icon",
+ "operationId": "generateProjectUploadUrl",
+ "fingerprint": "1d6e033b04fc60a7ee01ede98075e087e317bd80e859aee18bbba58988e094c3",
"typescript": {
- "status": "covered",
- "method": "Client.projects.approveProductionEnrollment"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Projects.ApproveProductionEnrollment"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.projects.approve_production_enrollment"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::projects.approveProductionEnrollment"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Projects.ApproveProductionEnrollmentAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.projects.approve_production_enrollment"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/projects/{projectId}/production-enrollments/{operationId}/cancel",
- "operationId": "cancelProductionEnrollment",
- "fingerprint": "da8d97ebdf0d6cd2ce5c5470d0543b767a098ad1095ff1a82e9174fe2f92d0d4",
+ "path": "/console/projects/{projectId}/regional-data/access",
+ "operationId": "issueRegionalDataAccess",
+ "fingerprint": "a8f82ddbf89f0eb88dc1ad1227b45700ee6d7ce83aa5a5e7577631eee31b5edd",
"typescript": {
- "status": "covered",
- "method": "Client.projects.cancelProductionEnrollment"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Projects.CancelProductionEnrollment"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.projects.cancel_production_enrollment"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "Client::projects.cancelProductionEnrollment"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Projects.CancelProductionEnrollmentAsync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.projects.cancel_production_enrollment"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/projects/{projectId}/promote",
- "operationId": "requestProductionEnrollment",
- "fingerprint": "6d555dfb3f520aac956a170d3f89fa01d745c2a749ba50a381cebfe410b0c930",
+ "path": "/console/projects/{projectId}/regional-data/client-tokens",
+ "operationId": "issueConsoleRegionalClientToken",
+ "fingerprint": "6c094bdb8f9ea6a7de1641fa710f4f9b2ad7cd0edac5da0aeb62460a277602da",
"typescript": {
- "status": "covered",
- "method": "Client.projects.requestProductionEnrollment"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Projects.RequestProductionEnrollment"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.projects.request_production_enrollment"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "covered",
- "method": "Client::projects.requestProductionEnrollment"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Projects.RequestProductionEnrollmentAsync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.projects.request_production_enrollment"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/projects/{projectId}/webhook-deliveries/{deliveryId}/retry",
- "operationId": "retryProjectWebhookDelivery",
- "fingerprint": "4d8551475d4cfe9361421b92e78afef220445544d18097593e8aac5c7ff6de7c",
+ "path": "/console/projects/{projectId}/setup/usage",
+ "operationId": "recordProjectSetupUsage",
+ "fingerprint": "2e8d10e8b5a179e5695bbedac50d88f570808bb344584b7144929d2701ae7a93",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).webhookDeliveries.retry"
+ "status": "excluded",
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.WebhookDeliveries.Retry"
+ "status": "excluded",
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.webhook_deliveries.retry"
+ "status": "excluded",
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::webhookDeliveries.retry"
+ "status": "excluded",
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.WebhookDeliveries.RetryAsync"
+ "status": "excluded",
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.webhook_deliveries.retry"
+ "status": "excluded",
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/projects/{projectId}/webhooks",
- "operationId": "createProjectWebhook",
- "fingerprint": "2e730955e2a1a420c98bcc9fa9784523bb91fcc0dc930daa24e5b9b2fe1308a2",
+ "path": "/console/quicklink/logo/project",
+ "operationId": "useProjectIconQuickLinkSettings",
+ "fingerprint": "d48fac41939598054da137cff798f2f85683fa994aab20c9aa52f7527f5440e2",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).webhooks.create"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/projects/{projectId}/webhooks/{webhookId}/secret-rotations",
- "operationId": "rotateProjectWebhookSecret",
- "fingerprint": "4b098a4721f407b09d7c942c14648846b9f1dff30ee6133d7b95c09dd5c63fbb",
+ "path": "/console/quicklink/logo/team",
+ "operationId": "useTeamLogoQuickLinkSettings",
+ "fingerprint": "f9b0713448982a21acbaee5b4da388aeafa55b947bb749315f4e335da65c5a72",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).webhooks.rotateSecret"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Webhooks.RotateSecret"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.webhooks.rotate_secret"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::webhooks.rotateSecret"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Webhooks.RotateSecretAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.webhooks.rotate_secret"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/projects/{projectId}/webhooks/{webhookId}/tests",
- "operationId": "testProjectWebhook",
- "fingerprint": "eb02b02260eb0b3ae0874c408e136b1d01ac59eed40b1914211c2cafc8f18980",
+ "path": "/console/quicklink/logo/uploads",
+ "operationId": "generateQuickLinkSettingsLogoUploadUrl",
+ "fingerprint": "5c0b34d2cfa41ce4cd9ca504b2a97bcd9c86ede4664115e8c0d1a2b1cb975fc7",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).webhooks.test"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Webhooks.Test"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.webhooks.test"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::webhooks.test"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Webhooks.TestAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.webhooks.test"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/handoff-ack",
- "operationId": "sessionHandoffAck",
- "fingerprint": "34f09411ed605362040cbf94203655143967f81ef7b8fd5653e488844520e25f",
+ "path": "/console/sip-trunks",
+ "operationId": "createConsoleSipTrunk",
+ "fingerprint": "cc0563be664757f92a2911557762cb404ba1566c60d3d2195709a80722e8e694",
"typescript": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/handoff-import",
- "operationId": "sessionHandoffImport",
- "fingerprint": "de346e15ce098edbf829d0f5145712609d6975576c76cfb05fe54a29357e9210",
+ "path": "/console/sip-trunks/{trunkId}/credentials",
+ "operationId": "rotateConsoleSipTrunkCredentials",
+ "fingerprint": "dbb1379fe9f22e160857efe1b2469f79a88de8ee03f9d4a124c4ae8daa873fef",
"typescript": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/handoff-keys",
- "operationId": "sessionHandoffKeys",
- "fingerprint": "308f8872e70238874beff994add71910c6f2d1f14ed0a4163345464d98a03f03",
+ "path": "/console/team-invitations/{invitationId}/accept",
+ "operationId": "acceptTeamInvitation",
+ "fingerprint": "b9ac80fc2ccea1727102a990f672791e423114e3dc2f3e8735a5c72ef703c93a",
"typescript": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/logout",
- "operationId": "logoutSession",
- "fingerprint": "237d1b751e42de6e62baa63b5ba241e82332aee3b589de2fd2cf74a45c2420e6",
+ "path": "/console/team/avatar/uploads",
+ "operationId": "generateTeamAvatarUploadUrl",
+ "fingerprint": "514ed6d1af39d25d9b45b7574f284e8e5dcec7da55838661ae8c1478efa1c7b4",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.sessions.logout"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Sessions.Logout"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.sessions.logout"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "MessagingClient::$sessions->logout"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Sessions.LogoutAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.sessions.logout"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/restart",
- "operationId": "restartSession",
- "fingerprint": "e244ce002226841ef849b681ce5be3da66dd345e354aa02261dba380ee9c1864",
+ "path": "/console/teams/{teamId}/delete",
+ "operationId": "deleteUserProfileTeam",
+ "fingerprint": "2a0939b2d5beb75f7b85d4cadcc0a5ab2f7709e8b961db8a375d5dd9b82361da",
"typescript": {
- "status": "covered",
- "method": "MessagingClient.sessions.restart"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "MessagingClient.Sessions.Restart"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncMessagingClient.sessions.restart"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "MessagingClient::$sessions->restart"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Sessions.RestartAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.sessions.restart"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/start",
- "operationId": "startPlatformSession",
- "fingerprint": "531d90fa3b944f926de8a555384936d9d4e55641b324020d02c19c3e401c7299",
+ "path": "/console/teams/ensure",
+ "operationId": "ensureForCurrentUserTeam",
+ "fingerprint": "edcfb26006b92e230056a06a1292a8fe5038a9cbc1e2a170f956c679b878a213",
"typescript": {
- "status": "covered",
- "method": "Client.sessions.start"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Sessions.Start"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.sessions.start"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::sessions.start"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Sessions.StartAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.sessions.start"
- }
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
+ }
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/stop",
- "operationId": "stopPlatformSession",
- "fingerprint": "fa33383bc53cfdce03691efe424b1996c569679977217a308e664382a4e97afd",
+ "path": "/console/teams/leave",
+ "operationId": "leaveTeamUserProfile",
+ "fingerprint": "182b578fd497ce09cd9ea77ada1324d5e87d9f5917e359c5b31347622327d071",
"typescript": {
- "status": "covered",
- "method": "Client.sessions.stop"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Sessions.Stop"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.sessions.stop"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::sessions.stop"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Sessions.StopAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "MessagingClient.sessions.stop"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/tier-quotes",
- "operationId": "quoteSessionTierChange",
- "fingerprint": "3e15c2d7bd564b1cb0fd59e9334ca29032d629b80b94ed1ca0acf85e9cb6a264",
+ "path": "/console/voice/audio",
+ "operationId": "createConsoleVoiceAudioUpload",
+ "fingerprint": "6d0004ab0b421098574b1eea06e01cea2bf32639676582f47902f0d7602c3252",
"typescript": {
- "status": "covered",
- "method": "Client.sessions.quoteTierChange"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Sessions.QuoteTierChange"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.sessions.quote_tier_change"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::sessions.quoteTierChange"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Sessions.QuoteTierChangeAsync"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.sessions.quote_tier_change"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/upload-appstate-keys",
- "operationId": "sessionUploadAppStateKeys",
- "fingerprint": "923c7dadb998d9d49e42ca47147fbd52c92b8a62035d8e4442ea2ec0690f315c",
+ "path": "/console/voice/audio/{assetId}/complete",
+ "operationId": "completeConsoleVoiceAudioUpload",
+ "fingerprint": "f03c5560deefe3f6473df195a645d05ff9986931edb4a317909fe964e6dcfa15",
"typescript": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"go": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"python": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"rust": {
"status": "excluded",
- "reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
- "milestone": "security-design"
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/delete",
- "operationId": "deleteSessions",
- "fingerprint": "9a6b8dffea1b90b9daa8420e55dd67562365c10f2616f1341e5ef78ffa8a90fb",
+ "path": "/console/voice/audio/tts",
+ "operationId": "synthesizeConsoleVoiceAudio",
+ "fingerprint": "f6ca3ab6be286ebf8402bb89f27cac7dd29814848c009a6596385973e7ce40f4",
"typescript": {
- "status": "covered",
- "method": "Client.sessions.deleteMany"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Sessions.DeleteMany"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.sessions.delete_many"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::sessions.deleteMany"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Sessions.DeleteManyAsync"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.sessions.delete_many"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/stop",
- "operationId": "stopSessions",
- "fingerprint": "7875855613581c00576db40d4149e59dd7027276f3439817e94ea9af9a98d026",
+ "path": "/console/voice/provider-credentials",
+ "operationId": "createConsoleVoiceProviderCredential",
+ "fingerprint": "44e47ae907c56c3bede0c0b76342a0ada0dbb9a84222d34bca578c342305d166",
"typescript": {
- "status": "covered",
- "method": "Client.sessions.stopMany"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"go": {
- "status": "covered",
- "method": "TeamClient.Sessions.StopMany"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.sessions.stop_many"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::sessions.stopMany"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Sessions.StopManyAsync"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.sessions.stop_many"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sip-trunks",
- "operationId": "createSipTrunk",
- "fingerprint": "c17fecb627c3d6f310dd8caa3f0c057ce93f1d6a63b2446f87ddc2fb34a944f2",
+ "path": "/console/voice/provider-credentials/{credentialId}/verify",
+ "operationId": "verifyConsoleVoiceProviderCredential",
+ "fingerprint": "a8fdcbda55cdcf9bf802bd6d1c5aa0bb61c0f54eb91260270d8f319e1e47d8b0",
"typescript": {
- "status": "covered",
- "method": "Client.sipTrunks.create"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"go": {
- "status": "covered",
- "method": "TeamClient.SIPTrunks.Create"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.sip_trunks.create"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::sipTrunks.create"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.SipTrunks.CreateAsync"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.sip_trunks.create"
+ "status": "excluded",
+ "reason": "Console-only voice routes require dashboard membership; server SDK uses Platform voice routes.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sip-trunks/{trunkId}/credentials",
- "operationId": "rotateSipTrunkCredentials",
- "fingerprint": "c4f8cceccf5eebd19e2d9805a12f75cbb5b51107ceabc7a96366087d2102f539",
+ "path": "/console/webhooks",
+ "operationId": "createWebhook",
+ "fingerprint": "ef9825c860655c458c15e1c54a9cbd22206d5c797c14eeb5ce9239291f62fc8b",
"typescript": {
- "status": "covered",
- "method": "Client.sipTrunks.rotateCredentials"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.SIPTrunks.RotateCredentials"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.sip_trunks.rotate_credentials"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::sipTrunks.rotateCredentials"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.SipTrunks.RotateCredentialsAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.sip_trunks.rotate_credentials"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/templates",
- "operationId": "createMessageTemplate",
- "fingerprint": "ff76bc7341bf8c7a3d88052c5c656a725fcd481b98a39d8660a45228eec08745",
+ "path": "/platform/audience-profile-imports",
+ "operationId": "createAudienceProfileImport",
+ "fingerprint": "d09a9d59487488ae4070fec662969eb5f8d49fd68de725dd50b96975a74cd027",
"typescript": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "excluded",
- "reason": "This dashboard-only route does not accept the team server API key used by Client.",
- "milestone": "credential-boundary"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/voice/audio",
- "operationId": "createVoiceAudioUpload",
- "fingerprint": "78aa4eda3eb9b236f9bc69350f50f10953dca8748704cdaf904bc5da5f2db3ac",
+ "path": "/platform/audience-segments",
+ "operationId": "createAudienceSegment",
+ "fingerprint": "0be3f23ef7cb10df01bccd72a8e665c6cae07aad2f5e7c10fd072433f2715db0",
"typescript": {
"status": "covered",
- "method": "Client.voice.audio.createUpload"
+ "method": "Client.audienceSegments.create"
},
"go": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.CreateUpload"
+ "method": "TeamClient.AudienceSegments().Create"
},
"python": {
"status": "covered",
- "method": "AsyncClient.voice.audio.create_upload"
+ "method": "AsyncClient.audience_segments.create"
},
"php": {
"status": "covered",
- "method": "Client::voice.audio.createUpload"
+ "method": "Client::audienceSegments.create"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.CreateUploadAsync"
+ "method": "TeamClient.AudienceSegments.CreateAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.voice.audio.create_upload"
+ "method": "TeamClient.audience_segments().create"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/voice/audio/{assetId}/complete",
- "operationId": "completeVoiceAudioUpload",
- "fingerprint": "df76426a834306eeb463ef0c5afd14c5f7136be11595606f3e936dab07c46cff",
+ "path": "/platform/audience-segments/preview",
+ "operationId": "previewAudienceSegmentRules",
+ "fingerprint": "685f6ef4e10d6ea88f9da2377ee32c7295776ce6ea16e057cd1821c8f4de7ba9",
"typescript": {
"status": "covered",
- "method": "Client.voice.audio.complete"
+ "method": "Client.audienceSegments.previewRules"
},
"go": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.Complete"
+ "method": "TeamClient.AudienceSegments().PreviewRules"
},
"python": {
"status": "covered",
- "method": "AsyncClient.voice.audio.complete"
+ "method": "AsyncClient.audience_segments.preview_rules"
},
"php": {
"status": "covered",
- "method": "Client::voice.audio.complete"
+ "method": "Client::audienceSegments.previewRules"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.CompleteAsync"
+ "method": "TeamClient.AudienceSegments.PreviewRulesAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.voice.audio.complete"
+ "method": "TeamClient.audience_segments().preview_rules"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/voice/audio/tts",
- "operationId": "synthesizeVoiceAudio",
- "fingerprint": "17c7fcde798d5caac29958959ee5ec33687bebb1a12ee733b6ec24cb5eb2ea75",
+ "path": "/platform/audiences",
+ "operationId": "createAudience",
+ "fingerprint": "cbd112b62e83a7f363317cbb052a9f42bd450b59889ad43aaa8aba05e5bf2ef6",
"typescript": {
"status": "covered",
- "method": "Client.voice.audio.synthesize"
+ "method": "Client.audiences.create"
},
"go": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.Synthesize"
+ "method": "TeamClient.Audiences.Create"
},
"python": {
"status": "covered",
- "method": "AsyncClient.voice.audio.synthesize"
+ "method": "AsyncClient.audiences.create"
},
"php": {
"status": "covered",
- "method": "Client::voice.audio.synthesize"
+ "method": "Client::audiences.create"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Voice.Audio.SynthesizeAsync"
+ "method": "TeamClient.Audiences.CreateAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.voice.audio.synthesize"
+ "method": "TeamClient.audiences.create"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/voice/provider-credentials",
- "operationId": "createVoiceProviderCredential",
- "fingerprint": "eda3bbd777c86dc191a07db0c06040579b89faa26c360d0871f33bc3907b4f1b",
+ "path": "/platform/audiences/{listId}/members",
+ "operationId": "addAudienceMembers",
+ "fingerprint": "e744311d136345c2cbb9a07486356225d20593f9ea5b34b1b8db658cb3342549",
"typescript": {
"status": "covered",
- "method": "Client.voice.providerCredentials.create"
+ "method": "Client.audiences.addMembers"
},
"go": {
"status": "covered",
- "method": "TeamClient.Voice.ProviderCredentials.Create"
+ "method": "TeamClient.Audiences.AddMembers"
},
"python": {
"status": "covered",
- "method": "AsyncClient.voice.provider_credentials.create"
+ "method": "AsyncClient.audiences.add_members"
},
"php": {
"status": "covered",
- "method": "Client::voice.providerCredentials.create"
+ "method": "Client::audiences.addMembers"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Voice.ProviderCredentials.CreateAsync"
+ "method": "TeamClient.Audiences.AddMembersAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.voice.provider_credentials.create"
+ "method": "TeamClient.audiences.add_members"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/voice/provider-credentials/{credentialId}/verify",
- "operationId": "verifyVoiceProviderCredential",
- "fingerprint": "3a0789a0e5fc26b8ffa0508f51175923a73e10ebdc09662ebc517879e85a480f",
+ "path": "/platform/audiences/from-campaign",
+ "operationId": "createAudienceFromCampaign",
+ "fingerprint": "943b6e2b29eb483c6b2db7b5c415fd643fa16dd982dc7fe0a7972bd7cfb84cf4",
"typescript": {
- "status": "covered",
- "method": "Client.voice.providerCredentials.verify"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Voice.ProviderCredentials.Verify"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.voice.provider_credentials.verify"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "Client::voice.providerCredentials.verify"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Voice.ProviderCredentials.VerifyAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.voice.provider_credentials.verify"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/webhook-deliveries/{deliveryId}/retry",
- "operationId": "retryTeamWebhookDelivery",
- "fingerprint": "a75bc14c49a898829e4c9d2e1d0e18a6128286f515441baaa2a3b8fbab94dbc5",
+ "path": "/platform/audiences/uploads",
+ "operationId": "createAudienceUploadUrl",
+ "fingerprint": "4842c0813d1ae2d28470723a77ec1bead89116815c1cd253f38588c9244c29fb",
"typescript": {
"status": "covered",
- "method": "Client.webhookDeliveries.retry"
+ "method": "Client.audiences.createUpload"
},
"go": {
"status": "covered",
- "method": "TeamClient.WebhookDeliveries.Retry"
+ "method": "TeamClient.Audiences.CreateUpload"
},
"python": {
"status": "covered",
- "method": "AsyncClient.webhook_deliveries.retry"
+ "method": "AsyncClient.audiences.create_upload"
},
"php": {
"status": "covered",
- "method": "Client::webhookDeliveries.retry"
+ "method": "Client::audiences.createUpload"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.WebhookDeliveries.RetryAsync"
+ "method": "TeamClient.Audiences.CreateUploadAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.webhook_deliveries.retry"
+ "method": "TeamClient.audiences.create_upload"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/webhooks",
- "operationId": "createTeamWebhook",
- "fingerprint": "759e6df60519cf6c150383244dd61d885c3da1491e8e5b89ed0e6aa08a6d1baa",
+ "path": "/platform/bansafe/incidents",
+ "operationId": "createBanSafeIncident",
+ "fingerprint": "f56100ad74ba67c332c93701e60a774e3df87a17b742332938385d587c292579",
"typescript": {
"status": "covered",
- "method": "Client.webhooks.create"
+ "method": "Client.banSafe.createIncident"
},
"go": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.BanSafe.CreateIncident"
},
"python": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.ban_safe.create_incident"
},
"php": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::banSafe.createIncident"
},
"dotnet": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.BanSafe.CreateIncidentAsync"
},
"rust": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.ban_safe.create_incident"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/webhooks/{webhookId}/secret-rotations",
- "operationId": "rotateTeamWebhookSecret",
- "fingerprint": "387e8fda3114d0d8c01e8d1e4a704a17bc8f438663c3709305927a1a4bbcb3e3",
+ "path": "/platform/bansafe/incidents/{incidentId}/retract",
+ "operationId": "retractBanSafeIncident",
+ "fingerprint": "5ae04660eba71af3d64ccbf0e19fd433a7fb00979232f9903f22c00dac43ce7e",
"typescript": {
"status": "covered",
- "method": "Client.webhooks.rotateSecret"
+ "method": "Client.banSafe.retractIncident"
},
"go": {
"status": "covered",
- "method": "TeamClient.Webhooks.RotateSecret"
+ "method": "TeamClient.BanSafe.RetractIncident"
},
"python": {
"status": "covered",
- "method": "AsyncClient.webhooks.rotate_secret"
+ "method": "AsyncClient.ban_safe.retract_incident"
},
"php": {
"status": "covered",
- "method": "Client::webhooks.rotateSecret"
+ "method": "Client::banSafe.retractIncident"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Webhooks.RotateSecretAsync"
+ "method": "TeamClient.BanSafe.RetractIncidentAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.webhooks.rotate_secret"
+ "method": "TeamClient.ban_safe.retract_incident"
}
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/webhooks/{webhookId}/tests",
- "operationId": "testTeamWebhook",
- "fingerprint": "d41cd2b64bd471ab56973a1dc77fb416761b43bc93fd9a9087f27ec496cc85b6",
+ "path": "/platform/call-opt-outs",
+ "operationId": "createCallOptOut",
+ "fingerprint": "955b3f1f9eedab83f32bccaf6f89f5bcc6d8999747e8f801d7ae23bee1554b3d",
"typescript": {
"status": "covered",
- "method": "Client.webhooks.test"
+ "method": "Client.callOptOuts.create"
},
"go": {
"status": "covered",
- "method": "TeamClient.Webhooks.Test"
+ "method": "TeamClient.CallOptOuts.Create"
},
"python": {
"status": "covered",
- "method": "AsyncClient.webhooks.test"
+ "method": "AsyncClient.call_opt_outs.create"
},
"php": {
"status": "covered",
- "method": "Client::webhooks.test"
+ "method": "Client::callOptOuts.create"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Webhooks.TestAsync"
+ "method": "TeamClient.CallOptOuts.CreateAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.webhooks.test"
+ "method": "TeamClient.call_opt_outs.create"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/api/account/meta-app",
- "operationId": "configureTeamMetaApp",
- "fingerprint": "77da5c3c1ead511a73d21b3b3697e80e8010d7f224649d2ec230184f817c3476",
+ "method": "POST",
+ "path": "/platform/call-opt-outs/import",
+ "operationId": "importCallOptOuts",
+ "fingerprint": "cf62e342736701c92aab500af9ebec1f82a6fef7fd2f53641f3d941ed3b07cdc",
"typescript": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "Client.callOptOuts.import"
},
"go": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "TeamClient.CallOptOuts.Import"
},
"python": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.call_opt_outs.import_entries"
},
"php": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::callOptOuts.import"
},
"dotnet": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
+ "status": "covered",
+ "method": "TeamClient.CallOptOuts.ImportAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.call_opt_outs.import"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/console/call-policy",
- "operationId": "updateConsoleCallPolicy",
- "fingerprint": "f32f6596c466a1367e6cbbde55b2135b6e57fba445942811614c5844a32461d9",
+ "method": "POST",
+ "path": "/platform/campaign-reply-flows",
+ "operationId": "createPlatformCampaignReplyFlow",
+ "fingerprint": "f66233dac8f95cb1569c52348de4995968f9fe43e7d360799973264ef25fb3d3",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/console/call-retention",
- "operationId": "updateTeamCallRetention",
- "fingerprint": "af7255c6a1e712c89e2ea8bdc33e722f3ab52a9b988d2c90504e94ca53c98f5d",
+ "method": "POST",
+ "path": "/platform/campaigns",
+ "operationId": "createPlatformCampaign",
+ "fingerprint": "e4163ed4226af508ec352d89bed00d65fde0a0b048cf5882b862e91fc965c70b",
"typescript": {
- "status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method."
+ "status": "covered",
+ "method": "Client.campaigns.create"
},
"go": {
- "status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.Create"
},
"python": {
- "status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.campaigns.create"
},
"php": {
- "status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::campaigns.create"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.CreateAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only dashboard operation; not a public SDK method.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.campaigns.create"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/console/call-settings/{sessionId}",
- "operationId": "updateSessionCallSettings",
- "fingerprint": "aec9983da75aece4721458cb3f46632449562e8b9cf083bd6143138c0b075872",
+ "method": "POST",
+ "path": "/platform/campaigns/{campaignId}/archive",
+ "operationId": "archiveCampaign",
+ "fingerprint": "94584b75f071c8e0ab6a58f383c44a6f9a0e1370ae367b9b5f0cfe4c2f155ad6",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.campaigns.archive"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.Archive"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.campaigns.archive"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::campaigns.archive"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.ArchiveAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.campaigns.archive"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/console/insights/preferences",
- "operationId": "updateInsightPreferences",
- "fingerprint": "0b31dd6664b3b8274a0bb295e4c3cf4288526ab99d609dcb298c300a1a77de99",
+ "method": "POST",
+ "path": "/platform/campaigns/{campaignId}/conversions",
+ "operationId": "recordCampaignConversion",
+ "fingerprint": "f2fa5db94a7942d22d540d8db650a91f6f4f0df0377f0333c0ed9677b3dfdb1a",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.campaigns.recordConversion"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.RecordConversion"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.campaigns.record_conversion"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::campaigns.recordConversion"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.RecordConversionAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.campaigns.record_conversion"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/console/notifications/preferences",
- "operationId": "updateNotificationPreferences",
- "fingerprint": "69c616c55c0a31847462ef4b5235c1dca308ecded0a3310789bb24407c930530",
+ "method": "POST",
+ "path": "/platform/campaigns/{campaignId}/duplicate",
+ "operationId": "duplicateCampaign",
+ "fingerprint": "28113a7936630e45d994a7e8f99ff2d69ab4bc7dc2efcbd96c835870370e6895",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.campaigns.duplicate"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.Duplicate"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.campaigns.duplicate"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::campaigns.duplicate"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.DuplicateAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.campaigns.duplicate"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/console/team/avatar",
- "operationId": "saveAvatarTeam",
- "fingerprint": "aabb9a048daf5adcf78b82be7282739231419c7ace62ee87a1c875e0ba685d21",
+ "method": "POST",
+ "path": "/platform/campaigns/{campaignId}/enrollments",
+ "operationId": "enrollCampaignContact",
+ "fingerprint": "8b63403fd07e40ca03202bf64735b456bd2c048bdf7154dcae5e368ca5edc63a",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.campaigns.enroll"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns().Enroll"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.campaigns.enroll"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::campaigns.enroll"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.EnrollAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.campaigns().enroll"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/console/profile/avatar",
- "operationId": "saveAvatarUserProfile",
- "fingerprint": "d74e3b056456be441e74d755507fe89a14531fa7d91178a3e3168178a9ddcbf8",
+ "method": "POST",
+ "path": "/platform/campaigns/{campaignId}/launch",
+ "operationId": "launchPlatformCampaign",
+ "fingerprint": "73e42cc4e7d50389e283d3da594e6ec4b346310d176fecfab6310a92a81c0baf",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.campaigns.launch"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.Launch"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.campaigns.launch"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::campaigns.launch"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.LaunchAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.campaigns.launch"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/console/projects/{projectId}/logging/drains",
- "operationId": "saveProjectDrain",
- "fingerprint": "0010f0509937c937608772a77b90655cc56b29303c8470bff5ceac3e1d6eaf94",
+ "method": "POST",
+ "path": "/platform/campaigns/{campaignId}/pause",
+ "operationId": "pausePlatformCampaign",
+ "fingerprint": "04be44e585eaa626863c3976e666a947fd8be70bc80cdc3854f8feb6cc1183da",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "Client.campaigns.pause"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.Pause"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.campaigns.pause"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::campaigns.pause"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.PauseAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.campaigns.pause"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/console/projects/{projectId}/logging/sampling",
- "operationId": "saveProjectSampling",
- "fingerprint": "b5f4816874dfaf6c392b1e2b041c854cb76fe7fb561d979e7effba3d3bd49ff7",
+ "method": "POST",
+ "path": "/platform/campaigns/{campaignId}/recipients",
+ "operationId": "addCampaignRecipients",
+ "fingerprint": "31c8731a6c5df6c0818d5ccb0dd58be22e2b74b836826ed93e68d23fed8648c3",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "Client.campaigns.addRecipients"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.AddRecipients"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.campaigns.add_recipients"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::campaigns.addRecipients"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.AddRecipientsAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.campaigns.add_recipients"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/console/projects/{projectId}/setup",
- "operationId": "saveProjectSetup",
- "fingerprint": "600cada94badc45f91b1ecde1eb38618678f47eaefe625b371cdb5ec7903670d",
+ "method": "POST",
+ "path": "/platform/campaigns/{campaignId}/requeue",
+ "operationId": "requeueFailedCampaign",
+ "fingerprint": "ba71b24cf4cde9aef7363e00112a598b093705809742696dcddafd69f2402512",
"typescript": {
- "status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
+ "status": "covered",
+ "method": "Client.campaigns.requeue"
},
"go": {
- "status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.Requeue"
},
"python": {
- "status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.campaigns.requeue"
},
"php": {
- "status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::campaigns.requeue"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.RequeueAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.campaigns.requeue"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/console/quicklink/logo",
- "operationId": "attachLogoQuickLinkSettings",
- "fingerprint": "2881f74db6f634f3d4cf6d05a616bf73fdf788f09cd869fdc48b9c9b1dfe367b",
+ "method": "POST",
+ "path": "/platform/campaigns/{campaignId}/reschedule",
+ "operationId": "reschedulePlatformCampaign",
+ "fingerprint": "03de3e68c10ec28bcf68437997cbf51083903f91a29f4acca6a7d4c4f5daf879",
"typescript": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "Client.campaigns.reschedule"
},
"go": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.Reschedule"
},
"python": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.campaigns.reschedule"
},
"php": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::campaigns.reschedule"
},
"dotnet": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.RescheduleAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.campaigns.reschedule"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/console/session-configuration/{sessionId}",
- "operationId": "updateSessionConfiguration",
- "fingerprint": "4980703c0d90638de715ed840b0b9f17b870415f215bb8a37ce1f8134384d2b6",
+ "method": "POST",
+ "path": "/platform/campaigns/{campaignId}/resume",
+ "operationId": "resumePlatformCampaign",
+ "fingerprint": "725f2e878135a947a04e0bfb9eb0f0f305374681883281563757d97318b230a8",
"typescript": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
+ "status": "covered",
+ "method": "Client.campaigns.resume"
},
"go": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.Resume"
},
"python": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "AsyncClient.campaigns.resume"
},
"php": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
- "milestone": "excluded-contract"
+ "status": "covered",
+ "method": "Client::campaigns.resume"
},
"dotnet": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
+ "status": "covered",
+ "method": "TeamClient.Campaigns.ResumeAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.campaigns.resume"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/billing/controls/{scope}/{resourceId}",
- "operationId": "setResourceBillingControls",
- "fingerprint": "4c6ebd858fade157a260c131bdb26836927eed48e59a89e411512e2ebc52620a",
+ "method": "POST",
+ "path": "/platform/campaigns/{campaignId}/stop",
+ "operationId": "stopPlatformCampaign",
+ "fingerprint": "f1ea68ebe7c6891db792287d60e248e1ad774217591bf65f356029e71a16719e",
"typescript": {
"status": "covered",
- "method": "Client.billing.setResourceControls"
+ "method": "Client.campaigns.stop"
},
"go": {
"status": "covered",
- "method": "TeamClient.Billing.SetResourceControls"
+ "method": "TeamClient.Campaigns.Stop"
},
"python": {
"status": "covered",
- "method": "AsyncClient.billing.set_resource_controls"
+ "method": "AsyncClient.campaigns.stop"
},
"php": {
"status": "covered",
- "method": "Client::billing.setResourceControls"
+ "method": "Client::campaigns.stop"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Billing.SetResourceControlsAsync"
+ "method": "TeamClient.Campaigns.StopAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.billing.set_resource_controls"
+ "method": "TeamClient.campaigns.stop"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/billing/limits/{scope}/{resourceId}",
- "operationId": "setBillingLimit",
- "fingerprint": "6031ea2378a384d49b1d769ffc4c94c5eaf5bfef747edcb6bea4231242c3d9dc",
+ "method": "POST",
+ "path": "/platform/campaigns/{campaignId}/test-send",
+ "operationId": "testSendPlatformCampaign",
+ "fingerprint": "3eb5b589b42263c068781e034706f0abc96aa7590f20d9116c30d2564110a68e",
"typescript": {
- "status": "covered",
- "method": "Client.billing.setLimit"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Billing.SetLimit"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncClient.billing.set_limit"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "Client::billing.setLimit"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Billing.SetLimitAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "TeamClient.billing.set_limit"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/billing/priorities",
- "operationId": "reorderBillingPriorities",
- "fingerprint": "febcac085f9e08309326af18799ebb6b63de76c81776dc502808d653e65e9b93",
+ "method": "POST",
+ "path": "/platform/client-tokens",
+ "operationId": "mintClientToken",
+ "fingerprint": "8dc137559f2b642a569b04b401ed6c443e46ae6a95c84f73f240e172bd877da2",
"typescript": {
"status": "covered",
- "method": "Client.billing.reorderPriorities"
+ "method": "MessagingClient.clientTokens.mint"
},
"go": {
"status": "covered",
- "method": "TeamClient.Billing.ReorderPriorities"
+ "method": "MessagingClient.ClientTokens.Mint"
},
"python": {
"status": "covered",
- "method": "AsyncClient.billing.reorder_priorities"
+ "method": "AsyncMessagingClient.client_tokens.mint"
},
"php": {
"status": "covered",
- "method": "Client::billing.reorderPriorities"
+ "method": "MessagingClient::$clientTokens->mint"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Billing.ReorderPrioritiesAsync"
+ "method": "TeamClient.ClientTokens.MintAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.billing.reorder_priorities"
+ "method": "MessagingClient.client_tokens.mint"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/billing/priorities/{scope}/{resourceId}",
- "operationId": "setBillingPriority",
- "fingerprint": "70e8779daa182ef3128ceed6f656492c5676898b784e93a60adfbb8b40413283",
+ "method": "POST",
+ "path": "/platform/connections/{connectionId}/handoff-ack",
+ "operationId": "connectionHandoffAck",
+ "fingerprint": "610724e07895a59eb2c44b2086edb9334de37ed1c9fb2a37cd727c349bfde96d",
"typescript": {
- "status": "covered",
- "method": "Client.billing.setPriority"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Billing.SetPriority"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.billing.set_priority"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
},
"php": {
- "status": "covered",
- "method": "Client::billing.setPriority"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Billing.SetPriorityAsync"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.billing.set_priority"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/call-policy",
- "operationId": "updateCallPolicy",
- "fingerprint": "f5b1885a345c7d5c0cf72151288715a3d93eaf1a441c56b56fed5e38ba6a1848",
+ "method": "POST",
+ "path": "/platform/connections/{connectionId}/handoff-import",
+ "operationId": "connectionHandoffImport",
+ "fingerprint": "0c4220af1e8ea9d2bce9594fd7937be97bc6aa6a830cc65a3f4fa4b56ab18f12",
"typescript": {
- "status": "covered",
- "method": "Client.callPolicy.update"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
},
"go": {
- "status": "covered",
- "method": "TeamClient.CallPolicy.Update"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.call_policy.update"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
},
"php": {
- "status": "covered",
- "method": "Client::callPolicy.update"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.CallPolicy.UpdateAsync"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.call_policy.update"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/call-retention",
- "operationId": "updateCallRetention",
- "fingerprint": "32a290ce8678fb5df506e122ffa92022472f550c2cad7afc3f522aecdae046bf",
+ "method": "POST",
+ "path": "/platform/connections/{connectionId}/handoff-keys",
+ "operationId": "connectionHandoffKeys",
+ "fingerprint": "5591f9b07a63b0414304120875ee2b48bde20ade695c02c6161390bc565ca833",
"typescript": {
- "status": "covered",
- "method": "Client.callRetention.update"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
},
"go": {
- "status": "covered",
- "method": "TeamClient.CallRetention.Update"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.call_retention.update"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
},
"php": {
- "status": "covered",
- "method": "Client::callRetention.update"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.CallRetention.UpdateAsync"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.call_retention.update"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/flows/{flowId}/endpoint",
- "operationId": "setFlowEndpoint",
- "fingerprint": "d0582fdf455237744a0a52a62c11d2c08397fff055595f3a72f802f0ad3373f3",
+ "method": "POST",
+ "path": "/platform/connections/{connectionId}/inspector/claim/release",
+ "operationId": "releaseConnectionInspectorClaim",
+ "fingerprint": "1b490e4323332acf99734403a9e6b126d158041fa07859295e24c2d7161f7f2e",
"typescript": {
- "status": "covered",
- "method": "Client.project(projectId).flows.setEndpoint"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "covered",
- "method": "ProjectClient.Flows.SetEndpoint"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.flows.set_endpoint"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::flows.setEndpoint"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Flows.SetEndpointAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.flows.set_endpoint"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/functions/{functionId}/promotion",
- "operationId": "promoteFunctionDeployment",
- "fingerprint": "87f0c7d4aff51ba32ed67dd96dc043b1bf7e4244437464d10588f23241b895c4",
+ "method": "POST",
+ "path": "/platform/connections/{connectionId}/logout",
+ "operationId": "logoutConnection",
+ "fingerprint": "2821eb0296dc69ce88f222f93dbd77ad9d7f3694bb4e99aeeb67389e8fc945e0",
"typescript": {
"status": "covered",
- "method": "Client.project(projectId).functions.deployments.promote"
+ "method": "MessagingClient.connections.logout"
},
"go": {
"status": "covered",
- "method": "ProjectClient.Functions.Deployments.Promote"
+ "method": "MessagingClient.Connections.Logout"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.functions.deployments.promote"
+ "method": "AsyncMessagingClient.connections.logout"
},
"php": {
"status": "covered",
- "method": "ProjectClient::functions.deployments.promote"
+ "method": "MessagingClient::$connections->logout"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Functions.Deployments.PromoteAsync"
+ "method": "TeamClient.Connections.LogoutAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.functions.deployments.promote"
+ "method": "MessagingClient.connections.logout"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/optouts/settings",
- "operationId": "updateOptOutSettings",
- "fingerprint": "244940ab4b3e41b7b9427f449022f154eaaf9534a4a35dc9226673508a1241e2",
+ "method": "POST",
+ "path": "/platform/connections/{connectionId}/restart",
+ "operationId": "restartConnection",
+ "fingerprint": "2d60318c4b77c21a7922f0ee188b70dee61837fc64e7ca0c4e5635290f750acd",
"typescript": {
"status": "covered",
- "method": "Client.optOuts.updateSettings"
+ "method": "MessagingClient.connections.restart"
},
"go": {
"status": "covered",
- "method": "TeamClient.OptOuts.UpdateSettings"
+ "method": "MessagingClient.Connections.Restart"
},
"python": {
"status": "covered",
- "method": "AsyncClient.opt_outs.update_settings"
+ "method": "AsyncMessagingClient.connections.restart"
},
"php": {
"status": "covered",
- "method": "Client::optOuts.updateSettings"
+ "method": "MessagingClient::$connections->restart"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.OptOuts.UpdateSettingsAsync"
+ "method": "TeamClient.Connections.RestartAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.opt_outs.update_settings"
+ "method": "MessagingClient.connections.restart"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/projects/{projectId}/health-policy",
- "operationId": "updateProjectHealthPolicySettings",
- "fingerprint": "7d963c433da85dccd79024877e040ebdfb7ccd3dbf37b7f289feea73fc5e55f1",
+ "method": "POST",
+ "path": "/platform/connections/{connectionId}/start",
+ "operationId": "startPlatformConnection",
+ "fingerprint": "4833a08db7c342beff177d01f8a8539fa64fada462635f8b70f8d99830f66125",
"typescript": {
"status": "covered",
- "method": "Client.projects.updateHealthPolicy"
+ "method": "Client.connections.start"
},
"go": {
"status": "covered",
- "method": "TeamClient.Projects.UpdateHealthPolicy"
+ "method": "TeamClient.Connections.Start"
},
"python": {
"status": "covered",
- "method": "AsyncClient.projects.update_health_policy"
+ "method": "AsyncClient.connections.start"
},
"php": {
"status": "covered",
- "method": "Client::$projects->updateHealthPolicy"
+ "method": "Client::connections.start"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Projects.UpdateHealthPolicyAsync"
+ "method": "TeamClient.Connections.StartAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.projects.update_health_policy"
+ "method": "MessagingClient.connections.start"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/projects/{projectId}/insurance-evidence",
- "operationId": "updateInsuranceEvidenceSettings",
- "fingerprint": "54da97d18246ed0e4687b46514a8bcbde791a39afdddb5079c5a10624a40002a",
+ "method": "POST",
+ "path": "/platform/connections/{connectionId}/stop",
+ "operationId": "stopPlatformConnection",
+ "fingerprint": "8549fcd3ed78db3abe0726ce22088a64696450ef060d0645c9a66e630e662509",
"typescript": {
"status": "covered",
- "method": "Client.projects.updateInsuranceEvidence"
+ "method": "Client.connections.stop"
},
"go": {
"status": "covered",
- "method": "TeamClient.Projects.UpdateInsuranceEvidence"
+ "method": "TeamClient.Connections.Stop"
},
"python": {
"status": "covered",
- "method": "AsyncClient.projects.update_insurance_evidence"
+ "method": "AsyncClient.connections.stop"
},
"php": {
"status": "covered",
- "method": "Client::$projects->updateInsuranceEvidence"
+ "method": "Client::connections.stop"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Projects.UpdateInsuranceEvidenceAsync"
+ "method": "TeamClient.Connections.StopAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.projects.update_insurance_evidence"
+ "method": "MessagingClient.connections.stop"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/projects/{projectId}/safe-mode",
- "operationId": "updateProjectSafeModeCeiling",
- "fingerprint": "4f2b55cf1ecbe55564175c47742d16eee4db8d28ea2891c0fea4941b42d995f2",
+ "method": "POST",
+ "path": "/platform/connections/{connectionId}/tier-quotes",
+ "operationId": "quoteConnectionTierChange",
+ "fingerprint": "075303048b2367ec64b056bf1fb7c132d20f4cf955a20fa5954ca20aaf374c54",
"typescript": {
"status": "covered",
- "method": "Client.projects.updateSafeMode"
+ "method": "Client.connections.quoteTierChange"
},
"go": {
"status": "covered",
- "method": "TeamClient.Projects.UpdateSafeMode"
+ "method": "TeamClient.Connections.QuoteTierChange"
},
"python": {
"status": "covered",
- "method": "AsyncClient.projects.update_safe_mode"
+ "method": "AsyncClient.connections.quote_tier_change"
},
"php": {
"status": "covered",
- "method": "Client::$projects->updateSafeMode"
+ "method": "Client::connections.quoteTierChange"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Projects.UpdateSafeModeAsync"
+ "method": "TeamClient.Connections.QuoteTierChangeAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.projects.update_safe_mode"
+ "method": "TeamClient.connections.quote_tier_change"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/projects/{projectId}/warmup-plan",
- "operationId": "updateProjectWarmupPlanSettings",
- "fingerprint": "c7939dd80b04968374dcd5ce555c83fa239a05abdab6a07cc74e9d4229e7a730",
+ "method": "POST",
+ "path": "/platform/connections/{connectionId}/upload-appstate-keys",
+ "operationId": "connectionUploadAppStateKeys",
+ "fingerprint": "e93a3c6cf1016da86c6d9c25c961043c313a9b44b21e121e8a62e576ffebb2a0",
"typescript": {
- "status": "covered",
- "method": "Client.projects.updateWarmupPlan"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
},
"go": {
- "status": "covered",
- "method": "TeamClient.Projects.UpdateWarmupPlan"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.projects.update_warmup_plan"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
},
"php": {
- "status": "covered",
- "method": "Client::$projects->updateWarmupPlan"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.Projects.UpdateWarmupPlanAsync"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.projects.update_warmup_plan"
+ "status": "excluded",
+ "reason": "Encrypted connection handoff remains outside the public SDK until its dedicated security and atomicity contract is complete.",
+ "milestone": "security-design"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/quicklink",
- "operationId": "updateQuickLinkSettings",
- "fingerprint": "1bec331053f7f052592b2454001a853e4cc6a7bacf2dd555e96438b21a3c292d",
+ "method": "POST",
+ "path": "/platform/connections/delete",
+ "operationId": "deleteConnections",
+ "fingerprint": "3f64e264ed6ab7f935c63521e49e160af679c7164f582b4f0ad380f10ad9efd1",
"typescript": {
"status": "covered",
- "method": "Client.quickLinkSettings.update"
+ "method": "Client.connections.deleteMany"
},
"go": {
"status": "covered",
- "method": "TeamClient.QuickLinkSettings.Update"
+ "method": "TeamClient.Connections.DeleteMany"
},
"python": {
"status": "covered",
- "method": "AsyncClient.quick_link_settings.update"
+ "method": "AsyncClient.connections.delete_many"
},
"php": {
"status": "covered",
- "method": "Client::quickLinkSettings.update"
+ "method": "Client::connections.deleteMany"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.QuickLinkSettings.UpdateAsync"
+ "method": "TeamClient.Connections.DeleteManyAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.quick_link_settings.update"
+ "method": "TeamClient.connections.delete_many"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/session-configuration",
- "operationId": "updateSessionConfigurationDefaults",
- "fingerprint": "5fccc358b52bd07b6068ff37e6c13cb480ad3e1868ba2c9c7c243f1011e34428",
+ "method": "POST",
+ "path": "/platform/connections/stop",
+ "operationId": "stopConnections",
+ "fingerprint": "f4a44f4bb03df57345958b7a4dd70d4e4735ba5296ee46831a3c0f371a23a5eb",
"typescript": {
"status": "covered",
- "method": "Client.sessionConfiguration.update"
+ "method": "Client.connections.stopMany"
},
"go": {
"status": "covered",
- "method": "TeamClient.SessionConfiguration.Update"
+ "method": "TeamClient.Connections.StopMany"
},
"python": {
"status": "covered",
- "method": "AsyncClient.session_configuration.update"
+ "method": "AsyncClient.connections.stop_many"
},
"php": {
"status": "covered",
- "method": "Client::sessionConfiguration.update"
+ "method": "Client::connections.stopMany"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Configuration.UpdateAsync"
+ "method": "TeamClient.Connections.StopManyAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.session_configuration.update"
- }
- },
- {
- "family": "platform",
- "method": "PUT",
- "path": "/platform/sessions/{session}/call-settings",
- "operationId": "updateCallSettings",
- "fingerprint": "9a898230fc536ee4f428d6046fc4ad3b845ffdc0da8d0ddfe3a4817e6760798e",
- "typescript": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (acceptTerms, termsLocale) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "go": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (acceptTerms, termsLocale) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "python": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (acceptTerms, termsLocale) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "php": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (acceptTerms, termsLocale) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "dotnet": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (acceptTerms, termsLocale) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "rust": {
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (acceptTerms, termsLocale) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "method": "TeamClient.connections.stop_many"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/sessions/{session}/client-rules",
- "operationId": "setClientRules",
- "fingerprint": "7249934cbfe762c67421ab330abc8aacfc1b8d78b05e187e004366c8a5803894",
+ "method": "POST",
+ "path": "/platform/customers",
+ "operationId": "createCustomer",
+ "fingerprint": "56dd6cf08e209da609fc78650a32abb261d4a6ea6c86c84d1883b441f68024d8",
"typescript": {
"status": "covered",
- "method": "MessagingClient.clientTokens.updateRules"
+ "method": "Client.customers.create"
},
"go": {
"status": "covered",
- "method": "MessagingClient.ClientTokens.UpdateRules"
+ "method": "TeamClient.Customers.Create"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.client_tokens.update_rules"
+ "method": "AsyncClient.customers.create"
},
"php": {
"status": "covered",
- "method": "MessagingClient::$clientTokens->updateRules"
+ "method": "Client::customers.create"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.ClientTokens.UpdateRulesAsync"
+ "method": "TeamClient.Customers.CreateAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.client_tokens.update_rules"
+ "method": "TeamClient.customers.create"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/sessions/{sessionId}",
- "operationId": "updateSession",
- "fingerprint": "d11d6cb84d056edc59f69256cc40c0030f38d641b16f799c04a1c9bdda7788c3",
+ "method": "POST",
+ "path": "/platform/customers/{customerId}/archive",
+ "operationId": "archiveCustomer",
+ "fingerprint": "13ce7838955c2d97174bc4b1309f3d62da03f3005f0e2a056db4003f6a10df42",
"typescript": {
"status": "covered",
- "method": "Client.sessions.update",
- "untypedResponseFields": ["inspector"]
+ "method": "Client.customers.archive"
},
"go": {
"status": "covered",
- "method": "TeamClient.Sessions.Update",
- "untypedResponseFields": ["inspector"]
+ "method": "TeamClient.Customers.Archive"
},
"python": {
"status": "covered",
- "method": "AsyncClient.sessions.update",
- "untypedResponseFields": ["inspector"]
+ "method": "AsyncClient.customers.archive"
},
"php": {
"status": "covered",
- "method": "Client::sessions.update",
- "untypedResponseFields": ["inspector"]
+ "method": "Client::customers.archive"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Sessions.UpdateAsync",
- "untypedResponseFields": ["inspector"]
+ "method": "TeamClient.Customers.ArchiveAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.sessions.update",
- "untypedResponseFields": ["inspector"]
+ "method": "TeamClient.customers.archive"
}
},
{
"family": "platform",
- "method": "PUT",
- "path": "/platform/sessions/{sessionId}/safe-mode",
- "operationId": "updateNumberSafeMode",
- "fingerprint": "7c6279c84979c1f7b5a0cd995c0b65c9b482af3190893294a3d586d48d5bdeeb",
+ "method": "POST",
+ "path": "/platform/customers/{customerId}/connections/{connectionId}/transfer",
+ "operationId": "transferCustomerConnection",
+ "fingerprint": "5180a688c873cebf592cb147bd61ad8b149351fab9f946d22aa384faae3b1dab",
"typescript": {
"status": "covered",
- "method": "Client.sessions.updateSafeMode"
+ "method": "Client.customers.transferConnection"
},
"go": {
"status": "covered",
- "method": "TeamClient.Sessions.UpdateSafeMode"
+ "method": "TeamClient.Customers.TransferConnection"
},
"python": {
"status": "covered",
- "method": "AsyncClient.sessions.update_safe_mode"
+ "method": "AsyncClient.customers.transfer_number"
},
"php": {
"status": "covered",
- "method": "Client::$sessions->updateSafeMode"
+ "method": "Client::customers.transferConnection"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Sessions.UpdateSafeModeAsync"
+ "method": "TeamClient.Customers.TransferConnectionAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.sessions.update_safe_mode"
+ "method": "TeamClient.customers.transfer_number"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/analytics",
- "operationId": "getWhatsAppAnalytics",
- "fingerprint": "7a154f991e4dc5f7d8137981a662b185b518473bb338000487965ee12c7ccb77",
+ "method": "POST",
+ "path": "/platform/customers/{customerId}/pairing-links",
+ "operationId": "createCustomerPairingLink",
+ "fingerprint": "2aa51255e929fe2130360e8cf70d1aa5d506beae30da1347b1294e774901a134",
"typescript": {
"status": "covered",
- "method": "Client.analytics.get"
+ "method": "Client.customers.createPairingLink"
},
- "sourceContractSha256": "bee9be6cc08d2ec78f5eb5e05135bea3751f93af917b8dd6983b26029feac485",
- "sourceCommit": "f180dc1ee2bd45dbecf01702f73bdd75c664634b",
- "sdkContractSha256": "bee9be6cc08d2ec78f5eb5e05135bea3751f93af917b8dd6983b26029feac485",
"go": {
"status": "covered",
- "method": "TeamClient.Analytics.Get"
+ "method": "TeamClient.Customers.CreatePairingLink"
},
"python": {
"status": "covered",
- "method": "AsyncClient.analytics.get"
+ "method": "AsyncClient.customers.create_pairing_link"
},
"php": {
"status": "covered",
- "method": "Client::analytics.get"
+ "method": "Client::customers.createPairingLink"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Analytics.GetAsync"
+ "method": "TeamClient.Customers.CreatePairingLinkAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.analytics.get"
+ "method": "TeamClient.customers.create_pairing_link"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/projects/{projectId}/analytics",
- "operationId": "getProjectWhatsAppAnalytics",
- "fingerprint": "22f452b4e0fb04cfb629cc0a8c56533bdd855d332b586f9314ea139adca19b7d",
+ "method": "POST",
+ "path": "/platform/customers/{customerId}/restore",
+ "operationId": "restoreCustomer",
+ "fingerprint": "d41b7d7f84da27f0e51f7c5ac8d8025cb04633edfe69592ed862b42d949c94ed",
"typescript": {
"status": "covered",
- "method": "Client.analytics.get"
+ "method": "Client.customers.restore"
},
- "sourceContractSha256": "bee9be6cc08d2ec78f5eb5e05135bea3751f93af917b8dd6983b26029feac485",
- "sourceCommit": "f180dc1ee2bd45dbecf01702f73bdd75c664634b",
- "sdkContractSha256": "bee9be6cc08d2ec78f5eb5e05135bea3751f93af917b8dd6983b26029feac485",
"go": {
"status": "covered",
- "method": "ProjectClient.Analytics.Get"
+ "method": "TeamClient.Customers.Restore"
},
"python": {
"status": "covered",
- "method": "AsyncProjectClient.analytics.get"
+ "method": "AsyncClient.customers.restore"
},
"php": {
"status": "covered",
- "method": "ProjectClient::analytics.get"
+ "method": "Client::customers.restore"
},
"dotnet": {
"status": "covered",
- "method": "ProjectClient.Analytics.GetAsync"
+ "method": "TeamClient.Customers.RestoreAsync"
},
"rust": {
"status": "covered",
- "method": "ProjectClient.analytics.get"
+ "method": "TeamClient.customers.restore"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/analytics/metrics",
- "operationId": "exportWhatsAppAnalyticsMetrics",
+ "method": "POST",
+ "path": "/platform/events/{eventId}/replays",
+ "operationId": "replayTeamEvent",
+ "fingerprint": "5bbc8270c7615f6ea6184b0cd0bd9276aa9d9c600c044b6cc4c52aa7a53b8684",
"typescript": {
"status": "covered",
- "method": "Client.analytics.metrics"
+ "method": "Client.events.replay"
},
- "fingerprint": "8cf4d32e988653ff5d90cc1984612f9e7c1159191b4ec0ec12a900bdb61ea27f",
- "sourceContractSha256": "bee9be6cc08d2ec78f5eb5e05135bea3751f93af917b8dd6983b26029feac485",
- "sdkContractSha256": "bee9be6cc08d2ec78f5eb5e05135bea3751f93af917b8dd6983b26029feac485",
- "sourceCommit": "f180dc1ee2bd45dbecf01702f73bdd75c664634b",
"go": {
"status": "covered",
- "method": "TeamClient.Analytics.Metrics"
+ "method": "TeamClient.Events.Replay"
},
"python": {
"status": "covered",
- "method": "AsyncClient.analytics.metrics"
+ "method": "AsyncClient.events.replay"
},
"php": {
"status": "covered",
- "method": "Client::analytics.metrics"
+ "method": "Client::events.replay"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Analytics.MetricsAsync"
+ "method": "TeamClient.Events.ReplayAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.analytics.metrics"
+ "method": "TeamClient.events.replay"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/projects/{projectId}/analytics/metrics",
- "operationId": "exportProjectWhatsAppAnalyticsMetrics",
+ "method": "POST",
+ "path": "/platform/feature-terms/{key}/accept",
+ "operationId": "acceptFeatureTerms",
+ "fingerprint": "ca2c0a8a7ec410b6c50a3296729cfa7bb62667f1b482e2bde1e30adafba71c42",
"typescript": {
- "status": "covered",
- "method": "Client.analytics.metrics"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
- "fingerprint": "6c1e33424f165788d8e34859e0ff539f92ca9dafef22aa679d8f7da99b290835",
- "sourceContractSha256": "bee9be6cc08d2ec78f5eb5e05135bea3751f93af917b8dd6983b26029feac485",
- "sdkContractSha256": "bee9be6cc08d2ec78f5eb5e05135bea3751f93af917b8dd6983b26029feac485",
- "sourceCommit": "f180dc1ee2bd45dbecf01702f73bdd75c664634b",
"go": {
- "status": "covered",
- "method": "ProjectClient.Analytics.Metrics"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "covered",
- "method": "AsyncProjectClient.analytics.metrics"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "covered",
- "method": "ProjectClient::analytics.metrics"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "covered",
- "method": "ProjectClient.Analytics.MetricsAsync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "covered",
- "method": "ProjectClient.analytics.metrics"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/console/insights/vitals",
- "operationId": "getConsoleErrorVitals",
- "fingerprint": "46d3924eb00a9fa4af60474852ff6770bad72ad8c6b8863f6ae6182a5bd1df84",
- "typescript": {
- "status": "excluded",
- "reason": "Dashboard-only operational error vitals require a live Console identity; server API keys do not grant this authority."
- },
- "go": {
- "status": "excluded",
- "reason": "Dashboard-only operational error vitals require a live Console identity; server API keys do not grant this authority."
- },
- "python": {
- "status": "excluded",
- "reason": "Dashboard-only operational error vitals require a live Console identity; server API keys do not grant this authority.",
- "milestone": "excluded-contract"
- },
- "php": {
- "status": "excluded",
- "reason": "Dashboard-only operational error vitals require a live Console identity; server API keys do not grant this authority.",
- "milestone": "excluded-contract"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Dashboard-only operational error vitals require a live Console identity; server API keys do not grant this authority."
- },
- "rust": {
- "status": "excluded",
- "reason": "Dashboard-only operational error vitals require a live Console identity; server API keys do not grant this authority.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/{session}/calls",
- "operationId": "listSessionCalls",
- "fingerprint": "d1b8f744f74e3a826fd25ac4e5c417f8373429b7397620a4fed5e27f4c673df1",
+ "method": "POST",
+ "path": "/platform/feature-terms/{key}/withdraw",
+ "operationId": "withdrawFeatureTerms",
+ "fingerprint": "630d38b62ee6d5ded2c02f052a56941b6c677a8813279337020098cc398a577c",
"typescript": {
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
@@ -18414,2672 +19311,1642 @@
}
},
{
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/{session}/catalogs",
- "operationId": "listCloudCatalogs",
- "fingerprint": "e49ea5a6ad6faa8e0d37d17bc95b9e277db950f5bfa06da605689ab49dd78e25",
+ "family": "platform",
+ "method": "POST",
+ "path": "/platform/flow-encryption-keys/rotate",
+ "operationId": "rotateFlowEncryptionKey",
+ "fingerprint": "7beae9ca1a212c871939e349d1820e22e94d363dc4d345f18f105814021ca265",
"typescript": {
"status": "covered",
- "method": "MessagingClient.catalogs.list"
+ "method": "Client.project(projectId).flows.rotateEncryptionKey"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Catalogs.List"
+ "method": "ProjectClient.Flows.RotateEncryptionKey"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.catalogs.list"
+ "method": "AsyncProjectClient.flows.rotate_encryption_key"
},
"php": {
"status": "covered",
- "method": "MessagingClient.catalogs.list"
+ "method": "ProjectClient::flows.rotateEncryptionKey"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Catalogs.ListAsync"
+ "method": "ProjectClient.Flows.RotateEncryptionKeyAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.catalogs.list"
+ "method": "ProjectClient.flows.rotate_encryption_key"
}
},
{
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/{session}/catalogs/{catalogId}",
- "operationId": "getCloudCatalog",
- "fingerprint": "b490146371af770e310ae4def325d300124ada2783e2597d4752e321fa1ccd9f",
+ "family": "platform",
+ "method": "POST",
+ "path": "/platform/flows",
+ "operationId": "createFlow",
+ "fingerprint": "8ecc908e5cec9106ead7b0945cb22c2ee841fb4c1bf6d45c15cf47af366b5be5",
"typescript": {
"status": "covered",
- "method": "MessagingClient.catalogs.retrieve"
+ "method": "Client.project(projectId).flows.create"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Catalogs.Retrieve"
+ "method": "ProjectClient.Flows.Create"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.catalogs.retrieve"
+ "method": "AsyncProjectClient.flows.create"
},
"php": {
"status": "covered",
- "method": "MessagingClient.catalogs.retrieve"
+ "method": "ProjectClient::flows.create"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Catalogs.RetrieveAsync"
+ "method": "ProjectClient.Flows.CreateAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.catalogs.retrieve"
+ "method": "ProjectClient.flows.create"
}
},
{
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/{session}/catalogs/{catalogId}/products",
- "operationId": "listCloudCatalogProducts",
- "fingerprint": "874d31fed468f64fa95275caf1ca10d2fabc1b8f4db476e14c5fa9f9b00bf683",
+ "family": "platform",
+ "method": "POST",
+ "path": "/platform/flows/{flowId}/deprecate",
+ "operationId": "deprecateFlow",
+ "fingerprint": "66f97fda1f29655f4d269d153bf680c0c4c1fbce8a30b7b93aa14c241f50f516",
"typescript": {
"status": "covered",
- "method": "MessagingClient.catalogs.listProducts"
+ "method": "Client.project(projectId).flows.deprecate"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Catalogs.ListProducts"
+ "method": "ProjectClient.Flows.Deprecate"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.catalogs.list_products"
+ "method": "AsyncProjectClient.flows.deprecate"
},
"php": {
"status": "covered",
- "method": "MessagingClient.catalogs.listProducts"
+ "method": "ProjectClient::flows.deprecate"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Catalogs.ListProductsAsync"
+ "method": "ProjectClient.Flows.DeprecateAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.catalogs.list_products"
+ "method": "ProjectClient.flows.deprecate"
}
},
{
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/{session}/groups/{id}/capabilities",
- "operationId": "getGroupCapabilities",
- "fingerprint": "1d3f982c409d886013ba5f902f2db562739d43eb20541ed0c7b2e67ff707698d",
+ "family": "platform",
+ "method": "POST",
+ "path": "/platform/flows/{flowId}/discard",
+ "operationId": "discardFlow",
+ "fingerprint": "505e083b27de755c16851f27d3995b1c219131d1ae594854870569cb4eb315ee",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.project(projectId).flows.discard"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Flows.Discard"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncProjectClient.flows.discard"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient::flows.discard"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Flows.DiscardAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.flows.discard"
}
},
{
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/{session}/marketing-messages/status",
- "operationId": "getMarketingMessagesStatus",
- "fingerprint": "33934556305f730014ea30e0a83d167db91ee54f244d641de43bd1d98c73a75f",
+ "family": "platform",
+ "method": "POST",
+ "path": "/platform/flows/{flowId}/publish",
+ "operationId": "publishFlow",
+ "fingerprint": "1c3fe22cbe330b1837de009fcaba1f225456827f16d23c14865fa2fcf76f56a0",
"typescript": {
"status": "covered",
- "method": "MessagingClient.cloudMarketing.getStatus"
+ "method": "Client.project(projectId).flows.publish"
},
"go": {
"status": "covered",
- "method": "MessagingClient.CloudMarketing.GetStatus"
+ "method": "ProjectClient.Flows.Publish"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.cloud_marketing.get_status"
+ "method": "AsyncProjectClient.flows.publish"
},
"php": {
"status": "covered",
- "method": "MessagingClient.cloudMarketing.getStatus"
+ "method": "ProjectClient::flows.publish"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.CloudGraph.GetMarketingMessagesStatusAsync"
+ "method": "ProjectClient.Flows.PublishAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.cloud_marketing.get_status"
+ "method": "ProjectClient.flows.publish"
}
},
{
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/{session}/passkey/challenge/{ticketId}",
- "operationId": "getPasskeyChallenge",
- "fingerprint": "c20ba549685c485c6c688daf42ddfbc6439bb5b714fe42dd098341489b37cfb9",
+ "family": "platform",
+ "method": "POST",
+ "path": "/platform/flows/{flowId}/sync",
+ "operationId": "syncFlow",
+ "fingerprint": "59701a8eac37aefe8b9ec21beb9d8c1ec48a7773fa091c8e8ce3fcce3f71e8a0",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.project(projectId).flows.sync"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Flows.Sync"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncProjectClient.flows.sync"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient::flows.sync"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Flows.SyncAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.flows.sync"
}
},
{
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/{session}/passkey/confirmation",
- "operationId": "getPasskeyConfirmation",
- "fingerprint": "494e96ed688ad87a29670513ecffea9582b92c34a30ac56bb8544ecee731d604",
+ "family": "platform",
+ "method": "POST",
+ "path": "/platform/flows/{flowId}/upload",
+ "operationId": "uploadFlow",
+ "fingerprint": "fc7081d849eeb07993a6019a895de559b74b27118647db37a8e6e09a38ca4f87",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.project(projectId).flows.upload"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Flows.Upload"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncProjectClient.flows.upload"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient::flows.upload"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Flows.UploadAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.flows.upload"
}
},
{
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/{session}/phone",
- "operationId": "getTestingPhone",
- "fingerprint": "3857280d47e6fdfea20616d423160d1eacf357b37609cc71b1d408ebb25e80fe",
- "typescript": {
- "status": "covered",
- "method": "MessagingClient.testing.getPhone"
- },
+ "family": "platform",
+ "method": "POST",
+ "path": "/platform/functions",
+ "operationId": "createFunction",
+ "fingerprint": "8208a572af52e4e614bae919d34f22dba70ab2fd9f2516d8832e97ecda09e90d",
+ "typescript": {
+ "status": "covered",
+ "method": "Client.project(projectId).functions.create"
+ },
"go": {
"status": "covered",
- "method": "MessagingClient.Testing.GetPhone"
+ "method": "ProjectClient.Functions.Create"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.testing.get_phone"
+ "method": "AsyncProjectClient.functions.create"
},
"php": {
"status": "covered",
- "method": "MessagingClient::testing.getPhone"
+ "method": "ProjectClient::functions.create"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Testing.GetPhoneAsync"
+ "method": "ProjectClient.Functions.CreateAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.testing.get_phone"
+ "method": "ProjectClient.functions.create"
}
},
{
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/{session}/stickers",
- "operationId": "listStoredStickers",
- "fingerprint": "108af2bda38b475585408ce87e1adf66b2c11d19b12e9870e2957bf95615bcfd",
+ "family": "platform",
+ "method": "POST",
+ "path": "/platform/functions/{functionId}/deployments",
+ "operationId": "createFunctionDeployment",
+ "fingerprint": "bb089e1d298059801ec5de981ab01740e3fb1419ab92920c72ca19784fa674eb",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.project(projectId).functions.deployments.create"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Functions.Deployments.Create"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncProjectClient.functions.deployments.create"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient::functions.deployments.create"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Functions.Deployments.CreateAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.functions.deployments.create"
}
},
{
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/projects/{projectSlug}/campaign-reply-flows/{id}",
- "operationId": "getCampaignReplyFlow",
- "fingerprint": "0f77e299902f1078ed0ed33bd3d8980d33d36fd2d45f1c93c90a3beb115f2d04",
+ "family": "platform",
+ "method": "POST",
+ "path": "/platform/functions/{functionId}/invocations",
+ "operationId": "createFunctionInvocation",
+ "fingerprint": "357fea45933e3d38f8f4e984e99b09b84f83954844fec71d9b21025c413f2425",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.project(projectId).functions.invocations.create"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Functions.Invocations.Create"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncProjectClient.functions.invocations.create"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient::functions.invocations.create"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Functions.Invocations.CreateAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.functions.invocations.create"
}
},
{
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/projects/{projectSlug}/campaigns/{id}/links",
- "operationId": "getProjectCampaignLinks",
- "fingerprint": "1e3ee56de32d8a1a89e751078ebf7d0ea00e04a3171b918c49684af164a3d0f5",
+ "family": "platform",
+ "method": "POST",
+ "path": "/platform/functions/{functionId}/secrets",
+ "operationId": "createFunctionSecret",
+ "fingerprint": "446eb6af30700b46c27358ad721256030f08824e38c1034de9520d8cd713fe96",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.project(projectId).functions.secrets.create"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Functions.Secrets.Create"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncProjectClient.functions.secrets.create"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient::functions.secrets.create"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Functions.Secrets.CreateAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.functions.secrets.create"
}
},
{
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/projects/{projectSlug}/campaigns/{id}/recipients/export",
- "operationId": "exportProjectCampaignRecipients",
- "fingerprint": "0952891d10493e0684a4f0f9a0f280db987c4f8aa8437d94d2c86f5e160dc1bf",
+ "family": "platform",
+ "method": "POST",
+ "path": "/platform/incidents/{incidentId}/acknowledge",
+ "operationId": "acknowledgeSecurityIncident",
+ "fingerprint": "15fbf19bde762dde938e6fc30220ae4815ef21180579ae645151ec8c424fa468",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.securityIncidents.acknowledge"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.SecurityIncidents.Acknowledge"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.security_incidents.acknowledge"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::securityIncidents.acknowledge"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.SecurityIncidents.AcknowledgeAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.security_incidents.acknowledge"
}
},
{
- "family": "messaging",
- "method": "GET",
- "path": "/messaging/test-events/fixtures",
- "operationId": "listTestEventFixtures",
- "fingerprint": "04fbd25cb26404b99eeee32dc3861e9fd89daff9cd273fa859787e7fe9cf13c1",
+ "family": "platform",
+ "method": "POST",
+ "path": "/platform/media/uploads",
+ "operationId": "createMediaUploadUrl",
+ "fingerprint": "df9a99427c2f268c4ce78e0295f5d3c9a477ceb238996665ba25210bd0700bc2",
"typescript": {
"status": "covered",
- "method": "MessagingClient.testing.listEventFixtures"
+ "method": "Client.media.createUpload"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Testing.ListEventFixtures"
+ "method": "TeamClient.Media.CreateUpload"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.testing.list_event_fixtures"
+ "method": "AsyncClient.media.create_upload"
},
"php": {
"status": "covered",
- "method": "MessagingClient::testing.listEventFixtures"
+ "method": "Client::media.createUpload"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Testing.ListEventFixturesAsync"
+ "method": "TeamClient.Media.CreateUploadAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.testing.list_event_fixtures"
+ "method": "TeamClient.media.create_upload"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/{session}/catalogs/{catalogId}/sync",
- "operationId": "syncCloudCatalog",
- "fingerprint": "bf89bf9bcfe6ed77749ba893b317a5bdd14829cc50b93ec1b42a589456149027",
+ "path": "/platform/operations/{operationId}/cancel",
+ "operationId": "cancelPlatformOperation",
+ "fingerprint": "0a39ba6ac5d6a2299dcfa61df73a98caab0df01abd2026a99ae4f9fcef03975b",
"typescript": {
"status": "covered",
- "method": "MessagingClient.catalogs.sync"
+ "method": "Client.operations.cancel"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Catalogs.Sync"
+ "method": "TeamClient.Operations.Cancel"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.catalogs.sync"
+ "method": "AsyncClient.operations.cancel"
},
"php": {
"status": "covered",
- "method": "MessagingClient.catalogs.sync"
+ "method": "Client::operations.cancel"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Catalogs.SyncAsync"
+ "method": "TeamClient.Operations.CancelAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.catalogs.sync"
+ "method": "TeamClient.operations.cancel"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/{session}/history/chunks/retry",
- "operationId": "retryHistoryChunk",
- "fingerprint": "5cffce5d1ad35b89e94eacceccbd4d674de75c972a1c8245da24a91fc816ea4d",
+ "path": "/platform/optouts",
+ "operationId": "createOptOut",
+ "fingerprint": "1f34c7db4335800796426db26e6cc54a99ebb3bd3fbe0c6b90f2ecbc2eb27be5",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.optOuts.create"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.OptOuts.Create"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.opt_outs.create"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::optOuts.create"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.OptOuts.CreateAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.opt_outs.create"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/{session}/history/media/delete",
- "operationId": "deleteHistoryMedia",
- "fingerprint": "26db9e57dec5332ac47ee0bb2319cbd65bc0b108e148ed1a9fdcc21e1d88b714",
+ "path": "/platform/optouts/batch",
+ "operationId": "createOptOuts",
+ "fingerprint": "ae3384a887dd31a5437a5208dc908126698a9b7dc4c0c690db7e65e7d3c51123",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.optOuts.createBatch"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.OptOuts.CreateBatch"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.opt_outs.create_batch"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::optOuts.createBatch"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.OptOuts.CreateBatchAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.opt_outs.create_batch"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/{session}/media/upload-grants",
- "operationId": "createMediaUploadGrant",
- "fingerprint": "0785d80eed92b6c098cf2c43c67ff11a51f40cda12ff8bf34833fc8d37672e11",
+ "path": "/platform/projects",
+ "operationId": "createProject",
+ "fingerprint": "e071637fd953c0a4845bd8844f59d19084594d402ab1a3dd10fb39bca592ba12",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.projects.create"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Projects.Create"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.projects.create"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::projects.create"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Projects.CreateAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.projects.create"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/{session}/media/uploads",
- "operationId": "uploadEncryptedMedia",
- "fingerprint": "0101cead982b108a204bb7db71ccb88a05ec013fc1adda2eea9213b8a8c7715c",
+ "path": "/platform/projects/{projectId}/customers/enable",
+ "operationId": "enableCustomers",
+ "fingerprint": "bda36cc5cf13e88b0ee4a737854f14c52541ed274040257c4c013dc4d7f67752",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.customers.enable"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Customers.Enable"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.customers.enable"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::customers.enable"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Customers.EnableAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.customers.enable"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/{session}/passkey/assertion",
- "operationId": "submitPasskeyAssertion",
- "fingerprint": "d7ab93b5e2d1eb248934ee88e81ca9fee45f036e7a3fd8edfc7f46aeca8b4204",
+ "path": "/platform/projects/{projectId}/events/{eventId}/replays",
+ "operationId": "replayProjectEvent",
+ "fingerprint": "fd8738d01fe9336178cd84470ec72261bdc078a5a5a4f5c1a1be4da8abace2ff",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.project(projectId).events.replay"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Events.Replay"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncProjectClient.events.replay"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::events.replay"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Events.ReplayAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.events.replay"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/{session}/passkey/challenge",
- "operationId": "issuePasskeyChallenge",
- "fingerprint": "7a88edb0330666c1b1672fec9bedeba2be3a4bb0cd308b99458ca238a70267d4",
+ "path": "/platform/projects/{projectId}/events/stream/{streamId}/ack",
+ "operationId": "acknowledgeProjectEventStream",
+ "fingerprint": "573da359df2789e69b074524e85e166fb9741d457870dbfaf0b0dcd98ddb81b7",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.events.acknowledgeStream"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Events.AcknowledgeStream"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncProjectClient.events.acknowledge_stream"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::events.acknowledgeStream"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Events.AcknowledgeStreamAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.events.acknowledge_stream"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/{session}/passkey/confirmation",
- "operationId": "confirmPasskey",
- "fingerprint": "934df244c32b3fc17cc16a5c6387d12d3992a9baee9ef89ff2c29c1bff901dc2",
+ "path": "/platform/projects/{projectId}/operations/{operationId}/cancel",
+ "operationId": "cancelProjectOperation",
+ "fingerprint": "898c474789d554194d3b8eaba528b020ff2ac2d4153e6e8551b5daa09d173c20",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.project(projectId).operations.cancel"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Operations.Cancel"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncProjectClient.operations.cancel"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::operations.cancel"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Operations.CancelAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.operations.cancel"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/{session}/phone/devices/{deviceId}/unlink",
- "operationId": "unlinkTestingPhoneDevice",
- "fingerprint": "c02e328d3ae2555873d9abcc37f40a25a95d4ed7d004a8d3bb147dd81fd9d628",
+ "path": "/platform/projects/{projectId}/production-enrollments/{operationId}/approve",
+ "operationId": "approveProductionEnrollment",
+ "fingerprint": "6737fb824d1dd4304872ebfb8a2f228b3ed3263705ae7ba00d84e80e0cddcdc1",
"typescript": {
"status": "covered",
- "method": "MessagingClient.testing.unlinkPhoneDevice"
+ "method": "Client.projects.approveProductionEnrollment"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Testing.UnlinkPhoneDevice"
+ "method": "TeamClient.Projects.ApproveProductionEnrollment"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.testing.unlink_phone_device"
+ "method": "AsyncClient.projects.approve_production_enrollment"
},
"php": {
"status": "covered",
- "method": "MessagingClient::testing.unlinkPhoneDevice"
+ "method": "Client::projects.approveProductionEnrollment"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Testing.UnlinkPhoneDeviceAsync"
+ "method": "TeamClient.Projects.ApproveProductionEnrollmentAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.testing.unlink_phone_device"
+ "method": "TeamClient.projects.approve_production_enrollment"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/{session}/phone/messages",
- "operationId": "sendTestingPhoneMessage",
- "fingerprint": "28d48aa209a0fb6dd2779d1103d2a0ca98f0f3407f3c1c806890076b0cf6e5d9",
+ "path": "/platform/projects/{projectId}/production-enrollments/{operationId}/cancel",
+ "operationId": "cancelProductionEnrollment",
+ "fingerprint": "da8d97ebdf0d6cd2ce5c5470d0543b767a098ad1095ff1a82e9174fe2f92d0d4",
"typescript": {
"status": "covered",
- "method": "MessagingClient.testing.sendPhoneMessage"
+ "method": "Client.projects.cancelProductionEnrollment"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Testing.SendPhoneMessage"
+ "method": "TeamClient.Projects.CancelProductionEnrollment"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.testing.send_phone_message"
+ "method": "AsyncClient.projects.cancel_production_enrollment"
},
"php": {
"status": "covered",
- "method": "MessagingClient::testing.sendPhoneMessage"
+ "method": "Client::projects.cancelProductionEnrollment"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Testing.SendPhoneMessageAsync"
+ "method": "TeamClient.Projects.CancelProductionEnrollmentAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.testing.send_phone_message"
+ "method": "TeamClient.projects.cancel_production_enrollment"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/{session}/stickers/recents/bootstrap",
- "operationId": "bootstrapRecentStickers",
- "fingerprint": "a93c16912b564139e93037d0cfd1ab8be2759488723c16c0957b82189faaea58",
+ "path": "/platform/projects/{projectId}/promote",
+ "operationId": "requestProductionEnrollment",
+ "fingerprint": "6d555dfb3f520aac956a170d3f89fa01d745c2a749ba50a381cebfe410b0c930",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.projects.requestProductionEnrollment"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- }
- },
- {
- "family": "messaging",
- "method": "POST",
- "path": "/messaging/{session}/stickers/recents/remove",
- "operationId": "removeRecentSticker",
- "fingerprint": "a10bdcc6b4f0fc4e763bf9fbd71e07b4f757d8361e1056e61d3fa552cae6d862",
- "typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- }
- },
- {
- "family": "messaging",
- "method": "POST",
- "path": "/messaging/{session}/stickers/reuploads",
- "operationId": "requestStickerReupload",
- "fingerprint": "7fa40defdbf92d2b5b5d0dc23c8ad8612ed5476d0a41bfbc243b29a78176c9a8",
- "typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- }
- },
- {
- "family": "messaging",
- "method": "POST",
- "path": "/messaging/{session}/test-events",
- "operationId": "triggerTestEvent",
- "fingerprint": "7bd451a4dad642aa1b260fbe735e0a31da10d88c9294f29983a6d13cff4cfe86",
- "typescript": {
"status": "covered",
- "method": "MessagingClient.testing.triggerEvent"
- },
- "go": {
- "status": "covered",
- "method": "MessagingClient.Testing.TriggerEvent"
+ "method": "TeamClient.Projects.RequestProductionEnrollment"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.testing.trigger_event"
+ "method": "AsyncClient.projects.request_production_enrollment"
},
"php": {
"status": "covered",
- "method": "MessagingClient::testing.triggerEvent"
+ "method": "Client::projects.requestProductionEnrollment"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Testing.TriggerEventAsync"
+ "method": "TeamClient.Projects.RequestProductionEnrollmentAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.testing.trigger_event"
- }
- },
- {
- "family": "messaging",
- "method": "POST",
- "path": "/messaging/customer-pairing/exchange",
- "operationId": "exchangeCustomerPairingLink",
- "fingerprint": "974162521796edc5083f0bd249d8f9cfd06dd05f3ab5baed14d2da20637d579c",
- "typescript": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
+ "method": "TeamClient.projects.request_production_enrollment"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/projects/{projectId}/test-history-fixtures",
- "operationId": "createTestingHistoryFixture",
- "fingerprint": "90836ddb657f5021281794ce5d3c24e6acc9a0a59fee2a23fb235fc418179abf",
+ "path": "/platform/projects/{projectId}/webhook-deliveries/{deliveryId}/retry",
+ "operationId": "retryProjectWebhookDelivery",
+ "fingerprint": "4d8551475d4cfe9361421b92e78afef220445544d18097593e8aac5c7ff6de7c",
"typescript": {
"status": "covered",
- "method": "MessagingClient.testing.createHistoryFixture"
+ "method": "Client.project(projectId).webhookDeliveries.retry"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Testing.CreateHistoryFixture"
+ "method": "ProjectClient.WebhookDeliveries.Retry"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.testing.create_history_fixture"
+ "method": "AsyncProjectClient.webhook_deliveries.retry"
},
"php": {
"status": "covered",
- "method": "MessagingClient::testing.createHistoryFixture"
+ "method": "Client::webhookDeliveries.retry"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Testing.CreateHistoryFixtureAsync"
+ "method": "ProjectClient.WebhookDeliveries.RetryAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.testing.create_history_fixture"
+ "method": "ProjectClient.webhook_deliveries.retry"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/campaign-reply-flows",
- "operationId": "createCampaignReplyFlow",
- "fingerprint": "346d65bb0b2ccf6be92d35fa803cfe9f98b424de5370691b77b1322db38ab880",
+ "path": "/platform/projects/{projectId}/webhooks",
+ "operationId": "createProjectWebhook",
+ "fingerprint": "2e730955e2a1a420c98bcc9fa9784523bb91fcc0dc930daa24e5b9b2fe1308a2",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.project(projectId).webhooks.create"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/campaigns/{id}/enrollments",
- "operationId": "enrollProjectCampaignContact",
- "fingerprint": "fb7c28f677fb3b36754a392999f7b9b319c5a19f1ff5d704799848e25e8edcad",
+ "path": "/platform/projects/{projectId}/webhooks/{webhookId}/secret-rotations",
+ "operationId": "rotateProjectWebhookSecret",
+ "fingerprint": "4b098a4721f407b09d7c942c14648846b9f1dff30ee6133d7b95c09dd5c63fbb",
"typescript": {
"status": "covered",
- "method": "MessagingClient.campaigns.enroll"
+ "method": "Client.project(projectId).webhooks.rotateSecret"
},
"go": {
"status": "covered",
- "method": "MessagingClient.Campaigns().Enroll"
+ "method": "ProjectClient.Webhooks.RotateSecret"
},
"python": {
"status": "covered",
- "method": "AsyncMessagingClient.campaigns.enroll"
+ "method": "AsyncProjectClient.webhooks.rotate_secret"
},
"php": {
"status": "covered",
- "method": "MessagingClient::campaigns.enroll"
+ "method": "Client::webhooks.rotateSecret"
},
"dotnet": {
"status": "covered",
- "method": "MessagingClient.Campaigns.EnrollAsync"
+ "method": "ProjectClient.Webhooks.RotateSecretAsync"
},
"rust": {
"status": "covered",
- "method": "MessagingClient.campaigns().enroll"
+ "method": "ProjectClient.webhooks.rotate_secret"
}
},
{
- "family": "messaging",
+ "family": "platform",
"method": "POST",
- "path": "/messaging/projects/{projectSlug}/campaigns/{id}/test-send",
- "operationId": "testSendCampaign",
- "fingerprint": "39abafde61592e4fec9abd7b62611da5728d5cd420df8ecad817f2a0c0d3f330",
+ "path": "/platform/projects/{projectId}/webhooks/{webhookId}/tests",
+ "operationId": "testProjectWebhook",
+ "fingerprint": "39e004913fa449ec6929dbf9a23da84d2ec1e1b03ca9d2476112fd4f60189714",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.project(projectId).webhooks.test"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- }
- },
- {
- "family": "messaging",
- "method": "POST",
- "path": "/passkey/verify",
- "operationId": "verifyExtensionPasskeyTicket",
- "fingerprint": "7599e0744a39e46bc7958eb7b910020c1fa70f9a61c4d86989353fbb10a01adf",
- "typescript": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "messaging",
- "method": "POST",
- "path": "/quicklink/{token}/passkey",
- "operationId": "submitQuickLinkPasskey",
- "fingerprint": "d59f704223168e1315f7563690b05f1c88338dcf43075723b4a1478c4d82f557",
- "typescript": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "messaging",
- "method": "POST",
- "path": "/quicklink/{token}/passkey/confirmation",
- "operationId": "confirmQuickLinkPasskey",
- "fingerprint": "95696ff9a6f73a050923e327d0c7025a9aedfea13801669a66f28373c1132afd",
- "typescript": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Credential-free public route used by hosted pairing pages, browser extensions or customer invitations, not by server SDK callers.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/official-groups/{group}/picture",
- "operationId": "setOfficialGroupPicture",
- "fingerprint": "647b05a4e8e69efba6785d4cd117360f91becdec6c2846e8078eada61e699f5f",
- "typescript": {
- "status": "covered",
- "method": "MessagingClient.officialGroups.setPicture"
- },
- "go": {
- "status": "covered",
- "method": "MessagingClient.OfficialGroups.SetPicture"
- },
- "python": {
- "status": "covered",
- "method": "AsyncMessagingClient.official_groups.set_picture"
- },
- "php": {
- "status": "covered",
- "method": "MessagingClient.officialGroups.setPicture"
- },
- "dotnet": {
"status": "covered",
- "method": "MessagingClient.OfficialGroups.SetPictureAsync"
- },
- "rust": {
- "status": "covered",
- "method": "MessagingClient.official_groups.set_picture"
- }
- },
- {
- "family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/phone/account-mode",
- "operationId": "setTestingAccountMode",
- "fingerprint": "6dc67b497a37770515d5fc747ab81fb1c6d63b46f071987274e556aa77937ef3",
- "typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- }
- },
- {
- "family": "messaging",
- "method": "PUT",
- "path": "/messaging/{session}/stickers/favorite",
- "operationId": "setStickerFavorite",
- "fingerprint": "134cc07717befe596924dc704ab427ebc8a917fd1e5af54f3e4fd7b544e85a6d",
- "typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- }
- },
- {
- "family": "messaging",
- "method": "PUT",
- "path": "/messaging/projects/{projectSlug}/campaigns/{id}/reply-flow",
- "operationId": "setCampaignReplyFlow",
- "fingerprint": "8bf79e77c26c524f020d433e222695c5247ee72a80e4af4bbb31e98212c97eb8",
- "typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- }
- },
- {
- "family": "platform",
- "method": "DELETE",
- "path": "/console/keys/{keyId}",
- "operationId": "deactivateApiKey",
- "fingerprint": "a877c66fc0828c659a860826c6e993bb955ec42ffbcf9b474032aed714aaad08",
- "typescript": {
- "status": "excluded",
- "reason": "Moved from DELETE /platform/keys/{keyId} to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Moved from DELETE /platform/keys/{keyId} to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Moved from DELETE /platform/keys/{keyId} to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Moved from DELETE /platform/keys/{keyId} to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Moved from DELETE /platform/keys/{keyId} to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Moved from DELETE /platform/keys/{keyId} to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "platform",
- "method": "DELETE",
- "path": "/console/projects/{projectId}/regional-data/access/{accessId}",
- "operationId": "revokeRegionalDataAccess",
- "fingerprint": "0d00bd6f062112ed258de365d0be1bb6689397c4f98a8029e2e78471a5e83f9c",
- "typescript": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/audience-profile-imports/{jobId}",
- "operationId": "cancelAudienceProfileImport",
- "fingerprint": "f7bb8a60d4caa59ac19f47ce496129c397fdee705d7c0e07cbfeaebfe4b0a3b7",
- "typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- }
- },
- {
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/audience-profiles/{phone}",
- "operationId": "deleteAudienceProfile",
- "fingerprint": "3baf1e380e2b9092315000a17daba39826cbf30514326a03b80c0f4332372855",
- "typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- }
- },
- {
- "family": "platform",
- "method": "DELETE",
- "path": "/platform/audience-segments/{segmentId}",
- "operationId": "deleteAudienceSegment",
- "fingerprint": "a02ed13e77da026ef0402df1ef32376297afc606a04baedca4744a756b805e25",
- "typescript": {
- "status": "covered",
- "method": "Client.audienceSegments.delete"
- },
- "go": {
- "status": "covered",
- "method": "TeamClient.AudienceSegments().Delete"
- },
- "python": {
- "status": "covered",
- "method": "AsyncClient.audience_segments.delete"
- },
- "php": {
- "status": "covered",
- "method": "Client::audienceSegments.delete"
- },
- "dotnet": {
- "status": "covered",
- "method": "TeamClient.AudienceSegments.DeleteAsync"
- },
- "rust": {
- "status": "covered",
- "method": "TeamClient.audience_segments().delete"
- }
- },
- {
- "family": "platform",
- "method": "GET",
- "path": "/api/account/feature-terms",
- "operationId": "accountListFeatureTerms",
- "fingerprint": "37181bfe58a5f996a2319310aedda6c649e7ab7e38e0289a4524aec294db699e",
- "typescript": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "platform",
- "method": "GET",
- "path": "/api/account/legal",
- "operationId": "getAccountLegalStatus",
- "fingerprint": "6e95bdacb3c7da99f0af483d5c5fda375fe769408f76507a2419fe3634d2bd08",
- "typescript": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "platform",
- "method": "GET",
- "path": "/console/keys",
- "operationId": "listApiKeys",
- "fingerprint": "94f9cc526993082d9cabf095f4780123f3a9f7b2e646be2dcfcdbbf536ccf325",
- "typescript": {
- "status": "excluded",
- "reason": "Moved from GET /platform/keys to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Moved from GET /platform/keys to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Moved from GET /platform/keys to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Moved from GET /platform/keys to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Moved from GET /platform/keys to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Moved from GET /platform/keys to a dashboard-identity Console route by polymorfa/polymorfa#887; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "platform",
- "method": "GET",
- "path": "/console/projects/{projectId}/numbers/{session}/catalogs",
- "operationId": "listConsoleCloudCatalogs",
- "fingerprint": "3c9aa9669b93690b8b4a5ce2e92f512db96c7ba16c730b35497f8897a14608ec",
- "typescript": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "platform",
- "method": "GET",
- "path": "/console/projects/{projectId}/numbers/{session}/catalogs/{catalogId}",
- "operationId": "getConsoleCloudCatalog",
- "fingerprint": "62800798db099e4da345706fdb1a7c866f33888f9dfec6bfcfd6db6e80eee47e",
- "typescript": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "platform",
- "method": "GET",
- "path": "/console/projects/{projectId}/numbers/{session}/catalogs/{catalogId}/products",
- "operationId": "listConsoleCloudCatalogProducts",
- "fingerprint": "f3f394abd0ee075507f9ca0c2aad925ba932fe9674a17a8f3b710949d7f22b8e",
- "typescript": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "platform",
- "method": "GET",
- "path": "/console/projects/{projectId}/regional-data/settings",
- "operationId": "getRegionalDataSettings",
- "fingerprint": "f1d16685d38a45c596c656c33106447b413fc7325dfa302757afcd0668fbdcae",
- "typescript": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "platform",
- "method": "GET",
- "path": "/platform/audience-profile-imports/{jobId}",
- "operationId": "getAudienceProfileImport",
- "fingerprint": "8855e87ca16906f5ec54d80164b86e4625fc322f3e4499fffd2a77d6247b2d22",
- "typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "method": "ProjectClient.Webhooks.Test"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncProjectClient.webhooks.test"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::webhooks.test"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Webhooks.TestAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.webhooks.test"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/audience-profiles",
- "operationId": "listAudienceProfiles",
- "fingerprint": "fb9d8ecc9bb9f7063ffca5c76a5494ac7f358ef9870389b97ceb07250bdb7257",
+ "method": "POST",
+ "path": "/platform/sip-trunks",
+ "operationId": "createSipTrunk",
+ "fingerprint": "10f164f3b97899f3addb4de5c1e1c2969a33d1f68bc620207f2cabf904dbb2da",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.sipTrunks.create"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.SIPTrunks.Create"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.sip_trunks.create"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::sipTrunks.create"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.SipTrunks.CreateAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.sip_trunks.create"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/audience-profiles/{phone}",
- "operationId": "getAudienceProfile",
- "fingerprint": "d5f962936dc574aecc2a7529238dc350c227228971f539e908efeee3ca418897",
+ "method": "POST",
+ "path": "/platform/sip-trunks/{trunkId}/credentials",
+ "operationId": "rotateSipTrunkCredentials",
+ "fingerprint": "4b85dd8896edca0f3f81ec7583a4fa9940217a87259f8043b74f40e4e201305e",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.sipTrunks.rotateCredentials"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.SIPTrunks.RotateCredentials"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.sip_trunks.rotate_credentials"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::sipTrunks.rotateCredentials"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.SipTrunks.RotateCredentialsAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.sip_trunks.rotate_credentials"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/audience-profiles/{phone}/consent",
- "operationId": "listAudienceProfileConsent",
- "fingerprint": "750098cc130885bc9b4fa6cc68d9d47eb8b6279cfd0f385e19f96272124abf53",
+ "method": "POST",
+ "path": "/platform/templates",
+ "operationId": "createMessageTemplate",
+ "fingerprint": "ff76bc7341bf8c7a3d88052c5c656a725fcd481b98a39d8660a45228eec08745",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "This dashboard-only route does not accept the team server API key used by Client."
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "This dashboard-only route does not accept the team server API key used by Client."
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "This dashboard-only route does not accept the team server API key used by Client.",
+ "milestone": "credential-boundary"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/audience-segments",
- "operationId": "listAudienceSegments",
- "fingerprint": "bc4cb882402e6f03332d74d4f20074f4e89634820221daa8aa58f46411e5314e",
+ "method": "POST",
+ "path": "/platform/voice/audio",
+ "operationId": "createVoiceAudioUpload",
+ "fingerprint": "aa1336115abe963b063f57c0419f2cae43a0f03871d19f029c79f435b91614f5",
"typescript": {
"status": "covered",
- "method": "Client.audienceSegments.list"
+ "method": "Client.voice.audio.createUpload"
},
"go": {
"status": "covered",
- "method": "TeamClient.AudienceSegments().List"
+ "method": "TeamClient.Voice.Audio.CreateUpload"
},
"python": {
"status": "covered",
- "method": "AsyncClient.audience_segments.list"
+ "method": "AsyncClient.voice.audio.create_upload"
},
"php": {
"status": "covered",
- "method": "Client::audienceSegments.list"
+ "method": "Client::voice.audio.createUpload"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.AudienceSegments.ListAsync"
+ "method": "TeamClient.Voice.Audio.CreateUploadAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.audience_segments().list"
+ "method": "TeamClient.voice.audio.create_upload"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/audience-segments/{segmentId}",
- "operationId": "getAudienceSegment",
- "fingerprint": "cf112314ad1fd7b59305eac8efcff804485de8411c3cbe287add969e6060b147",
+ "method": "POST",
+ "path": "/platform/voice/audio/{assetId}/complete",
+ "operationId": "completeVoiceAudioUpload",
+ "fingerprint": "0b17d42ee3a452d913e8c31c3f0dfe205755fdabb512362dc2e0a2cc84086633",
"typescript": {
"status": "covered",
- "method": "Client.audienceSegments.retrieve"
+ "method": "Client.voice.audio.complete"
},
"go": {
"status": "covered",
- "method": "TeamClient.AudienceSegments().Retrieve"
+ "method": "TeamClient.Voice.Audio.Complete"
},
"python": {
"status": "covered",
- "method": "AsyncClient.audience_segments.retrieve"
+ "method": "AsyncClient.voice.audio.complete"
},
"php": {
"status": "covered",
- "method": "Client::audienceSegments.retrieve"
+ "method": "Client::voice.audio.complete"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.AudienceSegments.RetrieveAsync"
+ "method": "TeamClient.Voice.Audio.CompleteAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.audience_segments().retrieve"
+ "method": "TeamClient.voice.audio.complete"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/audience-segments/{segmentId}/preview",
- "operationId": "previewAudienceSegment",
- "fingerprint": "8576e9fba36c050e04bb209309a2a3f851be43021e721c02ae20085c174dbf90",
+ "method": "POST",
+ "path": "/platform/voice/audio/tts",
+ "operationId": "synthesizeVoiceAudio",
+ "fingerprint": "309d596bcf159b97983f96705365eb18ad0f63a949f59aaaa1b71b37b1b24373",
"typescript": {
"status": "covered",
- "method": "Client.audienceSegments.preview"
+ "method": "Client.voice.audio.synthesize"
},
"go": {
"status": "covered",
- "method": "TeamClient.AudienceSegments().Preview"
+ "method": "TeamClient.Voice.Audio.Synthesize"
},
"python": {
"status": "covered",
- "method": "AsyncClient.audience_segments.preview"
+ "method": "AsyncClient.voice.audio.synthesize"
},
"php": {
"status": "covered",
- "method": "Client::audienceSegments.preview"
+ "method": "Client::voice.audio.synthesize"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.AudienceSegments.PreviewAsync"
+ "method": "TeamClient.Voice.Audio.SynthesizeAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.audience_segments().preview"
+ "method": "TeamClient.voice.audio.synthesize"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/campaign-reply-flows/{replyFlowId}",
- "operationId": "getPlatformCampaignReplyFlow",
- "fingerprint": "3996942bca4d772240dd92f1cad88cf4e460bba0995a82039362ba7d8a3b2020",
+ "method": "POST",
+ "path": "/platform/voice/provider-credentials",
+ "operationId": "createVoiceProviderCredential",
+ "fingerprint": "786bacf7dd5068567f1efe6a9012647cdfb50c6c472c0b71f906eff6090a0017",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.voice.providerCredentials.create"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Voice.ProviderCredentials.Create"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.voice.provider_credentials.create"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::voice.providerCredentials.create"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Voice.ProviderCredentials.CreateAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.voice.provider_credentials.create"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/campaign-settings",
- "operationId": "getCampaignSettings",
- "fingerprint": "b91ca61874b0ee0f91d37c7da0296bb674f25fa873cc2b73fc3f120b4b07a6df",
+ "method": "POST",
+ "path": "/platform/voice/provider-credentials/{credentialId}/verify",
+ "operationId": "verifyVoiceProviderCredential",
+ "fingerprint": "bfb5dfa7511ad4fc8b09a8d902adc8d0c78c8505040b6f320aab26dbff16922d",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.voice.providerCredentials.verify"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Voice.ProviderCredentials.Verify"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
- },
- "php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.voice.provider_credentials.verify"
+ },
+ "php": {
+ "status": "covered",
+ "method": "Client::voice.providerCredentials.verify"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Voice.ProviderCredentials.VerifyAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.voice.provider_credentials.verify"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/campaign-settings/frequency-cap",
- "operationId": "getCampaignFrequencyCap",
- "fingerprint": "113086d23bd8cf9835379a940c8e7c8207a17bba205b8a14fae1e1f9c1ab39a0",
+ "method": "POST",
+ "path": "/platform/webhook-deliveries/{deliveryId}/retry",
+ "operationId": "retryTeamWebhookDelivery",
+ "fingerprint": "a75bc14c49a898829e4c9d2e1d0e18a6128286f515441baaa2a3b8fbab94dbc5",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.getFrequencyCap"
+ "method": "Client.webhookDeliveries.retry"
},
"go": {
"status": "covered",
- "method": "TeamClient.Campaigns().GetFrequencyCap"
+ "method": "TeamClient.WebhookDeliveries.Retry"
},
"python": {
"status": "covered",
- "method": "AsyncClient.campaigns.get_frequency_cap"
+ "method": "AsyncClient.webhook_deliveries.retry"
},
"php": {
"status": "covered",
- "method": "Client::campaigns.getFrequencyCap"
+ "method": "Client::webhookDeliveries.retry"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Campaigns.GetFrequencyCapAsync"
+ "method": "TeamClient.WebhookDeliveries.RetryAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.campaigns().get_frequency_cap"
+ "method": "TeamClient.webhook_deliveries.retry"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/campaigns/{campaignId}/approvals",
- "operationId": "listCampaignLaunchApprovals",
- "fingerprint": "b08465f0c1bdb7d6a831bbef97400c5c58c0791bede04e942c2f9b469e418eb4",
+ "method": "POST",
+ "path": "/platform/webhooks",
+ "operationId": "createTeamWebhook",
+ "fingerprint": "759e6df60519cf6c150383244dd61d885c3da1491e8e5b89ed0e6aa08a6d1baa",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.webhooks.create"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (phoneOfflineStartDay) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/campaigns/{campaignId}/links",
- "operationId": "getCampaignLinks",
- "fingerprint": "1ef89c59be3c2b9d0ba6763dae4ac705a78bb8f9ce0911c54ff6ee89220c3e66",
+ "method": "POST",
+ "path": "/platform/webhooks/{webhookId}/secret-rotations",
+ "operationId": "rotateTeamWebhookSecret",
+ "fingerprint": "387e8fda3114d0d8c01e8d1e4a704a17bc8f438663c3709305927a1a4bbcb3e3",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.webhooks.rotateSecret"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Webhooks.RotateSecret"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.webhooks.rotate_secret"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::webhooks.rotateSecret"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Webhooks.RotateSecretAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.webhooks.rotate_secret"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/campaigns/{campaignId}/recipients/export",
- "operationId": "exportCampaignRecipients",
- "fingerprint": "c54318bb66fe72bd7389c5a2b4e41687bb6a7d5a56e74bcf966fef3428931037",
+ "method": "POST",
+ "path": "/platform/webhooks/{webhookId}/tests",
+ "operationId": "testTeamWebhook",
+ "fingerprint": "d41cd2b64bd471ab56973a1dc77fb416761b43bc93fd9a9087f27ec496cc85b6",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.webhooks.test"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Webhooks.Test"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.webhooks.test"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::webhooks.test"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Webhooks.TestAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.webhooks.test"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/feature-terms",
- "operationId": "listFeatureTerms",
- "fingerprint": "ee4cec6818f092f91773f4bf02adb8929ad702c74f8459787dc86564ea3bad4f",
+ "method": "PUT",
+ "path": "/api/account/meta-app",
+ "operationId": "configureTeamMetaApp",
+ "fingerprint": "77da5c3c1ead511a73d21b3b3697e80e8010d7f224649d2ec230184f817c3476",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK."
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Dashboard identity and account controls require a live browser account session; not part of the machine SDK.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/optouts/confirmation-settings",
- "operationId": "getStopConfirmationSettings",
- "fingerprint": "c5a536320d66a439737c9409f24c19a38eb1d04c1c2f3f0c61b20e572e199416",
+ "method": "PUT",
+ "path": "/console/call-policy",
+ "operationId": "updateConsoleCallPolicy",
+ "fingerprint": "f32f6596c466a1367e6cbbde55b2135b6e57fba445942811614c5844a32461d9",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/optouts/confirmation-summary",
- "operationId": "getStopConfirmationSummary",
- "fingerprint": "49f357d86d3c7eece9ee42abcd3053907929aedd7de3adebe9e068b6be78ab38",
+ "method": "PUT",
+ "path": "/console/call-retention",
+ "operationId": "updateTeamCallRetention",
+ "fingerprint": "af7255c6a1e712c89e2ea8bdc33e722f3ab52a9b988d2c90504e94ca53c98f5d",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method."
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method."
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method."
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only dashboard operation; not a public SDK method.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/projects/{projectId}/customers/{customerId}/signal-custody",
- "operationId": "getCustomerSignalCustody",
- "fingerprint": "3e5f662a1f4d1128287869955778045650bad447c44b3f1aabf0bceed378f8b8",
+ "method": "PUT",
+ "path": "/console/call-settings/{connectionId}",
+ "operationId": "updateConnectionCallSettings",
+ "fingerprint": "459e2f4299f725b018b70dbcf7ca079aded214b1761be903296deec80e80bbd0",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/projects/{projectId}/request-logs",
- "operationId": "listProjectRequestLogs",
- "fingerprint": "632688e5a1f8ff95251782d439643d189b3a957f93562ecc30ae5013f6930952",
+ "method": "PUT",
+ "path": "/console/campaign-settings",
+ "operationId": "updateCampaignSettings",
+ "fingerprint": "6c34baa304925a079d789d9d532dad3922590e0bc73f96bd638f314035a2edf2",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "GET",
- "path": "/platform/projects/{projectId}/signal-custody",
- "operationId": "getProjectSignalCustody",
- "fingerprint": "c09bb2706a193ee426582aa8782a8a312b53efdcaf836c062eb49453dbebea8c",
+ "method": "PUT",
+ "path": "/console/connection-configuration/{connectionId}",
+ "operationId": "updateConnectionConfiguration",
+ "fingerprint": "289afa6aa77dd0bceef9cfb1e22654931f38cc12a10d0486c23be5d614502ed4",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "excluded",
+ "reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "PATCH",
- "path": "/platform/audience-segments/{segmentId}",
- "operationId": "updateAudienceSegment",
- "fingerprint": "e491c82bc7e9cdd1b310b5eacd7eaa184ba97f3b60fcb582a21a4c61d11cf7d8",
+ "method": "PUT",
+ "path": "/console/insights/preferences",
+ "operationId": "updateInsightPreferences",
+ "fingerprint": "0b31dd6664b3b8274a0bb295e4c3cf4288526ab99d609dcb298c300a1a77de99",
"typescript": {
- "status": "covered",
- "method": "Client.audienceSegments.update"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
- "status": "covered",
- "method": "TeamClient.AudienceSegments().Update"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
- "status": "covered",
- "method": "AsyncClient.audience_segments.update"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
- "status": "covered",
- "method": "Client::audienceSegments.update"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
- "status": "covered",
- "method": "TeamClient.AudienceSegments.UpdateAsync"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
- "status": "covered",
- "method": "TeamClient.audience_segments().update"
+ "status": "excluded",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/api/account/feature-terms/{key}/accept",
- "operationId": "accountAcceptFeatureTerms",
- "fingerprint": "3fca6aad2caeb7df5e9548d096ba23f22a765f25920a4fba7105faf3b7856f49",
+ "method": "PUT",
+ "path": "/console/notifications/preferences",
+ "operationId": "updateNotificationPreferences",
+ "fingerprint": "69c616c55c0a31847462ef4b5235c1dca308ecded0a3310789bb24407c930530",
"typescript": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/api/account/feature-terms/{key}/withdraw",
- "operationId": "accountWithdrawFeatureTerms",
- "fingerprint": "d35b002a834c5f5b2d18ec7182511184a3454852234a9d91cb88056f67ac32a0",
+ "method": "PUT",
+ "path": "/console/profile/avatar",
+ "operationId": "saveAvatarUserProfile",
+ "fingerprint": "d74e3b056456be441e74d755507fe89a14531fa7d91178a3e3168178a9ddcbf8",
"typescript": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/api/account/legal/accept",
- "operationId": "acceptAccountLegalTerms",
- "fingerprint": "f881c93708c62110d676df2b031e34c27ef616152a829f44ca6564a835d3cd15",
+ "method": "PUT",
+ "path": "/console/projects/{projectId}/logging/drains",
+ "operationId": "saveProjectDrain",
+ "fingerprint": "2b0c2b0523a74f73f59dea5470920b5855564e96e4d904c0f36a264a9408041f",
"typescript": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"go": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"python": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
+ "milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
+ "milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"rust": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/campaigns/{campaignId}/approvals/{approvalId}/approve",
- "operationId": "approveCampaignLaunch",
- "fingerprint": "51fa19f4cf04ea22efef0c989e9524dc7ca0b56de0628eef471554a6f94d9393",
+ "method": "PUT",
+ "path": "/console/projects/{projectId}/logging/sampling",
+ "operationId": "saveProjectSampling",
+ "fingerprint": "f184e9c3f69713401b7379e13c809f4c766e4f051bec6ceb507399bbfcb4bd2b",
"typescript": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"go": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"python": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
+ "milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
+ "milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted."
},
"rust": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "reason": "Console-only operation requires dashboard identity; team API keys and project tokens are not accepted.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/campaigns/{campaignId}/approvals/{approvalId}/reject",
- "operationId": "rejectCampaignLaunch",
- "fingerprint": "872d7cd7121e654134e5abe325867d7ef57d09ce354b44ed7a66b5dd7cc4abe6",
+ "method": "PUT",
+ "path": "/console/projects/{projectId}/regional-data/settings",
+ "operationId": "putRegionalDataSettings",
+ "fingerprint": "dac490f8e593361a123feefd8eb91f7b21a777e263e1b55ddd33e6c48988707e",
"typescript": {
"status": "excluded",
"reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
@@ -21113,121 +20980,112 @@
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/projects/{projectId}/numbers/{session}/catalogs/{catalogId}/sync",
- "operationId": "syncConsoleCloudCatalog",
- "fingerprint": "4e45756e94ce10eedccd41a512633663bf71deb2917dd8ac6eaf348d98888fd8",
+ "method": "PUT",
+ "path": "/console/projects/{projectId}/setup",
+ "operationId": "saveProjectSetup",
+ "fingerprint": "ab8cc397fbfc5278ec5845c8fa43cc75043a3ce31a7b2ed83400c74003a6ee74",
"typescript": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "reason": "Console-only project setup uses dashboard identity and is unavailable to SDK credentials.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/projects/{projectId}/regional-data/access",
- "operationId": "issueRegionalDataAccess",
- "fingerprint": "a219c4dc8b209ff948687b7ea0f2b478ca146354bb68b5517e692472bc6e95e6",
+ "method": "PUT",
+ "path": "/console/quicklink/logo",
+ "operationId": "attachLogoQuickLinkSettings",
+ "fingerprint": "2881f74db6f634f3d4cf6d05a616bf73fdf788f09cd869fdc48b9c9b1dfe367b",
"typescript": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/console/projects/{projectId}/regional-data/client-tokens",
- "operationId": "issueConsoleRegionalClientToken",
- "fingerprint": "a34048226be0fbb68e19c5559ef4024d2f5543e8b533b7635fd02d61c19f71fb",
+ "method": "PUT",
+ "path": "/console/team/avatar",
+ "operationId": "saveAvatarTeam",
+ "fingerprint": "aabb9a048daf5adcf78b82be7282739231419c7ace62ee87a1c875e0ba685d21",
"typescript": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"go": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"python": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"php": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
+ "milestone": "excluded-contract"
},
"dotnet": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
"rust": {
"status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
+ "reason": "Console-only operation requires dashboard identity; not available to SDK credentials.",
"milestone": "not-server-sdk"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/audience-profile-imports",
- "operationId": "createAudienceProfileImport",
- "fingerprint": "d09a9d59487488ae4070fec662969eb5f8d49fd68de725dd50b96975a74cd027",
+ "method": "PUT",
+ "path": "/platform/audience-profiles/{phone}",
+ "operationId": "putAudienceProfile",
+ "fingerprint": "828657273a6c5ea794d61594d51b55c492e71bfee2bdd34459e881dbc0e96996",
"typescript": {
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
@@ -21239,94 +21097,249 @@
"milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "php": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "dotnet": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ },
+ "rust": {
+ "status": "missing",
+ "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "milestone": "contract-f180dc1ee2-sync"
+ }
+ },
+ {
+ "family": "platform",
+ "method": "PUT",
+ "path": "/platform/billing/controls/{scope}/{resourceId}",
+ "operationId": "setResourceBillingControls",
+ "fingerprint": "efdfb91f5473a5473e6ef5cf1cb13659564ed87e5890e7677fdc2ba17cfe8b45",
+ "typescript": {
+ "status": "covered",
+ "method": "Client.billing.setResourceControls"
+ },
+ "go": {
+ "status": "covered",
+ "method": "TeamClient.Billing.SetResourceControls"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncClient.billing.set_resource_controls"
+ },
+ "php": {
+ "status": "covered",
+ "method": "Client::billing.setResourceControls"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "TeamClient.Billing.SetResourceControlsAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "TeamClient.billing.set_resource_controls"
+ }
+ },
+ {
+ "family": "platform",
+ "method": "PUT",
+ "path": "/platform/billing/limits/{scope}/{resourceId}",
+ "operationId": "setBillingLimit",
+ "fingerprint": "b7e84e15eb44b9d36d03e1ec35a3060407befc22b76cc9807963f4a14b6e8274",
+ "typescript": {
+ "status": "covered",
+ "method": "Client.billing.setLimit"
+ },
+ "go": {
+ "status": "covered",
+ "method": "TeamClient.Billing.SetLimit"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncClient.billing.set_limit"
+ },
+ "php": {
+ "status": "covered",
+ "method": "Client::billing.setLimit"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "TeamClient.Billing.SetLimitAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "TeamClient.billing.set_limit"
+ }
+ },
+ {
+ "family": "platform",
+ "method": "PUT",
+ "path": "/platform/billing/priorities",
+ "operationId": "reorderBillingPriorities",
+ "fingerprint": "8fe26a28feffe7a241fa671f6969a2d4f45a6b8ad481bd48471121100031aa22",
+ "typescript": {
+ "status": "covered",
+ "method": "Client.billing.reorderPriorities"
+ },
+ "go": {
+ "status": "covered",
+ "method": "TeamClient.Billing.ReorderPriorities"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncClient.billing.reorder_priorities"
+ },
+ "php": {
+ "status": "covered",
+ "method": "Client::billing.reorderPriorities"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "TeamClient.Billing.ReorderPrioritiesAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "TeamClient.billing.reorder_priorities"
+ }
+ },
+ {
+ "family": "platform",
+ "method": "PUT",
+ "path": "/platform/billing/priorities/{scope}/{resourceId}",
+ "operationId": "setBillingPriority",
+ "fingerprint": "a123243285b7551efcff19203abf081d9c2b2ce1864c5502bc93dc4789e99538",
+ "typescript": {
+ "status": "covered",
+ "method": "Client.billing.setPriority"
+ },
+ "go": {
+ "status": "covered",
+ "method": "TeamClient.Billing.SetPriority"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncClient.billing.set_priority"
+ },
+ "php": {
+ "status": "covered",
+ "method": "Client::billing.setPriority"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "TeamClient.Billing.SetPriorityAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "TeamClient.billing.set_priority"
+ }
+ },
+ {
+ "family": "platform",
+ "method": "PUT",
+ "path": "/platform/call-policy",
+ "operationId": "updateCallPolicy",
+ "fingerprint": "3e26f300be11841eb51b476c39f5d1b0c4c2d3440b8b7c95bc3e3b61a48b0a46",
+ "typescript": {
+ "status": "covered",
+ "method": "Client.callPolicy.update"
+ },
+ "go": {
+ "status": "covered",
+ "method": "TeamClient.CallPolicy.Update"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncClient.call_policy.update"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::callPolicy.update"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.CallPolicy.UpdateAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.call_policy.update"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/audience-segments",
- "operationId": "createAudienceSegment",
- "fingerprint": "0be3f23ef7cb10df01bccd72a8e665c6cae07aad2f5e7c10fd072433f2715db0",
+ "method": "PUT",
+ "path": "/platform/call-retention",
+ "operationId": "updateCallRetention",
+ "fingerprint": "ec5c6bee6913e6b16cced43e75376a3dace73d0792d2b06ec11addeb6928b1a1",
"typescript": {
"status": "covered",
- "method": "Client.audienceSegments.create"
+ "method": "Client.callRetention.update"
},
"go": {
"status": "covered",
- "method": "TeamClient.AudienceSegments().Create"
+ "method": "TeamClient.CallRetention.Update"
},
"python": {
"status": "covered",
- "method": "AsyncClient.audience_segments.create"
+ "method": "AsyncClient.call_retention.update"
},
"php": {
"status": "covered",
- "method": "Client::audienceSegments.create"
+ "method": "Client::callRetention.update"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.AudienceSegments.CreateAsync"
+ "method": "TeamClient.CallRetention.UpdateAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.audience_segments().create"
+ "method": "TeamClient.call_retention.update"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/audience-segments/preview",
- "operationId": "previewAudienceSegmentRules",
- "fingerprint": "685f6ef4e10d6ea88f9da2377ee32c7295776ce6ea16e057cd1821c8f4de7ba9",
+ "method": "PUT",
+ "path": "/platform/campaign-settings/frequency-cap",
+ "operationId": "updateCampaignFrequencyCap",
+ "fingerprint": "4d9aa1bce723a50a3d1870ea588362d2cbc5785e31f1c349c9428103f762f421",
"typescript": {
"status": "covered",
- "method": "Client.audienceSegments.previewRules"
+ "method": "Client.campaigns.updateFrequencyCap"
},
"go": {
"status": "covered",
- "method": "TeamClient.AudienceSegments().PreviewRules"
+ "method": "TeamClient.Campaigns().UpdateFrequencyCap"
},
"python": {
"status": "covered",
- "method": "AsyncClient.audience_segments.preview_rules"
+ "method": "AsyncClient.campaigns.update_frequency_cap"
},
"php": {
"status": "covered",
- "method": "Client::audienceSegments.previewRules"
+ "method": "Client::campaigns.updateFrequencyCap"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.AudienceSegments.PreviewRulesAsync"
+ "method": "TeamClient.Campaigns.UpdateFrequencyCapAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.audience_segments().preview_rules"
+ "method": "TeamClient.campaigns().update_frequency_cap"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/audiences/from-campaign",
- "operationId": "createAudienceFromCampaign",
- "fingerprint": "943b6e2b29eb483c6b2db7b5c415fd643fa16dd982dc7fe0a7972bd7cfb84cf4",
+ "method": "PUT",
+ "path": "/platform/campaigns/{campaignId}/reply-flow",
+ "operationId": "setPlatformCampaignReplyFlow",
+ "fingerprint": "9265d705ae9175d417b76077354ea81eb71578d8674a6721d620e7c65c930e58",
"typescript": {
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
@@ -21360,189 +21373,239 @@
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaign-reply-flows",
- "operationId": "createPlatformCampaignReplyFlow",
- "fingerprint": "f66233dac8f95cb1569c52348de4995968f9fe43e7d360799973264ef25fb3d3",
+ "method": "PUT",
+ "path": "/platform/connection-configuration",
+ "operationId": "updateConnectionConfigurationDefaults",
+ "fingerprint": "b8087d56ffa49197b82fc235518d3f2ab35b43ae21a0f9bbd4d62e9ba0498a3b",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "covered",
+ "method": "Client.connectionConfiguration.update"
+ },
+ "go": {
+ "status": "covered",
+ "method": "TeamClient.ConnectionConfiguration.Update"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncClient.connection_configuration.update"
+ },
+ "php": {
+ "status": "covered",
+ "method": "Client::connectionConfiguration.update"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "TeamClient.Configuration.UpdateAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "TeamClient.connection_configuration.update"
+ }
+ },
+ {
+ "family": "platform",
+ "method": "PUT",
+ "path": "/platform/connections/{connection}/call-settings",
+ "operationId": "updateCallSettings",
+ "fingerprint": "18f8a88b88486ffe46044fb43482fe3f1be9a11aa47dec73d9490542f2c66bc8",
+ "typescript": {
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (acceptTerms, termsLocale) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (acceptTerms, termsLocale) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (acceptTerms, termsLocale) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (acceptTerms, termsLocale) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (acceptTerms, termsLocale) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
+ "status": "partial",
+ "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (acceptTerms, termsLocale) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaigns/{campaignId}/enrollments",
- "operationId": "enrollCampaignContact",
- "fingerprint": "8b63403fd07e40ca03202bf64735b456bd2c048bdf7154dcae5e368ca5edc63a",
+ "method": "PUT",
+ "path": "/platform/connections/{connection}/client-rules",
+ "operationId": "setClientRules",
+ "fingerprint": "7c8c591246931b9ee8a23efc71d67c38c432d8103d6e6ece36111e7e5b292d81",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.enroll"
+ "method": "MessagingClient.clientTokens.updateRules"
},
"go": {
"status": "covered",
- "method": "TeamClient.Campaigns().Enroll"
+ "method": "MessagingClient.ClientTokens.UpdateRules"
},
"python": {
"status": "covered",
- "method": "AsyncClient.campaigns.enroll"
+ "method": "AsyncMessagingClient.client_tokens.update_rules"
},
"php": {
"status": "covered",
- "method": "Client::campaigns.enroll"
+ "method": "MessagingClient::$clientTokens->updateRules"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Campaigns.EnrollAsync"
+ "method": "TeamClient.ClientTokens.UpdateRulesAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.campaigns().enroll"
+ "method": "MessagingClient.client_tokens.update_rules"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/campaigns/{campaignId}/test-send",
- "operationId": "testSendPlatformCampaign",
- "fingerprint": "189cee6e0537f9dd11db16b9e1f278448b4684ae86d187940cba38870274bd40",
+ "method": "PUT",
+ "path": "/platform/connections/{connectionId}",
+ "operationId": "updateConnection",
+ "fingerprint": "84254cc487be477f38da8b87f078d626e6d0de466647cbb72de5f8996ea87183",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.connections.update",
+ "untypedResponseFields": ["inspector"]
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Connections.Update",
+ "untypedResponseFields": ["inspector"]
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.connections.update",
+ "untypedResponseFields": ["inspector"]
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::connections.update",
+ "untypedResponseFields": ["inspector"]
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Connections.UpdateAsync",
+ "untypedResponseFields": ["inspector"]
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "MessagingClient.connections.update",
+ "untypedResponseFields": ["inspector"]
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/feature-terms/{key}/accept",
- "operationId": "acceptFeatureTerms",
- "fingerprint": "1f293692e330cf6aff06b98ce24ccdcb86d84559680cc99245521be68d8792af",
+ "method": "PUT",
+ "path": "/platform/connections/{connectionId}/safe-mode",
+ "operationId": "updatePlatformConnectionSafeMode",
+ "fingerprint": "7a556b9473a052e631f16e8aff6958bc87d178110e9458450f7da261b146f59f",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.connections.updateSafeMode"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Connections.UpdateSafeMode"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.connections.update_safe_mode"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::$connections->updateSafeMode"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Connections.UpdateSafeModeAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.connections.update_safe_mode"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/feature-terms/{key}/withdraw",
- "operationId": "withdrawFeatureTerms",
- "fingerprint": "f64716013972f22bf2a3ba441258c35675bf550033c8794384fc659ccd996b39",
+ "method": "PUT",
+ "path": "/platform/flows/{flowId}/endpoint",
+ "operationId": "setFlowEndpoint",
+ "fingerprint": "984f585762cb5b189812b6e2476c24244faab24140091b5f9b305c569a304526",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.project(projectId).flows.setEndpoint"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Flows.SetEndpoint"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncProjectClient.flows.set_endpoint"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient::flows.setEndpoint"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "ProjectClient.Flows.SetEndpointAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "ProjectClient.flows.set_endpoint"
+ }
+ },
+ {
+ "family": "platform",
+ "method": "PUT",
+ "path": "/platform/functions/{functionId}/promotion",
+ "operationId": "promoteFunctionDeployment",
+ "fingerprint": "87f0c7d4aff51ba32ed67dd96dc043b1bf7e4244437464d10588f23241b895c4",
+ "typescript": {
+ "status": "covered",
+ "method": "Client.project(projectId).functions.deployments.promote"
+ },
+ "go": {
+ "status": "covered",
+ "method": "ProjectClient.Functions.Deployments.Promote"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncProjectClient.functions.deployments.promote"
+ },
+ "php": {
+ "status": "covered",
+ "method": "ProjectClient::functions.deployments.promote"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.Functions.Deployments.PromoteAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "ProjectClient.functions.deployments.promote"
}
},
{
"family": "platform",
- "method": "POST",
- "path": "/platform/sessions/{sessionId}/inspector/claim/release",
- "operationId": "releaseSessionInspectorClaim",
- "fingerprint": "63eead286c32e28ecca008e93e59d0f56fe2ec184ee7c45cc178fad13d3257e8",
+ "method": "PUT",
+ "path": "/platform/optouts/confirmation-settings",
+ "operationId": "updateStopConfirmationSettings",
+ "fingerprint": "d8c66b056bb0d2a099a167c0d398f556f348ae61b3d1cc8b204e0a5f264e5dbd",
"typescript": {
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
@@ -21577,83 +21640,40 @@
{
"family": "platform",
"method": "PUT",
- "path": "/console/campaign-settings",
- "operationId": "updateCampaignSettings",
- "fingerprint": "6c34baa304925a079d789d9d532dad3922590e0bc73f96bd638f314035a2edf2",
- "typescript": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "go": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "python": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "php": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "dotnet": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- },
- "rust": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
- }
- },
- {
- "family": "platform",
- "method": "PUT",
- "path": "/console/projects/{projectId}/regional-data/settings",
- "operationId": "putRegionalDataSettings",
- "fingerprint": "48a3a33ec3f72a5353bc84a788edb2b5d1180dbf503de2e3cf5fff6de08e70a5",
+ "path": "/platform/optouts/settings",
+ "operationId": "updateOptOutSettings",
+ "fingerprint": "244940ab4b3e41b7b9427f449022f154eaaf9534a4a35dc9226673508a1241e2",
"typescript": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "Client.optOuts.updateSettings"
},
"go": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.OptOuts.UpdateSettings"
},
"python": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "AsyncClient.opt_outs.update_settings"
},
"php": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "Client::optOuts.updateSettings"
},
"dotnet": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.OptOuts.UpdateSettingsAsync"
},
"rust": {
- "status": "excluded",
- "reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
- "milestone": "not-server-sdk"
+ "status": "covered",
+ "method": "TeamClient.opt_outs.update_settings"
}
},
{
"family": "platform",
"method": "PUT",
- "path": "/platform/audience-profiles/{phone}",
- "operationId": "putAudienceProfile",
- "fingerprint": "828657273a6c5ea794d61594d51b55c492e71bfee2bdd34459e881dbc0e96996",
+ "path": "/platform/projects/{projectId}/customers/{customerId}/signal-custody",
+ "operationId": "updateCustomerSignalCustody",
+ "fingerprint": "33341f15c68111ee7d7ccfb862f46a73b9c6c7a0c596e5ee2d03cbea761a51e3",
"typescript": {
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
@@ -21688,114 +21708,102 @@
{
"family": "platform",
"method": "PUT",
- "path": "/platform/campaign-settings/frequency-cap",
- "operationId": "updateCampaignFrequencyCap",
- "fingerprint": "4d9aa1bce723a50a3d1870ea588362d2cbc5785e31f1c349c9428103f762f421",
+ "path": "/platform/projects/{projectId}/health-policy",
+ "operationId": "updateProjectHealthPolicySettings",
+ "fingerprint": "1133dce3b013a320717a4502e90477b20df6db49ab6ce5a855d650bc0a12a56d",
"typescript": {
"status": "covered",
- "method": "Client.campaigns.updateFrequencyCap"
+ "method": "Client.projects.updateHealthPolicy"
},
"go": {
"status": "covered",
- "method": "TeamClient.Campaigns().UpdateFrequencyCap"
+ "method": "TeamClient.Projects.UpdateHealthPolicy"
},
"python": {
"status": "covered",
- "method": "AsyncClient.campaigns.update_frequency_cap"
+ "method": "AsyncClient.projects.update_health_policy"
},
"php": {
"status": "covered",
- "method": "Client::campaigns.updateFrequencyCap"
+ "method": "Client::$projects->updateHealthPolicy"
},
"dotnet": {
"status": "covered",
- "method": "TeamClient.Campaigns.UpdateFrequencyCapAsync"
+ "method": "TeamClient.Projects.UpdateHealthPolicyAsync"
},
"rust": {
"status": "covered",
- "method": "TeamClient.campaigns().update_frequency_cap"
+ "method": "TeamClient.projects.update_health_policy"
}
},
{
"family": "platform",
"method": "PUT",
- "path": "/platform/campaigns/{campaignId}/reply-flow",
- "operationId": "setPlatformCampaignReplyFlow",
- "fingerprint": "9265d705ae9175d417b76077354ea81eb71578d8674a6721d620e7c65c930e58",
+ "path": "/platform/projects/{projectId}/insurance-evidence",
+ "operationId": "updateInsuranceEvidenceSettings",
+ "fingerprint": "54da97d18246ed0e4687b46514a8bcbde791a39afdddb5079c5a10624a40002a",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.projects.updateInsuranceEvidence"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Projects.UpdateInsuranceEvidence"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.projects.update_insurance_evidence"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::$projects->updateInsuranceEvidence"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Projects.UpdateInsuranceEvidenceAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.projects.update_insurance_evidence"
}
},
{
"family": "platform",
"method": "PUT",
- "path": "/platform/optouts/confirmation-settings",
- "operationId": "updateStopConfirmationSettings",
- "fingerprint": "d8c66b056bb0d2a099a167c0d398f556f348ae61b3d1cc8b204e0a5f264e5dbd",
+ "path": "/platform/projects/{projectId}/safe-mode",
+ "operationId": "updateProjectSafeModeCeiling",
+ "fingerprint": "4f2b55cf1ecbe55564175c47742d16eee4db8d28ea2891c0fea4941b42d995f2",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.projects.updateSafeMode"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Projects.UpdateSafeMode"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.projects.update_safe_mode"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::$projects->updateSafeMode"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Projects.UpdateSafeModeAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.projects.update_safe_mode"
}
},
{
"family": "platform",
"method": "PUT",
- "path": "/platform/projects/{projectId}/customers/{customerId}/signal-custody",
- "operationId": "updateCustomerSignalCustody",
- "fingerprint": "33341f15c68111ee7d7ccfb862f46a73b9c6c7a0c596e5ee2d03cbea761a51e3",
+ "path": "/platform/projects/{projectId}/signal-custody",
+ "operationId": "updateProjectSignalCustody",
+ "fingerprint": "5de4c3428c6d38d968c38a5231134828e75235837f63647679e90f2b6b532e61",
"typescript": {
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
@@ -21830,38 +21838,63 @@
{
"family": "platform",
"method": "PUT",
- "path": "/platform/projects/{projectId}/signal-custody",
- "operationId": "updateProjectSignalCustody",
- "fingerprint": "5de4c3428c6d38d968c38a5231134828e75235837f63647679e90f2b6b532e61",
+ "path": "/platform/projects/{projectId}/warmup-plan",
+ "operationId": "updateProjectWarmupPlanSettings",
+ "fingerprint": "c7939dd80b04968374dcd5ce555c83fa239a05abdab6a07cc74e9d4229e7a730",
"typescript": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client.projects.updateWarmupPlan"
},
"go": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Projects.UpdateWarmupPlan"
},
"python": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "AsyncClient.projects.update_warmup_plan"
},
"php": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "Client::$projects->updateWarmupPlan"
},
"dotnet": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.Projects.UpdateWarmupPlanAsync"
},
"rust": {
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "method": "TeamClient.projects.update_warmup_plan"
+ }
+ },
+ {
+ "family": "platform",
+ "method": "PUT",
+ "path": "/platform/quicklink",
+ "operationId": "updateQuickLinkSettings",
+ "fingerprint": "1bec331053f7f052592b2454001a853e4cc6a7bacf2dd555e96438b21a3c292d",
+ "typescript": {
+ "status": "covered",
+ "method": "Client.quickLinkSettings.update"
+ },
+ "go": {
+ "status": "covered",
+ "method": "TeamClient.QuickLinkSettings.Update"
+ },
+ "python": {
+ "status": "covered",
+ "method": "AsyncClient.quick_link_settings.update"
+ },
+ "php": {
+ "status": "covered",
+ "method": "Client::quickLinkSettings.update"
+ },
+ "dotnet": {
+ "status": "covered",
+ "method": "ProjectClient.QuickLinkSettings.UpdateAsync"
+ },
+ "rust": {
+ "status": "covered",
+ "method": "TeamClient.quick_link_settings.update"
}
}
],
diff --git a/contracts/doc-snippets.json b/contracts/doc-snippets.json
index eb1532571..9b3183e41 100644
--- a/contracts/doc-snippets.json
+++ b/contracts/doc-snippets.json
@@ -1,12 +1,12 @@
{
"schemaVersion": 1,
- "sourceCommit": "641230d38744d862cbf66ae3af56fbfb203e1e73",
- "sourceFilesSha256": "2c9b8c527fdebf3ca68ffb320c2ac118778502c74571365cd116c53427b475f8",
+ "sourceCommit": "63cca58d5bd8a8604047faa42569527527b217d3",
+ "sourceFilesSha256": "c3d902babda95ca0b63bea4d2571a432d84449c38639265e9ae44809e4e65803",
"apiVersion": "2026-09-22",
- "apiSourceCommit": "f180dc1ee2bd45dbecf01702f73bdd75c664634b",
+ "apiSourceCommit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
"specs": {
- "messaging": "0c66f1ee93923cf57425ac29c01a84c5c140b703ace2160e1b899ee6dad0b071",
- "platform": "bee9be6cc08d2ec78f5eb5e05135bea3751f93af917b8dd6983b26029feac485"
+ "messaging": "e84c7ff814c6b59ca7f32c3fda1aedbed3f672e728910adb883f0aa8c6cf3ab7",
+ "platform": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559"
},
"releaseStatus": "source-only",
"packages": {
@@ -24,453 +24,453 @@
"createBusinessCatalog": {
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/catalog",
+ "path": "/messaging/{connection}/business/catalog",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.createCatalog(\"{{session}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.createCatalog(\"{{connection}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().CreateCatalog(ctx, \"{{session}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().CreateCatalog(ctx, \"{{connection}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.create_catalog(\"{{session}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.create_catalog(\"{{connection}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->createCatalog(\"{{session}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->createCatalog(\"{{connection}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.CreateCatalogAsync(\"{{session}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.CreateCatalogAsync(\"{{connection}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().create_catalog(\"{{session}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().create_catalog(\"{{connection}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"createBusinessCollection": {
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/collections",
+ "path": "/messaging/{connection}/business/collections",
"credentialKind": "team_api_key",
"request": {
"body": { "name": "Featured", "productIds": ["product-id"] }
},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.createCollection(\"{{session}}\", {\"name\": \"Featured\", \"productIds\": [\"product-id\"]});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.createCollection(\"{{connection}}\", {\"name\": \"Featured\", \"productIds\": [\"product-id\"]});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().CreateCollection(ctx, \"{{session}}\", sdk.BusinessCollectionCreateRequest{Name: \"Featured\", ProductIDs: []string{\"product-id\"}})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().CreateCollection(ctx, \"{{connection}}\", sdk.BusinessCollectionCreateRequest{Name: \"Featured\", ProductIDs: []string{\"product-id\"}})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.create_collection(\"{{session}}\", {\"name\": \"Featured\", \"productIds\": [\"product-id\"]})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.create_collection(\"{{connection}}\", {\"name\": \"Featured\", \"productIds\": [\"product-id\"]})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->createCollection(\"{{session}}\", [\"name\" => \"Featured\", \"productIds\" => [\"product-id\"]]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->createCollection(\"{{connection}}\", [\"name\" => \"Featured\", \"productIds\" => [\"product-id\"]]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.CreateCollectionAsync(\"{{session}}\", new BusinessCollectionCreateRequest(\"Featured\", new[] { \"product-id\" }));\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.CreateCollectionAsync(\"{{connection}}\", new BusinessCollectionCreateRequest(\"Featured\", new[] { \"product-id\" }));\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().create_collection(\"{{session}}\", &polymorfa_sdk::business::BusinessCollectionCreateRequest { name: \"Featured\".into(), product_ids: vec![\"product-id\".into()] }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().create_collection(\"{{connection}}\", &polymorfa_sdk::business::BusinessCollectionCreateRequest { name: \"Featured\".into(), product_ids: vec![\"product-id\".into()] }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"deleteBusinessCollection": {
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/business/collections/{collectionId}",
+ "path": "/messaging/{connection}/business/collections/{collectionId}",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.deleteCollection(\"{{session}}\", \"{{collectionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.deleteCollection(\"{{connection}}\", \"{{collectionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().DeleteCollection(ctx, \"{{session}}\", \"{{collectionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().DeleteCollection(ctx, \"{{connection}}\", \"{{collectionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.delete_collection(\"{{session}}\", \"{{collectionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.delete_collection(\"{{connection}}\", \"{{collectionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->deleteCollection(\"{{session}}\", \"{{collectionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->deleteCollection(\"{{connection}}\", \"{{collectionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.DeleteCollectionAsync(\"{{session}}\", \"{{collectionId}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.DeleteCollectionAsync(\"{{connection}}\", \"{{collectionId}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().delete_collection(\"{{session}}\", \"{{collectionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().delete_collection(\"{{connection}}\", \"{{collectionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"deleteBusinessCoverPhoto": {
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/business/profile/cover-photo/{coverPhotoId}",
+ "path": "/messaging/{connection}/business/profile/cover-photo/{coverPhotoId}",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.deleteCoverPhoto(\"{{session}}\", \"{{coverPhotoId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.deleteCoverPhoto(\"{{connection}}\", \"{{coverPhotoId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().DeleteCoverPhoto(ctx, \"{{session}}\", \"{{coverPhotoId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().DeleteCoverPhoto(ctx, \"{{connection}}\", \"{{coverPhotoId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.delete_cover_photo(\"{{session}}\", \"{{coverPhotoId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.delete_cover_photo(\"{{connection}}\", \"{{coverPhotoId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->deleteCoverPhoto(\"{{session}}\", \"{{coverPhotoId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->deleteCoverPhoto(\"{{connection}}\", \"{{coverPhotoId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.DeleteCoverPhotoAsync(\"{{session}}\", \"{{coverPhotoId}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.DeleteCoverPhotoAsync(\"{{connection}}\", \"{{coverPhotoId}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().delete_cover_photo(\"{{session}}\", \"{{coverPhotoId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().delete_cover_photo(\"{{connection}}\", \"{{coverPhotoId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"deleteBusinessProduct": {
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/business/products/{productId}",
+ "path": "/messaging/{connection}/business/products/{productId}",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.deleteProduct(\"{{session}}\", \"{{productId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.deleteProduct(\"{{connection}}\", \"{{productId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().DeleteProduct(ctx, \"{{session}}\", \"{{productId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().DeleteProduct(ctx, \"{{connection}}\", \"{{productId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.delete_product(\"{{session}}\", \"{{productId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.delete_product(\"{{connection}}\", \"{{productId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->deleteProduct(\"{{session}}\", \"{{productId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->deleteProduct(\"{{connection}}\", \"{{productId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.DeleteProductAsync(\"{{session}}\", \"{{productId}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.DeleteProductAsync(\"{{connection}}\", \"{{productId}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().delete_product(\"{{session}}\", \"{{productId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().delete_product(\"{{connection}}\", \"{{productId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
- "deletePlatformSession": {
+ "deletePlatformConnection": {
"family": "platform",
"method": "DELETE",
- "path": "/platform/sessions/{sessionId}",
+ "path": "/platform/connections/{connectionId}",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.sessions.delete(\"{{sessionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.connections.delete(\"{{connectionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Sessions().Delete(ctx, \"{{sessionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Connections().Delete(ctx, \"{{connectionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.sessions.delete(\"{{sessionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.connections.delete(\"{{connectionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "sessions->delete(\"{{sessionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "connections->delete(\"{{connectionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Sessions.DeleteAsync(\"{{sessionId}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Connections.DeleteAsync(\"{{connectionId}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.sessions().delete(\"{{sessionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.connections().delete(\"{{connectionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"getBusinessCatalog": {
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/catalog",
+ "path": "/messaging/{connection}/business/catalog",
"credentialKind": "team_api_key",
"request": { "query": { "id": "42" } },
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getCatalog(\"{{session}}\", {\"id\": \"42\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getCatalog(\"{{connection}}\", {\"id\": \"42\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetCatalog(ctx, \"{{session}}\", sdk.BusinessCatalogParams{ID: \"42\"})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetCatalog(ctx, \"{{connection}}\", sdk.BusinessCatalogParams{ID: \"42\"})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_catalog(\"{{session}}\", {\"id\": \"42\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_catalog(\"{{connection}}\", {\"id\": \"42\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->getCatalog(\"{{session}}\", [\"id\" => \"42\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->getCatalog(\"{{connection}}\", [\"id\" => \"42\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetCatalogAsync(\"{{session}}\", new BusinessCatalogParameters(\"42\"));\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetCatalogAsync(\"{{connection}}\", new BusinessCatalogParameters(\"42\"));\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_catalog(\"{{session}}\", &polymorfa_sdk::business::BusinessCatalogParameters { id: \"42\".into(), after: None, limit: None, width: None, height: None }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_catalog(\"{{connection}}\", &polymorfa_sdk::business::BusinessCatalogParameters { id: \"42\".into(), after: None, limit: None, width: None, height: None }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"getBusinessCollection": {
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/collections/{collectionId}",
+ "path": "/messaging/{connection}/business/collections/{collectionId}",
"credentialKind": "team_api_key",
"request": { "query": { "id": "42" } },
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getCollection(\"{{session}}\", \"{{collectionId}}\", {\"id\": \"42\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getCollection(\"{{connection}}\", \"{{collectionId}}\", {\"id\": \"42\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetCollection(ctx, \"{{session}}\", \"{{collectionId}}\", sdk.BusinessCollectionParams{ID: \"42\"})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetCollection(ctx, \"{{connection}}\", \"{{collectionId}}\", sdk.BusinessCollectionParams{ID: \"42\"})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_collection(\"{{session}}\", \"{{collectionId}}\", {\"id\": \"42\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_collection(\"{{connection}}\", \"{{collectionId}}\", {\"id\": \"42\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->getCollection(\"{{session}}\", \"{{collectionId}}\", [\"id\" => \"42\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->getCollection(\"{{connection}}\", \"{{collectionId}}\", [\"id\" => \"42\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetCollectionAsync(\"{{session}}\", \"{{collectionId}}\", new BusinessCatalogParameters(\"42\"));\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetCollectionAsync(\"{{connection}}\", \"{{collectionId}}\", new BusinessCatalogParameters(\"42\"));\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_collection(\"{{session}}\", \"{{collectionId}}\", &polymorfa_sdk::business::BusinessCatalogParameters { id: \"42\".into(), after: None, limit: None, width: None, height: None }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_collection(\"{{connection}}\", \"{{collectionId}}\", &polymorfa_sdk::business::BusinessCatalogParameters { id: \"42\".into(), after: None, limit: None, width: None, height: None }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"getBusinessCollections": {
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/collections",
+ "path": "/messaging/{connection}/business/collections",
"credentialKind": "team_api_key",
"request": { "query": { "id": "42" } },
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.listCollections(\"{{session}}\", {\"id\": \"42\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.listCollections(\"{{connection}}\", {\"id\": \"42\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().ListCollections(ctx, \"{{session}}\", sdk.BusinessCollectionsParams{ID: \"42\"})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().ListCollections(ctx, \"{{connection}}\", sdk.BusinessCollectionsParams{ID: \"42\"})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.list_collections(\"{{session}}\", {\"id\": \"42\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.list_collections(\"{{connection}}\", {\"id\": \"42\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->listCollections(\"{{session}}\", [\"id\" => \"42\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->listCollections(\"{{connection}}\", [\"id\" => \"42\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.ListCollectionsAsync(\"{{session}}\", new BusinessCollectionsParameters(\"42\"));\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.ListCollectionsAsync(\"{{connection}}\", new BusinessCollectionsParameters(\"42\"));\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().list_collections(\"{{session}}\", &polymorfa_sdk::business::BusinessCollectionsParameters { id: \"42\".into(), after: None, collection_limit: None, item_limit: None, width: None, height: None }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().list_collections(\"{{connection}}\", &polymorfa_sdk::business::BusinessCollectionsParameters { id: \"42\".into(), after: None, collection_limit: None, item_limit: None, width: None, height: None }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"getBusinessEligibility": {
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/eligibility",
+ "path": "/messaging/{connection}/business/eligibility",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getEligibility(\"{{session}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getEligibility(\"{{connection}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetEligibility(ctx, \"{{session}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetEligibility(ctx, \"{{connection}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_eligibility(\"{{session}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_eligibility(\"{{connection}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->getEligibility(\"{{session}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->getEligibility(\"{{connection}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetEligibilityAsync(\"{{session}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetEligibilityAsync(\"{{connection}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_eligibility(\"{{session}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_eligibility(\"{{connection}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"getBusinessLinkedAccounts": {
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/linked-accounts",
+ "path": "/messaging/{connection}/business/linked-accounts",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getLinkedAccounts(\"{{session}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getLinkedAccounts(\"{{connection}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetLinkedAccounts(ctx, \"{{session}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetLinkedAccounts(ctx, \"{{connection}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_linked_accounts(\"{{session}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_linked_accounts(\"{{connection}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->getLinkedAccounts(\"{{session}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->getLinkedAccounts(\"{{connection}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetLinkedAccountsAsync(\"{{session}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetLinkedAccountsAsync(\"{{connection}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_linked_accounts(\"{{session}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_linked_accounts(\"{{connection}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"getBusinessMerchantCompliance": {
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/compliance",
+ "path": "/messaging/{connection}/business/compliance",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getMerchantCompliance(\"{{session}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getMerchantCompliance(\"{{connection}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetMerchantCompliance(ctx, \"{{session}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetMerchantCompliance(ctx, \"{{connection}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_merchant_compliance(\"{{session}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_merchant_compliance(\"{{connection}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->getMerchantCompliance(\"{{session}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->getMerchantCompliance(\"{{connection}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetMerchantComplianceAsync(\"{{session}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetMerchantComplianceAsync(\"{{connection}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_merchant_compliance(\"{{session}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_merchant_compliance(\"{{connection}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"getBusinessProduct": {
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/products/{productId}",
+ "path": "/messaging/{connection}/business/products/{productId}",
"credentialKind": "team_api_key",
"request": { "query": { "id": "42" } },
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getProduct(\"{{session}}\", \"{{productId}}\", {\"id\": \"42\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getProduct(\"{{connection}}\", \"{{productId}}\", {\"id\": \"42\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetProduct(ctx, \"{{session}}\", \"{{productId}}\", \"42\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetProduct(ctx, \"{{connection}}\", \"{{productId}}\", \"42\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_product(\"{{session}}\", \"{{productId}}\", {\"id\": \"42\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_product(\"{{connection}}\", \"{{productId}}\", {\"id\": \"42\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->getProduct(\"{{session}}\", \"{{productId}}\", [\"id\" => \"42\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->getProduct(\"{{connection}}\", \"{{productId}}\", [\"id\" => \"42\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetProductAsync(\"{{session}}\", \"{{productId}}\", \"42\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetProductAsync(\"{{connection}}\", \"{{productId}}\", \"42\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_product(\"{{session}}\", \"{{productId}}\", \"42\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_product(\"{{connection}}\", \"{{productId}}\", \"42\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
- "getMessageOperation": {
- "family": "messaging",
+ "getConnection": {
+ "family": "platform",
"method": "GET",
- "path": "/messaging/{session}/operations/{operationId}",
+ "path": "/platform/connections/{connectionId}",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.messages.operationStatus(\"{{session}}\", \"{{operationId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.connections.retrieve(\"{{connectionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Messages().OperationStatus(ctx, \"{{session}}\", \"{{operationId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Connections().Retrieve(ctx, \"{{connectionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.messages.operation_status(\"{{session}}\", \"{{operationId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.connections.retrieve(\"{{connectionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "messages->operationStatus(\"{{session}}\", \"{{operationId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "connections->retrieve(\"{{connectionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Messages.OperationStatusAsync(\"{{session}}\", \"{{operationId}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Connections.RetrieveAsync(\"{{connectionId}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.messages().operation_status(\"{{session}}\", \"{{operationId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.connections().retrieve(\"{{connectionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
- "getOwnBusinessProfile": {
- "family": "messaging",
+ "getConnectionAccount": {
+ "family": "platform",
"method": "GET",
- "path": "/messaging/{session}/business/profile",
+ "path": "/platform/connections/{connectionId}/me",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getProfile(\"{{session}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.connections.account(\"{{connectionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetProfile(ctx, \"{{session}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Connections().Account(ctx, \"{{connectionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_profile(\"{{session}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.connections.account(\"{{connectionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->getProfile(\"{{session}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "connections->account(\"{{connectionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetProfileAsync(\"{{session}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Connections.AccountAsync(\"{{connectionId}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_profile(\"{{session}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.connections().account(\"{{connectionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
- "getSession": {
- "family": "platform",
+ "getMessageOperation": {
+ "family": "messaging",
"method": "GET",
- "path": "/platform/sessions/{sessionId}",
+ "path": "/messaging/{connection}/operations/{operationId}",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.sessions.retrieve(\"{{sessionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.messages.operationStatus(\"{{connection}}\", \"{{operationId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Sessions().Retrieve(ctx, \"{{sessionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Messages().OperationStatus(ctx, \"{{connection}}\", \"{{operationId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.sessions.retrieve(\"{{sessionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.messages.operation_status(\"{{connection}}\", \"{{operationId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "sessions->retrieve(\"{{sessionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "messages->operationStatus(\"{{connection}}\", \"{{operationId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Sessions.RetrieveAsync(\"{{sessionId}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Messages.OperationStatusAsync(\"{{connection}}\", \"{{operationId}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.sessions().retrieve(\"{{sessionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.messages().operation_status(\"{{connection}}\", \"{{operationId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
- "getSessionAccount": {
- "family": "platform",
+ "getOwnBusinessProfile": {
+ "family": "messaging",
"method": "GET",
- "path": "/platform/sessions/{sessionId}/me",
+ "path": "/messaging/{connection}/business/profile",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.sessions.account(\"{{sessionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.getProfile(\"{{connection}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Sessions().Account(ctx, \"{{sessionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().GetProfile(ctx, \"{{connection}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.sessions.account(\"{{sessionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.get_profile(\"{{connection}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "sessions->account(\"{{sessionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->getProfile(\"{{connection}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Sessions.AccountAsync(\"{{sessionId}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.GetProfileAsync(\"{{connection}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.sessions().account(\"{{sessionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().get_profile(\"{{connection}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
- "listPlatformSessions": {
+ "listPlatformConnections": {
"family": "platform",
"method": "GET",
- "path": "/platform/sessions",
+ "path": "/platform/connections",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.sessions.list();\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.connections.list();\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Sessions().List(ctx)\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Connections().List(ctx)\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.sessions.list()\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.connections.list()\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "sessions->list();\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "connections->list();\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Sessions.ListAsync();\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Connections.ListAsync();\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.sessions().list(Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.connections().list(Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"listProjectEvents": {
@@ -523,60 +523,60 @@
"code": "use polymorfa_sdk::{TeamClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = TeamClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.projects().list(Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
- "logoutSession": {
+ "logoutConnection": {
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/logout",
+ "path": "/platform/connections/{connectionId}/logout",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.sessions.logout(\"{{sessionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.connections.logout(\"{{connectionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Sessions().Logout(ctx, \"{{sessionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Connections().Logout(ctx, \"{{connectionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.sessions.logout(\"{{sessionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.connections.logout(\"{{connectionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "sessions->logout(\"{{sessionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "connections->logout(\"{{connectionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Sessions.LogoutAsync(\"{{sessionId}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Connections.LogoutAsync(\"{{connectionId}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.sessions().logout(\"{{sessionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.connections().logout(\"{{connectionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
- "restartSession": {
+ "restartConnection": {
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/restart",
+ "path": "/platform/connections/{connectionId}/restart",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.sessions.restart(\"{{sessionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.connections.restart(\"{{connectionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Sessions().Restart(ctx, \"{{sessionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Connections().Restart(ctx, \"{{connectionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.sessions.restart(\"{{sessionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.connections.restart(\"{{connectionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "sessions->restart(\"{{sessionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "connections->restart(\"{{connectionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Sessions.RestartAsync(\"{{sessionId}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Connections.RestartAsync(\"{{connectionId}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.sessions().restart(\"{{sessionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.connections().restart(\"{{connectionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"sendMessage": {
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/send",
+ "path": "/messaging/{connection}/messages/send",
"credentialKind": "team_api_key",
"request": {
"body": {
@@ -585,228 +585,228 @@
}
},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.messages.send(\"{{session}}\", {\"conversation\": {\"phoneNumber\": \"+15550001111\"}, \"content\": {\"text\": \"Hello\"}});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.messages.send(\"{{connection}}\", {\"conversation\": {\"phoneNumber\": \"+15550001111\"}, \"content\": {\"text\": \"Hello\"}});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n text := \"Hello\"\n result, err := api.Messages().Send(ctx, \"{{session}}\", sdk.SendMessageRequest{Conversation: sdk.ConversationReference{PhoneNumber: \"+15550001111\"}, Content: sdk.MessageContent{Text: &text}})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n text := \"Hello\"\n result, err := api.Messages().Send(ctx, \"{{connection}}\", sdk.SendMessageRequest{Conversation: sdk.ConversationReference{PhoneNumber: \"+15550001111\"}, Content: sdk.MessageContent{Text: &text}})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.messages.send(\"{{session}}\", {\"conversation\": {\"phoneNumber\": \"+15550001111\"}, \"content\": {\"text\": \"Hello\"}})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.messages.send(\"{{connection}}\", {\"conversation\": {\"phoneNumber\": \"+15550001111\"}, \"content\": {\"text\": \"Hello\"}})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "messages->send(\"{{session}}\", [\"conversation\" => [\"phoneNumber\" => \"+15550001111\"], \"content\" => [\"text\" => \"Hello\"]]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "messages->send(\"{{connection}}\", [\"conversation\" => [\"phoneNumber\" => \"+15550001111\"], \"content\" => [\"text\" => \"Hello\"]]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Messages.SendAsync(\"{{session}}\", new SendMessageRequest(new ConversationReference(PhoneNumber: \"+15550001111\"), new TextContent(\"Hello\")));\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Messages.SendAsync(\"{{connection}}\", new SendMessageRequest(new ConversationReference(PhoneNumber: \"+15550001111\"), new TextContent(\"Hello\")));\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.messages().send(\"{{session}}\", &polymorfa_sdk::models::SendMessageRequest::text(polymorfa_sdk::models::ConversationReference::phone(\"+15550001111\"), \"Hello\"), Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.messages().send(\"{{connection}}\", &polymorfa_sdk::models::SendMessageRequest::text(polymorfa_sdk::models::ConversationReference::phone(\"+15550001111\"), \"Hello\"), Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"sendReaction": {
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/react",
+ "path": "/messaging/{connection}/messages/react",
"credentialKind": "team_api_key",
"request": {
"body": { "conversation": { "id": "42" }, "id": "43", "reaction": "👍" }
},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.messages.react(\"{{session}}\", {\"conversation\": {\"id\": \"42\"}, \"id\": \"43\", \"reaction\": \"👍\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.messages.react(\"{{connection}}\", {\"conversation\": {\"id\": \"42\"}, \"id\": \"43\", \"reaction\": \"👍\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Messages().React(ctx, \"{{session}}\", sdk.ReactionRequest{Conversation: sdk.ConversationReference{ID: \"42\"}, ID: \"43\", Reaction: \"👍\"})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Messages().React(ctx, \"{{connection}}\", sdk.ReactionRequest{Conversation: sdk.ConversationReference{ID: \"42\"}, ID: \"43\", Reaction: \"👍\"})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.messages.react(\"{{session}}\", {\"conversation\": {\"id\": \"42\"}, \"id\": \"43\", \"reaction\": \"👍\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.messages.react(\"{{connection}}\", {\"conversation\": {\"id\": \"42\"}, \"id\": \"43\", \"reaction\": \"👍\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "messages->react(\"{{session}}\", [\"conversation\" => [\"id\" => \"42\"], \"id\" => \"43\", \"reaction\" => \"👍\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "messages->react(\"{{connection}}\", [\"conversation\" => [\"id\" => \"42\"], \"id\" => \"43\", \"reaction\" => \"👍\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Messages.ReactAsync(\"{{session}}\", new ReactRequest(new ConversationReference(Id: \"42\"), \"43\", \"👍\"));\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Messages.ReactAsync(\"{{connection}}\", new ReactRequest(new ConversationReference(Id: \"42\"), \"43\", \"👍\"));\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.messages().react(\"{{session}}\", &polymorfa_sdk::models::ReactRequest { conversation: polymorfa_sdk::models::ConversationReference::id(\"42\"), id: \"43\".into(), reaction: \"👍\".into(), transport: None }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.messages().react(\"{{connection}}\", &polymorfa_sdk::models::ReactRequest { conversation: polymorfa_sdk::models::ConversationReference::id(\"42\"), id: \"43\".into(), reaction: \"👍\".into(), transport: None }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"sendSeen": {
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/seen",
+ "path": "/messaging/{connection}/messages/seen",
"credentialKind": "team_api_key",
"request": { "body": { "conversation": { "id": "42" }, "id": "43" } },
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.messages.markSeen(\"{{session}}\", {\"conversation\": {\"id\": \"42\"}, \"id\": \"43\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.messages.markSeen(\"{{connection}}\", {\"conversation\": {\"id\": \"42\"}, \"id\": \"43\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Messages().MarkSeen(ctx, \"{{session}}\", sdk.SeenRequest{Conversation: sdk.ConversationReference{ID: \"42\"}, ID: \"43\"})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Messages().MarkSeen(ctx, \"{{connection}}\", sdk.SeenRequest{Conversation: sdk.ConversationReference{ID: \"42\"}, ID: \"43\"})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.messages.mark_seen(\"{{session}}\", {\"conversation\": {\"id\": \"42\"}, \"id\": \"43\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.messages.mark_seen(\"{{connection}}\", {\"conversation\": {\"id\": \"42\"}, \"id\": \"43\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "messages->markSeen(\"{{session}}\", [\"conversation\" => [\"id\" => \"42\"], \"id\" => \"43\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "messages->markSeen(\"{{connection}}\", [\"conversation\" => [\"id\" => \"42\"], \"id\" => \"43\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Messages.MarkSeenAsync(\"{{session}}\", new SeenRequest(new ConversationReference(Id: \"42\"), \"43\"));\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Messages.MarkSeenAsync(\"{{connection}}\", new SeenRequest(new ConversationReference(Id: \"42\"), \"43\"));\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.messages().mark_seen(\"{{session}}\", &polymorfa_sdk::models::SeenRequest { conversation: polymorfa_sdk::models::ConversationReference::id(\"42\"), id: \"43\".into() }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.messages().mark_seen(\"{{connection}}\", &polymorfa_sdk::models::SeenRequest { conversation: polymorfa_sdk::models::ConversationReference::id(\"42\"), id: \"43\".into() }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"setBusinessCartEnabled": {
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/business/catalog/cart",
+ "path": "/messaging/{connection}/business/catalog/cart",
"credentialKind": "team_api_key",
"request": { "body": { "enabled": true } },
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.setCartEnabled(\"{{session}}\", {\"enabled\": true});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.setCartEnabled(\"{{connection}}\", {\"enabled\": true});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().SetCartEnabled(ctx, \"{{session}}\", true)\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().SetCartEnabled(ctx, \"{{connection}}\", true)\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.set_cart_enabled(\"{{session}}\", {\"enabled\": True})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.set_cart_enabled(\"{{connection}}\", {\"enabled\": True})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->setCartEnabled(\"{{session}}\", [\"enabled\" => true]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->setCartEnabled(\"{{connection}}\", [\"enabled\" => true]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.SetCartEnabledAsync(\"{{session}}\", true);\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.SetCartEnabledAsync(\"{{connection}}\", true);\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().set_cart_enabled(\"{{session}}\", &polymorfa_sdk::business::BusinessCartSettingRequest { enabled: true }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().set_cart_enabled(\"{{connection}}\", &polymorfa_sdk::business::BusinessCartSettingRequest { enabled: true }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"setBusinessProductVisibility": {
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/business/products/{productId}/visibility",
+ "path": "/messaging/{connection}/business/products/{productId}/visibility",
"credentialKind": "team_api_key",
"request": { "body": { "hidden": true } },
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.setProductVisibility(\"{{session}}\", \"{{productId}}\", {\"hidden\": true});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.business.setProductVisibility(\"{{connection}}\", \"{{productId}}\", {\"hidden\": true});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().SetProductVisibility(ctx, \"{{session}}\", \"{{productId}}\", true)\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Business().SetProductVisibility(ctx, \"{{connection}}\", \"{{productId}}\", true)\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.set_product_visibility(\"{{session}}\", \"{{productId}}\", {\"hidden\": True})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.business.set_product_visibility(\"{{connection}}\", \"{{productId}}\", {\"hidden\": True})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "business->setProductVisibility(\"{{session}}\", \"{{productId}}\", [\"hidden\" => true]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "business->setProductVisibility(\"{{connection}}\", \"{{productId}}\", [\"hidden\" => true]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.SetProductVisibilityAsync(\"{{session}}\", \"{{productId}}\", true);\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Business.SetProductVisibilityAsync(\"{{connection}}\", \"{{productId}}\", true);\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().set_product_visibility(\"{{session}}\", \"{{productId}}\", &polymorfa_sdk::business::BusinessProductVisibilityRequest { hidden: true }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.business().set_product_visibility(\"{{connection}}\", \"{{productId}}\", &polymorfa_sdk::business::BusinessProductVisibilityRequest { hidden: true }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"setTyping": {
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/typing",
+ "path": "/messaging/{connection}/messages/typing",
"credentialKind": "team_api_key",
"request": {
"body": { "conversation": { "id": "42" }, "state": "paused" }
},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.messages.setTyping(\"{{session}}\", {\"conversation\": {\"id\": \"42\"}, \"state\": \"paused\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.messages.setTyping(\"{{connection}}\", {\"conversation\": {\"id\": \"42\"}, \"state\": \"paused\"});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Messages().SetTyping(ctx, \"{{session}}\", sdk.TypingRequest{Conversation: sdk.ConversationReference{ID: \"42\"}, State: \"paused\"})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Messages().SetTyping(ctx, \"{{connection}}\", sdk.TypingRequest{Conversation: sdk.ConversationReference{ID: \"42\"}, State: \"paused\"})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.messages.set_typing(\"{{session}}\", {\"conversation\": {\"id\": \"42\"}, \"state\": \"paused\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.messages.set_typing(\"{{connection}}\", {\"conversation\": {\"id\": \"42\"}, \"state\": \"paused\"})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "messages->setTyping(\"{{session}}\", [\"conversation\" => [\"id\" => \"42\"], \"state\" => \"paused\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "messages->setTyping(\"{{connection}}\", [\"conversation\" => [\"id\" => \"42\"], \"state\" => \"paused\"]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Messages.SetTypingAsync(\"{{session}}\", new TypingRequest(new ConversationReference(Id: \"42\"), \"paused\"));\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Messages.SetTypingAsync(\"{{connection}}\", new TypingRequest(new ConversationReference(Id: \"42\"), \"paused\"));\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.messages().set_typing(\"{{session}}\", &polymorfa_sdk::models::TypingRequest { conversation: polymorfa_sdk::models::ConversationReference::id(\"42\"), id: None, state: polymorfa_sdk::models::TypingState::Paused }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.messages().set_typing(\"{{connection}}\", &polymorfa_sdk::models::TypingRequest { conversation: polymorfa_sdk::models::ConversationReference::id(\"42\"), id: None, state: polymorfa_sdk::models::TypingState::Paused }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
"starMessage": {
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/star",
+ "path": "/messaging/{connection}/messages/star",
"credentialKind": "team_api_key",
"request": {
"body": { "conversation": { "id": "42" }, "id": "43", "star": false }
},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.messages.star(\"{{session}}\", {\"conversation\": {\"id\": \"42\"}, \"id\": \"43\", \"star\": false});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.messages.star(\"{{connection}}\", {\"conversation\": {\"id\": \"42\"}, \"id\": \"43\", \"star\": false});\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Messages().Star(ctx, \"{{session}}\", sdk.StarRequest{Conversation: sdk.ConversationReference{ID: \"42\"}, ID: \"43\", Star: false})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Messages().Star(ctx, \"{{connection}}\", sdk.StarRequest{Conversation: sdk.ConversationReference{ID: \"42\"}, ID: \"43\", Star: false})\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.messages.star(\"{{session}}\", {\"conversation\": {\"id\": \"42\"}, \"id\": \"43\", \"star\": False})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.messages.star(\"{{connection}}\", {\"conversation\": {\"id\": \"42\"}, \"id\": \"43\", \"star\": False})\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "messages->star(\"{{session}}\", [\"conversation\" => [\"id\" => \"42\"], \"id\" => \"43\", \"star\" => false]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "messages->star(\"{{connection}}\", [\"conversation\" => [\"id\" => \"42\"], \"id\" => \"43\", \"star\" => false]);\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Messages.StarAsync(\"{{session}}\", new StarRequest(new ConversationReference(Id: \"42\"), \"43\", false));\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Messages.StarAsync(\"{{connection}}\", new StarRequest(new ConversationReference(Id: \"42\"), \"43\", false));\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.messages().star(\"{{session}}\", &polymorfa_sdk::models::StarRequest { conversation: polymorfa_sdk::models::ConversationReference::id(\"42\"), id: \"43\".into(), star: false }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.messages().star(\"{{connection}}\", &polymorfa_sdk::models::StarRequest { conversation: polymorfa_sdk::models::ConversationReference::id(\"42\"), id: \"43\".into(), star: false }, Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
- "startPlatformSession": {
+ "startPlatformConnection": {
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/start",
+ "path": "/platform/connections/{connectionId}/start",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.sessions.start(\"{{sessionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.connections.start(\"{{connectionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Sessions().Start(ctx, \"{{sessionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Connections().Start(ctx, \"{{connectionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.sessions.start(\"{{sessionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.connections.start(\"{{connectionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "sessions->start(\"{{sessionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "connections->start(\"{{connectionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Sessions.StartAsync(\"{{sessionId}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Connections.StartAsync(\"{{connectionId}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.sessions().start(\"{{sessionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.connections().start(\"{{connectionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
},
- "stopPlatformSession": {
+ "stopPlatformConnection": {
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/stop",
+ "path": "/platform/connections/{connectionId}/stop",
"credentialKind": "team_api_key",
"request": {},
"typescript": {
- "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.sessions.stop(\"{{sessionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
+ "code": "import { MessagingClient } from \"@polymorfa/sdk\";\n\nasync function main(): Promise {\n const sdk = new MessagingClient({ credential: { type: \"apiKey\", value: \"{{POLYMORFA_API_KEY}}\" } });\n const result = await sdk.connections.stop(\"{{connectionId}}\");\n console.log(result);\n}\n\nmain().catch((error: unknown) => { console.error(error); process.exitCode = 1; });\n"
},
"go": {
- "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Sessions().Stop(ctx, \"{{sessionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
+ "code": "package main\n\nimport (\n \"context\"\n \"fmt\"\n \"log\"\n sdk \"github.com/polymorfa/sdks/packages/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n api, err := sdk.NewMessagingClient(sdk.Config{Credential: sdk.Credential{Kind: sdk.TeamAPIKey, Value: \"{{POLYMORFA_API_KEY}}\"}})\n if err != nil { log.Fatal(err) }\n result, err := api.Connections().Stop(ctx, \"{{connectionId}}\")\n if err != nil { log.Fatal(err) }\n fmt.Println(result)\n}\n"
},
"python": {
- "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.sessions.stop(\"{{sessionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
+ "code": "import asyncio\nfrom polymorfa import AsyncMessagingClient, Credential\n\n\nasync def main() -> None:\n async with AsyncMessagingClient(Credential(\"team_api_key\", \"{{POLYMORFA_API_KEY}}\")) as sdk:\n result = await sdk.connections.stop(\"{{connectionId}}\")\n print(result)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n"
},
"php": {
- "code": "sessions->stop(\"{{sessionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
+ "code": "connections->stop(\"{{connectionId}}\");\necho json_encode($result->data, JSON_THROW_ON_ERROR), PHP_EOL;\n"
},
"dotnet": {
- "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Sessions.StopAsync(\"{{sessionId}}\");\nConsole.WriteLine(result);\n"
+ "code": "using System;\nusing Polymorfa.Sdk;\n\nusing var sdk = new MessagingClient(Credential.TeamApiKey(\"{{POLYMORFA_API_KEY}}\"));\nvar result = await sdk.Connections.StopAsync(\"{{connectionId}}\");\nConsole.WriteLine(result);\n"
},
"rust": {
- "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.sessions().stop(\"{{sessionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
+ "code": "use polymorfa_sdk::{MessagingClient, ClientOptions, Credential};\n\n#[tokio::main(flavor = \"current_thread\")]\nasync fn main() -> Result<(), Box> {\n let sdk = MessagingClient::new(Credential::team_api_key(\"{{POLYMORFA_API_KEY}}\")?, ClientOptions::default())?;\n let result = sdk.connections().stop(\"{{connectionId}}\", Default::default()).await?;\n println!(\"{:?}\", result);\n Ok(())\n}\n"
}
}
}
diff --git a/contracts/doc-snippets.md b/contracts/doc-snippets.md
index a9841688b..078730331 100644
--- a/contracts/doc-snippets.md
+++ b/contracts/doc-snippets.md
@@ -9,7 +9,7 @@ later tooling or documentation commit does not create a self-reference.
The current source includes main's separately pinned webhook phone-offline
supplement. The baseline stays at `Polymorfa-Version: 2026-09-22`, with API source
-`f180dc1ee2bd45dbecf01702f73bdd75c664634b` (polymorfa/polymorfa#887) and the two
+`15db8b1c9d88e2ceccb58c851e731feabb659a39` (the Connection source candidate) and the two
hashes in `specs`.
Separately pinned supplements retain their own versions. The generator rejects
changed source files, coverage pins and OpenAPI snapshots until the source is
@@ -25,15 +25,15 @@ reference being rendered. A newer or mismatched page uses cURL, even if its
operation ID has the same spelling. Do not rewrite an older SDK call to fit it.
Replace `{{POLYMORFA_API_KEY}}` with a credential of the explicit
-`credentialKind`. These recipes use an **team API key** and the matching
+`credentialKind`. These recipes use a **team API key** and the matching
client principal. A project Test key does not authorize team operations.
The docs renderer owns key selection and retrieval; this catalog never retrieves,
stores or logs a reader's key. It must escape substituted values as string
literals in the selected language. Plain text replacement of untrusted values is
unsafe, particularly for PHP dollar interpolation and quote/backslash handling.
-Every spec path parameter appears under its exact name, such as `{{session}}`,
-`{{sessionId}}`, `{{projectId}}`, `{{operationId}}` and `{{collectionId}}`.
+Every spec path parameter appears under its exact name, such as `{{connection}}`,
+`{{connectionId}}`, `{{projectId}}`, `{{operationId}}` and `{{collectionId}}`.
Preserve their names when consuming the artifact. Non-path request values are
synthetic examples: replace the send recipient `+15550001111`, message IDs,
business ID `42` and product IDs with values authorized for the intended request.
@@ -42,8 +42,8 @@ recipe. Its schemas and union branches are validated against the pinned OpenAPI.
No optional request fields are included in this initial catalog.
There are **31 operations per language**, 186 complete programs. The TypeScript
-coverage ledger contains 457 covered operations (**426 omitted**) and each
-native ledger 451 (**420 omitted**). The initial recipes cover text sends, message actions, session
+coverage ledger contains 460 covered operations (**429 omitted**) and each
+native ledger 454 (**423 omitted**). The initial recipes cover text sends, message actions, Connection
lifecycle, business profiles/catalogs/collections and project event listing.
The remaining operations have no verified recipe in this catalog and retain
cURL fallback. Coverage of a method does not imply a verified documentation
diff --git a/contracts/fixtures/connections/behavior.json b/contracts/fixtures/connections/behavior.json
new file mode 100644
index 000000000..30f3874e3
--- /dev/null
+++ b/contracts/fixtures/connections/behavior.json
@@ -0,0 +1,1203 @@
+{
+ "schemaVersion": 1,
+ "sourceSdkCommit": "d80b581c",
+ "apiVersion": "2026-09-22",
+ "teamCredential": "pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "projectCredential": "pmfa_pt_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "scenarios": [
+ {
+ "id": "connections-list",
+ "request": {
+ "method": "GET",
+ "path": "/platform/connections",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ },
+ "query": {}
+ },
+ "responses": [
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "data": [
+ {
+ "_id": "number_fixture",
+ "_creationTime": 1787133600000,
+ "projectId": "project_fixture",
+ "connectionId": "session_fixture",
+ "name": "support",
+ "phone": null,
+ "platform": null,
+ "isBusiness": false,
+ "testMode": true,
+ "tierOverride": null,
+ "status": "CONNECTED",
+ "messageCount": 0,
+ "lastActiveAt": null,
+ "paidUntil": null
+ }
+ ]
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1
+ }
+ },
+ {
+ "id": "query-encoding",
+ "request": {
+ "method": "GET",
+ "path": "/platform/connections",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ },
+ "query": {
+ "limit": "25",
+ "active": "true",
+ "tag": ["alpha", "beta"],
+ "search": "a & b"
+ }
+ },
+ "responses": [
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1
+ }
+ },
+ {
+ "id": "message-send",
+ "request": {
+ "method": "POST",
+ "path": "/messaging/support/messages/send",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22",
+ "idempotency-key": "send-fixture"
+ },
+ "body": {
+ "conversation": {
+ "phoneNumber": "+15551234567"
+ },
+ "content": {
+ "text": "Hello"
+ }
+ }
+ },
+ "responses": [
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "success": true,
+ "data": {
+ "id": "msg_fixture",
+ "whatsapp_ids": {
+ "linked_devices": "provider_fixture"
+ },
+ "conversation": {
+ "id": "user_fixture"
+ },
+ "timestamp": "2026-08-19T10:00:00Z",
+ "status": "sent",
+ "type": "text"
+ }
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1
+ }
+ },
+ {
+ "id": "safe-retry",
+ "request": {
+ "method": "GET",
+ "path": "/platform/connections",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ },
+ "query": {}
+ },
+ "responses": [
+ {
+ "status": 503,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ },
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 2
+ }
+ },
+ {
+ "id": "rate-limit-retry",
+ "request": {
+ "method": "GET",
+ "path": "/platform/connections",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ },
+ "query": {}
+ },
+ "responses": [
+ {
+ "status": 429,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ },
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 2
+ }
+ },
+ {
+ "id": "unsafe-no-retry",
+ "request": {
+ "method": "POST",
+ "path": "/messaging/fixtures/mutation",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "fixture": true
+ }
+ },
+ "responses": [
+ {
+ "status": 503,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ },
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "error": "server"
+ }
+ },
+ {
+ "id": "idempotent-retry",
+ "request": {
+ "method": "POST",
+ "path": "/messaging/fixtures/mutation",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22",
+ "idempotency-key": "fixture-stable-key"
+ },
+ "body": {
+ "fixture": true
+ }
+ },
+ "responses": [
+ {
+ "status": 503,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ },
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 2
+ }
+ },
+ {
+ "id": "replayed-final",
+ "request": {
+ "method": "POST",
+ "path": "/messaging/fixtures/mutation",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22",
+ "idempotency-key": "fixture-stable-key"
+ },
+ "body": {
+ "fixture": true
+ }
+ },
+ "responses": [
+ {
+ "status": 503,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "idempotent-replayed": "true"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ },
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "error": "server"
+ }
+ },
+ {
+ "id": "error-400",
+ "request": {
+ "method": "GET",
+ "path": "/messaging/fixtures/error",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ }
+ },
+ "responses": [
+ {
+ "status": 400,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0"
+ },
+ "body": {
+ "error": {
+ "code": "fixture_error",
+ "message": "Fixture rejection",
+ "request_id": "req_body",
+ "request_log_url": "https://console.polymorfa.com/logs/fixture"
+ },
+ "docs": "https://docs.polymorfa.com/errors"
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "maxNetworkRetries": 0,
+ "error": "validation",
+ "code": "fixture_error",
+ "requestId": "req_body",
+ "metadataRequestId": "req_fixture"
+ }
+ },
+ {
+ "id": "error-401",
+ "request": {
+ "method": "GET",
+ "path": "/messaging/fixtures/error",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ }
+ },
+ "responses": [
+ {
+ "status": 401,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0"
+ },
+ "body": {
+ "error": {
+ "code": "fixture_error",
+ "message": "Fixture rejection",
+ "request_id": "req_body",
+ "request_log_url": "https://console.polymorfa.com/logs/fixture"
+ },
+ "docs": "https://docs.polymorfa.com/errors"
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "maxNetworkRetries": 0,
+ "error": "authentication",
+ "code": "fixture_error",
+ "requestId": "req_body",
+ "metadataRequestId": "req_fixture"
+ }
+ },
+ {
+ "id": "error-402",
+ "request": {
+ "method": "GET",
+ "path": "/messaging/fixtures/error",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ }
+ },
+ "responses": [
+ {
+ "status": 402,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0"
+ },
+ "body": {
+ "error": {
+ "code": "fixture_error",
+ "message": "Fixture rejection",
+ "request_id": "req_body",
+ "request_log_url": "https://console.polymorfa.com/logs/fixture"
+ },
+ "docs": "https://docs.polymorfa.com/errors"
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "maxNetworkRetries": 0,
+ "error": "payment_required",
+ "code": "fixture_error",
+ "requestId": "req_body",
+ "metadataRequestId": "req_fixture"
+ }
+ },
+ {
+ "id": "error-403",
+ "request": {
+ "method": "GET",
+ "path": "/messaging/fixtures/error",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ }
+ },
+ "responses": [
+ {
+ "status": 403,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0"
+ },
+ "body": {
+ "error": {
+ "code": "fixture_error",
+ "message": "Fixture rejection",
+ "request_id": "req_body",
+ "request_log_url": "https://console.polymorfa.com/logs/fixture"
+ },
+ "docs": "https://docs.polymorfa.com/errors"
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "maxNetworkRetries": 0,
+ "error": "authorization",
+ "code": "fixture_error",
+ "requestId": "req_body",
+ "metadataRequestId": "req_fixture"
+ }
+ },
+ {
+ "id": "error-404",
+ "request": {
+ "method": "GET",
+ "path": "/messaging/fixtures/error",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ }
+ },
+ "responses": [
+ {
+ "status": 404,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0"
+ },
+ "body": {
+ "error": {
+ "code": "fixture_error",
+ "message": "Fixture rejection",
+ "request_id": "req_body",
+ "request_log_url": "https://console.polymorfa.com/logs/fixture"
+ },
+ "docs": "https://docs.polymorfa.com/errors"
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "maxNetworkRetries": 0,
+ "error": "not_found",
+ "code": "fixture_error",
+ "requestId": "req_body",
+ "metadataRequestId": "req_fixture"
+ }
+ },
+ {
+ "id": "error-409",
+ "request": {
+ "method": "GET",
+ "path": "/messaging/fixtures/error",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ }
+ },
+ "responses": [
+ {
+ "status": 409,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0"
+ },
+ "body": {
+ "error": {
+ "code": "fixture_error",
+ "message": "Fixture rejection",
+ "request_id": "req_body",
+ "request_log_url": "https://console.polymorfa.com/logs/fixture"
+ },
+ "docs": "https://docs.polymorfa.com/errors"
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "maxNetworkRetries": 0,
+ "error": "conflict",
+ "code": "fixture_error",
+ "requestId": "req_body",
+ "metadataRequestId": "req_fixture"
+ }
+ },
+ {
+ "id": "error-422",
+ "request": {
+ "method": "GET",
+ "path": "/messaging/fixtures/error",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ }
+ },
+ "responses": [
+ {
+ "status": 422,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0"
+ },
+ "body": {
+ "error": {
+ "code": "fixture_error",
+ "message": "Fixture rejection",
+ "request_id": "req_body",
+ "request_log_url": "https://console.polymorfa.com/logs/fixture"
+ },
+ "docs": "https://docs.polymorfa.com/errors"
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "maxNetworkRetries": 0,
+ "error": "validation",
+ "code": "fixture_error",
+ "requestId": "req_body",
+ "metadataRequestId": "req_fixture"
+ }
+ },
+ {
+ "id": "error-429",
+ "request": {
+ "method": "GET",
+ "path": "/messaging/fixtures/error",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ }
+ },
+ "responses": [
+ {
+ "status": 429,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0"
+ },
+ "body": {
+ "error": {
+ "code": "fixture_error",
+ "message": "Fixture rejection",
+ "request_id": "req_body",
+ "request_log_url": "https://console.polymorfa.com/logs/fixture"
+ },
+ "docs": "https://docs.polymorfa.com/errors"
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "maxNetworkRetries": 0,
+ "error": "rate_limit",
+ "code": "fixture_error",
+ "requestId": "req_body",
+ "metadataRequestId": "req_fixture"
+ }
+ },
+ {
+ "id": "error-500",
+ "request": {
+ "method": "GET",
+ "path": "/messaging/fixtures/error",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ }
+ },
+ "responses": [
+ {
+ "status": 500,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0"
+ },
+ "body": {
+ "error": {
+ "code": "fixture_error",
+ "message": "Fixture rejection",
+ "request_id": "req_body",
+ "request_log_url": "https://console.polymorfa.com/logs/fixture"
+ },
+ "docs": "https://docs.polymorfa.com/errors"
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "maxNetworkRetries": 0,
+ "error": "server",
+ "code": "fixture_error",
+ "requestId": "req_body",
+ "metadataRequestId": "req_fixture"
+ }
+ },
+ {
+ "id": "html-error",
+ "request": {
+ "method": "GET",
+ "path": "/messaging/fixtures/error",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ }
+ },
+ "responses": [
+ {
+ "status": 502,
+ "headers": {
+ "content-type": "text/html",
+ "x-request-id": "req_proxy"
+ },
+ "rawBody": "proxy failure"
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "maxNetworkRetries": 0,
+ "error": "server"
+ }
+ },
+ {
+ "id": "timeout",
+ "request": {
+ "method": "GET",
+ "path": "/platform/connections",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ },
+ "query": {}
+ },
+ "responses": [
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ },
+ "delayMs": 250
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "timeoutMs": 20,
+ "maxNetworkRetries": 0,
+ "error": "timeout"
+ }
+ },
+ {
+ "id": "cancellation",
+ "request": {
+ "method": "GET",
+ "path": "/platform/connections",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ },
+ "query": {}
+ },
+ "responses": [
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ },
+ "delayMs": 250
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "cancelAfterMs": 20,
+ "maxNetworkRetries": 0,
+ "error": "cancelled"
+ }
+ },
+ {
+ "id": "no-content",
+ "request": {
+ "method": "DELETE",
+ "path": "/messaging/fixtures/item",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22"
+ }
+ },
+ "responses": [
+ {
+ "status": 204,
+ "headers": {
+ "x-request-id": "req_empty"
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "data": null
+ }
+ },
+ {
+ "id": "request-version",
+ "request": {
+ "method": "GET",
+ "path": "/platform/connections",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-10-01"
+ },
+ "query": {}
+ },
+ "responses": [
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-10-01"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1
+ }
+ },
+ {
+ "id": "operation-admitted-final",
+ "request": {
+ "method": "POST",
+ "path": "/messaging/fixtures/mutation",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22",
+ "idempotency-key": "fixture-stable-key"
+ },
+ "body": {
+ "fixture": true
+ }
+ },
+ "responses": [
+ {
+ "status": 503,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0",
+ "x-polymorfa-operation-id": "op_fixture"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ },
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ }
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "error": "server",
+ "operationId": "op_fixture"
+ }
+ },
+ {
+ "id": "operation-admitted-body-timeout",
+ "request": {
+ "method": "POST",
+ "path": "/messaging/fixtures/mutation",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22",
+ "idempotency-key": "fixture-stable-key"
+ },
+ "body": {
+ "fixture": true
+ }
+ },
+ "responses": [
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0",
+ "x-polymorfa-operation-id": "op_fixture"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ },
+ "bodyDelayMs": 250
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "error": "timeout",
+ "operationId": "op_fixture",
+ "metadataRequestId": "req_fixture",
+ "timeoutMs": 75
+ }
+ },
+ {
+ "id": "operation-admitted-body-truncated",
+ "request": {
+ "method": "POST",
+ "path": "/messaging/fixtures/mutation",
+ "headers": {
+ "authorization": "Bearer pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "polymorfa-version": "2026-09-22",
+ "idempotency-key": "fixture-stable-key"
+ },
+ "body": {
+ "fixture": true
+ }
+ },
+ "responses": [
+ {
+ "status": 200,
+ "headers": {
+ "content-type": "application/json",
+ "x-request-id": "req_fixture",
+ "polymorfa-version": "2026-09-22",
+ "retry-after": "0",
+ "x-polymorfa-operation-id": "op_fixture"
+ },
+ "body": {
+ "data": {
+ "id": "fixture"
+ }
+ },
+ "disconnectAfterBytes": 6
+ }
+ ],
+ "outcome": {
+ "attempts": 1,
+ "error": "connection",
+ "operationId": "op_fixture",
+ "metadataRequestId": "req_fixture",
+ "timeoutMs": 1000
+ }
+ }
+ ],
+ "webhooks": [
+ {
+ "id": "native-unknown",
+ "protocol": "native",
+ "body": "{\"id\":\"evt_fixture\",\"connection\":\"support\",\"timestamp\":\"2026-08-19T10:00:00Z\",\"event\":\"future.ready\",\"payload\":{\"capability\":42}}",
+ "secret": "fixture-secret",
+ "signature": "73d99b218c7e61dcd19df2f845229e2e290275a546b7bb6e565395df7a7124a0",
+ "valid": true,
+ "event": "future.ready"
+ },
+ {
+ "id": "native-prefixed",
+ "protocol": "native",
+ "body": "{\"id\":\"evt_fixture\",\"connection\":\"support\",\"timestamp\":\"2026-08-19T10:00:00Z\",\"event\":\"future.ready\",\"payload\":{\"capability\":42}}",
+ "secret": "fixture-secret",
+ "signature": "sha256=73d99b218c7e61dcd19df2f845229e2e290275a546b7bb6e565395df7a7124a0",
+ "valid": true
+ },
+ {
+ "id": "native-replay",
+ "protocol": "native",
+ "body": "{\"id\":\"evt_fixture\",\"connection\":\"support\",\"timestamp\":\"2026-08-19T10:00:00Z\",\"event\":\"future.ready\",\"payload\":{\"capability\":42}}",
+ "secret": "fixture-secret",
+ "signature": "73d99b218c7e61dcd19df2f845229e2e290275a546b7bb6e565395df7a7124a0",
+ "valid": true,
+ "note": "A repeated native signature stays valid; application event-ID deduplication is separate."
+ },
+ {
+ "id": "native-mutated",
+ "protocol": "native",
+ "body": "{\"id\":\"evt_fixture\",\"connection\":\"support\",\"timestamp\":\"2026-08-19T10:00:00Z\",\"event\":\"future.ready\",\"payload\":{\"capability\":42}} ",
+ "secret": "fixture-secret",
+ "signature": "8b9682c1aee07cf45ce4b83983c2c224000ae4f8289c1ff38169bec4a52c6edd",
+ "valid": false
+ },
+ {
+ "id": "native-malformed",
+ "protocol": "native",
+ "body": "{\"id\":\"evt_fixture\",\"connection\":\"support\",\"timestamp\":\"2026-08-19T10:00:00Z\",\"event\":\"future.ready\",\"payload\":{\"capability\":42}}",
+ "secret": "fixture-secret",
+ "signature": "not-hex",
+ "valid": false
+ },
+ {
+ "id": "native-empty-secret",
+ "protocol": "native",
+ "body": "{\"id\":\"evt_fixture\",\"connection\":\"support\",\"timestamp\":\"2026-08-19T10:00:00Z\",\"event\":\"future.ready\",\"payload\":{\"capability\":42}}",
+ "secret": "",
+ "signature": "8b9682c1aee07cf45ce4b83983c2c224000ae4f8289c1ff38169bec4a52c6edd",
+ "valid": false
+ },
+ {
+ "id": "local-10",
+ "protocol": "local",
+ "body": "{\"id\":\"evt_fixture\",\"connection\":\"support\",\"timestamp\":\"2026-08-19T10:00:00Z\",\"event\":\"future.ready\",\"payload\":{\"capability\":42}}",
+ "secret": "BwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwc",
+ "signature": "t=1787133600,v1=4a8f8fa8171e153c7b2d9b44b0765238e6fe208ffa49ee6ba368f63484f402f7",
+ "nowUnixSeconds": 1787133610,
+ "toleranceSeconds": 300,
+ "valid": true
+ },
+ {
+ "id": "local-300",
+ "protocol": "local",
+ "body": "{\"id\":\"evt_fixture\",\"connection\":\"support\",\"timestamp\":\"2026-08-19T10:00:00Z\",\"event\":\"future.ready\",\"payload\":{\"capability\":42}}",
+ "secret": "BwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwc",
+ "signature": "t=1787133600,v1=4a8f8fa8171e153c7b2d9b44b0765238e6fe208ffa49ee6ba368f63484f402f7",
+ "nowUnixSeconds": 1787133900,
+ "toleranceSeconds": 300,
+ "valid": true
+ },
+ {
+ "id": "local-301",
+ "protocol": "local",
+ "body": "{\"id\":\"evt_fixture\",\"connection\":\"support\",\"timestamp\":\"2026-08-19T10:00:00Z\",\"event\":\"future.ready\",\"payload\":{\"capability\":42}}",
+ "secret": "BwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwc",
+ "signature": "t=1787133600,v1=4a8f8fa8171e153c7b2d9b44b0765238e6fe208ffa49ee6ba368f63484f402f7",
+ "nowUnixSeconds": 1787133901,
+ "toleranceSeconds": 300,
+ "valid": false
+ },
+ {
+ "id": "local--301",
+ "protocol": "local",
+ "body": "{\"id\":\"evt_fixture\",\"connection\":\"support\",\"timestamp\":\"2026-08-19T10:00:00Z\",\"event\":\"future.ready\",\"payload\":{\"capability\":42}}",
+ "secret": "BwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwc",
+ "signature": "t=1787133600,v1=4a8f8fa8171e153c7b2d9b44b0765238e6fe208ffa49ee6ba368f63484f402f7",
+ "nowUnixSeconds": 1787133299,
+ "toleranceSeconds": 300,
+ "valid": false
+ }
+ ],
+ "configuration": [
+ {
+ "id": "team-valid",
+ "client": "platform",
+ "credentialType": "teamApiKey",
+ "credential": "pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "valid": true
+ },
+ {
+ "id": "messaging-team-valid",
+ "client": "messaging",
+ "credentialType": "apiKey",
+ "credential": "pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "valid": true
+ },
+ {
+ "id": "project-valid",
+ "client": "platform",
+ "credentialType": "projectToken",
+ "credential": "pmfa_pt_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "projectId": "project_fixture",
+ "valid": true
+ },
+ {
+ "id": "project-missing-id",
+ "client": "platform",
+ "credentialType": "projectToken",
+ "credential": "pmfa_pt_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "valid": false,
+ "field": "projectId"
+ },
+ {
+ "id": "project-noncanonical-tail",
+ "client": "platform",
+ "credentialType": "projectToken",
+ "credential": "pmfa_pt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaB",
+ "projectId": "project_fixture",
+ "valid": false,
+ "field": "credential"
+ },
+ {
+ "id": "team-short",
+ "client": "platform",
+ "credentialType": "teamApiKey",
+ "credential": "pmfa_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "valid": false,
+ "field": "credential"
+ },
+ {
+ "id": "team-wrong-principal",
+ "client": "platform",
+ "credentialType": "teamApiKey",
+ "credential": "pmfa_pt_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "valid": false,
+ "field": "credential"
+ },
+ {
+ "id": "project-wrong-principal",
+ "client": "platform",
+ "credentialType": "projectToken",
+ "credential": "pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "projectId": "project_fixture",
+ "valid": false,
+ "field": "credential"
+ },
+ {
+ "id": "listener-refused",
+ "client": "platform",
+ "credentialType": "teamApiKey",
+ "credential": "pmfa_ls_fixture",
+ "valid": false,
+ "field": "credential"
+ },
+ {
+ "id": "client-token-refused-platform",
+ "client": "platform",
+ "credentialType": "projectToken",
+ "credential": "pmfa_ct_Zml4dHVyZQ",
+ "projectId": "project_fixture",
+ "valid": false,
+ "field": "credential"
+ },
+ {
+ "id": "client-token-valid-messaging",
+ "client": "messaging",
+ "credentialType": "clientToken",
+ "credential": "pmfa_ct_Zml4dHVyZQ",
+ "valid": true
+ },
+ {
+ "id": "invalid-base-url",
+ "client": "platform",
+ "credentialType": "teamApiKey",
+ "credential": "pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "baseUrl": "https://user:password@example.invalid",
+ "valid": false,
+ "field": "baseUrl"
+ },
+ {
+ "id": "negative-retries",
+ "client": "platform",
+ "credentialType": "teamApiKey",
+ "credential": "pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "maxNetworkRetries": -1,
+ "valid": false
+ },
+ {
+ "id": "zero-timeout",
+ "client": "platform",
+ "credentialType": "teamApiKey",
+ "credential": "pmfa_AAECAwQFBgcICQoLDA0ODxAREhM73f-k",
+ "timeoutMs": 0,
+ "valid": false
+ }
+ ],
+ "derivedFrom": "contracts/fixtures/behavior.json",
+ "apiSource": "1c1c88f04bac58ba1f006af9d4879fa0648576cb",
+ "published": false
+}
diff --git a/contracts/fixtures/connections/campaign-webhook-metadata.json b/contracts/fixtures/connections/campaign-webhook-metadata.json
new file mode 100644
index 000000000..c9b198785
--- /dev/null
+++ b/contracts/fixtures/connections/campaign-webhook-metadata.json
@@ -0,0 +1,82 @@
+{
+ "source": "9bb1e2ed92d8b4a07ff727f8e7ae185498f0868f",
+ "secret": "campaign-fixture-only",
+ "batchId": "00000000-0000-4000-8000-000000000001",
+ "events": [
+ {
+ "id": "auto",
+ "connection": "",
+ "timestamp": "2026-10-22T00:00:00Z",
+ "event": "campaign.paused",
+ "payload": {
+ "campaignId": "01936b2e-5f2a-7c1d-9a3e-8b4c2d1e0f11",
+ "sentCount": 3,
+ "remainingCount": 7,
+ "pausedAt": 1757161200,
+ "reason": "Automatic safety pause",
+ "code": "future_automatic_pause",
+ "future": {
+ "kept": true
+ }
+ }
+ },
+ {
+ "id": "manual",
+ "connection": "",
+ "timestamp": "2026-10-22T00:00:00Z",
+ "event": "campaign.paused",
+ "payload": {
+ "campaignId": "01936b2e-5f2a-7c1d-9a3e-8b4c2d1e0f11",
+ "sentCount": 3,
+ "remainingCount": 7,
+ "pausedAt": 1757161200
+ }
+ },
+ {
+ "id": "sequence",
+ "connection": "",
+ "timestamp": "2026-10-22T00:00:00Z",
+ "event": "campaign.recipient_skipped",
+ "payload": {
+ "campaignId": "01936b2e-5f2a-7c1d-9a3e-8b4c2d1e0f11",
+ "recipientId": "01936b2e-6a11-7d2e-8f4a-1c2b3d4e5f66",
+ "phone": "+14155550123",
+ "reason": "frequency_cap_exceeded",
+ "skippedAt": 1757161200000,
+ "messageIndex": 0
+ }
+ },
+ {
+ "id": "followup",
+ "connection": "",
+ "timestamp": "2026-10-22T00:00:00Z",
+ "event": "campaign.recipient_skipped",
+ "payload": {
+ "campaignId": "01936b2e-5f2a-7c1d-9a3e-8b4c2d1e0f11",
+ "recipientId": "01936b2e-6a11-7d2e-8f4a-1c2b3d4e5f66",
+ "phone": "+14155550123",
+ "reason": "frequency_cap_exceeded",
+ "skippedAt": 1757161200000,
+ "messageIndex": 1,
+ "followUpId": "0198a2cb-0000-7000-8000-0000000000f1"
+ }
+ },
+ {
+ "id": "plain",
+ "connection": "",
+ "timestamp": "2026-10-22T00:00:00Z",
+ "event": "campaign.recipient_skipped",
+ "payload": {
+ "campaignId": "01936b2e-5f2a-7c1d-9a3e-8b4c2d1e0f11",
+ "recipientId": "01936b2e-6a11-7d2e-8f4a-1c2b3d4e5f66",
+ "phone": "+14155550123",
+ "reason": "future_skip_reason",
+ "skippedAt": 1757161200000
+ }
+ }
+ ],
+ "derivedFrom": "contracts/fixtures/campaign-webhook-metadata.json",
+ "sourceAccepted": false,
+ "published": false,
+ "apiSource": "1c1c88f04bac58ba1f006af9d4879fa0648576cb"
+}
diff --git a/contracts/fixtures/connections/passkeys.candidate.json b/contracts/fixtures/connections/passkeys.candidate.json
new file mode 100644
index 000000000..ca5c850fe
--- /dev/null
+++ b/contracts/fixtures/connections/passkeys.candidate.json
@@ -0,0 +1,58 @@
+{
+ "schemaVersion": 1,
+ "candidateSource": "77e9ce31aa5e0ea58815662ba0028f1927f690d5",
+ "sourceAccepted": false,
+ "connection": "desk/1",
+ "ticketId": "ticket/?",
+ "issue": {
+ "challengeB64Url": "AQIDBAUGBwgJCgsMDQ4PEA",
+ "ttlSeconds": 300
+ },
+ "assertion": {
+ "ticketId": "ticket/?",
+ "assertion": {
+ "id": "aWQ",
+ "rawIdB64Url": "aWQ",
+ "response": {
+ "authenticatorDataB64": "AQID",
+ "clientDataJSONB64": "e30",
+ "signatureB64": "AQID",
+ "userHandleB64": "dXNlcg"
+ }
+ }
+ },
+ "confirm": {
+ "ticketId": "ticket/?",
+ "code": "ABCD-EF12"
+ },
+ "ticket": {
+ "version": 2,
+ "ticket": "ticket/?",
+ "connection": "desk/1",
+ "rpId": "whatsapp.com",
+ "challengeB64Url": "AQIDBAUGBwgJCgsMDQ4PEA",
+ "userVerification": "required",
+ "expiresAt": "2026-10-23T16:00:00.123Z",
+ "timeoutMs": 120000
+ },
+ "assertionResult": {
+ "ok": true,
+ "ticket": "ticket/?",
+ "connection": "desk/1"
+ },
+ "statuses": [
+ "none",
+ "challenge_pending",
+ "assertion_sending",
+ "assertion_submitted",
+ "code_available",
+ "confirmation_sending",
+ "waiting_for_pairing",
+ "completed",
+ "failed"
+ ],
+ "errors": [400, 403, 404, 409, 410, 413, 422, 502, 503],
+ "derivedFrom": "contracts/fixtures/passkeys.candidate.json",
+ "published": false,
+ "apiSource": "1c1c88f04bac58ba1f006af9d4879fa0648576cb"
+}
diff --git a/contracts/fixtures/connections/signal-sidecar.json b/contracts/fixtures/connections/signal-sidecar.json
new file mode 100644
index 000000000..93610d74e
--- /dev/null
+++ b/contracts/fixtures/connections/signal-sidecar.json
@@ -0,0 +1,10 @@
+{
+ "syntheticOnly": true,
+ "sourceCommit": "61209057729b002a2122b898d744a8813a702fc7",
+ "secret": "synthetic_signal_app_secret_for_native_fixtures",
+ "timestamp": "1792022400",
+ "eventId": "event-fixture",
+ "rawBody": "{\"id\":\"event-fixture\",\"type\":\"message\",\"connection_id\":\"session-fixture\",\"chat\":\"chat-fixture\",\"sender\":\"sender-fixture\",\"sender_alt\":\"alternate@lid\",\"message_id\":\"message-fixture\",\"timestamp\":1720000000,\"is_from_me\":false,\"redelivered\":false,\"identity_changed\":false,\"message_proto\":\"CgdmaXh0dXJl\",\"text\":\"private fixture text\",\"future_field\":{\"retained\":true}}",
+ "signature": "v1=6c6a6faa7ede380da88712b66cfcb5f33a8bade60a730d0f86a7a856f6c572f1",
+ "derivedFrom": "packages/go/testdata/signal-sidecar.json"
+}
diff --git a/contracts/history/pre-connections/abprops-capabilities.json b/contracts/history/pre-connections/abprops-capabilities.json
new file mode 100644
index 000000000..ca515dcf4
--- /dev/null
+++ b/contracts/history/pre-connections/abprops-capabilities.json
@@ -0,0 +1,605 @@
+{
+ "repository": "polymorfa/polymorfa",
+ "sourceCommit": "2f9efad933b3a7a455f73245a566c827ac004608",
+ "sourcePath": "apps/api/docs/openapi.json",
+ "sourceSha256": "53b2c76e344052152b3fc627a478adcd79130b7876d528aac8056b13e555b127",
+ "published": false,
+ "scope": "Group capability read and canonical session capability webhook only. Other SDK contracts retain their recorded source revisions.",
+ "openapi": "3.0.3",
+ "paths": {
+ "/messaging/{session}/groups/{id}/capabilities": {
+ "get": {
+ "operationId": "getGroupCapabilities",
+ "tags": ["Groups"],
+ "summary": "Read stored WhatsApp group capabilities",
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-required-scope": "groups:read",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "session",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "pattern": "^[1-9][0-9]{0,18}$"
+ },
+ "required": true,
+ "name": "id",
+ "in": "path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Account-bound stored group capabilities. Unknown until successful number and group syncs for the linked account. Requires current group membership and the enrolled number-capabilities beta.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetGroupCapabilitiesResponse"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request \u2014 request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "Authenticated but not permitted (missing scope or rule violation)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "503": {
+ "description": "The stored capability reader, identity resolution or command dispatch is temporarily unavailable.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "service_unavailable",
+ "message": "A required service is unavailable. Check completion before repeating a write.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#service-unavailable"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "Linked Device API groups:read "
+ },
+ "x-protocols": ["Linked Device API"],
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`"
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "GetGroupCapabilitiesResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "enum": [true]
+ },
+ "data": {
+ "$ref": "#/components/schemas/GroupCapabilities"
+ }
+ },
+ "required": ["success", "data"]
+ },
+ "GroupCapabilities": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": ["synced", "unknown"]
+ },
+ "syncedAt": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "checkedAt": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "capabilities": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "enum": [
+ "polls.endTime",
+ "polls.hideVoters",
+ "polls.creatorEdit"
+ ]
+ },
+ "kind": {
+ "type": "string",
+ "enum": ["feature"]
+ },
+ "unit": {
+ "nullable": true,
+ "type": "string",
+ "enum": [null]
+ },
+ "value": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "source": {
+ "type": "string",
+ "nullable": true,
+ "enum": ["server", "client_default", null]
+ }
+ },
+ "required": ["key", "kind", "unit", "value", "source"],
+ "additionalProperties": false
+ }
+ }
+ },
+ "required": ["status", "syncedAt", "checkedAt", "capabilities"],
+ "additionalProperties": false
+ },
+ "PublicError": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "invalid_request_error",
+ "authentication_error",
+ "permission_error",
+ "conflict_error",
+ "rate_limit_error",
+ "api_error",
+ "upstream_error"
+ ]
+ },
+ "code": {
+ "type": "string",
+ "enum": [
+ "invalid_parameter",
+ "invalid_credential",
+ "entitlement_required",
+ "cloud_template_authority_restricted",
+ "gate_limit_reached",
+ "method_not_allowed",
+ "permission_denied",
+ "missing_scope",
+ "resource_not_found",
+ "hms_not_enabled",
+ "media_fetch_failed",
+ "resource_gone",
+ "feature_unavailable",
+ "stream_cursor_invalid",
+ "stream_cursor_expired",
+ "stream_connection_limit_reached",
+ "state_conflict",
+ "hybrid_routing_paused",
+ "hybrid_choice_required",
+ "hybrid_transition_ineligible",
+ "hybrid_automation_unavailable",
+ "hybrid_transport_unavailable",
+ "hybrid_target_reference_unavailable",
+ "send_outcome_unknown",
+ "idempotency_conflict",
+ "idempotency_in_progress",
+ "idempotency_completed",
+ "idempotency_outcome_unknown",
+ "call_claimed",
+ "call_not_ringing",
+ "connection_limit",
+ "unsupported_for_connection",
+ "call_permission_required",
+ "invalid_sip_trunk",
+ "calls_disabled",
+ "call_recipient_opted_out",
+ "call_destination_blocked",
+ "call_permission_request_limited",
+ "call_permission_granted",
+ "order_status_transition_invalid",
+ "order_cancellation_failed",
+ "call_opt_out_limit",
+ "number_restricted",
+ "sip_trunk_in_use",
+ "sip_trunk_revision_conflict",
+ "sip_trunk_limit",
+ "sip_unavailable",
+ "voice_not_enabled",
+ "provider_credential_invalid",
+ "provider_unavailable",
+ "asset_not_ready",
+ "voice_asset_in_use",
+ "voice_asset_revision_conflict",
+ "voice_unavailable",
+ "rate_limit_exceeded",
+ "internal_error",
+ "operation_not_supported",
+ "upstream_failure",
+ "service_unavailable",
+ "credential_verification_unavailable",
+ "session_not_ready",
+ "command_dispatch_failed",
+ "result_unknown",
+ "recipient_not_on_whatsapp",
+ "conversation_window_closed",
+ "template_not_approved",
+ "media_too_large",
+ "whatsapp_rate_limited",
+ "new_chat_limit_reached",
+ "whatsapp_account_restricted",
+ "whatsapp_groups_ineligible",
+ "whatsapp_group_creation_paused",
+ "whatsapp_group_limit_reached",
+ "whatsapp_group_full",
+ "whatsapp_group_suspended",
+ "whatsapp_group_has_no_participants",
+ "bansafe_suspended",
+ "bansafe_team_suspended",
+ "bansafe_cold_blocked",
+ "bansafe_cold_held",
+ "bansafe_throttled",
+ "bansafe_daily_allowance_reached",
+ "bansafe_accounting_unavailable",
+ "bansafe_send_outcome_unknown",
+ "campaigns_not_entitled",
+ "campaign_throughput_capped",
+ "campaign_approval_required",
+ "campaign_approval_stale",
+ "campaign_variables_missing"
+ ]
+ },
+ "message": {
+ "type": "string"
+ },
+ "param": {
+ "type": "string",
+ "nullable": true
+ },
+ "request_id": {
+ "type": "string",
+ "description": "Matches the X-Request-Id response header. Include it when you contact support."
+ },
+ "request_log_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "Console page that shows this request. Returned only to team and project credentials whose request was logged."
+ }
+ },
+ "required": ["type", "code", "message", "param", "request_id"]
+ },
+ "data": {
+ "type": "string",
+ "nullable": true,
+ "enum": [null],
+ "description": "Always null for a failed request."
+ },
+ "docs": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": ["error", "data", "docs"]
+ },
+ "SessionCapabilitiesUpdatedEvent": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique event identifier"
+ },
+ "session": {
+ "type": "string",
+ "description": "Session that produced this event"
+ },
+ "externalId": {
+ "type": "string",
+ "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ },
+ "timestamp": {
+ "type": "string",
+ "description": "ISO 8601 timestamp"
+ },
+ "event": {
+ "type": "string",
+ "enum": ["session.capabilities_updated"],
+ "description": "Event type"
+ },
+ "payload": {
+ "$ref": "#/components/schemas/SessionCapabilitiesUpdatedPayload"
+ }
+ },
+ "required": ["id", "session", "timestamp", "event", "payload"]
+ },
+ "SessionCapabilitiesUpdatedPayload": {
+ "type": "object",
+ "properties": {
+ "session": {
+ "type": "string",
+ "maxLength": 256
+ },
+ "projectId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "status": {
+ "type": "string",
+ "enum": ["synced", "unknown"]
+ },
+ "syncedAt": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "checkedAt": {
+ "type": "string",
+ "nullable": true,
+ "format": "date-time"
+ },
+ "accountType": {
+ "type": "string",
+ "nullable": true,
+ "enum": ["business", "personal", null]
+ },
+ "capabilities": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "maxLength": 128
+ },
+ "kind": {
+ "type": "string",
+ "enum": ["feature", "limit"]
+ },
+ "unit": {
+ "type": "string",
+ "nullable": true,
+ "enum": ["seconds", "count", "characters", "members", null]
+ },
+ "value": {
+ "anyOf": [
+ {
+ "type": "boolean",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ }
+ ],
+ "nullable": true
+ },
+ "source": {
+ "type": "string",
+ "nullable": true,
+ "enum": ["server", "client_default", "account_type", null]
+ }
+ },
+ "required": ["key", "kind", "unit", "value", "source"],
+ "additionalProperties": false
+ },
+ "maxItems": 100
+ },
+ "changedKeys": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "maxLength": 128
+ },
+ "maxItems": 100
+ }
+ },
+ "required": [
+ "session",
+ "projectId",
+ "status",
+ "syncedAt",
+ "checkedAt",
+ "accountType",
+ "capabilities",
+ "changedKeys"
+ ],
+ "additionalProperties": false
+ }
+ }
+ },
+ "family": "messaging"
+}
diff --git a/contracts/history/pre-connections/analytics-device-signals.json b/contracts/history/pre-connections/analytics-device-signals.json
new file mode 100644
index 000000000..677dc6919
--- /dev/null
+++ b/contracts/history/pre-connections/analytics-device-signals.json
@@ -0,0 +1,4044 @@
+{
+ "repository": "polymorfa/polymorfa",
+ "sourceCommit": "113d91b12a1db19cbddc4130cea308f38663bb9d",
+ "sourcePath": "apps/api/docs/openapi.management.json",
+ "sourceSha256": "f1d08f7f9605a39b0c96da1567ba2231bc8c456e2ef039a9ea67db8a4a252fac",
+ "scope": "Analytics operations and their referenced schemas only; all other SDK operations retain contracts/source.json",
+ "published": false,
+ "paths": {
+ "/platform/analytics/metrics": {
+ "get": {
+ "operationId": "exportWhatsAppAnalyticsMetrics",
+ "tags": ["Analytics"],
+ "summary": "Export analytics metrics",
+ "description": "**Required scope:** `sessions:read`\n\nAuthenticated metrics for a customer's Prometheus or OpenTelemetry Collector. Requires live Analytics enablement. Disabled Analytics returns only enablement and export-window metrics, with no business measurements. All samples are gauges: counts describe an overlapping window, not monotonic counters. Do not use rate() or increase() on them. Labels contain number/project record IDs and bounded categories, never contact identities or message content. Null or unmeasured values are omitted; coverage and observation timestamps are included. API request vitals retain project/team scope even when filtering a number.",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "x-polymorfa-resource-boundary": "project",
+ "x-required-scope": "sessions:read",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "required": false,
+ "name": "projectId",
+ "in": "query"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "description": "One number record UUID, within the authorized project or team."
+ },
+ "required": false,
+ "description": "One number record UUID, within the authorized project or team.",
+ "name": "sessionId",
+ "in": "query"
+ },
+ {
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 168,
+ "default": 24,
+ "description": "Number of completed UTC hours in the window, ending at the most recent hour boundary. Default 24; maximum 168."
+ },
+ "required": false,
+ "description": "Number of completed UTC hours in the window, ending at the most recent hour boundary. Default 24; maximum 168.",
+ "name": "windowHours",
+ "in": "query"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "enum": ["true", "false"],
+ "default": "false",
+ "description": "Include message type, text length, origin, calling-code and device-count breakdowns. Adds metric series."
+ },
+ "required": false,
+ "description": "Include message type, text length, origin, calling-code and device-count breakdowns. Adds metric series.",
+ "name": "segments",
+ "in": "query"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "enum": ["prometheus", "openmetrics"],
+ "default": "prometheus",
+ "description": "Prometheus text 0.0.4 or OpenMetrics text 1.0. The format parameter selects the representation."
+ },
+ "required": false,
+ "description": "Prometheus text 0.0.4 or OpenMetrics text 1.0. The format parameter selects the representation.",
+ "name": "format",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Windowed analytics gauges. OpenMetrics ends with # EOF. No JSON envelope.",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ },
+ "application/openmetrics-text": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request \u2014 request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "Authenticated but not permitted (missing scope or rule violation)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "503": {
+ "description": "Analytics query deadline exceeded. Retry later or use a shorter window.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "service_unavailable",
+ "message": "A required service is unavailable. Check completion before repeating a write.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#service-unavailable"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "sessions:read "
+ },
+ "x-audience": "public"
+ }
+ },
+ "/platform/projects/{projectId}/analytics/metrics": {
+ "get": {
+ "operationId": "exportProjectWhatsAppAnalyticsMetrics",
+ "tags": ["Analytics"],
+ "summary": "Export project analytics metrics",
+ "description": "**Required scope:** `sessions:read`\n\nAuthenticated metrics for a customer's Prometheus or OpenTelemetry Collector. Requires live Analytics enablement. Disabled Analytics returns only enablement and export-window metrics, with no business measurements. All samples are gauges: counts describe an overlapping window, not monotonic counters. Do not use rate() or increase() on them. Labels contain number/project record IDs and bounded categories, never contact identities or message content. Null or unmeasured values are omitted; coverage and observation timestamps are included. API request vitals retain project/team scope even when filtering a number.",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "x-polymorfa-resource-boundary": "project",
+ "x-required-scope": "sessions:read",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "required": true,
+ "name": "projectId",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "description": "One number record UUID, within the authorized project or team."
+ },
+ "required": false,
+ "description": "One number record UUID, within the authorized project or team.",
+ "name": "sessionId",
+ "in": "query"
+ },
+ {
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 168,
+ "default": 24,
+ "description": "Number of completed UTC hours in the window, ending at the most recent hour boundary. Default 24; maximum 168."
+ },
+ "required": false,
+ "description": "Number of completed UTC hours in the window, ending at the most recent hour boundary. Default 24; maximum 168.",
+ "name": "windowHours",
+ "in": "query"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "enum": ["true", "false"],
+ "default": "false",
+ "description": "Include message type, text length, origin, calling-code and device-count breakdowns. Adds metric series."
+ },
+ "required": false,
+ "description": "Include message type, text length, origin, calling-code and device-count breakdowns. Adds metric series.",
+ "name": "segments",
+ "in": "query"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "enum": ["prometheus", "openmetrics"],
+ "default": "prometheus",
+ "description": "Prometheus text 0.0.4 or OpenMetrics text 1.0. The format parameter selects the representation."
+ },
+ "required": false,
+ "description": "Prometheus text 0.0.4 or OpenMetrics text 1.0. The format parameter selects the representation.",
+ "name": "format",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Windowed analytics gauges. OpenMetrics ends with # EOF. No JSON envelope.",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ },
+ "application/openmetrics-text": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request \u2014 request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "Authenticated but not permitted (missing scope or rule violation)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "503": {
+ "description": "Analytics query deadline exceeded. Retry later or use a shorter window.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "service_unavailable",
+ "message": "A required service is unavailable. Check completion before repeating a write.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#service-unavailable"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "sessions:read "
+ },
+ "x-audience": "public"
+ }
+ },
+ "/platform/analytics": {
+ "get": {
+ "operationId": "getWhatsAppAnalytics",
+ "tags": ["Analytics"],
+ "summary": "Get WhatsApp number analytics",
+ "description": "Aggregated number activity and operational vitals. Returns disabled with null summary and empty data until a team owner or admin enables Analytics. Conversation rates use completed 24-hour direct-chat cohorts, booked in the period when they mature; missing or dropped cohort coverage returns null rates. Read means an observed read receipt, not a verified app open. No contact identifiers or message content. Linked Devices telemetry only; unsupported or unobserved numbers carry measured=false. Bucket timestamps use UTC. Activity series use hourly buckets for ranges up to 48 hours and daily buckets for longer ranges. Call series use daily buckets. Message metadata compares direct sends and completed conversations by type, coarse text/caption length, source, calling code and observed device count. Device observations are bounded samples. Calling-code shares describe conversations, not distinct people or location. Presence signals require existing subscriptions. Primary phone activity spans end at their last observed signal and close after 15 minutes without evidence. Quiet gaps end at the next observed signal. Duration sums and averages count completed intervals and exclude open or restart-censored intervals; they do not measure phone online/offline or power state. Metadata collection uses the current team opt-in; disable erases these aggregates and stale queued metadata is rejected. Calls aggregate retained records by their immutable original number/project ownership, including supported Official API calls; message measured/coverage fields do not apply to calls. Call series groups starts by UTC day. Answer rate excludes still-ringing calls; timing fields have explicit observation counts. Missed-call follow-up observes an answered outgoing call to the same pseudonymous contact within 24h, including after the requested end; only completed windows with a known contact form the denominator. It does not prove callback intent. Quality uses reported measurements, latest cumulative app reports per connection and per-call averages. Breakdown counts can overlap. Disabling hides this call view without deleting operational call history. Device analytics estimates sending client families from message ID prefixes, not verified hardware. Customer/account distributions count observed live direct messages, not unique people or installed devices; unknown is included. Older retained buckets lack device coverage and return null shares. Each number exposes at most 25 of its own device indexes, coarse reported class and last observed sending activity. A list change makes inventory membership/count unknown until another full list. Inventory is null in the combined summary. No recipient device identity or raw message ID is retained by this analytics block. Joint conversation breakdown rows retain first outgoing message type, length band, send source, inferred calling code and observed customer device-count class together with UTC completion bucket. Combine rows matching all selected categories to drill into countries and message attributes without inferring intersections from independent marginal totals. Calling codes do not establish current location and shared codes do not identify a unique country. Counts describe completed 24-hour conversation cohorts, not distinct customers. Rates and averages are null when coverage is missing, dropped or truncated. At most 4096 number/time/category groups are returned in one scope, prioritizing largest groups and marking truncation; raw reply latency sums support weighted aggregation. Connection/call vitals and live message platform distributions are separate measurements, not recipient-country filtered cohorts. Recipient country and recipient linked-device-count fields refine joint conversation metadata. Recipient activity remains hourly even for long date ranges, supporting incoming-message timing in an explicit time zone. Delivery signals do not prove reading; read signals are distinct. Presence subscriptions are best-effort around permitted direct sends, reuse a live bounded local lease, preserve observation-off policies and never poll every contact. Missing presence is Unknown, not offline.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "sessions:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "query",
+ "required": false,
+ "description": "Project to read. Omit to total every project in the team.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sessionId",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Number record UUID."
+ }
+ },
+ {
+ "name": "start",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Unix milliseconds; maximum range 366 days."
+ }
+ },
+ {
+ "name": "end",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Unix milliseconds; maximum range 366 days."
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/WhatsAppAnalytics"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "503": {
+ "$ref": "#/components/responses/PropagationPending"
+ }
+ }
+ }
+ },
+ "/platform/projects/{projectId}/analytics": {
+ "get": {
+ "operationId": "getProjectWhatsAppAnalytics",
+ "tags": ["Analytics"],
+ "summary": "Get WhatsApp number analytics",
+ "description": "Aggregated number activity and operational vitals. Returns disabled with null summary and empty data until a team owner or admin enables Analytics. Conversation rates use completed 24-hour direct-chat cohorts, booked in the period when they mature; missing or dropped cohort coverage returns null rates. Read means an observed read receipt, not a verified app open. No contact identifiers or message content. Linked Devices telemetry only; unsupported or unobserved numbers carry measured=false. Bucket timestamps use UTC. Activity series use hourly buckets for ranges up to 48 hours and daily buckets for longer ranges. Call series use daily buckets. Message metadata compares direct sends and completed conversations by type, coarse text/caption length, source, calling code and observed device count. Device observations are bounded samples. Calling-code shares describe conversations, not distinct people or location. Presence signals require existing subscriptions. Primary phone activity spans end at their last observed signal and close after 15 minutes without evidence. Quiet gaps end at the next observed signal. Duration sums and averages count completed intervals and exclude open or restart-censored intervals; they do not measure phone online/offline or power state. Metadata collection uses the current team opt-in; disable erases these aggregates and stale queued metadata is rejected. Calls aggregate retained records by their immutable original number/project ownership, including supported Official API calls; message measured/coverage fields do not apply to calls. Call series groups starts by UTC day. Answer rate excludes still-ringing calls; timing fields have explicit observation counts. Missed-call follow-up observes an answered outgoing call to the same pseudonymous contact within 24h, including after the requested end; only completed windows with a known contact form the denominator. It does not prove callback intent. Quality uses reported measurements, latest cumulative app reports per connection and per-call averages. Breakdown counts can overlap. Disabling hides this call view without deleting operational call history. Device analytics estimates sending client families from message ID prefixes, not verified hardware. Customer/account distributions count observed live direct messages, not unique people or installed devices; unknown is included. Older retained buckets lack device coverage and return null shares. Each number exposes at most 25 of its own device indexes, coarse reported class and last observed sending activity. A list change makes inventory membership/count unknown until another full list. Inventory is null in the combined summary. No recipient device identity or raw message ID is retained by this analytics block. Joint conversation breakdown rows retain first outgoing message type, length band, send source, inferred calling code and observed customer device-count class together with UTC completion bucket. Combine rows matching all selected categories to drill into countries and message attributes without inferring intersections from independent marginal totals. Calling codes do not establish current location and shared codes do not identify a unique country. Counts describe completed 24-hour conversation cohorts, not distinct customers. Rates and averages are null when coverage is missing, dropped or truncated. At most 4096 number/time/category groups are returned in one scope, prioritizing largest groups and marking truncation; raw reply latency sums support weighted aggregation. Connection/call vitals and live message platform distributions are separate measurements, not recipient-country filtered cohorts. Recipient country and recipient linked-device-count fields refine joint conversation metadata. Recipient activity remains hourly even for long date ranges, supporting incoming-message timing in an explicit time zone. Delivery signals do not prove reading; read signals are distinct. Presence subscriptions are best-effort around permitted direct sends, reuse a live bounded local lease, preserve observation-off policies and never poll every contact. Missing presence is Unknown, not offline.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "sessions:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "sessionId",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Number record UUID."
+ }
+ },
+ {
+ "name": "start",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Unix milliseconds; maximum range 366 days."
+ }
+ },
+ {
+ "name": "end",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Unix milliseconds; maximum range 366 days."
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/WhatsAppAnalytics"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "503": {
+ "$ref": "#/components/responses/PropagationPending"
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "PlatformAccessPublicError": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "invalid_request_error",
+ "authentication_error",
+ "permission_error",
+ "conflict_error",
+ "rate_limit_error",
+ "api_error",
+ "upstream_error"
+ ]
+ },
+ "code": {
+ "type": "string",
+ "enum": [
+ "invalid_parameter",
+ "invalid_credential",
+ "entitlement_required",
+ "cloud_template_authority_restricted",
+ "gate_limit_reached",
+ "method_not_allowed",
+ "permission_denied",
+ "missing_scope",
+ "resource_not_found",
+ "hms_not_enabled",
+ "media_fetch_failed",
+ "resource_gone",
+ "feature_unavailable",
+ "stream_cursor_invalid",
+ "stream_cursor_expired",
+ "stream_connection_limit_reached",
+ "state_conflict",
+ "hybrid_routing_paused",
+ "hybrid_choice_required",
+ "hybrid_transition_ineligible",
+ "hybrid_automation_unavailable",
+ "hybrid_transport_unavailable",
+ "hybrid_target_reference_unavailable",
+ "send_outcome_unknown",
+ "idempotency_conflict",
+ "idempotency_in_progress",
+ "idempotency_completed",
+ "idempotency_outcome_unknown",
+ "call_claimed",
+ "call_not_ringing",
+ "connection_limit",
+ "unsupported_for_connection",
+ "call_permission_required",
+ "invalid_sip_trunk",
+ "calls_disabled",
+ "call_recipient_opted_out",
+ "call_destination_blocked",
+ "call_permission_request_limited",
+ "call_permission_granted",
+ "order_status_transition_invalid",
+ "order_cancellation_failed",
+ "call_opt_out_limit",
+ "number_restricted",
+ "sip_trunk_in_use",
+ "sip_trunk_revision_conflict",
+ "sip_trunk_limit",
+ "sip_unavailable",
+ "voice_not_enabled",
+ "provider_credential_invalid",
+ "provider_unavailable",
+ "asset_not_ready",
+ "voice_asset_in_use",
+ "voice_asset_revision_conflict",
+ "voice_unavailable",
+ "rate_limit_exceeded",
+ "internal_error",
+ "operation_not_supported",
+ "upstream_failure",
+ "service_unavailable",
+ "credential_verification_unavailable",
+ "session_not_ready",
+ "command_dispatch_failed",
+ "result_unknown",
+ "recipient_not_on_whatsapp",
+ "conversation_window_closed",
+ "template_not_approved",
+ "media_too_large",
+ "whatsapp_rate_limited",
+ "new_chat_limit_reached",
+ "whatsapp_account_restricted",
+ "whatsapp_groups_ineligible",
+ "whatsapp_group_creation_paused",
+ "whatsapp_group_limit_reached",
+ "whatsapp_group_full",
+ "whatsapp_group_suspended",
+ "whatsapp_group_has_no_participants",
+ "bansafe_suspended",
+ "bansafe_team_suspended",
+ "bansafe_cold_blocked",
+ "bansafe_cold_held",
+ "bansafe_throttled",
+ "bansafe_daily_allowance_reached",
+ "bansafe_accounting_unavailable",
+ "bansafe_send_outcome_unknown",
+ "campaigns_not_entitled",
+ "campaign_throughput_capped"
+ ]
+ },
+ "message": {
+ "type": "string"
+ },
+ "param": {
+ "type": "string",
+ "nullable": true
+ },
+ "request_id": {
+ "type": "string",
+ "description": "Matches the X-Request-Id response header. Include it when you contact support."
+ },
+ "request_log_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "Console page that shows this request. Returned only to team and project credentials whose request was logged."
+ }
+ },
+ "required": ["type", "code", "message", "param", "request_id"]
+ },
+ "data": {
+ "type": "string",
+ "nullable": true,
+ "enum": [null],
+ "description": "Always null for a failed request."
+ },
+ "docs": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": ["error", "data", "docs"]
+ },
+ "WhatsAppAnalytics": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "period": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "start": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ },
+ "end": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ }
+ },
+ "required": ["start", "end"]
+ },
+ "requestVitals": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "requests": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "failures": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "errorRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ }
+ },
+ "required": ["requests", "failures", "errorRate"]
+ },
+ "summary": {
+ "type": "object",
+ "nullable": true,
+ "allOf": [
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "measured": {
+ "type": "boolean"
+ },
+ "observedHours": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "lastObservedAt": {
+ "type": "integer",
+ "description": "Unix milliseconds.",
+ "nullable": true
+ },
+ "outgoingMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "incomingMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sendAttempts": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sendFailures": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sendFailureRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "businessReplies": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageBusinessResponseMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "onlineMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "disconnects": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "connectFailures": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "streamErrors": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "keepaliveTimeouts": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "engagement": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "windowHours": {
+ "type": "integer",
+ "enum": [24]
+ },
+ "completedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "deliveredConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "readConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "repliedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "deliveryRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "readRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "replyRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "averageCustomerReplyMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "complete": {
+ "type": "boolean"
+ },
+ "droppedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "droppedRecords": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "droppedReceiptJoins": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "windowHours",
+ "completedConversations",
+ "deliveredConversations",
+ "readConversations",
+ "repliedConversations",
+ "deliveryRate",
+ "readRate",
+ "replyRate",
+ "averageCustomerReplyMs",
+ "complete",
+ "droppedConversations",
+ "droppedRecords",
+ "droppedReceiptJoins"
+ ]
+ },
+ "totalNumbers": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "measuredNumbers": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "connectedNumbers": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "messageAnalysis": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "complete": {
+ "type": "boolean"
+ },
+ "segments": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "dimension": {
+ "type": "string",
+ "enum": [
+ "message_type",
+ "text_band",
+ "origin",
+ "calling_code",
+ "customer_devices"
+ ]
+ },
+ "key": {
+ "type": "string"
+ },
+ "sendAttempts": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sent": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sendFailures": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sendFailureRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "completedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "deliveredConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "readConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "repliedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "deliveryRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "readRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "replyRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "averageCustomerReplyMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "shareOfConversations": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "shareOfSends": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "readRateInterval95": {
+ "type": "array",
+ "nullable": true,
+ "minItems": 2,
+ "maxItems": 2,
+ "items": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1
+ },
+ "description": "95% Wilson interval for observed conversation receipts or replies; not a causal effect."
+ },
+ "replyRateInterval95": {
+ "type": "array",
+ "nullable": true,
+ "minItems": 2,
+ "maxItems": 2,
+ "items": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1
+ },
+ "description": "95% Wilson interval for observed conversation receipts or replies; not a causal effect."
+ },
+ "readRateDifference": {
+ "type": "number",
+ "minimum": -1,
+ "maximum": 1,
+ "nullable": true
+ },
+ "replyRateDifference": {
+ "type": "number",
+ "minimum": -1,
+ "maximum": 1,
+ "nullable": true
+ }
+ },
+ "required": [
+ "dimension",
+ "key",
+ "sendAttempts",
+ "sent",
+ "sendFailures",
+ "sendFailureRate",
+ "completedConversations",
+ "deliveredConversations",
+ "readConversations",
+ "repliedConversations",
+ "deliveryRate",
+ "readRate",
+ "replyRate",
+ "averageCustomerReplyMs",
+ "shareOfConversations",
+ "shareOfSends",
+ "readRateInterval95",
+ "replyRateInterval95",
+ "readRateDifference",
+ "replyRateDifference"
+ ]
+ }
+ }
+ },
+ "required": ["complete", "segments"]
+ },
+ "customerActivity": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "observed": {
+ "type": "boolean"
+ },
+ "onlineSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "offlineSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "typingSignals": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "observed",
+ "onlineSignals",
+ "offlineSignals",
+ "typingSignals"
+ ]
+ },
+ "accountActivity": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "observed": {
+ "type": "boolean"
+ },
+ "primaryPhoneActivitySignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "primaryPhoneActivePeriods": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "completedPhoneActivityPeriods": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "phoneActivityMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averagePhoneActivityMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "phoneQuietGaps": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "phoneQuietMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averagePhoneQuietMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "primaryPhoneMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "otherDeviceMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "lastPrimaryPhoneAt": {
+ "type": "integer",
+ "description": "Unix milliseconds.",
+ "nullable": true
+ },
+ "primaryPhoneReplies": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "otherDeviceReplies": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averagePrimaryPhoneResponseMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "averageOtherDeviceResponseMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ }
+ },
+ "required": [
+ "observed",
+ "primaryPhoneActivitySignals",
+ "primaryPhoneActivePeriods",
+ "completedPhoneActivityPeriods",
+ "phoneActivityMs",
+ "averagePhoneActivityMs",
+ "phoneQuietGaps",
+ "phoneQuietMs",
+ "averagePhoneQuietMs",
+ "primaryPhoneMessages",
+ "otherDeviceMessages",
+ "lastPrimaryPhoneAt",
+ "primaryPhoneReplies",
+ "otherDeviceReplies",
+ "averagePrimaryPhoneResponseMs",
+ "averageOtherDeviceResponseMs"
+ ]
+ },
+ "responseQueue": {
+ "type": "object",
+ "nullable": true,
+ "allOf": [
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "awaitingReply": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "oldestWaitingMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "observedAt": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ },
+ "complete": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "awaitingReply",
+ "oldestWaitingMs",
+ "observedAt",
+ "complete"
+ ]
+ }
+ ]
+ },
+ "calls": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "total": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "missed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "declined": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "failed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "ringing": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answerRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "talkSeconds": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedPickup": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "medianTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95TalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "averagePickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95PickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "shortAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "video": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "directions": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "inbound": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "total": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "missed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "declined": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "failed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "ringing": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answerRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "talkSeconds": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedPickup": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "medianTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95TalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "averagePickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95PickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "shortAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "video": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "total",
+ "answered",
+ "missed",
+ "declined",
+ "failed",
+ "ringing",
+ "answerRate",
+ "talkSeconds",
+ "timedAnswered",
+ "timedPickup",
+ "averageTalkSeconds",
+ "medianTalkSeconds",
+ "p95TalkSeconds",
+ "averagePickupMs",
+ "p95PickupMs",
+ "shortAnswered",
+ "video"
+ ]
+ },
+ "outbound": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "total": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "missed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "declined": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "failed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "ringing": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answerRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "talkSeconds": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedPickup": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "medianTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95TalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "averagePickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95PickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "shortAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "video": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "total",
+ "answered",
+ "missed",
+ "declined",
+ "failed",
+ "ringing",
+ "answerRate",
+ "talkSeconds",
+ "timedAnswered",
+ "timedPickup",
+ "averageTalkSeconds",
+ "medianTalkSeconds",
+ "p95TalkSeconds",
+ "averagePickupMs",
+ "p95PickupMs",
+ "shortAnswered",
+ "video"
+ ]
+ }
+ },
+ "required": ["inbound", "outbound"]
+ },
+ "mediaQuality": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "measuredCalls": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageJitterMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "averageRttMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "packetsLost": {
+ "type": "integer",
+ "minimum": 0,
+ "nullable": true
+ }
+ },
+ "required": [
+ "measuredCalls",
+ "averageJitterMs",
+ "averageRttMs",
+ "packetsLost"
+ ]
+ },
+ "appQuality": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "measuredCalls": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageJitterMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "averageRttMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "packetLossRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "reconnects": {
+ "type": "integer",
+ "minimum": 0,
+ "nullable": true
+ }
+ },
+ "required": [
+ "measuredCalls",
+ "averageJitterMs",
+ "averageRttMs",
+ "packetLossRate",
+ "reconnects"
+ ]
+ },
+ "endReasons": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "count": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": ["code", "count"]
+ }
+ },
+ "appErrors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "count": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": ["code", "count"]
+ }
+ },
+ "transports": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "count": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": ["code", "count"]
+ }
+ },
+ "multiParticipantCalls": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "followUp": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "eligibleMissed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "returnedWithin24h": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "rate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "averageDelayMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "pendingWindow": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "unknownContact": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "eligibleMissed",
+ "returnedWithin24h",
+ "rate",
+ "averageDelayMs",
+ "pendingWindow",
+ "unknownContact"
+ ]
+ }
+ },
+ "required": [
+ "total",
+ "answered",
+ "missed",
+ "declined",
+ "failed",
+ "ringing",
+ "answerRate",
+ "talkSeconds",
+ "timedAnswered",
+ "timedPickup",
+ "averageTalkSeconds",
+ "medianTalkSeconds",
+ "p95TalkSeconds",
+ "averagePickupMs",
+ "p95PickupMs",
+ "shortAnswered",
+ "video",
+ "directions",
+ "mediaQuality",
+ "appQuality",
+ "endReasons",
+ "appErrors",
+ "transports",
+ "multiParticipantCalls",
+ "followUp"
+ ]
+ },
+ "deviceAnalytics": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "detector": {
+ "type": "string",
+ "enum": ["message_id_prefix/v1"]
+ },
+ "measured": {
+ "type": "boolean",
+ "description": "True when at least one retained bucket has client-family measurement coverage, including buckets with zero messages."
+ },
+ "complete": {
+ "type": "boolean",
+ "description": "True when measured is true, every retained bucket has device-family coverage and conversation receipt coverage is complete. False when coverage is missing or records, conversations or receipt joins were dropped. Inventory truncation is reported separately."
+ },
+ "observedBuckets": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "customerMessages": {
+ "type": "integer",
+ "minimum": 0,
+ "nullable": true
+ },
+ "accountMessages": {
+ "type": "integer",
+ "minimum": 0,
+ "nullable": true
+ },
+ "customerPlatforms": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "platform": {
+ "type": "string",
+ "enum": [
+ "web",
+ "android",
+ "iphone",
+ "ipad",
+ "macos",
+ "windows",
+ "wearable",
+ "ar_device",
+ "unknown"
+ ],
+ "description": "Sending client family estimated from a message ID prefix; not verified hardware or operating system.",
+ "x-enumDescriptions": {
+ "web": "Web client.",
+ "android": "Android client.",
+ "iphone": "iPhone client.",
+ "ipad": "iPad client.",
+ "macos": "macOS client.",
+ "windows": "Windows client.",
+ "wearable": "Wearable client.",
+ "ar_device": "AR device client.",
+ "unknown": "No recognized client-family prefix."
+ }
+ },
+ "messages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "share": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ }
+ },
+ "required": ["platform", "messages", "share"]
+ }
+ },
+ "accountPlatforms": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "platform": {
+ "type": "string",
+ "enum": [
+ "web",
+ "android",
+ "iphone",
+ "ipad",
+ "macos",
+ "windows",
+ "wearable",
+ "ar_device",
+ "unknown"
+ ],
+ "description": "Sending client family estimated from a message ID prefix; not verified hardware or operating system.",
+ "x-enumDescriptions": {
+ "web": "Web client.",
+ "android": "Android client.",
+ "iphone": "iPhone client.",
+ "ipad": "iPad client.",
+ "macos": "macOS client.",
+ "windows": "Windows client.",
+ "wearable": "Wearable client.",
+ "ar_device": "AR device client.",
+ "unknown": "No recognized client-family prefix."
+ }
+ },
+ "messages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "share": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ }
+ },
+ "required": ["platform", "messages", "share"]
+ }
+ },
+ "inventory": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "listObserved": {
+ "type": "boolean",
+ "description": "True after a full device list for this number was observed."
+ },
+ "listCurrent": {
+ "type": "boolean",
+ "description": "True when a full list was observed and no later list-change signal invalidated it. Membership and device count are unknown until another full list after a change."
+ },
+ "observedAt": {
+ "type": "integer",
+ "description": "Unix milliseconds.",
+ "nullable": true
+ },
+ "deviceCount": {
+ "type": "integer",
+ "minimum": 0,
+ "nullable": true
+ },
+ "truncated": {
+ "type": "boolean",
+ "description": "True when the bounded inventory omitted devices. At most 25 device rows are returned; a current full-list device count can be larger."
+ },
+ "devices": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "deviceIndex": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 999
+ },
+ "estimatedPlatform": {
+ "type": "string",
+ "enum": [
+ "web",
+ "android",
+ "iphone",
+ "ipad",
+ "macos",
+ "windows",
+ "wearable",
+ "ar_device",
+ "unknown"
+ ],
+ "description": "Sending client family estimated from a message ID prefix; not verified hardware or operating system.",
+ "x-enumDescriptions": {
+ "web": "Web client.",
+ "android": "Android client.",
+ "iphone": "iPhone client.",
+ "ipad": "iPad client.",
+ "macos": "macOS client.",
+ "windows": "Windows client.",
+ "wearable": "Wearable client.",
+ "ar_device": "AR device client.",
+ "unknown": "No recognized client-family prefix."
+ }
+ },
+ "reportedClass": {
+ "type": "string",
+ "enum": [
+ "phone",
+ "desktop_app",
+ "browser",
+ "business_api",
+ "unknown"
+ ],
+ "x-enumDescriptions": {
+ "phone": "Phone.",
+ "desktop_app": "Desktop app.",
+ "browser": "Browser.",
+ "business_api": "Business API.",
+ "unknown": "No recognized reported device class."
+ }
+ },
+ "lastActiveAt": {
+ "type": "integer",
+ "description": "Unix milliseconds.",
+ "nullable": true
+ },
+ "listed": {
+ "type": "boolean",
+ "nullable": true,
+ "description": "Whether this device index belongs to the latest observed full list. Null when that list is no longer current."
+ }
+ },
+ "required": [
+ "deviceIndex",
+ "estimatedPlatform",
+ "reportedClass",
+ "lastActiveAt",
+ "listed"
+ ]
+ },
+ "maxItems": 25
+ }
+ },
+ "required": [
+ "listObserved",
+ "listCurrent",
+ "observedAt",
+ "deviceCount",
+ "truncated",
+ "devices"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "detector",
+ "measured",
+ "complete",
+ "observedBuckets",
+ "customerMessages",
+ "accountMessages",
+ "customerPlatforms",
+ "accountPlatforms",
+ "inventory"
+ ],
+ "description": "Observed message client-family distributions and a bounded inventory of this number's own devices. The combined summary has null inventory."
+ },
+ "conversationBreakdown": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "measured": {
+ "type": "boolean",
+ "description": "True when at least one retained bucket includes joint conversation categories."
+ },
+ "complete": {
+ "type": "boolean",
+ "description": "True when measured is true, every retained bucket has joint conversation coverage, no conversation, record or receipt-join coverage was lost and the returned groups are not truncated. Rates and averages are null when false."
+ },
+ "observedBuckets": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "droppedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "truncated": {
+ "type": "boolean",
+ "description": "True when the requested scope exceeded 4096 number/time/category groups. The largest groups are retained; rates and averages are null."
+ },
+ "buckets": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "ts": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ },
+ "complete": {
+ "type": "boolean",
+ "description": "True when this UTC time bucket has joint category coverage and no conversations or records were dropped. A summary bucket also requires every scoped number to have a bucket."
+ }
+ },
+ "required": ["ts", "complete"]
+ }
+ },
+ "rows": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "ts": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ },
+ "messageType": {
+ "type": "string",
+ "enum": [
+ "text",
+ "image",
+ "video",
+ "audio",
+ "document",
+ "sticker",
+ "interactive",
+ "template",
+ "other"
+ ]
+ },
+ "textBand": {
+ "type": "string",
+ "enum": [
+ "none",
+ "short",
+ "medium",
+ "long",
+ "very_long",
+ "unknown"
+ ]
+ },
+ "origin": {
+ "type": "string",
+ "enum": ["api", "campaign", "other"],
+ "x-enumDescriptions": {
+ "api": "API send.",
+ "campaign": "Campaign send.",
+ "other": "Other or unclassified send source."
+ }
+ },
+ "callingCode": {
+ "type": "string",
+ "pattern": "^(unknown|[1-9][0-9]{0,2})$"
+ },
+ "customerDevices": {
+ "type": "string",
+ "enum": ["single", "multiple", "unknown"]
+ },
+ "completedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "deliveredConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "readConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "repliedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "replyLatencySumMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "readRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "replyRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "averageCustomerReplyMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ }
+ },
+ "required": [
+ "ts",
+ "messageType",
+ "textBand",
+ "origin",
+ "callingCode",
+ "customerDevices",
+ "completedConversations",
+ "deliveredConversations",
+ "readConversations",
+ "repliedConversations",
+ "replyLatencySumMs",
+ "readRate",
+ "replyRate",
+ "averageCustomerReplyMs"
+ ]
+ },
+ "maxItems": 4096
+ }
+ },
+ "required": [
+ "measured",
+ "complete",
+ "observedBuckets",
+ "droppedConversations",
+ "truncated",
+ "buckets",
+ "rows"
+ ],
+ "description": "Completed 24-hour conversation cohorts grouped jointly by completion bucket, first outgoing message metadata, calling code and observed device-count class."
+ }
+ },
+ "required": [
+ "measured",
+ "observedHours",
+ "lastObservedAt",
+ "outgoingMessages",
+ "incomingMessages",
+ "sendAttempts",
+ "sendFailures",
+ "sendFailureRate",
+ "businessReplies",
+ "averageBusinessResponseMs",
+ "onlineMs",
+ "disconnects",
+ "connectFailures",
+ "streamErrors",
+ "keepaliveTimeouts",
+ "engagement",
+ "totalNumbers",
+ "measuredNumbers",
+ "connectedNumbers",
+ "messageAnalysis",
+ "customerActivity",
+ "accountActivity",
+ "responseQueue",
+ "calls",
+ "deviceAnalytics",
+ "conversationBreakdown"
+ ]
+ }
+ ]
+ },
+ "numbers": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "sessionId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "projectId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "backend": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ },
+ "measured": {
+ "type": "boolean"
+ },
+ "observedHours": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "lastObservedAt": {
+ "type": "integer",
+ "description": "Unix milliseconds.",
+ "nullable": true
+ },
+ "outgoingMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "incomingMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sendAttempts": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sendFailures": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sendFailureRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "businessReplies": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageBusinessResponseMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "onlineMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "disconnects": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "connectFailures": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "streamErrors": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "keepaliveTimeouts": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "engagement": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "windowHours": {
+ "type": "integer",
+ "enum": [24]
+ },
+ "completedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "deliveredConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "readConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "repliedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "deliveryRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "readRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "replyRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "averageCustomerReplyMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "complete": {
+ "type": "boolean"
+ },
+ "droppedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "droppedRecords": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "droppedReceiptJoins": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "windowHours",
+ "completedConversations",
+ "deliveredConversations",
+ "readConversations",
+ "repliedConversations",
+ "deliveryRate",
+ "readRate",
+ "replyRate",
+ "averageCustomerReplyMs",
+ "complete",
+ "droppedConversations",
+ "droppedRecords",
+ "droppedReceiptJoins"
+ ]
+ },
+ "messageAnalysis": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "complete": {
+ "type": "boolean"
+ },
+ "segments": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "dimension": {
+ "type": "string",
+ "enum": [
+ "message_type",
+ "text_band",
+ "origin",
+ "calling_code",
+ "customer_devices"
+ ]
+ },
+ "key": {
+ "type": "string"
+ },
+ "sendAttempts": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sent": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sendFailures": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sendFailureRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "completedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "deliveredConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "readConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "repliedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "deliveryRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "readRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "replyRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "averageCustomerReplyMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "shareOfConversations": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "shareOfSends": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "readRateInterval95": {
+ "type": "array",
+ "nullable": true,
+ "minItems": 2,
+ "maxItems": 2,
+ "items": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1
+ },
+ "description": "95% Wilson interval for observed conversation receipts or replies; not a causal effect."
+ },
+ "replyRateInterval95": {
+ "type": "array",
+ "nullable": true,
+ "minItems": 2,
+ "maxItems": 2,
+ "items": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1
+ },
+ "description": "95% Wilson interval for observed conversation receipts or replies; not a causal effect."
+ },
+ "readRateDifference": {
+ "type": "number",
+ "minimum": -1,
+ "maximum": 1,
+ "nullable": true
+ },
+ "replyRateDifference": {
+ "type": "number",
+ "minimum": -1,
+ "maximum": 1,
+ "nullable": true
+ }
+ },
+ "required": [
+ "dimension",
+ "key",
+ "sendAttempts",
+ "sent",
+ "sendFailures",
+ "sendFailureRate",
+ "completedConversations",
+ "deliveredConversations",
+ "readConversations",
+ "repliedConversations",
+ "deliveryRate",
+ "readRate",
+ "replyRate",
+ "averageCustomerReplyMs",
+ "shareOfConversations",
+ "shareOfSends",
+ "readRateInterval95",
+ "replyRateInterval95",
+ "readRateDifference",
+ "replyRateDifference"
+ ]
+ }
+ }
+ },
+ "required": ["complete", "segments"]
+ },
+ "customerActivity": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "observed": {
+ "type": "boolean"
+ },
+ "onlineSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "offlineSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "typingSignals": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "observed",
+ "onlineSignals",
+ "offlineSignals",
+ "typingSignals"
+ ]
+ },
+ "accountActivity": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "observed": {
+ "type": "boolean"
+ },
+ "primaryPhoneActivitySignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "primaryPhoneActivePeriods": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "completedPhoneActivityPeriods": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "phoneActivityMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averagePhoneActivityMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "phoneQuietGaps": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "phoneQuietMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averagePhoneQuietMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "primaryPhoneMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "otherDeviceMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "lastPrimaryPhoneAt": {
+ "type": "integer",
+ "description": "Unix milliseconds.",
+ "nullable": true
+ },
+ "primaryPhoneReplies": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "otherDeviceReplies": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averagePrimaryPhoneResponseMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "averageOtherDeviceResponseMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ }
+ },
+ "required": [
+ "observed",
+ "primaryPhoneActivitySignals",
+ "primaryPhoneActivePeriods",
+ "completedPhoneActivityPeriods",
+ "phoneActivityMs",
+ "averagePhoneActivityMs",
+ "phoneQuietGaps",
+ "phoneQuietMs",
+ "averagePhoneQuietMs",
+ "primaryPhoneMessages",
+ "otherDeviceMessages",
+ "lastPrimaryPhoneAt",
+ "primaryPhoneReplies",
+ "otherDeviceReplies",
+ "averagePrimaryPhoneResponseMs",
+ "averageOtherDeviceResponseMs"
+ ]
+ },
+ "responseQueue": {
+ "type": "object",
+ "nullable": true,
+ "allOf": [
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "awaitingReply": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "oldestWaitingMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "observedAt": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ },
+ "complete": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "awaitingReply",
+ "oldestWaitingMs",
+ "observedAt",
+ "complete"
+ ]
+ }
+ ]
+ },
+ "projectName": {
+ "type": "string"
+ },
+ "calls": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "total": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "missed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "declined": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "failed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "ringing": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answerRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "talkSeconds": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedPickup": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "medianTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95TalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "averagePickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95PickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "shortAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "video": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "directions": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "inbound": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "total": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "missed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "declined": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "failed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "ringing": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answerRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "talkSeconds": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedPickup": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "medianTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95TalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "averagePickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95PickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "shortAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "video": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "total",
+ "answered",
+ "missed",
+ "declined",
+ "failed",
+ "ringing",
+ "answerRate",
+ "talkSeconds",
+ "timedAnswered",
+ "timedPickup",
+ "averageTalkSeconds",
+ "medianTalkSeconds",
+ "p95TalkSeconds",
+ "averagePickupMs",
+ "p95PickupMs",
+ "shortAnswered",
+ "video"
+ ]
+ },
+ "outbound": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "total": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "missed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "declined": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "failed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "ringing": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answerRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "talkSeconds": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedPickup": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "medianTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95TalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "averagePickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95PickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "shortAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "video": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "total",
+ "answered",
+ "missed",
+ "declined",
+ "failed",
+ "ringing",
+ "answerRate",
+ "talkSeconds",
+ "timedAnswered",
+ "timedPickup",
+ "averageTalkSeconds",
+ "medianTalkSeconds",
+ "p95TalkSeconds",
+ "averagePickupMs",
+ "p95PickupMs",
+ "shortAnswered",
+ "video"
+ ]
+ }
+ },
+ "required": ["inbound", "outbound"]
+ },
+ "mediaQuality": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "measuredCalls": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageJitterMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "averageRttMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "packetsLost": {
+ "type": "integer",
+ "minimum": 0,
+ "nullable": true
+ }
+ },
+ "required": [
+ "measuredCalls",
+ "averageJitterMs",
+ "averageRttMs",
+ "packetsLost"
+ ]
+ },
+ "appQuality": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "measuredCalls": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageJitterMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "averageRttMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "packetLossRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "reconnects": {
+ "type": "integer",
+ "minimum": 0,
+ "nullable": true
+ }
+ },
+ "required": [
+ "measuredCalls",
+ "averageJitterMs",
+ "averageRttMs",
+ "packetLossRate",
+ "reconnects"
+ ]
+ },
+ "endReasons": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "count": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": ["code", "count"]
+ }
+ },
+ "appErrors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "count": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": ["code", "count"]
+ }
+ },
+ "transports": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "count": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": ["code", "count"]
+ }
+ },
+ "multiParticipantCalls": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "followUp": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "eligibleMissed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "returnedWithin24h": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "rate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "averageDelayMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "pendingWindow": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "unknownContact": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "eligibleMissed",
+ "returnedWithin24h",
+ "rate",
+ "averageDelayMs",
+ "pendingWindow",
+ "unknownContact"
+ ]
+ }
+ },
+ "required": [
+ "total",
+ "answered",
+ "missed",
+ "declined",
+ "failed",
+ "ringing",
+ "answerRate",
+ "talkSeconds",
+ "timedAnswered",
+ "timedPickup",
+ "averageTalkSeconds",
+ "medianTalkSeconds",
+ "p95TalkSeconds",
+ "averagePickupMs",
+ "p95PickupMs",
+ "shortAnswered",
+ "video",
+ "directions",
+ "mediaQuality",
+ "appQuality",
+ "endReasons",
+ "appErrors",
+ "transports",
+ "multiParticipantCalls",
+ "followUp"
+ ]
+ },
+ "deviceAnalytics": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "detector": {
+ "type": "string",
+ "enum": ["message_id_prefix/v1"]
+ },
+ "measured": {
+ "type": "boolean",
+ "description": "True when at least one retained bucket has client-family measurement coverage, including buckets with zero messages."
+ },
+ "complete": {
+ "type": "boolean",
+ "description": "True when measured is true, every retained bucket has device-family coverage and conversation receipt coverage is complete. False when coverage is missing or records, conversations or receipt joins were dropped. Inventory truncation is reported separately."
+ },
+ "observedBuckets": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "customerMessages": {
+ "type": "integer",
+ "minimum": 0,
+ "nullable": true
+ },
+ "accountMessages": {
+ "type": "integer",
+ "minimum": 0,
+ "nullable": true
+ },
+ "customerPlatforms": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "platform": {
+ "type": "string",
+ "enum": [
+ "web",
+ "android",
+ "iphone",
+ "ipad",
+ "macos",
+ "windows",
+ "wearable",
+ "ar_device",
+ "unknown"
+ ],
+ "description": "Sending client family estimated from a message ID prefix; not verified hardware or operating system.",
+ "x-enumDescriptions": {
+ "web": "Web client.",
+ "android": "Android client.",
+ "iphone": "iPhone client.",
+ "ipad": "iPad client.",
+ "macos": "macOS client.",
+ "windows": "Windows client.",
+ "wearable": "Wearable client.",
+ "ar_device": "AR device client.",
+ "unknown": "No recognized client-family prefix."
+ }
+ },
+ "messages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "share": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ }
+ },
+ "required": ["platform", "messages", "share"]
+ }
+ },
+ "accountPlatforms": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "platform": {
+ "type": "string",
+ "enum": [
+ "web",
+ "android",
+ "iphone",
+ "ipad",
+ "macos",
+ "windows",
+ "wearable",
+ "ar_device",
+ "unknown"
+ ],
+ "description": "Sending client family estimated from a message ID prefix; not verified hardware or operating system.",
+ "x-enumDescriptions": {
+ "web": "Web client.",
+ "android": "Android client.",
+ "iphone": "iPhone client.",
+ "ipad": "iPad client.",
+ "macos": "macOS client.",
+ "windows": "Windows client.",
+ "wearable": "Wearable client.",
+ "ar_device": "AR device client.",
+ "unknown": "No recognized client-family prefix."
+ }
+ },
+ "messages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "share": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ }
+ },
+ "required": ["platform", "messages", "share"]
+ }
+ },
+ "inventory": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "listObserved": {
+ "type": "boolean",
+ "description": "True after a full device list for this number was observed."
+ },
+ "listCurrent": {
+ "type": "boolean",
+ "description": "True when a full list was observed and no later list-change signal invalidated it. Membership and device count are unknown until another full list after a change."
+ },
+ "observedAt": {
+ "type": "integer",
+ "description": "Unix milliseconds.",
+ "nullable": true
+ },
+ "deviceCount": {
+ "type": "integer",
+ "minimum": 0,
+ "nullable": true
+ },
+ "truncated": {
+ "type": "boolean",
+ "description": "True when the bounded inventory omitted devices. At most 25 device rows are returned; a current full-list device count can be larger."
+ },
+ "devices": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "deviceIndex": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 999
+ },
+ "estimatedPlatform": {
+ "type": "string",
+ "enum": [
+ "web",
+ "android",
+ "iphone",
+ "ipad",
+ "macos",
+ "windows",
+ "wearable",
+ "ar_device",
+ "unknown"
+ ],
+ "description": "Sending client family estimated from a message ID prefix; not verified hardware or operating system.",
+ "x-enumDescriptions": {
+ "web": "Web client.",
+ "android": "Android client.",
+ "iphone": "iPhone client.",
+ "ipad": "iPad client.",
+ "macos": "macOS client.",
+ "windows": "Windows client.",
+ "wearable": "Wearable client.",
+ "ar_device": "AR device client.",
+ "unknown": "No recognized client-family prefix."
+ }
+ },
+ "reportedClass": {
+ "type": "string",
+ "enum": [
+ "phone",
+ "desktop_app",
+ "browser",
+ "business_api",
+ "unknown"
+ ],
+ "x-enumDescriptions": {
+ "phone": "Phone.",
+ "desktop_app": "Desktop app.",
+ "browser": "Browser.",
+ "business_api": "Business API.",
+ "unknown": "No recognized reported device class."
+ }
+ },
+ "lastActiveAt": {
+ "type": "integer",
+ "description": "Unix milliseconds.",
+ "nullable": true
+ },
+ "listed": {
+ "type": "boolean",
+ "nullable": true,
+ "description": "Whether this device index belongs to the latest observed full list. Null when that list is no longer current."
+ }
+ },
+ "required": [
+ "deviceIndex",
+ "estimatedPlatform",
+ "reportedClass",
+ "lastActiveAt",
+ "listed"
+ ]
+ },
+ "maxItems": 25
+ }
+ },
+ "required": [
+ "listObserved",
+ "listCurrent",
+ "observedAt",
+ "deviceCount",
+ "truncated",
+ "devices"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "detector",
+ "measured",
+ "complete",
+ "observedBuckets",
+ "customerMessages",
+ "accountMessages",
+ "customerPlatforms",
+ "accountPlatforms",
+ "inventory"
+ ],
+ "description": "Observed message client-family distributions and a bounded inventory of this number's own devices. The combined summary has null inventory."
+ },
+ "conversationBreakdown": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "measured": {
+ "type": "boolean",
+ "description": "True when at least one retained bucket includes joint conversation categories."
+ },
+ "complete": {
+ "type": "boolean",
+ "description": "True when measured is true, every retained bucket has joint conversation coverage, no conversation, record or receipt-join coverage was lost and the returned groups are not truncated. Rates and averages are null when false."
+ },
+ "observedBuckets": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "droppedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "truncated": {
+ "type": "boolean",
+ "description": "True when the requested scope exceeded 4096 number/time/category groups. The largest groups are retained; rates and averages are null."
+ },
+ "buckets": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "ts": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ },
+ "complete": {
+ "type": "boolean",
+ "description": "True when this UTC time bucket has joint category coverage and no conversations or records were dropped. A summary bucket also requires every scoped number to have a bucket."
+ }
+ },
+ "required": ["ts", "complete"]
+ }
+ },
+ "rows": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "ts": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ },
+ "messageType": {
+ "type": "string",
+ "enum": [
+ "text",
+ "image",
+ "video",
+ "audio",
+ "document",
+ "sticker",
+ "interactive",
+ "template",
+ "other"
+ ]
+ },
+ "textBand": {
+ "type": "string",
+ "enum": [
+ "none",
+ "short",
+ "medium",
+ "long",
+ "very_long",
+ "unknown"
+ ]
+ },
+ "origin": {
+ "type": "string",
+ "enum": ["api", "campaign", "other"],
+ "x-enumDescriptions": {
+ "api": "API send.",
+ "campaign": "Campaign send.",
+ "other": "Other or unclassified send source."
+ }
+ },
+ "callingCode": {
+ "type": "string",
+ "pattern": "^(unknown|[1-9][0-9]{0,2})$"
+ },
+ "customerDevices": {
+ "type": "string",
+ "enum": ["single", "multiple", "unknown"]
+ },
+ "completedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "deliveredConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "readConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "repliedConversations": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "replyLatencySumMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "readRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "replyRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "averageCustomerReplyMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ }
+ },
+ "required": [
+ "ts",
+ "messageType",
+ "textBand",
+ "origin",
+ "callingCode",
+ "customerDevices",
+ "completedConversations",
+ "deliveredConversations",
+ "readConversations",
+ "repliedConversations",
+ "replyLatencySumMs",
+ "readRate",
+ "replyRate",
+ "averageCustomerReplyMs"
+ ]
+ },
+ "maxItems": 4096
+ }
+ },
+ "required": [
+ "measured",
+ "complete",
+ "observedBuckets",
+ "droppedConversations",
+ "truncated",
+ "buckets",
+ "rows"
+ ],
+ "description": "Completed 24-hour conversation cohorts grouped jointly by completion bucket, first outgoing message metadata, calling code and observed device-count class."
+ }
+ },
+ "required": [
+ "sessionId",
+ "projectId",
+ "name",
+ "backend",
+ "status",
+ "measured",
+ "observedHours",
+ "lastObservedAt",
+ "outgoingMessages",
+ "incomingMessages",
+ "sendAttempts",
+ "sendFailures",
+ "sendFailureRate",
+ "businessReplies",
+ "averageBusinessResponseMs",
+ "onlineMs",
+ "disconnects",
+ "connectFailures",
+ "streamErrors",
+ "keepaliveTimeouts",
+ "engagement",
+ "messageAnalysis",
+ "customerActivity",
+ "accountActivity",
+ "responseQueue",
+ "projectName",
+ "calls",
+ "deviceAnalytics",
+ "conversationBreakdown"
+ ]
+ }
+ },
+ "series": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "ts": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ },
+ "outgoingMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "incomingMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sendFailures": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "businessReplies": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageBusinessResponseMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "onlineMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "disconnects": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sessionId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "customerOnlineSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "customerTypingSignals": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "primaryPhoneMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "otherDeviceMessages": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "primaryPhoneReplies": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "phoneActivePeriods": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "completedPhoneActivityPeriods": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "phoneActivityMs": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "phoneQuietGaps": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "phoneQuietMs": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "ts",
+ "outgoingMessages",
+ "incomingMessages",
+ "sendFailures",
+ "businessReplies",
+ "averageBusinessResponseMs",
+ "onlineMs",
+ "disconnects",
+ "sessionId",
+ "customerOnlineSignals",
+ "customerTypingSignals",
+ "primaryPhoneMessages",
+ "otherDeviceMessages",
+ "primaryPhoneReplies",
+ "phoneActivePeriods",
+ "completedPhoneActivityPeriods",
+ "phoneActivityMs",
+ "phoneQuietGaps",
+ "phoneQuietMs"
+ ]
+ }
+ },
+ "callSeries": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "total": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "missed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "declined": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "failed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "ringing": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "answerRate": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "nullable": true
+ },
+ "talkSeconds": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "timedPickup": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "averageTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "medianTalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95TalkSeconds": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "averagePickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "p95PickupMs": {
+ "type": "number",
+ "minimum": 0,
+ "nullable": true
+ },
+ "shortAnswered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "video": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sessionId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "ts": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ }
+ },
+ "required": [
+ "total",
+ "answered",
+ "missed",
+ "declined",
+ "failed",
+ "ringing",
+ "answerRate",
+ "talkSeconds",
+ "timedAnswered",
+ "timedPickup",
+ "averageTalkSeconds",
+ "medianTalkSeconds",
+ "p95TalkSeconds",
+ "averagePickupMs",
+ "p95PickupMs",
+ "shortAnswered",
+ "video",
+ "sessionId",
+ "ts"
+ ]
+ }
+ }
+ },
+ "required": [
+ "enabled",
+ "period",
+ "requestVitals",
+ "summary",
+ "numbers",
+ "series",
+ "callSeries"
+ ]
+ }
+ }
+ },
+ "family": "platform"
+}
diff --git a/contracts/history/pre-connections/campaign-custody-20261014.json b/contracts/history/pre-connections/campaign-custody-20261014.json
new file mode 100644
index 000000000..b7904dd18
--- /dev/null
+++ b/contracts/history/pre-connections/campaign-custody-20261014.json
@@ -0,0 +1,6608 @@
+{
+ "repository": "polymorfa/polymorfa",
+ "commit": "f97ad78b172e80788c33bdc0fcf28f75db9283ec",
+ "published": false,
+ "apiVersion": "2026-10-14",
+ "note": "Thirty campaign, audience profile, STOP confirmation and custody-default operations. TypeScript adoption is in source; five native ports, full 625-operation reconciliation, deployed acceptance and publication remain required. Global snapshots and their coverage ledger remain unchanged.",
+ "sources": {
+ "messaging": {
+ "sourcePath": "apps/api/docs/openapi.json",
+ "sourceSha256": "009bf72f1c0bb65c6f2d168e804fdd50f60ab1394a5a06632391b87986a5fcb4",
+ "paths": {
+ "/messaging/projects/{projectSlug}/campaigns/{id}/links": {
+ "get": {
+ "operationId": "getProjectCampaignLinks",
+ "tags": ["Campaigns"],
+ "summary": "Get tracked link opens",
+ "description": "**Required scope:** `campaigns:read`\n\nBeta. Opens of each tracked link, in the campaign's link order. An open is a request to the short link: a person, or an app or security scanner previewing the link. It is not proof of a click. Requires the campaign link tracking beta (`403 feature_unavailable` otherwise).",
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-required-scope": "campaigns:read",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectSlug",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "id",
+ "in": "path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetCampaignLinksResponse"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request — request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "Authenticated but not permitted (missing scope or rule violation)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "campaigns:read "
+ }
+ }
+ },
+ "/messaging/projects/{projectSlug}/campaigns/{id}/test-send": {
+ "post": {
+ "operationId": "testSendCampaign",
+ "tags": ["Campaigns"],
+ "summary": "Send a test of a draft campaign",
+ "description": "**Required scopes (all):** `campaigns:manage` · `campaigns:read`\n\nRequires campaigns:manage and campaigns:read because the test can use stored recipient samples. Sends one copy of a draft campaign's content to a seed recipient, through the same rendering, sending, and BanSafe checks as a launched campaign. The seed recipient must be a number connected to your team. A test is not a campaign recipient and is not counted in the campaign's statistics or webhooks. A team can send 20 tests an hour, and at most 5 an hour to one seed recipient.",
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-required-scopes": ["campaigns:manage", "campaigns:read"],
+ "x-required-scope-mode": "all",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectSlug",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "id",
+ "in": "path"
+ },
+ {
+ "name": "Idempotency-Key",
+ "in": "header",
+ "required": false,
+ "description": "Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version`, and request never runs the write again: it returns `409 idempotency_completed` when the original succeeded, or the original server error, with `Idempotent-Replayed: true`. Reusing the key for a different request returns `409 idempotency_conflict`; a retry while the original is still running returns `409 idempotency_in_progress`, and a retry after an unrecorded outcome returns `409 idempotency_outcome_unknown`.",
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CampaignTestSendRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestSendCampaignResponse"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request — request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "402": {
+ "description": "`campaigns_not_entitled`: the sending number's plan does not include Campaigns.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "campaigns_not_entitled",
+ "message": "This number’s plan does not include Campaigns.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#campaigns-not-entitled"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "Authenticated but not permitted (missing scope or rule violation)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "409": {
+ "description": "`state_conflict`: The campaign is not a draft or has A/B or weighted content alternatives, the sending number is a Hybrid Link number, or the seed recipient opted out. `bansafe_cold_held`: the seed recipient has never written to the sending number and the campaign holds first messages. The Idempotency-Key already succeeded (`idempotency_completed`), was used for a different request (`idempotency_conflict`), belongs to a request that is still running (`idempotency_in_progress`, with Retry-After), or belongs to a request whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "conflict_error",
+ "code": "state_conflict",
+ "message": "The request conflicts with the resource state.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#state-conflict"
+ }
+ }
+ },
+ "headers": {
+ "Retry-After": {
+ "description": "Seconds to wait before retrying `idempotency_in_progress`.",
+ "schema": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "Idempotent-Replayed": {
+ "description": "`true` when this response reports the recorded outcome of an earlier request with the same Idempotency-Key.",
+ "schema": {
+ "type": "string",
+ "enum": ["true"]
+ }
+ },
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "422": {
+ "description": "`campaign_variables_missing`: the selected sample and explicit values cannot fill a variable in the content.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "campaign_variables_missing",
+ "message": "A recipient has no value and no fallback for a variable in the campaign content.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#campaign-variables-missing"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "429": {
+ "description": "The team or seed recipient reached its test-send limit (`rate_limit_exceeded`), or BanSafe is pacing the sending number. Follow `Retry-After`.",
+ "headers": {
+ "Retry-After": {
+ "description": "Seconds to wait before retrying.",
+ "schema": {
+ "type": "integer",
+ "minimum": 1
+ }
+ },
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "rate_limit_error",
+ "code": "rate_limit_exceeded",
+ "message": "The request limit was reached. Follow Retry-After when supplied.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#rate-limit-exceeded"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "502": {
+ "description": "`upstream_failure`: the send path reported that the test could not be sent.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "upstream_error",
+ "code": "upstream_failure",
+ "message": "The messaging provider could not complete the request.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#upstream-failure"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "503": {
+ "description": "The test was not sent: the sending number is not connected (`session_not_ready`), test sends or the send path are unavailable (`service_unavailable`, `command_dispatch_failed`), or the sending number's allowance could not be checked (`bansafe_accounting_unavailable`). Retry later.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "service_unavailable",
+ "message": "A required service is unavailable. Check completion before repeating a write.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#service-unavailable"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "504": {
+ "description": "`result_unknown`: the outcome was not received in time. The test may still arrive.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "result_unknown",
+ "message": "The result was not obtained before the deadline. Check completion before repeating a write.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#result-unknown"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "campaigns:manage campaigns:read "
+ }
+ }
+ },
+ "/messaging/projects/{projectSlug}/campaign-reply-flows": {
+ "post": {
+ "operationId": "createCampaignReplyFlow",
+ "tags": ["Campaigns"],
+ "summary": "Create a reply flow revision",
+ "description": "**Required scope:** `campaigns:manage`\n\nCreates an immutable reply flow revision: the steps a campaign runs when a recipient replies. Each step can send a text, reply buttons, a list, or a Flow form, and branches on the button or list row chosen, an exact keyword, or a Flow form submission. Beta.",
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-required-scope": "campaigns:manage",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectSlug",
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateCampaignReplyFlowRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateCampaignReplyFlowResponse"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request — request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "`missing_scope`, or `feature_unavailable` when campaign reply flows are not enabled for the team.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "missing_scope",
+ "message": "The credential lacks a required API scope.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#missing-scope"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "409": {
+ "description": "`state_conflict`: this flow key and revision already exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "conflict_error",
+ "code": "state_conflict",
+ "message": "The request conflicts with the resource state.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#state-conflict"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "campaigns:manage "
+ }
+ }
+ },
+ "/messaging/projects/{projectSlug}/campaign-reply-flows/{id}": {
+ "get": {
+ "operationId": "getCampaignReplyFlow",
+ "tags": ["Campaigns"],
+ "summary": "Get a reply flow revision",
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-required-scope": "campaigns:read",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectSlug",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "required": true,
+ "name": "id",
+ "in": "path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetCampaignReplyFlowResponse"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request — request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "`missing_scope`, or `feature_unavailable` when campaign reply flows are not enabled for the team.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "missing_scope",
+ "message": "The credential lacks a required API scope.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#missing-scope"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "campaigns:read "
+ },
+ "description": "**Required scope:** `campaigns:read`"
+ }
+ },
+ "/messaging/projects/{projectSlug}/campaigns/{id}/reply-flow": {
+ "put": {
+ "operationId": "setCampaignReplyFlow",
+ "tags": ["Campaigns"],
+ "summary": "Set a campaign's reply flow",
+ "description": "**Required scope:** `campaigns:manage`\n\nAttaches a reply flow revision to a draft or scheduled campaign, or detaches it with `null`. The flow starts for each recipient once their message is sent.",
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-required-scope": "campaigns:manage",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectSlug",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "required": true,
+ "name": "id",
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SetCampaignReplyFlowRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SetCampaignReplyFlowResponse"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request — request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "`missing_scope`, or `feature_unavailable` when campaign reply flows are not enabled for the team.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "missing_scope",
+ "message": "The credential lacks a required API scope.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#missing-scope"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "409": {
+ "description": "`state_conflict`: the campaign has already launched.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "conflict_error",
+ "code": "state_conflict",
+ "message": "The request conflicts with the resource state.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#state-conflict"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "campaigns:manage "
+ }
+ }
+ },
+ "/messaging/projects/{projectSlug}/campaigns/{id}/recipients/export": {
+ "get": {
+ "operationId": "exportProjectCampaignRecipients",
+ "tags": ["Campaigns"],
+ "summary": "Export campaign recipients",
+ "description": "**Required scope:** `campaigns:read`\n\nReturns recipients as CSV in queue order. Unfiltered exports page up to 1,000 recipients per request. Each page starts with a header row. When more recipients match, the `Polymorfa-Next-Cursor` response header carries the cursor for the next page; it is absent on the last page. Each page is read when it is requested, so a recipient appears once, with the outcome it had when its page was read. A filtered export is one atomic page of up to 1,000 recipients; larger filtered results return 409, so changing statuses cannot silently omit matches between pages. The export contains outcomes and `failureReason` codes only, never message content or template variables.",
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-required-scope": "campaigns:read",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectSlug",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "id",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "enum": [
+ "queued",
+ "sending",
+ "sent",
+ "delivered",
+ "read",
+ "failed",
+ "skipped"
+ ]
+ },
+ "required": false,
+ "name": "status",
+ "in": "query"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "enum": [
+ "opted_out",
+ "cold_held",
+ "campaign_cancelled",
+ "invalid_recipient",
+ "session_not_connected",
+ "ack_timeout",
+ "blocked_by_safety",
+ "send_failed",
+ "missing_variable",
+ "other"
+ ],
+ "description": "Only recipients whose `failureReason` is this code."
+ },
+ "required": false,
+ "name": "reason",
+ "in": "query"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "description": "The `Polymorfa-Next-Cursor` value from the previous unfiltered page. Filtered exports cannot be paged."
+ },
+ "required": false,
+ "name": "cursor",
+ "in": "query"
+ },
+ {
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 1000,
+ "description": "Recipients per unfiltered page, up to 1,000. Filtered exports require 1,000. Default 1,000."
+ },
+ "required": false,
+ "name": "limit",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "One page of recipients.",
+ "headers": {
+ "Polymorfa-Next-Cursor": {
+ "schema": {
+ "type": "string",
+ "description": "Cursor for the next page. Absent on the last page."
+ },
+ "required": false
+ },
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "text/csv": {
+ "schema": {
+ "type": "string",
+ "description": "Header row, then one row per recipient. Columns: recipientId, phone, status, failureReason, attempts, variantKey, queuedAt, sentAt, deliveredAt, readAt, failedAt, respondedAt, followUpStatus, followUpAnchor, followUpDueAt, followUpExpiresAt, followUpSentAt, followUpReadAt, followUpRepliedAt, followUpReason, followUpCommandId. Times are ISO 8601 in UTC. Empty fields are null. Text that begins with =, +, -, @, tab or carriage return is prefixed with an apostrophe, including phone numbers in international format. Machine readers should remove that leading apostrophe from phone cells."
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request — request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "Authenticated but not permitted (missing scope or rule violation)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "409": {
+ "description": "More than 1,000 recipients match the filter",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "conflict_error",
+ "code": "state_conflict",
+ "message": "The request conflicts with the resource state.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#state-conflict"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "campaigns:read "
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "GetCampaignLinksResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "enum": [true]
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CampaignTrackedLinkReport"
+ }
+ }
+ },
+ "required": ["success", "data"]
+ },
+ "CampaignTrackedLinkReport": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Tracked link key.",
+ "example": "offer"
+ },
+ "url": {
+ "type": "string",
+ "description": "Destination of the tracked link.",
+ "example": "https://example.com/spring-sale"
+ },
+ "uniqueOpens": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Recipients who opened the link at least once."
+ },
+ "totalOpens": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Every recorded open, including repeat opens."
+ }
+ },
+ "required": ["key", "url", "uniqueOpens", "totalOpens"]
+ },
+ "PublicError": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "invalid_request_error",
+ "authentication_error",
+ "permission_error",
+ "conflict_error",
+ "rate_limit_error",
+ "api_error",
+ "upstream_error"
+ ]
+ },
+ "code": {
+ "type": "string",
+ "enum": [
+ "zero_knowledge_session",
+ "invalid_parameter",
+ "invalid_credential",
+ "entitlement_required",
+ "cloud_template_authority_restricted",
+ "gate_limit_reached",
+ "method_not_allowed",
+ "permission_denied",
+ "missing_scope",
+ "resource_not_found",
+ "hms_not_enabled",
+ "media_fetch_failed",
+ "resource_gone",
+ "feature_unavailable",
+ "stream_cursor_invalid",
+ "stream_cursor_expired",
+ "stream_connection_limit_reached",
+ "state_conflict",
+ "hybrid_routing_paused",
+ "hybrid_choice_required",
+ "hybrid_transition_ineligible",
+ "hybrid_automation_unavailable",
+ "hybrid_transport_unavailable",
+ "hybrid_target_reference_unavailable",
+ "send_outcome_unknown",
+ "idempotency_conflict",
+ "idempotency_in_progress",
+ "idempotency_completed",
+ "idempotency_outcome_unknown",
+ "call_claimed",
+ "call_not_ringing",
+ "connection_limit",
+ "unsupported_for_connection",
+ "call_permission_required",
+ "invalid_sip_trunk",
+ "calls_disabled",
+ "call_recipient_opted_out",
+ "call_destination_blocked",
+ "call_permission_request_limited",
+ "call_permission_granted",
+ "order_status_transition_invalid",
+ "order_cancellation_failed",
+ "call_opt_out_limit",
+ "number_restricted",
+ "sip_trunk_in_use",
+ "sip_trunk_revision_conflict",
+ "sip_trunk_limit",
+ "sip_unavailable",
+ "voice_not_enabled",
+ "provider_credential_invalid",
+ "provider_unavailable",
+ "asset_not_ready",
+ "voice_asset_in_use",
+ "voice_asset_revision_conflict",
+ "voice_unavailable",
+ "rate_limit_exceeded",
+ "internal_error",
+ "operation_not_supported",
+ "upstream_failure",
+ "service_unavailable",
+ "credential_verification_unavailable",
+ "session_not_ready",
+ "command_dispatch_failed",
+ "result_unknown",
+ "recipient_not_on_whatsapp",
+ "conversation_window_closed",
+ "template_not_approved",
+ "media_too_large",
+ "whatsapp_rate_limited",
+ "new_chat_limit_reached",
+ "whatsapp_account_restricted",
+ "whatsapp_groups_ineligible",
+ "whatsapp_group_creation_paused",
+ "whatsapp_group_limit_reached",
+ "whatsapp_group_full",
+ "whatsapp_group_suspended",
+ "whatsapp_group_has_no_participants",
+ "bansafe_suspended",
+ "bansafe_team_suspended",
+ "bansafe_cold_blocked",
+ "bansafe_cold_held",
+ "bansafe_throttled",
+ "bansafe_daily_allowance_reached",
+ "bansafe_accounting_unavailable",
+ "bansafe_send_outcome_unknown",
+ "campaigns_not_entitled",
+ "campaign_throughput_capped",
+ "campaign_approval_required",
+ "campaign_approval_stale",
+ "campaign_variables_missing"
+ ]
+ },
+ "message": {
+ "type": "string"
+ },
+ "param": {
+ "type": "string",
+ "nullable": true
+ },
+ "request_id": {
+ "type": "string",
+ "description": "Matches the X-Request-Id response header. Include it when you contact support."
+ },
+ "request_log_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "Console page that shows this request. Returned only to team and project credentials whose request was logged."
+ }
+ },
+ "required": ["type", "code", "message", "param", "request_id"]
+ },
+ "data": {
+ "type": "string",
+ "nullable": true,
+ "enum": [null],
+ "description": "Always null for a failed request."
+ },
+ "docs": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": ["error", "data", "docs"]
+ },
+ "CampaignTestSendRequest": {
+ "type": "object",
+ "properties": {
+ "sessionId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The number to send the test from. It must be connected, on a plan that includes Campaigns, and, when the campaign selects numbers, one of them."
+ },
+ "to": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 32,
+ "description": "The seed recipient in international format. It must be the phone of a number connected to your team.",
+ "example": "+5511999990000"
+ },
+ "sampleRecipientId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "A recipient of this campaign whose variables fill the content. Without it and without `variables`, the campaign's first recipient, or its audience's first member, is the sample."
+ },
+ "variables": {
+ "type": "object",
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 1024
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ },
+ "description": "Variable values for the test, at most 50. They override the sample recipient's values; without `sampleRecipientId`, only these values are used.",
+ "maxProperties": 50
+ }
+ },
+ "required": ["sessionId", "to"]
+ },
+ "TestSendCampaignResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "enum": [true]
+ },
+ "data": {
+ "$ref": "#/components/schemas/CampaignTestSend"
+ }
+ },
+ "required": ["success", "data"]
+ },
+ "CampaignTestSend": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The test send's ID."
+ },
+ "campaignId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "status": {
+ "type": "string",
+ "enum": ["sent"]
+ },
+ "from": {
+ "type": "object",
+ "properties": {
+ "sessionId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "phone": {
+ "type": "string"
+ }
+ },
+ "required": ["sessionId", "phone"],
+ "description": "The number the test was sent from."
+ },
+ "to": {
+ "type": "string",
+ "description": "The seed recipient, in E.164 format."
+ },
+ "messageId": {
+ "type": "string",
+ "nullable": true,
+ "description": "The WhatsApp message ID, when the send path returned one."
+ },
+ "variables": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The variable values the content was rendered with."
+ },
+ "createdAt": {
+ "type": "number",
+ "description": "When the test was admitted, in epoch milliseconds."
+ }
+ },
+ "required": [
+ "id",
+ "campaignId",
+ "status",
+ "from",
+ "to",
+ "messageId",
+ "variables",
+ "createdAt"
+ ]
+ },
+ "CreateCampaignReplyFlowRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128
+ },
+ "flowKey": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Existing flow key to add a revision to. Omit to start a new reply flow."
+ },
+ "revision": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 1000000,
+ "description": "Revision number. Defaults to 1; each key and revision can be created once."
+ },
+ "definition": {
+ "$ref": "#/components/schemas/CampaignReplyFlowDefinition"
+ }
+ },
+ "required": ["name", "definition"],
+ "additionalProperties": false
+ },
+ "CampaignReplyFlowDefinition": {
+ "type": "object",
+ "properties": {
+ "entryNodeId": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$"
+ },
+ "nodes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CampaignReplyFlowNode"
+ },
+ "minItems": 2,
+ "maxItems": 12
+ }
+ },
+ "required": ["entryNodeId", "nodes"],
+ "additionalProperties": false,
+ "description": "An acyclic graph of 2 to 12 steps. The entry step waits for the first reply to the campaign message and sends nothing."
+ },
+ "CampaignReplyFlowNode": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$"
+ },
+ "send": {
+ "$ref": "#/components/schemas/CampaignReplyFlowSend"
+ },
+ "edges": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "match": {
+ "$ref": "#/components/schemas/CampaignReplyFlowMatch"
+ },
+ "to": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$"
+ }
+ },
+ "required": ["match", "to"],
+ "additionalProperties": false
+ },
+ "maxItems": 3
+ }
+ },
+ "required": ["id", "edges"],
+ "additionalProperties": false
+ },
+ "CampaignReplyFlowSend": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["text"]
+ },
+ "text": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4096
+ }
+ },
+ "required": ["kind", "text"],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["buttons"]
+ },
+ "body": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "footer": {
+ "type": "string",
+ "maxLength": 60
+ },
+ "buttons": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$",
+ "description": "Choice ID, 1 to 64 letters, digits, `.`, `_`, `:` or `-`, starting with a letter or digit."
+ },
+ "text": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 20
+ }
+ },
+ "required": ["id", "text"],
+ "additionalProperties": false
+ },
+ "minItems": 1,
+ "maxItems": 3
+ }
+ },
+ "required": ["kind", "body", "buttons"],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["list"]
+ },
+ "body": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "buttonText": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 20
+ },
+ "footer": {
+ "type": "string",
+ "maxLength": 60
+ },
+ "rows": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$",
+ "description": "Choice ID, 1 to 64 letters, digits, `.`, `_`, `:` or `-`, starting with a letter or digit."
+ },
+ "title": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 24
+ },
+ "description": {
+ "type": "string",
+ "maxLength": 72
+ }
+ },
+ "required": ["id", "title"],
+ "additionalProperties": false
+ },
+ "minItems": 1,
+ "maxItems": 10
+ }
+ },
+ "required": ["kind", "body", "buttonText", "rows"],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["flow_form"]
+ },
+ "flowId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "body": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "buttonText": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 20
+ },
+ "footer": {
+ "type": "string",
+ "maxLength": 60
+ },
+ "screen": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9_]{1,64}$"
+ }
+ },
+ "required": ["kind", "flowId", "body", "buttonText", "screen"],
+ "additionalProperties": false,
+ "description": "A published WhatsApp Flow form. Official numbers only."
+ }
+ ]
+ },
+ "CampaignReplyFlowMatch": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["choice"]
+ },
+ "replyKind": {
+ "type": "string",
+ "enum": ["button", "list"]
+ },
+ "id": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$",
+ "description": "Choice ID, 1 to 64 letters, digits, `.`, `_`, `:` or `-`, starting with a letter or digit."
+ }
+ },
+ "required": ["kind", "replyKind", "id"],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["keyword"]
+ },
+ "value": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 64
+ }
+ },
+ "required": ["kind", "value"],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["flow_submission"]
+ }
+ },
+ "required": ["kind"],
+ "additionalProperties": false
+ }
+ ]
+ },
+ "CreateCampaignReplyFlowResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "enum": [true]
+ },
+ "data": {
+ "$ref": "#/components/schemas/CampaignReplyFlow"
+ }
+ },
+ "required": ["success", "data"]
+ },
+ "CampaignReplyFlow": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "flowKey": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Groups the revisions of one reply flow."
+ },
+ "revision": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "definition": {
+ "$ref": "#/components/schemas/CampaignReplyFlowDefinition"
+ },
+ "createdAt": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "id",
+ "flowKey",
+ "revision",
+ "name",
+ "definition",
+ "createdAt"
+ ]
+ },
+ "GetCampaignReplyFlowResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "enum": [true]
+ },
+ "data": {
+ "$ref": "#/components/schemas/CampaignReplyFlow"
+ }
+ },
+ "required": ["success", "data"]
+ },
+ "SetCampaignReplyFlowRequest": {
+ "type": "object",
+ "properties": {
+ "replyFlowId": {
+ "type": "string",
+ "nullable": true,
+ "format": "uuid",
+ "description": "Reply flow revision to run after replies, or null to detach it."
+ }
+ },
+ "required": ["replyFlowId"],
+ "additionalProperties": false
+ },
+ "SetCampaignReplyFlowResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "enum": [true]
+ },
+ "data": {
+ "type": "object",
+ "properties": {
+ "campaignId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "replyFlowId": {
+ "type": "string",
+ "nullable": true,
+ "format": "uuid"
+ }
+ },
+ "required": ["campaignId", "replyFlowId"]
+ }
+ },
+ "required": ["success", "data"]
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "description": "Team request quota per rolling minute, when the per-team request limiter applies.",
+ "schema": {
+ "type": "integer",
+ "minimum": 1
+ }
+ },
+ "X-RateLimit-Remaining": {
+ "description": "Requests left in the per-team quota; zero when this limiter rejects the request.",
+ "schema": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "X-RateLimit-Reset": {
+ "description": "Unix timestamp in seconds when the oldest counted request leaves the rolling window, when the per-team request limiter applies. Follow Retry-After on a rejected request.",
+ "schema": {
+ "type": "integer",
+ "minimum": 0
+ }
+ }
+ }
+ }
+ },
+ "platform": {
+ "sourcePath": "apps/api/docs/openapi.management.json",
+ "sourceSha256": "160fbc57b94ae0be9e5b1e9c183361582fe4b179e1b03c5917959d108990a057",
+ "paths": {
+ "/platform/projects/{projectId}/signal-custody": {
+ "get": {
+ "operationId": "getProjectSignalCustody",
+ "tags": ["signal-custody"],
+ "summary": "Read Project Signal custody default",
+ "description": "Returns the custody default for future Number reservations. Existing Number custody is immutable. Customer null defaults inherit the Project default.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "sessions:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/SignalCustodyDefault"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ }
+ }
+ },
+ "put": {
+ "operationId": "updateProjectSignalCustody",
+ "tags": ["signal-custody"],
+ "summary": "Update Project Signal custody default",
+ "description": "Changes the default for future Number reservations with a revision check. Customer-owned custody requires beta admission and runtime availability. Existing Numbers keep their custody. Dashboard writes require a team owner or admin. Setting a Customer default to null restores Project inheritance.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "sessions:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ProjectSignalCustodyUpdate"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/SignalCustodyDefault"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ },
+ "/platform/projects/{projectId}/customers/{customerId}/signal-custody": {
+ "get": {
+ "operationId": "getCustomerSignalCustody",
+ "tags": ["signal-custody"],
+ "summary": "Read Customer Signal custody default",
+ "description": "Returns the custody default for future Number reservations. Existing Number custody is immutable. Customer null defaults inherit the Project default.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "sessions:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "customerId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/SignalCustodyDefault"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ }
+ }
+ },
+ "put": {
+ "operationId": "updateCustomerSignalCustody",
+ "tags": ["signal-custody"],
+ "summary": "Update Customer Signal custody default",
+ "description": "Changes the default for future Number reservations with a revision check. Customer-owned custody requires beta admission and runtime availability. Existing Numbers keep their custody. Dashboard writes require a team owner or admin. Setting a Customer default to null restores Project inheritance.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "sessions:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ {
+ "name": "customerId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CustomerSignalCustodyUpdate"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/SignalCustodyDefault"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ },
+ "/platform/campaigns/{campaignId}/test-send": {
+ "post": {
+ "operationId": "testSendPlatformCampaign",
+ "tags": ["campaigns"],
+ "summary": "Send a test of a draft campaign",
+ "description": "Requires campaigns:manage and campaigns:read because the test can use stored recipient samples. Sends one copy of a draft campaign's content to a seed recipient, through the same rendering, sending and BanSafe checks as a launched campaign. The seed recipient must be a number connected to your team. The sending number must be connected, on a plan that includes Campaigns and, when the campaign selects numbers, one of them. A test is not a campaign recipient and is not counted in the campaign's statistics or webhooks. A team can send 20 tests an hour, and at most 5 an hour to one seed recipient. `429` means one of these limits was reached or BanSafe is pacing the sending number; follow `Retry-After`. `409 bansafe_cold_held` means the seed recipient has never written to the sending number and the campaign holds first messages. `409 state_conflict` means the campaign is not a draft or has A/B or weighted content alternatives, the sending number is a Hybrid Link number, or the seed recipient opted out. `504 result_unknown` means the outcome was not received in time and the test may still arrive. Send `projectId` in the body when using a team API key. `422 campaign_variables_missing` means the test's sample values, the mapped recipient value and the fallback all leave a variable in the campaign content empty.\n\nRequires `campaigns:manage` and `campaigns:read`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scopes": ["campaigns:manage", "campaigns:read"],
+ "x-required-scope-mode": "all",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "campaignId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "Idempotency-Key",
+ "in": "header",
+ "required": false,
+ "description": "Optional unique key, 1 to 255 bytes, that makes this request safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version` and request never runs it again: it returns `409 idempotency_completed` when the original succeeded, or the original server error. Reusing the key for a different request returns `409 idempotency_conflict`; a retry while the original is still running returns `409 idempotency_in_progress`, and a retry after an unrecorded outcome returns `409 idempotency_outcome_unknown`.",
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CampaignTestSendRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/CampaignTestSend"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "402": {
+ "$ref": "#/components/responses/PaymentRequired"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ },
+ "422": {
+ "$ref": "#/components/responses/CampaignVariablesMissing"
+ },
+ "429": {
+ "$ref": "#/components/responses/RateLimited"
+ },
+ "502": {
+ "$ref": "#/components/responses/UpstreamFailure"
+ },
+ "503": {
+ "$ref": "#/components/responses/SendPathUnavailable"
+ },
+ "504": {
+ "$ref": "#/components/responses/ResultUnknown"
+ }
+ }
+ }
+ },
+ "/platform/campaign-reply-flows": {
+ "post": {
+ "operationId": "createPlatformCampaignReplyFlow",
+ "tags": ["campaigns"],
+ "summary": "Create campaign reply flow",
+ "description": "Creates an immutable reply flow revision: the steps a campaign runs when a recipient replies. Each step can send a text, reply buttons, a list, or a Flow form (Official numbers only), and branches on the button or list row chosen, an exact keyword, or a Flow form submission. Beta: returns `403` unless campaign reply flows are enabled for the team. `409` means this flow key and revision already exist.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreatePlatformCampaignReplyFlowRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/PlatformCampaignReplyFlow"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ },
+ "/platform/campaign-reply-flows/{replyFlowId}": {
+ "get": {
+ "operationId": "getPlatformCampaignReplyFlow",
+ "tags": ["campaigns"],
+ "summary": "Get campaign reply flow",
+ "description": "Gets one reply flow revision in a project. Beta: returns `403` unless campaign reply flows are enabled for the team.\n\nRequires `campaigns:read`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "replyFlowId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectId",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/PlatformCampaignReplyFlow"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ }
+ }
+ }
+ },
+ "/platform/campaigns/{campaignId}/reply-flow": {
+ "put": {
+ "operationId": "setPlatformCampaignReplyFlow",
+ "tags": ["campaigns"],
+ "summary": "Set campaign reply flow",
+ "description": "Attaches a reply flow revision to a draft or scheduled campaign, or detaches it with `null`. The flow starts for each recipient once their message is sent. `409` means the campaign has already launched. Beta: returns `403` unless campaign reply flows are enabled for the team.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "campaignId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SetPlatformCampaignReplyFlowRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": ["campaignId", "replyFlowId"],
+ "properties": {
+ "campaignId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "replyFlowId": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ },
+ "/platform/campaigns/{campaignId}/recipients/export": {
+ "get": {
+ "operationId": "exportCampaignRecipients",
+ "tags": ["campaigns"],
+ "summary": "Export campaign recipients",
+ "description": "Returns recipients as CSV in queue order. Unfiltered exports page up to 1,000 recipients per request, using the `Polymorfa-Next-Cursor` response header. Each page starts with a header row and reflects outcomes when requested. Filtered exports are one atomic page of up to 1,000 recipients; larger filtered results return 409, so changing statuses cannot silently omit matches between pages. The export contains outcomes and `failureReason` codes only, never message content or template variables.\n\nRequires `campaigns:read`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "campaignId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectId",
+ "in": "query",
+ "required": false,
+ "description": "Project the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.",
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Project that owns the campaign. Required for team API keys; a project token is bound to its own project."
+ }
+ },
+ {
+ "name": "status",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "queued",
+ "sending",
+ "sent",
+ "delivered",
+ "read",
+ "failed",
+ "skipped"
+ ]
+ }
+ },
+ {
+ "name": "reason",
+ "in": "query",
+ "required": false,
+ "description": "Only recipients whose `failureReason` is this code.",
+ "schema": {
+ "$ref": "#/components/schemas/CampaignRecipientFailureReason"
+ }
+ },
+ {
+ "name": "cursor",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "description": "The `Polymorfa-Next-Cursor` value from the previous unfiltered page. Filtered exports cannot be paged."
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 1000,
+ "default": 1000,
+ "description": "Recipients per unfiltered page, up to 1,000. Filtered exports require 1,000."
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "One CSV page.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ },
+ "Polymorfa-Next-Cursor": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Cursor for the next page. Absent on the last page."
+ }
+ },
+ "content": {
+ "text/csv": {
+ "schema": {
+ "type": "string",
+ "description": "Header row, then one row per recipient. Columns: recipientId, phone, status, failureReason, attempts, variantKey, queuedAt, sentAt, deliveredAt, readAt, failedAt, respondedAt. Times are ISO 8601 in UTC. Empty fields are null. Text that begins with =, +, -, @, tab or carriage return is prefixed with an apostrophe, including phone numbers in international format. Machine readers should remove that leading apostrophe from phone cells."
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ },
+ "/platform/campaigns/{campaignId}/links": {
+ "get": {
+ "operationId": "getCampaignLinks",
+ "tags": ["campaigns"],
+ "summary": "Get tracked link opens",
+ "description": "Beta: requires team enrollment in campaign link tracking. Returns opens of each tracked link in the campaign's link order. An open is a request to the short link from a person, or from an app or security scanner previewing the link; it is not proof of a click. `uniqueOpens` counts recipients who opened the link at least once; `totalOpens` counts every open. A team without the beta answers `403 feature_unavailable`.\n\nRequires `campaigns:read`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "campaignId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectId",
+ "in": "query",
+ "required": false,
+ "description": "Project the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CampaignTrackedLinkReport"
+ }
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ }
+ }
+ }
+ },
+ "/platform/campaigns/{campaignId}/approvals": {
+ "get": {
+ "operationId": "listCampaignLaunchApprovals",
+ "tags": ["campaigns"],
+ "summary": "List campaign launch approvals",
+ "description": "Lists a campaign's approval requests, newest first, at most 20. A request is created when a launch is held by the team's approval threshold, or when an AI agent asks through the hosted MCP server to launch, resume or move the start (`reasons` says which). `action` is the requested step. It records the frozen recipient count and the requested start time. `status` is `pending` until a team owner or admin approves or rejects it, `superseded` when a later launch request or a change to the campaign replaced it, and `expired` 72 hours after it was requested.\n\nRequires `campaigns:read`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "campaignId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectId",
+ "in": "query",
+ "required": false,
+ "description": "Project the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CampaignLaunchApproval"
+ }
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ }
+ }
+ }
+ },
+ "/platform/campaign-settings": {
+ "get": {
+ "operationId": "getCampaignSettings",
+ "tags": ["campaign-settings"],
+ "summary": "Get campaign settings",
+ "description": "Returns the team's campaign settings. `launchApproval.recipientThreshold` is the number of recipients above which a launch needs a team owner or admin; null means no launch needs approval. A team that never saved settings receives `launchApproval.recipientThreshold: null`.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/CampaignSettings"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ }
+ }
+ }
+ },
+ "/platform/audiences/from-campaign": {
+ "post": {
+ "operationId": "createAudienceFromCampaign",
+ "tags": ["audiences"],
+ "summary": "Create an audience from a campaign",
+ "description": "Creates an audience from the recipients of a previous campaign that had one `outcome`, to send them a follow-up campaign. The members are a snapshot taken when the request runs: later receipts, reads or replies on the source campaign do not change the audience. Numbers on the team's opt-out list are left out and counted in `optedOutCount`; each member keeps the template variables it had on the source campaign. Outcomes: `delivered` (the device confirmed delivery), `not_delivered` (sent, with no delivery confirmation), `read`, `not_read` (sent and not read, including sends never delivered), `replied`, `not_replied` (sent and no reply was attributed), and `failed` (confirmed failed sends; sends whose outcome is uncertain, such as a timeout waiting for WhatsApp, are excluded). Read outcomes depend on the recipient's read receipts. `404` means the campaign is not in your team (or not in `projectId` when given); `409` means no recipient that is not opted out has the outcome, and nothing is created.\n\nRequires a team API key with `campaigns:manage`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 200
+ },
+ "campaignId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The campaign whose recipients are selected."
+ },
+ "projectId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Optional. When given, the campaign must belong to this project."
+ },
+ "outcome": {
+ "type": "string",
+ "enum": [
+ "delivered",
+ "not_delivered",
+ "read",
+ "not_read",
+ "replied",
+ "not_replied",
+ "failed"
+ ]
+ }
+ },
+ "required": ["name", "campaignId", "outcome"]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/AudienceFromCampaignResult"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ },
+ "/platform/audience-profiles": {
+ "get": {
+ "operationId": "listAudienceProfiles",
+ "tags": ["audience-profiles"],
+ "summary": "List audience profiles",
+ "description": "Lists customer-supplied profiles for the team with cursor pagination. Deleted profiles are omitted.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "cursor",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100,
+ "default": 25
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "phone": {
+ "type": "string",
+ "pattern": "^\\+[1-9][0-9]{6,14}$"
+ },
+ "revision": {
+ "type": "integer",
+ "minimum": 1
+ },
+ "tags": {
+ "type": "array",
+ "maxItems": 20,
+ "items": {
+ "type": "string",
+ "maxLength": 48
+ }
+ },
+ "attributes": {
+ "type": "object",
+ "maxProperties": 20,
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ }
+ },
+ "provenance": {
+ "type": "object",
+ "nullable": true,
+ "additionalProperties": false,
+ "properties": {
+ "source": {
+ "type": "string",
+ "enum": ["api", "csv", "form"]
+ },
+ "reference": {
+ "type": "string",
+ "maxLength": 128
+ }
+ },
+ "required": ["source", "reference"]
+ },
+ "createdAt": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "updatedAt": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "id",
+ "phone",
+ "revision",
+ "tags",
+ "attributes",
+ "provenance",
+ "createdAt",
+ "updatedAt"
+ ]
+ }
+ },
+ "page": {
+ "$ref": "#/components/schemas/CursorPageMetadata"
+ }
+ },
+ "required": ["data", "page"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ }
+ }
+ }
+ },
+ "/platform/audience-profiles/{phone}": {
+ "get": {
+ "operationId": "getAudienceProfile",
+ "tags": ["audience-profiles"],
+ "summary": "Get an audience profile",
+ "description": "Gets one customer-supplied profile by its E.164 phone. Deleted profiles return 404.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "phone",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "phone": {
+ "type": "string",
+ "pattern": "^\\+[1-9][0-9]{6,14}$"
+ },
+ "revision": {
+ "type": "integer",
+ "minimum": 1
+ },
+ "tags": {
+ "type": "array",
+ "maxItems": 20,
+ "items": {
+ "type": "string",
+ "maxLength": 48
+ }
+ },
+ "attributes": {
+ "type": "object",
+ "maxProperties": 20,
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ }
+ },
+ "provenance": {
+ "type": "object",
+ "nullable": true,
+ "additionalProperties": false,
+ "properties": {
+ "source": {
+ "type": "string",
+ "enum": ["api", "csv", "form"]
+ },
+ "reference": {
+ "type": "string",
+ "maxLength": 128
+ }
+ },
+ "required": ["source", "reference"]
+ },
+ "createdAt": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "updatedAt": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "id",
+ "phone",
+ "revision",
+ "tags",
+ "attributes",
+ "provenance",
+ "createdAt",
+ "updatedAt"
+ ]
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ }
+ }
+ },
+ "put": {
+ "operationId": "putAudienceProfile",
+ "tags": ["audience-profiles"],
+ "summary": "Create or update an audience profile",
+ "description": "Creates a bounded team profile, or replaces tags and attributes at the observed revision. A stale revision returns 409. To recreate a profile deleted in the last 30 days, send the `revision` the delete returned as `expectedRevision`; a put without it returns 409 with a message naming that revision. A consent assertion records the customer's statement; it does not clear an opt-out or authorize a send. This beta requires enrollment and release eligibility.\n\nRequires a team API key with `campaigns:manage`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "phone",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "expectedRevision": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "Required to edit or recreate a deleted profile; omit only for first creation."
+ },
+ "tags": {
+ "type": "array",
+ "maxItems": 20,
+ "items": {
+ "type": "string",
+ "maxLength": 48
+ }
+ },
+ "attributes": {
+ "type": "object",
+ "maxProperties": 20,
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ }
+ },
+ "provenance": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "source": {
+ "type": "string",
+ "enum": ["api", "csv", "form"]
+ },
+ "reference": {
+ "type": "string",
+ "maxLength": 128
+ }
+ },
+ "required": ["source", "reference"]
+ },
+ "consent": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "purpose": {
+ "type": "string",
+ "enum": ["campaigns"]
+ },
+ "source": {
+ "type": "string",
+ "enum": ["api", "csv", "form"]
+ },
+ "reference": {
+ "type": "string",
+ "maxLength": 128
+ },
+ "allowed": {
+ "type": "boolean"
+ },
+ "assertedAt": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 8640000000000000
+ }
+ },
+ "required": [
+ "purpose",
+ "source",
+ "reference",
+ "allowed",
+ "assertedAt"
+ ]
+ }
+ },
+ "required": ["tags", "attributes"]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "phone": {
+ "type": "string",
+ "pattern": "^\\+[1-9][0-9]{6,14}$"
+ },
+ "revision": {
+ "type": "integer",
+ "minimum": 1
+ },
+ "tags": {
+ "type": "array",
+ "maxItems": 20,
+ "items": {
+ "type": "string",
+ "maxLength": 48
+ }
+ },
+ "attributes": {
+ "type": "object",
+ "maxProperties": 20,
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ }
+ },
+ "provenance": {
+ "type": "object",
+ "nullable": true,
+ "additionalProperties": false,
+ "properties": {
+ "source": {
+ "type": "string",
+ "enum": ["api", "csv", "form"]
+ },
+ "reference": {
+ "type": "string",
+ "maxLength": 128
+ }
+ },
+ "required": ["source", "reference"]
+ },
+ "createdAt": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "updatedAt": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "id",
+ "phone",
+ "revision",
+ "tags",
+ "attributes",
+ "provenance",
+ "createdAt",
+ "updatedAt"
+ ]
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ },
+ "delete": {
+ "operationId": "deleteAudienceProfile",
+ "tags": ["audience-profiles"],
+ "summary": "Delete an audience profile",
+ "description": "Removes profile fields, consent assertions and reusable audience-list memberships at the observed revision, and clears the preview row of each audience the phone belonged to. Recipients already added to campaigns (including drafts), previously uploaded files and opt-outs are not changed. The phone's deletion record is kept for 30 days; `revision` is its revision. During that time, adding the phone to an audience returns 409, and recreating the profile requires `expectedRevision` set to this revision. Deletion remains available after beta withdrawal.\n\nRequires a team API key with `campaigns:manage`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "phone",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "expectedRevision",
+ "in": "query",
+ "required": true,
+ "description": "The profile revision you last read. A different current revision returns 409.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "deleted": {
+ "type": "boolean",
+ "enum": [true]
+ },
+ "phone": {
+ "type": "string"
+ },
+ "revision": {
+ "type": "integer",
+ "minimum": 2
+ }
+ },
+ "required": ["deleted", "phone", "revision"]
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ },
+ "/platform/audience-profiles/{phone}/consent": {
+ "get": {
+ "operationId": "listAudienceProfileConsent",
+ "tags": ["audience-profiles"],
+ "summary": "List audience consent assertions",
+ "description": "Lists the customer's recorded campaign consent assertions for one profile. Assertions do not override opt-outs.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "phone",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "cursor",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100,
+ "default": 25
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "profileRevision": {
+ "type": "integer",
+ "minimum": 1
+ },
+ "purpose": {
+ "type": "string",
+ "enum": ["campaigns"]
+ },
+ "source": {
+ "type": "string",
+ "enum": ["api", "csv", "form"]
+ },
+ "reference": {
+ "type": "string"
+ },
+ "allowed": {
+ "type": "boolean"
+ },
+ "assertedAt": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "createdAt": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "id",
+ "profileRevision",
+ "purpose",
+ "source",
+ "reference",
+ "allowed",
+ "assertedAt",
+ "createdAt"
+ ]
+ }
+ },
+ "page": {
+ "$ref": "#/components/schemas/CursorPageMetadata"
+ }
+ },
+ "required": ["data", "page"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ }
+ }
+ }
+ },
+ "/platform/audience-profile-imports": {
+ "post": {
+ "operationId": "createAudienceProfileImport",
+ "tags": ["audience-profiles"],
+ "summary": "Start an audience profile CSV import",
+ "description": "Queues a bounded CSV import of customer-supplied team profiles. Exact CSV header names can be mapped to profile fields. At most one import is active per team. Files contain at most 10 MiB and 10,000 rows; the CSV is removed after completion or cancellation. The same replay key, file and mapping return the existing job. Requires beta enrollment.\n\nRequires a team API key with `campaigns:manage`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "replayKey": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "pattern": "^[A-Za-z0-9._:-]+$"
+ },
+ "csvBase64": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 13981016,
+ "format": "byte",
+ "description": "UTF-8 CSV encoded as standard padded base64; decoded file at most 10 MiB and 10,000 data rows. The `tags` cell holds a JSON array of strings and the `attributes` cell a JSON object, quoted as CSV requires, for example `+15550100001,\"[\"\"vip\"\"]\",\"{\"\"city\"\":\"\"Lisbon\"\"}\"`."
+ },
+ "mapping": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "Maps profile fields to exact CSV header names. Required when the CSV uses different headers; unmapped CSV columns are ignored.",
+ "properties": {
+ "phone": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 64
+ },
+ "tags": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 64
+ },
+ "attributes": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 64
+ },
+ "expectedRevision": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 64
+ },
+ "provenanceReference": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 64
+ },
+ "consentAllowed": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 64
+ },
+ "consentAssertedAt": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 64
+ },
+ "consentReference": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 64
+ }
+ },
+ "required": ["phone", "tags", "attributes"]
+ }
+ },
+ "required": ["replayKey", "csvBase64"]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "state": {
+ "type": "string",
+ "enum": ["queued", "completed", "cancelled"]
+ },
+ "totalValid": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Rows that passed validation and will be written."
+ },
+ "invalidCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Rows refused by validation; `invalidSamples` lists up to 20."
+ },
+ "invalidSamples": {
+ "type": "array",
+ "maxItems": 20,
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "row": {
+ "type": "integer",
+ "minimum": 2
+ },
+ "reason": {
+ "type": "string"
+ }
+ },
+ "required": ["row", "reason"]
+ }
+ },
+ "conflictSamples": {
+ "type": "array",
+ "maxItems": 20,
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "row": {
+ "type": "integer",
+ "minimum": 2
+ },
+ "reason": {
+ "type": "string",
+ "enum": ["quota", "revision_conflict"]
+ }
+ },
+ "required": ["row", "reason"]
+ }
+ },
+ "processedValid": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Valid rows written so far."
+ },
+ "createdCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Profiles created."
+ },
+ "updatedCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Existing profiles updated."
+ },
+ "conflictCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Valid rows not written because of the team's profile quota or a revision conflict; `conflictSamples` lists up to 20."
+ },
+ "createdAt": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "updatedAt": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "completedAt": {
+ "type": "integer",
+ "minimum": 0,
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "state",
+ "totalValid",
+ "invalidCount",
+ "invalidSamples",
+ "conflictSamples",
+ "processedValid",
+ "createdCount",
+ "updatedCount",
+ "conflictCount",
+ "createdAt",
+ "updatedAt",
+ "completedAt"
+ ]
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ },
+ "413": {
+ "$ref": "#/components/responses/PayloadTooLarge"
+ }
+ }
+ }
+ },
+ "/platform/audience-profile-imports/{jobId}": {
+ "get": {
+ "operationId": "getAudienceProfileImport",
+ "tags": ["audience-profiles"],
+ "summary": "Get an audience profile import report",
+ "description": "Returns aggregate counts and up to 20 row-number/reason samples. Raw phone numbers and custom values are not included. Reports expire 30 days after completion or cancellation.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "jobId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "state": {
+ "type": "string",
+ "enum": ["queued", "completed", "cancelled"]
+ },
+ "totalValid": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Rows that passed validation and will be written."
+ },
+ "invalidCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Rows refused by validation; `invalidSamples` lists up to 20."
+ },
+ "invalidSamples": {
+ "type": "array",
+ "maxItems": 20,
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "row": {
+ "type": "integer",
+ "minimum": 2
+ },
+ "reason": {
+ "type": "string"
+ }
+ },
+ "required": ["row", "reason"]
+ }
+ },
+ "conflictSamples": {
+ "type": "array",
+ "maxItems": 20,
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "row": {
+ "type": "integer",
+ "minimum": 2
+ },
+ "reason": {
+ "type": "string",
+ "enum": ["quota", "revision_conflict"]
+ }
+ },
+ "required": ["row", "reason"]
+ }
+ },
+ "processedValid": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Valid rows written so far."
+ },
+ "createdCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Profiles created."
+ },
+ "updatedCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Existing profiles updated."
+ },
+ "conflictCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Valid rows not written because of the team's profile quota or a revision conflict; `conflictSamples` lists up to 20."
+ },
+ "createdAt": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "updatedAt": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "completedAt": {
+ "type": "integer",
+ "minimum": 0,
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "state",
+ "totalValid",
+ "invalidCount",
+ "invalidSamples",
+ "conflictSamples",
+ "processedValid",
+ "createdCount",
+ "updatedCount",
+ "conflictCount",
+ "createdAt",
+ "updatedAt",
+ "completedAt"
+ ]
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ }
+ }
+ },
+ "delete": {
+ "operationId": "cancelAudienceProfileImport",
+ "tags": ["audience-profiles"],
+ "summary": "Cancel an audience profile import",
+ "description": "Stops the next batch and removes the CSV. Already committed profile edits remain. Cancellation and report reads remain available after beta withdrawal.\n\nRequires a team API key with `campaigns:manage`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "jobId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "state": {
+ "type": "string",
+ "enum": ["queued", "completed", "cancelled"]
+ },
+ "totalValid": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Rows that passed validation and will be written."
+ },
+ "invalidCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Rows refused by validation; `invalidSamples` lists up to 20."
+ },
+ "invalidSamples": {
+ "type": "array",
+ "maxItems": 20,
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "row": {
+ "type": "integer",
+ "minimum": 2
+ },
+ "reason": {
+ "type": "string"
+ }
+ },
+ "required": ["row", "reason"]
+ }
+ },
+ "conflictSamples": {
+ "type": "array",
+ "maxItems": 20,
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "row": {
+ "type": "integer",
+ "minimum": 2
+ },
+ "reason": {
+ "type": "string",
+ "enum": ["quota", "revision_conflict"]
+ }
+ },
+ "required": ["row", "reason"]
+ }
+ },
+ "processedValid": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Valid rows written so far."
+ },
+ "createdCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Profiles created."
+ },
+ "updatedCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Existing profiles updated."
+ },
+ "conflictCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Valid rows not written because of the team's profile quota or a revision conflict; `conflictSamples` lists up to 20."
+ },
+ "createdAt": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "updatedAt": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "completedAt": {
+ "type": "integer",
+ "minimum": 0,
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "state",
+ "totalValid",
+ "invalidCount",
+ "invalidSamples",
+ "conflictSamples",
+ "processedValid",
+ "createdCount",
+ "updatedCount",
+ "conflictCount",
+ "createdAt",
+ "updatedAt",
+ "completedAt"
+ ]
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ }
+ }
+ }
+ },
+ "/platform/optouts/confirmation-settings": {
+ "get": {
+ "operationId": "getStopConfirmationSettings",
+ "tags": ["optouts"],
+ "summary": "Get STOP confirmation settings",
+ "description": "Returns the team's optional acknowledgement preference. Confirmations are disabled by default. A locale is explicitly selected from English, Brazilian Portuguese or Spanish; the response includes the reviewed acknowledgement text. Reads remain available after beta withdrawal.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/StopConfirmationSettings"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ }
+ }
+ },
+ "put": {
+ "operationId": "updateStopConfirmationSettings",
+ "tags": ["optouts"],
+ "summary": "Update STOP confirmation settings",
+ "description": "Replaces the team's preference using the observed revision. Enabling requires STOP confirmations beta access and a selected locale. A team owner or admin can also change it in the console. A new STOP opt-out queues at most one plain acknowledgement from the receiving connection; manual opt-outs, repeated STOP while suppressed and START produce none. A confirmation cannot undo suppression. Disabling remains available after beta withdrawal and cancels queued acknowledgements. A changed revision returns 409. Unknown send outcomes are never resent with a new operation identity.\n\nRequires a team API key with `campaigns:manage`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateStopConfirmationSettingsInput"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/StopConfirmationSettings"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ },
+ "/platform/optouts/confirmation-summary": {
+ "get": {
+ "operationId": "getStopConfirmationSummary",
+ "tags": ["optouts"],
+ "summary": "Get STOP confirmation outcome counts",
+ "description": "Returns aggregate acknowledgement outcomes from the last 30 days, without recipient phones or message content. Disabled is the preference state, queued is waiting, admitted may have been submitted, completed means the provider accepted the send rather than delivered it, failed is a proven skip or rejection, and unknown means the send outcome could not be established. All outcomes preserve the opt-out.\n\nRequires a team API key with `campaigns:read`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/StopConfirmationSummary"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "SignalCustodyDefault": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "signalModeDefault": {
+ "type": "string",
+ "enum": ["standard", "zero_knowledge", null],
+ "nullable": true
+ },
+ "effectiveSignalMode": {
+ "type": "string",
+ "enum": ["standard", "zero_knowledge"]
+ },
+ "revision": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": ["signalModeDefault", "effectiveSignalMode", "revision"]
+ },
+ "ErrorEnvelope": {
+ "type": "object",
+ "required": ["error", "data", "docs"],
+ "properties": {
+ "error": {
+ "type": "object",
+ "required": ["type", "code", "message", "param", "request_id"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "invalid_request_error",
+ "authentication_error",
+ "permission_error",
+ "conflict_error",
+ "rate_limit_error",
+ "api_error",
+ "upstream_error"
+ ]
+ },
+ "code": {
+ "type": "string",
+ "description": "Stable failure code. Use this value for programmatic handling."
+ },
+ "message": {
+ "type": "string",
+ "description": "Safe explanation of the failure."
+ },
+ "param": {
+ "type": "string",
+ "nullable": true,
+ "description": "Invalid request field, or null when no field applies."
+ },
+ "request_id": {
+ "type": "string",
+ "description": "Matches the X-Request-Id response header. Include it when you contact support."
+ },
+ "request_log_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "Console page that shows this request. Returned only to team and project credentials whose request was logged."
+ }
+ }
+ },
+ "data": {
+ "type": "string",
+ "nullable": true,
+ "enum": [null],
+ "description": "Always null for a failed request."
+ },
+ "docs": {
+ "type": "string",
+ "format": "uri",
+ "description": "Documentation link to this failure code."
+ }
+ }
+ },
+ "ProjectSignalCustodyUpdate": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "expectedRevision": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 9007199254740991
+ },
+ "signalModeDefault": {
+ "type": "string",
+ "enum": ["standard", "zero_knowledge"]
+ }
+ },
+ "required": ["expectedRevision", "signalModeDefault"]
+ },
+ "CustomerSignalCustodyUpdate": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "expectedRevision": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 9007199254740991
+ },
+ "signalModeDefault": {
+ "type": "string",
+ "enum": ["standard", "zero_knowledge", null],
+ "nullable": true
+ }
+ },
+ "required": ["expectedRevision", "signalModeDefault"]
+ },
+ "CampaignTestSendRequest": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "projectId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Required when using a team API key. Project tokens derive the project from the credential."
+ },
+ "sessionId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The number to send the test from. It must be connected, on a plan that includes Campaigns and, when the campaign selects numbers, one of them."
+ },
+ "to": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 32,
+ "description": "The seed recipient in international format. It must be the phone of a number connected to your team.",
+ "example": "+5511999990000"
+ },
+ "sampleRecipientId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "A recipient of this campaign whose variables fill the content. Without it and without `variables`, the campaign's first recipient, or its audience's first member, is the sample."
+ },
+ "variables": {
+ "type": "object",
+ "maxProperties": 50,
+ "additionalProperties": {
+ "oneOf": [
+ {
+ "type": "string",
+ "maxLength": 1024
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ },
+ "description": "Variable values for the test. They override the sample recipient's values; without `sampleRecipientId`, only these values are used."
+ }
+ },
+ "required": ["sessionId", "to"]
+ },
+ "CampaignTestSend": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The test send's ID."
+ },
+ "campaignId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "status": {
+ "type": "string",
+ "enum": ["sent"]
+ },
+ "from": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "sessionId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "phone": {
+ "type": "string"
+ }
+ },
+ "required": ["sessionId", "phone"],
+ "description": "The number the test was sent from."
+ },
+ "to": {
+ "type": "string",
+ "description": "The seed recipient, in E.164 format."
+ },
+ "messageId": {
+ "type": "string",
+ "nullable": true,
+ "description": "The WhatsApp message ID, when the send path returned one."
+ },
+ "variables": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The variable values the content was rendered with."
+ },
+ "createdAt": {
+ "type": "number",
+ "description": "When the test was admitted, in Unix milliseconds."
+ }
+ },
+ "required": [
+ "id",
+ "campaignId",
+ "status",
+ "from",
+ "to",
+ "messageId",
+ "variables",
+ "createdAt"
+ ]
+ },
+ "CreatePlatformCampaignReplyFlowRequest": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": ["name", "definition"],
+ "properties": {
+ "name": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128
+ },
+ "flowKey": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Existing flow key to add a revision to. Omit to start a new reply flow."
+ },
+ "revision": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 1000000,
+ "description": "Defaults to 1; each key and revision can be created once."
+ },
+ "definition": {
+ "$ref": "#/components/schemas/PlatformCampaignReplyFlowDefinition"
+ },
+ "projectId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Required when using a team API key. Project tokens derive the project from the credential."
+ }
+ }
+ },
+ "PlatformCampaignReplyFlowDefinition": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": ["entryNodeId", "nodes"],
+ "description": "An acyclic graph of 2 to 12 steps. The entry step waits for the first reply and sends nothing. See the reply flows guide for step and branch shapes.",
+ "properties": {
+ "entryNodeId": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$"
+ },
+ "nodes": {
+ "type": "array",
+ "minItems": 2,
+ "maxItems": 12,
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": ["id", "edges"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$"
+ },
+ "send": {
+ "type": "object",
+ "required": ["kind"],
+ "additionalProperties": true,
+ "description": "`text` (`text`), `buttons` (`body`, up to 3 `buttons` with `id` and `text`), `list` (`body`, `buttonText`, up to 10 `rows`), or `flow_form` (`flowId`, `body`, `buttonText`, `screen`; Official numbers only).",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["text", "buttons", "list", "flow_form"]
+ }
+ }
+ },
+ "edges": {
+ "type": "array",
+ "maxItems": 3,
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": ["match", "to"],
+ "properties": {
+ "match": {
+ "type": "object",
+ "required": ["kind"],
+ "additionalProperties": true,
+ "description": "`choice` (`replyKind` `button` or `list`, `id`), `keyword` (`value`), or `flow_submission`.",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "enum": ["choice", "keyword", "flow_submission"]
+ }
+ }
+ },
+ "to": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "PlatformCampaignReplyFlow": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": [
+ "id",
+ "flowKey",
+ "revision",
+ "name",
+ "definition",
+ "createdAt"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "flowKey": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Groups the revisions of one reply flow."
+ },
+ "revision": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "definition": {
+ "$ref": "#/components/schemas/PlatformCampaignReplyFlowDefinition"
+ },
+ "createdAt": {
+ "type": "integer",
+ "description": "Unix milliseconds."
+ }
+ }
+ },
+ "SetPlatformCampaignReplyFlowRequest": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": ["replyFlowId"],
+ "properties": {
+ "replyFlowId": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true,
+ "description": "Reply flow revision to run after replies, or null to detach it."
+ },
+ "projectId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Required when using a team API key. Project tokens derive the project from the credential."
+ }
+ }
+ },
+ "CampaignRecipientFailureReason": {
+ "type": "string",
+ "enum": [
+ "opted_out",
+ "cold_held",
+ "campaign_cancelled",
+ "invalid_recipient",
+ "session_not_connected",
+ "ack_timeout",
+ "blocked_by_safety",
+ "send_failed",
+ "missing_variable",
+ "other"
+ ],
+ "description": "Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the number is on the team's opt-out list. `cold_held`: the number never wrote to the sending number and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the number is not a valid WhatsApp address. `session_not_connected`: the sending number was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `other`: any other reason. New codes may be added."
+ },
+ "CampaignTrackedLinkReport": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Tracked link key.",
+ "example": "offer"
+ },
+ "url": {
+ "type": "string",
+ "description": "Destination of the tracked link."
+ },
+ "uniqueOpens": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Recipients who opened the link at least once."
+ },
+ "totalOpens": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Every recorded open, including repeat opens."
+ }
+ },
+ "required": ["key", "url", "uniqueOpens", "totalOpens"]
+ },
+ "CampaignLaunchApproval": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "campaignId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "action": {
+ "type": "string",
+ "enum": ["launch", "resume", "reschedule"],
+ "description": "The held command. Approving it runs that command."
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "pending",
+ "approved",
+ "rejected",
+ "superseded",
+ "expired"
+ ]
+ },
+ "reasons": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": ["audience_threshold", "agent_request"]
+ },
+ "description": "Why the command was held. `audience_threshold`: a launch would send to more recipients than the team's threshold. `agent_request`: an AI agent asked through the hosted MCP server."
+ },
+ "recipientCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Recipients the command would send to: the frozen audience after opt-outs for a launch, the queued recipients for a resume or new start time."
+ },
+ "scheduledAt": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true,
+ "description": "Requested start in Unix milliseconds; null starts when approved. Null for a resume."
+ },
+ "requestedBy": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ }
+ },
+ "required": ["type", "id"]
+ },
+ "requestedAt": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "expiresAt": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "decidedBy": {
+ "type": "string",
+ "nullable": true,
+ "description": "The owner or admin who approved or rejected it."
+ },
+ "decidedAt": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ },
+ "operationId": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true,
+ "description": "The launch operation an approval started."
+ }
+ },
+ "required": [
+ "id",
+ "campaignId",
+ "action",
+ "status",
+ "reasons",
+ "recipientCount",
+ "scheduledAt",
+ "requestedBy",
+ "requestedAt",
+ "expiresAt",
+ "decidedBy",
+ "decidedAt",
+ "operationId"
+ ]
+ },
+ "CampaignSettings": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "launchApproval": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "recipientThreshold": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 1000000,
+ "nullable": true,
+ "description": "Launches that would send to more recipients than this need a team owner or admin. Null turns approval off."
+ }
+ },
+ "required": ["recipientThreshold"]
+ }
+ },
+ "required": ["launchApproval"]
+ },
+ "AudienceFromCampaignResult": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string"
+ },
+ "source": {
+ "type": "string",
+ "enum": ["campaign"]
+ },
+ "recipientCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Members in the new audience."
+ },
+ "fileId": {
+ "type": "string",
+ "nullable": true
+ },
+ "columns": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ },
+ "sampleRow": {
+ "type": "object",
+ "nullable": true,
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "mapping": {
+ "type": "object",
+ "nullable": true,
+ "additionalProperties": true
+ },
+ "createdAt": {
+ "type": "integer"
+ },
+ "updatedAt": {
+ "type": "integer"
+ },
+ "sourceCampaignId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "outcome": {
+ "type": "string",
+ "enum": [
+ "delivered",
+ "not_delivered",
+ "read",
+ "not_read",
+ "replied",
+ "not_replied",
+ "failed"
+ ]
+ },
+ "matchedCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Recipients of the source campaign with the outcome, before opt-outs were left out."
+ },
+ "optedOutCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Matched recipients left out because the number is on the team's opt-out list."
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "source",
+ "recipientCount",
+ "fileId",
+ "columns",
+ "sampleRow",
+ "mapping",
+ "createdAt",
+ "updatedAt",
+ "sourceCampaignId",
+ "outcome",
+ "matchedCount",
+ "optedOutCount"
+ ]
+ },
+ "CursorPageMetadata": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "nextCursor": {
+ "type": "string",
+ "nullable": true
+ },
+ "hasMore": {
+ "type": "boolean"
+ }
+ },
+ "required": ["nextCursor", "hasMore"]
+ },
+ "StopConfirmationSettings": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "teamId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "locale": {
+ "type": "string",
+ "enum": ["en", "pt-BR", "es", null],
+ "nullable": true
+ },
+ "revision": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "textRevision": {
+ "type": "integer",
+ "enum": [1]
+ },
+ "acknowledgement": {
+ "type": "string",
+ "nullable": true
+ },
+ "updatedAt": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ }
+ },
+ "required": [
+ "teamId",
+ "enabled",
+ "locale",
+ "revision",
+ "textRevision",
+ "acknowledgement",
+ "updatedAt"
+ ]
+ },
+ "UpdateStopConfirmationSettingsInput": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "teamId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The teamId returned by the settings read. Must match the authenticated team."
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "locale": {
+ "type": "string",
+ "enum": ["en", "pt-BR", "es", null],
+ "nullable": true,
+ "description": "Required when enabled. Never inferred from a phone number."
+ },
+ "revision": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 2147483646
+ }
+ },
+ "required": ["teamId", "enabled", "locale", "revision"]
+ },
+ "StopConfirmationSummary": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "counts": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "queued": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "admitted": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "completed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "failed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "unknown": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "queued",
+ "admitted",
+ "completed",
+ "failed",
+ "unknown"
+ ]
+ }
+ },
+ "required": ["enabled", "counts"]
+ }
+ },
+ "responses": {
+ "BadRequest": {
+ "description": "A path, query, or request-body value did not pass validation.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
+ },
+ "Unauthorized": {
+ "description": "Missing/invalid credential for this audience.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
+ },
+ "Forbidden": {
+ "description": "Authenticated but lacks the required scope/role/audience.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
+ },
+ "NotFound": {
+ "description": "The requested resource was not found inside the authenticated team or project scope.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
+ },
+ "Conflict": {
+ "description": "The request conflicts with the resource's current state.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
+ },
+ "PaymentRequired": {
+ "description": "The number's plan does not include this capability.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
+ },
+ "CampaignVariablesMissing": {
+ "description": "`campaign_variables_missing`: a recipient (or the test's sample values) has no value and no fallback for a variable in the campaign content. Nothing was sent.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
+ },
+ "RateLimited": {
+ "description": "A limit was reached. Wait for `Retry-After` before retrying.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ },
+ "Retry-After": {
+ "schema": {
+ "type": "integer",
+ "minimum": 1
+ },
+ "description": "Seconds to wait before retrying."
+ },
+ "Polymorfa-RateLimit-Reason": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "The limit that was reached. See the rate-limit reasons in the error reference."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
+ },
+ "UpstreamFailure": {
+ "description": "`upstream_failure`: the messaging provider could not complete the send.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
+ },
+ "SendPathUnavailable": {
+ "description": "The send path is unavailable or the sending number is not ready (`session_not_ready`, `command_dispatch_failed`, `service_unavailable`, or `bansafe_accounting_unavailable`). No message was sent.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
+ },
+ "ResultUnknown": {
+ "description": "`result_unknown`: the outcome was not received before the deadline. The message may still arrive; check before repeating the request.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
+ },
+ "PayloadTooLarge": {
+ "description": "Request body exceeds the endpoint limit.",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorEnvelope"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/contracts/history/pre-connections/campaign-follow-ups.json b/contracts/history/pre-connections/campaign-follow-ups.json
new file mode 100644
index 000000000..d5921b020
--- /dev/null
+++ b/contracts/history/pre-connections/campaign-follow-ups.json
@@ -0,0 +1,620 @@
+{
+ "repository": "polymorfa/polymorfa",
+ "commit": "87b25fd9e2494d90f01f7511fb47be6a28845fa1",
+ "note": "Receipt-timed campaign follow-up beta (PR #503). Adds followUp to Messaging and Platform campaigns and recipients, and followUps to campaign analytics; the full snapshots stay pinned to contracts/source.json until the next repin.",
+ "sources": {
+ "messaging": {
+ "sourcePath": "apps/api/docs/openapi.json",
+ "sourceSha256": "c30cd7523f3fbec9c83214f899781f6f43c7e3d5fd05dd828158d3dfb32df6cb",
+ "schemas": {
+ "CampaignFollowUpReport": {
+ "type": "object",
+ "properties": {
+ "total": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "waiting": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "scheduled": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sending": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sent": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "delivered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "read": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "replied": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "cancelled": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "expired": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "failed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "unknown": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "nextDueAt": {
+ "type": "number",
+ "nullable": true
+ }
+ },
+ "required": [
+ "total",
+ "waiting",
+ "scheduled",
+ "sending",
+ "sent",
+ "delivered",
+ "read",
+ "replied",
+ "cancelled",
+ "expired",
+ "failed",
+ "unknown",
+ "nextDueAt"
+ ],
+ "additionalProperties": false,
+ "description": "Follow-up outcomes, counted separately from the first message. All zero when the campaign has no follow-up."
+ }
+ },
+ "fields": {
+ "Campaign.followUp": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "delaySeconds": {
+ "type": "integer",
+ "minimum": 60,
+ "maximum": 604800,
+ "default": 86400
+ },
+ "expirySeconds": {
+ "type": "integer",
+ "minimum": 86400,
+ "maximum": 2592000,
+ "default": 604800
+ },
+ "message": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["text"]
+ },
+ "text": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16384
+ }
+ },
+ "required": ["type", "text"],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["template"]
+ },
+ "templateId": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "required": ["type", "templateId"],
+ "additionalProperties": false
+ }
+ ]
+ }
+ },
+ "required": ["message"],
+ "additionalProperties": false,
+ "description": "One optional follow-up, sent from the Number that sent the first message. Null when the campaign has none. Content and timing freeze at launch."
+ },
+ "CreateCampaignRequest.followUp": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "delaySeconds": {
+ "type": "integer",
+ "minimum": 60,
+ "maximum": 604800,
+ "default": 86400
+ },
+ "expirySeconds": {
+ "type": "integer",
+ "minimum": 86400,
+ "maximum": 2592000,
+ "default": 604800
+ },
+ "message": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["text"]
+ },
+ "text": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16384
+ }
+ },
+ "required": ["type", "text"],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["template"]
+ },
+ "templateId": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "required": ["type", "templateId"],
+ "additionalProperties": false
+ }
+ ]
+ }
+ },
+ "required": ["message"],
+ "additionalProperties": false,
+ "description": "One optional follow-up. A beta; a team that is not enrolled gets `403 feature_unavailable`. Requires a single first message: a campaign with a composed message sequence cannot launch with a follow-up. Follow-up text cannot contain tracked links."
+ },
+ "UpdateCampaignRequest.followUp": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "delaySeconds": {
+ "type": "integer",
+ "minimum": 60,
+ "maximum": 604800,
+ "default": 86400
+ },
+ "expirySeconds": {
+ "type": "integer",
+ "minimum": 86400,
+ "maximum": 2592000,
+ "default": 604800
+ },
+ "message": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["text"]
+ },
+ "text": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16384
+ }
+ },
+ "required": ["type", "text"],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["template"]
+ },
+ "templateId": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "required": ["type", "templateId"],
+ "additionalProperties": false
+ }
+ ]
+ }
+ },
+ "required": ["message"],
+ "additionalProperties": false,
+ "description": "One follow-up, editable only before launch. Null removes it. A beta; a team that is not enrolled gets `403 feature_unavailable` when setting one. The first read takes precedence over the first delivery; replies and opt-outs cancel; an expired wait never sends."
+ },
+ "CampaignRecipient.followUp": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "numberId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "waiting_receipt",
+ "scheduled",
+ "sending",
+ "sent",
+ "cancelled",
+ "expired",
+ "failed",
+ "outcome_unknown"
+ ]
+ },
+ "anchorKind": {
+ "type": "string",
+ "nullable": true,
+ "enum": ["delivered", "read", null]
+ },
+ "firstDeliveredAt": {
+ "type": "number",
+ "nullable": true
+ },
+ "firstReadAt": {
+ "type": "number",
+ "nullable": true
+ },
+ "dueAt": {
+ "type": "number",
+ "nullable": true
+ },
+ "expiresAt": {
+ "type": "number"
+ },
+ "sentAt": {
+ "type": "number",
+ "nullable": true
+ },
+ "deliveredAt": {
+ "type": "number",
+ "nullable": true
+ },
+ "readAt": {
+ "type": "number",
+ "nullable": true
+ },
+ "repliedAt": {
+ "type": "number",
+ "nullable": true
+ },
+ "reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "commandId": {
+ "type": "string",
+ "nullable": true,
+ "format": "uuid"
+ }
+ },
+ "required": [
+ "id",
+ "numberId",
+ "status",
+ "anchorKind",
+ "firstDeliveredAt",
+ "firstReadAt",
+ "dueAt",
+ "expiresAt",
+ "sentAt",
+ "deliveredAt",
+ "readAt",
+ "repliedAt",
+ "reason",
+ "commandId"
+ ],
+ "additionalProperties": false
+ },
+ "CampaignAnalytics.followUps": {
+ "$ref": "#/components/schemas/CampaignFollowUpReport"
+ }
+ }
+ },
+ "platform": {
+ "sourcePath": "apps/api/docs/openapi.management.json",
+ "sourceSha256": "583b9d99426de8a13462eafa3a0095e3c7386282e73f23c14238f41a15ccab0d",
+ "schemas": {
+ "CampaignFollowUp": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": ["message"],
+ "description": "One optional receipt-timed follow-up, sent from the Number that sent the first message. A beta; a team that is not enrolled gets `403 feature_unavailable`. Expiry must exceed delay and is counted from the first send. Configuration freezes at launch. The first read takes precedence over the first delivery; additional reads do not move it. Replies and opt-outs cancel it. Without a delivery or read receipt it never arms, and an expired wait never sends. Requires a single first message, and the text cannot contain tracked links.",
+ "properties": {
+ "delaySeconds": {
+ "type": "integer",
+ "minimum": 60,
+ "maximum": 604800,
+ "default": 86400
+ },
+ "expirySeconds": {
+ "type": "integer",
+ "minimum": 86400,
+ "maximum": 2592000,
+ "default": 604800
+ },
+ "message": {
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "required": ["type", "text"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["text"]
+ },
+ "text": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 16384
+ }
+ }
+ },
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "required": ["type", "templateId"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": ["template"]
+ },
+ "templateId": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ }
+ ]
+ }
+ }
+ },
+ "CampaignFollowUpSummary": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": [
+ "id",
+ "numberId",
+ "status",
+ "anchorKind",
+ "firstDeliveredAt",
+ "firstReadAt",
+ "dueAt",
+ "expiresAt",
+ "sentAt",
+ "deliveredAt",
+ "readAt",
+ "repliedAt",
+ "reason",
+ "commandId"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "numberId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "waiting_receipt",
+ "scheduled",
+ "sending",
+ "sent",
+ "cancelled",
+ "expired",
+ "failed",
+ "outcome_unknown"
+ ]
+ },
+ "anchorKind": {
+ "type": "string",
+ "enum": ["delivered", "read", null],
+ "nullable": true
+ },
+ "firstDeliveredAt": {
+ "type": "number",
+ "nullable": true,
+ "description": "Unix milliseconds."
+ },
+ "firstReadAt": {
+ "type": "number",
+ "nullable": true,
+ "description": "Unix milliseconds."
+ },
+ "dueAt": {
+ "type": "number",
+ "nullable": true,
+ "description": "Unix milliseconds."
+ },
+ "sentAt": {
+ "type": "number",
+ "nullable": true,
+ "description": "Unix milliseconds."
+ },
+ "deliveredAt": {
+ "type": "number",
+ "nullable": true,
+ "description": "Unix milliseconds."
+ },
+ "readAt": {
+ "type": "number",
+ "nullable": true,
+ "description": "Unix milliseconds."
+ },
+ "repliedAt": {
+ "type": "number",
+ "nullable": true,
+ "description": "Unix milliseconds."
+ },
+ "expiresAt": {
+ "type": "number",
+ "description": "Unix milliseconds."
+ },
+ "reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "commandId": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true
+ }
+ }
+ },
+ "CampaignFollowUpReport": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": [
+ "total",
+ "waiting",
+ "scheduled",
+ "sending",
+ "sent",
+ "delivered",
+ "read",
+ "replied",
+ "cancelled",
+ "expired",
+ "failed",
+ "unknown",
+ "nextDueAt"
+ ],
+ "properties": {
+ "total": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "waiting": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "scheduled": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sending": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "sent": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "delivered": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "read": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "replied": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "cancelled": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "expired": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "failed": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "unknown": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "nextDueAt": {
+ "type": "number",
+ "nullable": true,
+ "description": "Unix milliseconds."
+ }
+ }
+ }
+ },
+ "fields": {
+ "PlatformCampaign.followUp": {
+ "nullable": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CampaignFollowUp"
+ }
+ ]
+ },
+ "CreatePlatformCampaignRequest.followUp": {
+ "nullable": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CampaignFollowUp"
+ }
+ ]
+ },
+ "UpdatePlatformCampaignRequest.followUp": {
+ "nullable": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CampaignFollowUp"
+ }
+ ],
+ "description": "Only editable before launch. Null removes the optional follow-up."
+ },
+ "CampaignRecipient.followUp": {
+ "nullable": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CampaignFollowUpSummary"
+ }
+ ],
+ "description": "Receipt-timed follow-up for this recipient; null when none was admitted."
+ },
+ "PlatformCampaignAnalytics.followUps": {
+ "$ref": "#/components/schemas/CampaignFollowUpReport",
+ "description": "Follow-up outcomes, counted separately from the first message. All zero when the campaign has no follow-up."
+ }
+ }
+ }
+ }
+}
diff --git a/contracts/history/pre-connections/campaign-frequency-cap.json b/contracts/history/pre-connections/campaign-frequency-cap.json
new file mode 100644
index 000000000..e507aa1a3
--- /dev/null
+++ b/contracts/history/pre-connections/campaign-frequency-cap.json
@@ -0,0 +1,1257 @@
+{
+ "repository": "polymorfa/polymorfa",
+ "commit": "9bb1e2ed92d8b4a07ff727f8e7ae185498f0868f",
+ "note": "Contact frequency cap beta, merged backend #601 and Console #609. Full snapshots retain their independent pins.",
+ "sources": {
+ "messaging": {
+ "sourcePath": "apps/api/docs/openapi.json",
+ "sourceSha256": "6d5b5477a86a85504f921933bf7b26f2c47506e21380fe73c8a5ff1002163b28",
+ "schemas": {},
+ "fields": {
+ "VoiceAssetFailedPayload.failureReason": {
+ "type": "string",
+ "enum": [
+ "unsupported_format",
+ "too_large",
+ "too_long",
+ "decode_failed",
+ "silent",
+ "tts_failed",
+ "processing_failed"
+ ],
+ "description": "Treat unknown values as `processing_failed`."
+ },
+ "Campaign.frequencyCap": {
+ "$ref": "#/components/schemas/CampaignFrequencyCap"
+ },
+ "CampaignAnalytics.frequencyCap": {
+ "$ref": "#/components/schemas/CampaignFrequencyCapAnalytics"
+ },
+ "CreateCampaignRequest.frequencyCap": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CampaignFrequencyCap"
+ },
+ {
+ "description": "This campaign's own contact frequency cap. It can only make the team cap stricter. Contact frequency caps are a beta; a team that is not enrolled gets `403 feature_unavailable`. Omit, or send null, to use the team cap alone."
+ }
+ ]
+ },
+ "UpdateCampaignRequest.frequencyCap": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CampaignFrequencyCap"
+ },
+ {
+ "description": "Replaces this campaign's own contact frequency cap; null removes it and leaves the team cap. Only a draft or paused campaign can change it. Setting a cap requires the contact frequency caps beta; removing one does not."
+ }
+ ]
+ },
+ "CampaignRecipient.failureReason": {
+ "type": "string",
+ "nullable": true,
+ "enum": [
+ "opted_out",
+ "cold_held",
+ "campaign_cancelled",
+ "invalid_recipient",
+ "session_not_connected",
+ "ack_timeout",
+ "blocked_by_safety",
+ "send_failed",
+ "missing_variable",
+ "frequency_cap",
+ "other",
+ null
+ ],
+ "description": "Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the number is on the team's opt-out list. `cold_held`: the number never wrote to the sending number and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the number is not a valid WhatsApp address. `session_not_connected`: the sending number was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `frequency_cap`: the recipient reached the team's or campaign's rolling contact frequency cap. `other`: any other reason. New codes may be added."
+ },
+ "TestEventOverrides.failureReason": {
+ "type": "string",
+ "enum": [
+ "invalid_recipient",
+ "session_not_connected",
+ "ack_timeout",
+ "send_failed",
+ "blocked_by_safety"
+ ]
+ }
+ },
+ "paths": {
+ "/messaging/projects/{projectSlug}/campaigns/{id}/recipients": {
+ "get": {
+ "operationId": "listProjectCampaignRecipients",
+ "tags": ["Campaigns"],
+ "summary": "List campaign recipients",
+ "description": "**Required scope:** `campaigns:read`\n\nLists a campaign's recipients in queue order with cursor pagination. Filter by `status`, by `reason`, or both: for example `status=skipped&reason=opted_out` lists recipients skipped because they opted out. `failureReason` gives the stable reason a recipient was not sent.",
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-required-scope": "campaigns:read",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectSlug",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "id",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "enum": [
+ "queued",
+ "sending",
+ "sent",
+ "delivered",
+ "read",
+ "failed",
+ "skipped"
+ ]
+ },
+ "required": false,
+ "name": "status",
+ "in": "query"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "enum": [
+ "opted_out",
+ "cold_held",
+ "campaign_cancelled",
+ "invalid_recipient",
+ "session_not_connected",
+ "ack_timeout",
+ "blocked_by_safety",
+ "send_failed",
+ "missing_variable",
+ "frequency_cap",
+ "other"
+ ],
+ "description": "Only recipients whose `failureReason` is this code."
+ },
+ "required": false,
+ "name": "reason",
+ "in": "query"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "maxLength": 256
+ },
+ "required": false,
+ "name": "cursor",
+ "in": "query"
+ },
+ {
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100,
+ "description": "Page size, default 25."
+ },
+ "required": false,
+ "name": "limit",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ListCampaignRecipientsResponse"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request \u2014 request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "Authenticated but not permitted (missing scope or rule violation)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "campaigns:read "
+ }
+ },
+ "post": {
+ "operationId": "addProjectCampaignRecipients",
+ "tags": ["Campaigns"],
+ "summary": "Add recipients to a draft campaign",
+ "description": "**Required scope:** `campaigns:manage`\n\nAdds up to 1,000 recipients to a campaign that has not started sending. A phone already on the campaign is skipped. Invalid entries are reported and not added.",
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-required-scope": "campaigns:manage",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectSlug",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "id",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ },
+ "required": false,
+ "description": "Optional key, 1 to 255 bytes of UTF-8, that makes this request safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version` and request is not applied again: it returns `200` with `Idempotent-Replayed: true` and the replay result described for this operation. Reusing the key for a different request returns `409 idempotency_conflict`. A retry sent while the original is still running waits for it and then returns its result. A request that failed left no record, so retrying it with the same key runs it again. Access to the resource is checked again on every retry. A replay returns the original counts, even after the campaign has launched.",
+ "name": "Idempotency-Key",
+ "in": "header"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AddCampaignRecipientsRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {
+ "Idempotent-Replayed": {
+ "description": "`true` when this response replays the result of an earlier request with the same Idempotency-Key.",
+ "schema": {
+ "type": "string",
+ "enum": ["true"]
+ }
+ },
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AddCampaignRecipientsResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request \u2014 request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "Authenticated but not permitted (missing scope or rule violation)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "409": {
+ "description": "The campaign has started sending and no longer accepts recipients, or the Idempotency-Key was already used for a different request (`idempotency_conflict`)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "conflict_error",
+ "code": "state_conflict",
+ "message": "The request conflicts with the resource state.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#state-conflict"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "campaigns:manage "
+ }
+ }
+ }
+ }
+ },
+ "platform": {
+ "sourcePath": "apps/api/docs/openapi.management.json",
+ "sourceSha256": "bf4c6056b75e2fb0293b48edc5d8c12c36cdcbd194b9d11159f59522d30badc3",
+ "schemas": {
+ "CampaignRecipientFailureReason": {
+ "type": "string",
+ "enum": [
+ "opted_out",
+ "cold_held",
+ "campaign_cancelled",
+ "invalid_recipient",
+ "session_not_connected",
+ "ack_timeout",
+ "blocked_by_safety",
+ "send_failed",
+ "missing_variable",
+ "frequency_cap",
+ "other"
+ ],
+ "description": "Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the number is on the team's opt-out list. `cold_held`: the number never wrote to the sending number and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the number is not a valid WhatsApp address. `session_not_connected`: the sending number was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `frequency_cap`: the recipient reached the team's or campaign's rolling contact frequency cap. `other`: any other reason. New codes may be added."
+ },
+ "CampaignFrequencyCapSettings": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The team's contact frequency cap.",
+ "properties": {
+ "teamId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "maxPer24Hours": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 50,
+ "nullable": true,
+ "description": "Most campaign messages one phone number receives from the team in any rolling 24 hours, 1 to 50. `null` sets no 24-hour limit."
+ },
+ "maxPer7Days": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 200,
+ "nullable": true,
+ "description": "Most campaign messages one phone number receives from the team in any rolling 7 days, 1 to 200. `null` sets no 7-day limit. Must not be lower than `maxPer24Hours`."
+ },
+ "revision": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Send this value back to change the cap. 0 until the team first saves."
+ },
+ "updatedAt": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true,
+ "description": "Unix time in milliseconds of the last change; null until the team first saves."
+ }
+ },
+ "required": [
+ "teamId",
+ "maxPer24Hours",
+ "maxPer7Days",
+ "revision",
+ "updatedAt"
+ ]
+ },
+ "UpdateCampaignFrequencyCapInput": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "maxPer24Hours": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 50,
+ "nullable": true,
+ "description": "Most campaign messages one phone number receives from the team in any rolling 24 hours, 1 to 50. `null` sets no 24-hour limit."
+ },
+ "maxPer7Days": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 200,
+ "nullable": true,
+ "description": "Most campaign messages one phone number receives from the team in any rolling 7 days, 1 to 200. `null` sets no 7-day limit. Must not be lower than `maxPer24Hours`."
+ },
+ "revision": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 2147483646,
+ "description": "The `revision` from your last read."
+ }
+ },
+ "required": ["maxPer24Hours", "maxPer7Days", "revision"]
+ }
+ },
+ "fields": {
+ "NumberTierChange.failureReason": {
+ "type": "string",
+ "nullable": true
+ },
+ "NumberHybridTransition.failureReason": {
+ "type": "string",
+ "nullable": true
+ },
+ "CreatePlatformCampaignRequest.frequencyCap": {
+ "type": "object",
+ "additionalProperties": false,
+ "nullable": true,
+ "description": "Beta. This campaign's own contact frequency cap, counted over every campaign message the team sent to the phone number. Each limit applies together with the team cap and the lower one wins, so a campaign cap can only make sending stricter. A message over a limit is skipped with `frequency_cap_exceeded`; later sequence messages stop for that recipient. `null` uses the team cap alone. Setting a cap requires the contact frequency caps beta and otherwise answers `403 feature_unavailable`.",
+ "properties": {
+ "maxPer24Hours": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 50,
+ "nullable": true,
+ "description": "Most campaign messages one phone number receives from the team in any rolling 24 hours, 1 to 50. `null` sets no 24-hour limit."
+ },
+ "maxPer7Days": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 200,
+ "nullable": true,
+ "description": "Most campaign messages one phone number receives from the team in any rolling 7 days, 1 to 200. `null` sets no 7-day limit. Must not be lower than `maxPer24Hours`."
+ }
+ },
+ "required": ["maxPer24Hours", "maxPer7Days"]
+ },
+ "PlatformCampaignAnalytics.frequencyCap": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "Recipients with a message skipped by the contact frequency cap.",
+ "properties": {
+ "skippedRecipientCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Recipients whose first, sequence or follow-up message was skipped by the cap."
+ }
+ },
+ "required": ["skippedRecipientCount"]
+ },
+ "UpdatePlatformCampaignRequest.frequencyCap": {
+ "type": "object",
+ "additionalProperties": false,
+ "nullable": true,
+ "description": "Beta. Replaces this campaign's own contact frequency cap; `null` removes it and leaves the team cap. Only while the campaign is a draft or paused; a running campaign answers `409`, so pause it first. Setting a cap requires the contact frequency caps beta; removing one does not.",
+ "properties": {
+ "maxPer24Hours": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 50,
+ "nullable": true,
+ "description": "Most campaign messages one phone number receives from the team in any rolling 24 hours, 1 to 50. `null` sets no 24-hour limit."
+ },
+ "maxPer7Days": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 200,
+ "nullable": true,
+ "description": "Most campaign messages one phone number receives from the team in any rolling 7 days, 1 to 200. `null` sets no 7-day limit. Must not be lower than `maxPer24Hours`."
+ }
+ },
+ "required": ["maxPer24Hours", "maxPer7Days"]
+ },
+ "PlatformCampaign.frequencyCap": {
+ "type": "object",
+ "additionalProperties": false,
+ "nullable": true,
+ "description": "This campaign's own contact frequency cap; null when only the team cap applies.",
+ "properties": {
+ "maxPer24Hours": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 50,
+ "nullable": true,
+ "description": "Most campaign messages one phone number receives from the team in any rolling 24 hours, 1 to 50. `null` sets no 24-hour limit."
+ },
+ "maxPer7Days": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 200,
+ "nullable": true,
+ "description": "Most campaign messages one phone number receives from the team in any rolling 7 days, 1 to 200. `null` sets no 7-day limit. Must not be lower than `maxPer24Hours`."
+ }
+ },
+ "required": ["maxPer24Hours", "maxPer7Days"]
+ },
+ "CampaignRecipient.failureReason": {
+ "nullable": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CampaignRecipientFailureReason"
+ }
+ ]
+ },
+ "PlatformAccessVoiceAudioAsset.failureReason": {
+ "$ref": "#/components/schemas/PlatformAccessVoiceAudioFailureReason"
+ }
+ },
+ "paths": {
+ "/platform/campaigns/{campaignId}/recipients": {
+ "get": {
+ "operationId": "listCampaignRecipients",
+ "tags": ["campaigns"],
+ "summary": "List campaign recipients",
+ "description": "Lists a campaign's recipients in queue order with cursor pagination. Filter by `status`, by `reason`, or both: for example `status=skipped&reason=opted_out` lists recipients skipped because the number opted out. `failureReason` gives the stable reason a recipient was not sent.\n\nRequires `campaigns:read`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "campaignId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "projectId",
+ "in": "query",
+ "required": false,
+ "description": "Project the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.",
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Project that owns the campaign. Required for team API keys; a project token is bound to its own project."
+ }
+ },
+ {
+ "name": "status",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "queued",
+ "sending",
+ "sent",
+ "delivered",
+ "read",
+ "failed",
+ "skipped"
+ ]
+ }
+ },
+ {
+ "name": "reason",
+ "in": "query",
+ "required": false,
+ "description": "Only recipients whose `failureReason` is this code.",
+ "schema": {
+ "$ref": "#/components/schemas/CampaignRecipientFailureReason"
+ }
+ },
+ {
+ "name": "cursor",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100,
+ "default": 25
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CampaignRecipient"
+ }
+ },
+ "page": {
+ "$ref": "#/components/schemas/CursorPageMetadata"
+ }
+ },
+ "required": ["data", "page"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ }
+ }
+ },
+ "post": {
+ "operationId": "addCampaignRecipients",
+ "tags": ["campaigns"],
+ "summary": "Add recipients to a draft campaign",
+ "description": "Adds up to 1,000 recipients to a campaign that has not been launched. A number already on the campaign is skipped. Invalid entries are reported, not added. A campaign that has been launched answers `409`. Send `projectId` in the body when using a team API key.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "campaignId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "Idempotency-Key",
+ "in": "header",
+ "required": false,
+ "description": "Optional key, 1 to 255 bytes of UTF-8, that makes this request safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version` and request is not applied again: it returns `200` with `Idempotent-Replayed: true` and the replay result described for this operation. Reusing the key for a different request returns `409 idempotency_conflict`. A retry sent while the original is still running waits for it and then returns its result. A request that failed left no record, so retrying it with the same key runs it again. Access to the resource is checked again on every retry. A replay returns the original counts, even after the campaign has launched.",
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "projectId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recipients": {
+ "type": "array",
+ "minItems": 1,
+ "maxItems": 1000,
+ "description": "At most 1,000 recipients per request.",
+ "items": {
+ "$ref": "#/components/schemas/RecipientInput"
+ }
+ }
+ },
+ "required": ["recipients"]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ },
+ "Idempotent-Replayed": {
+ "description": "`true` when this response replays the result of an earlier request with the same Idempotency-Key.",
+ "schema": {
+ "type": "string",
+ "enum": ["true"]
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/CampaignRecipientAppendResult"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ },
+ "/platform/campaign-settings/frequency-cap": {
+ "get": {
+ "operationId": "getCampaignFrequencyCap",
+ "tags": ["campaign-settings"],
+ "summary": "Get the contact frequency cap",
+ "description": "Returns the team's contact frequency cap: the most campaign messages one phone number receives from the team in any rolling 24 hours and any rolling 7 days. Every campaign message counts, first messages and later messages of a sequence, from every campaign, project and number in the team. Test sends and messages sent outside campaigns do not count. `null` means no limit for that window. A team that never saved a cap receives both limits `null` and `revision` 0. A campaign can set its own, stricter cap with `frequencyCap`. Accepts a team API key or a live signed-in team member.\n\nAPI keys require `campaigns:read`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/CampaignFrequencyCapSettings"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ }
+ }
+ },
+ "put": {
+ "operationId": "updateCampaignFrequencyCap",
+ "tags": ["campaign-settings"],
+ "summary": "Update the contact frequency cap",
+ "description": "Replaces the team's contact frequency cap using the `revision` you read; a changed revision answers `409`. Send `null` for a window to remove its limit, or both `null` to remove the cap. Setting a limit requires the contact frequency caps beta and otherwise answers `403 feature_unavailable`; removing the cap does not. Requires a team API key or a signed-in team owner or admin; project tokens answer `403`. A message over the cap is skipped with `frequency_cap_exceeded`; a later sequence message stops that recipient's remaining sequence. Settled skips are never retried when a cap changes.\n\nAPI keys require `campaigns:manage`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateCampaignFrequencyCapInput"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/CampaignFrequencyCapSettings"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/contracts/history/pre-connections/campaign-segments-drip.json b/contracts/history/pre-connections/campaign-segments-drip.json
new file mode 100644
index 000000000..43a0c1ef3
--- /dev/null
+++ b/contracts/history/pre-connections/campaign-segments-drip.json
@@ -0,0 +1,2708 @@
+{
+ "repository": "polymorfa/polymorfa",
+ "commit": "9bb1e2ed92d8b4a07ff727f8e7ae185498f0868f",
+ "sources": {
+ "messaging": {
+ "sourcePath": "apps/api/docs/openapi.json",
+ "sourceSha256": "6d5b5477a86a85504f921933bf7b26f2c47506e21380fe73c8a5ff1002163b28",
+ "schemas": {
+ "CampaignDrip": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "enrollment": {
+ "type": "string",
+ "enum": ["audience", "continuous"],
+ "description": "Select `audience` for contacts present at launch. Select `continuous` to also accept contacts through the enrollment endpoint while the campaign is running or paused. Setting a continuous drip back to `audience` closes enrollment; the campaign completes after all enrolled contacts finish."
+ },
+ "exitOnReply": {
+ "type": "boolean",
+ "description": "When true, a contact who replies to the sending number gets no further steps."
+ },
+ "exitOnLinkClick": {
+ "type": "boolean",
+ "description": "When true, a GET request to one of the campaign's tracked links stops the contact's remaining steps. HEAD requests do not count. GET requests from link previews and security scanners also count and do not prove that a person clicked."
+ }
+ },
+ "required": ["enrollment", "exitOnReply", "exitOnLinkClick"],
+ "description": "Beta drip settings; null for a campaign that is not a drip."
+ },
+ "CampaignDripInput": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "enrollment": {
+ "type": "string",
+ "enum": ["audience", "continuous"],
+ "default": "audience",
+ "description": "Select `audience` for contacts present at launch. Select `continuous` to also accept contacts through the enrollment endpoint while the campaign is running or paused. Setting a continuous drip back to `audience` closes enrollment; the campaign completes after all enrolled contacts finish."
+ },
+ "exitOnReply": {
+ "type": "boolean",
+ "default": true,
+ "description": "When true, a contact who replies to the sending number gets no further steps."
+ },
+ "exitOnLinkClick": {
+ "type": "boolean",
+ "default": false,
+ "description": "When true, a GET request to one of the campaign's tracked links stops the contact's remaining steps. HEAD requests do not count. GET requests from link previews and security scanners also count and do not prove that a person clicked."
+ }
+ },
+ "additionalProperties": false,
+ "description": "Beta access is required. Defaults to audience enrollment, exit on reply true and exit on link open false. Null creates an ordinary campaign."
+ },
+ "CampaignDripPatch": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "enrollment": {
+ "type": "string",
+ "enum": ["audience", "continuous"],
+ "description": "Select `audience` for contacts present at launch. Select `continuous` to also accept contacts through the enrollment endpoint while the campaign is running or paused. Setting a continuous drip back to `audience` closes enrollment; the campaign completes after all enrolled contacts finish."
+ },
+ "exitOnReply": {
+ "type": "boolean",
+ "description": "When true, a contact who replies to the sending number gets no further steps."
+ },
+ "exitOnLinkClick": {
+ "type": "boolean",
+ "description": "When true, a GET request to one of the campaign's tracked links stops the contact's remaining steps. HEAD requests do not count. GET requests from link previews and security scanners also count and do not prove that a person clicked."
+ }
+ },
+ "additionalProperties": false,
+ "description": "Beta. Omitted fields preserve stored settings; new drip settings default to audience enrollment, exit on reply true and exit on link open false. Null makes the draft an ordinary campaign. Only an unlaunched draft can change settings, except closing continuous enrollment with unchanged exit flags. A PATCH containing only that close is allowed without beta access."
+ },
+ "CampaignDripStats": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "enrollment": {
+ "type": "string",
+ "enum": ["audience", "continuous"]
+ },
+ "enrolled": {
+ "type": "integer",
+ "description": "Contacts in the drip, from the audience and the enrollment endpoint."
+ },
+ "enrolledByApi": {
+ "type": "integer",
+ "description": "Contacts added through the enrollment endpoint."
+ },
+ "active": {
+ "type": "integer",
+ "description": "Contacts still owed a step."
+ },
+ "completed": {
+ "type": "integer",
+ "description": "Contacts sent every step."
+ },
+ "exited": {
+ "type": "integer",
+ "description": "Contacts who left early: a reply, an opt-out or an opened tracked link."
+ },
+ "steps": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CampaignDripStepStats"
+ }
+ }
+ },
+ "required": [
+ "enrollment",
+ "enrolled",
+ "enrolledByApi",
+ "active",
+ "completed",
+ "exited",
+ "steps"
+ ],
+ "description": "Drip results by step; null for a campaign that is not a drip."
+ },
+ "CampaignDripStepStats": {
+ "type": "object",
+ "properties": {
+ "step": {
+ "type": "integer",
+ "description": "Step position, from 0."
+ },
+ "entered": {
+ "type": "integer",
+ "description": "Contacts who reached this step: its delay started. Every contact enters step 0."
+ },
+ "waiting": {
+ "type": "integer",
+ "description": "Contacts waiting for this step or being sent it now."
+ },
+ "sent": {
+ "type": "integer"
+ },
+ "delivered": {
+ "type": "integer"
+ },
+ "read": {
+ "type": "integer"
+ },
+ "replied": {
+ "type": "integer",
+ "description": "Contacts whose first reply after this step came within 7 days of it, before the next step."
+ },
+ "exited": {
+ "type": "integer",
+ "description": "Contacts who left the drip while waiting for this step: they replied, opted out or opened a tracked link."
+ },
+ "failed": {
+ "type": "integer",
+ "description": "Contacts whose step could not be sent. Their remaining steps stop."
+ }
+ },
+ "required": [
+ "step",
+ "entered",
+ "waiting",
+ "sent",
+ "delivered",
+ "read",
+ "replied",
+ "exited",
+ "failed"
+ ]
+ },
+ "CampaignEnrollment": {
+ "type": "object",
+ "properties": {
+ "campaignId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recipientId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The contact's recipient ID in this campaign."
+ },
+ "phone": {
+ "type": "string",
+ "description": "The contact, in E.164 format."
+ },
+ "created": {
+ "type": "boolean",
+ "description": "False when the phone was already in this drip. Nothing changed, and a contact who finished or left is not enrolled again."
+ },
+ "status": {
+ "type": "string",
+ "description": "Recipient status of the first step: `queued` until sent, or `skipped` for an opted-out phone, which is never sent."
+ },
+ "enrolledAt": {
+ "type": "number",
+ "description": "When the contact joined the drip, in Unix milliseconds."
+ }
+ },
+ "required": [
+ "campaignId",
+ "recipientId",
+ "phone",
+ "created",
+ "status",
+ "enrolledAt"
+ ]
+ },
+ "EnrollCampaignContactRequest": {
+ "type": "object",
+ "properties": {
+ "phone": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 32,
+ "description": "The contact in international format. A phone already in the drip returns its existing enrollment with `created: false`.",
+ "example": "+5511999990000"
+ },
+ "variables": {
+ "type": "object",
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 1024
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ },
+ "description": "The contact's variables, at most 50, used to fill the steps.",
+ "maxProperties": 50
+ }
+ },
+ "required": ["phone"],
+ "additionalProperties": false
+ },
+ "EnrollCampaignContactResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "enum": [true]
+ },
+ "data": {
+ "$ref": "#/components/schemas/CampaignEnrollment"
+ }
+ },
+ "required": ["success", "data"]
+ }
+ },
+ "fields": {
+ "Campaign.drip": {
+ "$ref": "#/components/schemas/CampaignDrip"
+ },
+ "Campaign.enrollmentOpen": {
+ "type": "boolean",
+ "nullable": true,
+ "description": "Whether the drip is configured for continuous enrollment. Null for a non-drip. Enrollment also requires running or paused status."
+ },
+ "Campaign.pauseReason": {
+ "type": "string",
+ "nullable": true,
+ "description": "Current stored pause reason while paused; null when unavailable, for a manual pause without a reason, or for any other status."
+ },
+ "Campaign.segmentId": {
+ "type": "string",
+ "nullable": true,
+ "description": "Saved audience segment the campaign evaluates at launch, or null. Segments are chosen with a team API key through the Platform API; this field is read-only here."
+ },
+ "Campaign.segmentSnapshot": {
+ "type": "object",
+ "nullable": true,
+ "properties": {
+ "revision": {
+ "type": "integer",
+ "description": "Segment revision that launch evaluated."
+ },
+ "evaluatedAt": {
+ "type": "integer",
+ "description": "Time launch evaluated the segment, in Unix milliseconds."
+ },
+ "matchedCount": {
+ "type": "integer",
+ "description": "Profiles that matched at launch, before opt-outs and withheld consent were removed."
+ }
+ },
+ "required": ["revision", "evaluatedAt", "matchedCount"],
+ "additionalProperties": false,
+ "description": "The segment revision, evaluation time (Unix milliseconds) and matching profile count launch froze; null before a segment launch."
+ },
+ "CampaignAnalytics.drip": {
+ "$ref": "#/components/schemas/CampaignDripStats"
+ },
+ "CreateCampaignRequest.drip": {
+ "$ref": "#/components/schemas/CampaignDripInput"
+ },
+ "UpdateCampaignRequest.drip": {
+ "$ref": "#/components/schemas/CampaignDripPatch"
+ }
+ },
+ "paths": {
+ "/messaging/projects/{projectSlug}/campaigns/{id}/enrollments": {
+ "post": {
+ "operationId": "enrollProjectCampaignContact",
+ "tags": ["Campaigns"],
+ "summary": "Enroll a contact in a drip",
+ "description": "**Required scope:** `campaigns:manage`\n\nBeta. Adds one contact to a running or paused drip whose `drip.enrollment` is `continuous`. The contact starts at the first step, subject to the drip's send window, pacing and caps. Idempotent per phone: a phone already in the drip, including one that finished or left, returns its existing enrollment with `created: false`. An opted-out phone is enrolled as `skipped` and never sent. A team without the drip sequences beta gets `403 feature_unavailable`; a campaign that is not a drip, or a drip that is not accepting enrollments, answers `409 state_conflict`.",
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-required-scope": "campaigns:manage",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectSlug",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "required": true,
+ "name": "id",
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EnrollCampaignContactRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EnrollCampaignContactResponse"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request \u2014 request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "Authenticated but not permitted (missing scope or rule violation)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "409": {
+ "description": "`state_conflict`: the campaign is not a drip, or the drip does not use continuous enrollment, has not started, or has ended",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "conflict_error",
+ "code": "state_conflict",
+ "message": "The request conflicts with the resource state.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#state-conflict"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "campaigns:manage "
+ }
+ }
+ },
+ "/messaging/projects/{projectSlug}/campaigns/{id}/launch": {
+ "post": {
+ "operationId": "launchCampaign",
+ "tags": ["Campaigns"],
+ "summary": "Launch a campaign",
+ "description": "**Required scope:** `campaigns:manage`\n\nStarts a draft campaign. It begins sending at `scheduledAt`, or right away when no start time is set. Launch checks the saved sender selection against live plans: `402 campaigns_not_entitled` when a selected number is missing or its plan does not include Campaigns, or when an unselected campaign's project has no such number; `400 invalid_parameter` on `senderConfig.sessionIds` when a selected number is not connected or the selection mixes sending types; `400 campaign_throughput_capped` when a requested throughput is above its ceiling. Segment campaigns require a team API key; project tokens answer `403 permission_denied`, and unavailable audience betas answer `403 feature_unavailable`. An audience change during launch answers `409 state_conflict`. Segment evaluation that exceeds its time limit also answers `409 state_conflict`; simplify the rules and retry. A launched campaign whose segment was deleted remains launched and cannot be launched again (`409 state_conflict`). A message that references a `{{link:}}` the campaign does not define, or tracked links on a campaign that would send from Official API numbers, answers `400 invalid_parameter` on `trackedLinks`; tracked links without the campaign link tracking beta answer `403 feature_unavailable`. A drip without a sendable composed message answers `400 invalid_parameter` on `messagesArray`. Saving a draft does not apply this check. The template must be complete and approved on every Cloud API number; every recipient needs a value or fallback for each variable unless `skipMissingVariables` is true. When the team requires approval above a recipient threshold and the launch would send to more recipients, it answers `409 campaign_approval_required`, sends nothing, and records a pending approval request for a team owner or admin. Launching again with the campaign unchanged returns the same request. A launch requested by an AI agent through the hosted MCP server is held the same way, whatever the threshold. The response returns the campaign as it was when the launch was accepted.",
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-required-scope": "campaigns:manage",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "projectSlug",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "id",
+ "in": "path"
+ },
+ {
+ "name": "Idempotency-Key",
+ "in": "header",
+ "required": false,
+ "description": "Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version`, and request never runs the write again: it returns `409 idempotency_completed` when the original succeeded, or the original server error, with `Idempotent-Replayed: true`. Reusing the key for a different request returns `409 idempotency_conflict`; a retry while the original is still running returns `409 idempotency_in_progress`, and a retry after an unrecorded outcome returns `409 idempotency_outcome_unknown`.",
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LaunchCampaignRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LaunchCampaignResponse"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "`invalid_parameter` naming the field: an unconnected or mixed sender selection (`senderConfig.sessionIds`), an incomplete or authentication template (`templateId`), a composed attachment without a public URL, or a `{{link:}}` the campaign does not define or tracked links on Official API numbers (`trackedLinks`). `campaign_throughput_capped` when a requested throughput is above its ceiling; `template_not_approved` when a Cloud API number has not approved the template.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "402": {
+ "description": "`campaigns_not_entitled`: a selected number is missing or its plan does not include Campaigns, or the project has no number on such a plan. Drafts are saved on every plan.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "campaigns_not_entitled",
+ "message": "This number\u2019s plan does not include Campaigns.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#campaigns-not-entitled"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "`permission_denied`: a project token attempted to launch a segment campaign; use a team API key or signed-in dashboard session. `feature_unavailable`: either audience beta is unavailable for a segment campaign, or the campaign has tracked links and its link tracking beta is unavailable. `bansafe_team_suspended` while the team is suspended.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "409": {
+ "description": "`campaign_approval_required`: the launch is held for a team owner or admin and nothing was sent; the message names the approval request. `state_conflict`: the campaign is not a draft, is already launched and waiting for its start time, its sending numbers or audience changed during launch, or segment evaluation exceeded its time limit (simplify the rules and retry). A launched campaign whose segment was deleted cannot be launched again.. The Idempotency-Key already succeeded (`idempotency_completed`), was used for a different request (`idempotency_conflict`), belongs to a request that is still running (`idempotency_in_progress`, with Retry-After), or belongs to a request whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "conflict_error",
+ "code": "campaign_approval_required",
+ "message": "This request needs approval from a team owner or admin. Nothing was sent.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#campaign-approval-required"
+ }
+ }
+ },
+ "headers": {
+ "Retry-After": {
+ "description": "Seconds to wait before retrying `idempotency_in_progress`.",
+ "schema": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "Idempotent-Replayed": {
+ "description": "`true` when this response reports the recorded outcome of an earlier request with the same Idempotency-Key.",
+ "schema": {
+ "type": "string",
+ "enum": ["true"]
+ }
+ },
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "422": {
+ "description": "`campaign_variables_missing`: some recipients have no value and no fallback for a variable. The message names the variables and counts the recipients.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "campaign_variables_missing",
+ "message": "A recipient has no value and no fallback for a variable in the campaign content.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#campaign-variables-missing"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "503": {
+ "description": "`service_unavailable`: the selected numbers' plans could not be checked; retry",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "service_unavailable",
+ "message": "A required service is unavailable. Check completion before repeating a write.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#service-unavailable"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "campaigns:manage "
+ }
+ }
+ }
+ }
+ },
+ "platform": {
+ "sourcePath": "apps/api/docs/openapi.management.json",
+ "sourceSha256": "bf4c6056b75e2fb0293b48edc5d8c12c36cdcbd194b9d11159f59522d30badc3",
+ "schemas": {
+ "AudienceSegment": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "name": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 100
+ },
+ "revision": {
+ "type": "integer",
+ "minimum": 1
+ },
+ "rules": {
+ "$ref": "#/components/schemas/AudienceSegmentRules"
+ },
+ "createdAt": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "updatedAt": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "revision",
+ "rules",
+ "createdAt",
+ "updatedAt"
+ ]
+ },
+ "AudienceSegmentCondition": {
+ "description": "One condition. A condition on a missing or null attribute, or a value of another type, is false.",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The profile has this tag.",
+ "properties": {
+ "field": {
+ "type": "string",
+ "enum": ["tag"]
+ },
+ "operator": {
+ "type": "string",
+ "enum": ["contains"]
+ },
+ "value": {
+ "type": "string",
+ "minLength": 1,
+ "x-max-utf8-bytes": 48,
+ "description": "1-48 UTF-8 bytes without control characters. The byte limit can be reached before 48 Unicode characters."
+ }
+ },
+ "required": ["field", "operator", "value"]
+ },
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The profile has at least one of these tags.",
+ "properties": {
+ "field": {
+ "type": "string",
+ "enum": ["tag"]
+ },
+ "operator": {
+ "type": "string",
+ "enum": ["in"]
+ },
+ "values": {
+ "type": "array",
+ "minItems": 1,
+ "maxItems": 50,
+ "items": {
+ "type": "string",
+ "minLength": 1,
+ "x-max-utf8-bytes": 48,
+ "description": "1-48 UTF-8 bytes without control characters. The byte limit can be reached before 48 Unicode characters."
+ }
+ }
+ },
+ "required": ["field", "operator", "values"]
+ },
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The profile has at least one tag.",
+ "properties": {
+ "field": {
+ "type": "string",
+ "enum": ["tag"]
+ },
+ "operator": {
+ "type": "string",
+ "enum": ["exists"]
+ }
+ },
+ "required": ["field", "operator"]
+ },
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The attribute equals this value, with the same type.",
+ "properties": {
+ "field": {
+ "type": "string",
+ "enum": ["attribute"]
+ },
+ "name": {
+ "type": "string",
+ "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,47}$"
+ },
+ "operator": {
+ "type": "string",
+ "enum": ["equals"]
+ },
+ "value": {
+ "anyOf": [
+ {
+ "type": "string",
+ "minLength": 1,
+ "x-max-utf8-bytes": 256,
+ "description": "1-256 UTF-8 bytes. The byte limit can be reached before 256 Unicode characters."
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ }
+ },
+ "required": ["field", "name", "operator", "value"]
+ },
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The text attribute contains this text, ignoring case.",
+ "properties": {
+ "field": {
+ "type": "string",
+ "enum": ["attribute"]
+ },
+ "name": {
+ "type": "string",
+ "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,47}$"
+ },
+ "operator": {
+ "type": "string",
+ "enum": ["contains"]
+ },
+ "value": {
+ "type": "string",
+ "minLength": 1,
+ "x-max-utf8-bytes": 256,
+ "description": "1-256 UTF-8 bytes. The byte limit can be reached before 256 Unicode characters."
+ }
+ },
+ "required": ["field", "name", "operator", "value"]
+ },
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The attribute equals one of these values.",
+ "properties": {
+ "field": {
+ "type": "string",
+ "enum": ["attribute"]
+ },
+ "name": {
+ "type": "string",
+ "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,47}$"
+ },
+ "operator": {
+ "type": "string",
+ "enum": ["in"]
+ },
+ "values": {
+ "type": "array",
+ "minItems": 1,
+ "maxItems": 50,
+ "items": {
+ "anyOf": [
+ {
+ "type": "string",
+ "minLength": 1,
+ "x-max-utf8-bytes": 256,
+ "description": "1-256 UTF-8 bytes. The byte limit can be reached before 256 Unicode characters."
+ },
+ {
+ "type": "number"
+ }
+ ]
+ }
+ }
+ },
+ "required": ["field", "name", "operator", "values"]
+ },
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The number attribute is greater or less than this number.",
+ "properties": {
+ "field": {
+ "type": "string",
+ "enum": ["attribute"]
+ },
+ "name": {
+ "type": "string",
+ "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,47}$"
+ },
+ "operator": {
+ "type": "string",
+ "enum": ["greater_than", "less_than"]
+ },
+ "value": {
+ "type": "number"
+ }
+ },
+ "required": ["field", "name", "operator", "value"]
+ },
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The date attribute is before or after this instant. Both bounds are exclusive.",
+ "properties": {
+ "field": {
+ "type": "string",
+ "enum": ["attribute"]
+ },
+ "name": {
+ "type": "string",
+ "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,47}$"
+ },
+ "operator": {
+ "type": "string",
+ "enum": ["before", "after"]
+ },
+ "value": {
+ "type": "string",
+ "maxLength": 40,
+ "description": "ISO 8601 date (`YYYY-MM-DD`, read as midnight UTC) or date-time with `Z` or an offset."
+ }
+ },
+ "required": ["field", "name", "operator", "value"]
+ },
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The attribute is set and not null.",
+ "properties": {
+ "field": {
+ "type": "string",
+ "enum": ["attribute"]
+ },
+ "name": {
+ "type": "string",
+ "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,47}$"
+ },
+ "operator": {
+ "type": "string",
+ "enum": ["exists"]
+ }
+ },
+ "required": ["field", "name", "operator"]
+ },
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The profile's latest campaign consent assertion has this `allowed` value.",
+ "properties": {
+ "field": {
+ "type": "string",
+ "enum": ["consent"]
+ },
+ "operator": {
+ "type": "string",
+ "enum": ["equals"]
+ },
+ "value": {
+ "type": "boolean"
+ }
+ },
+ "required": ["field", "operator", "value"]
+ },
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "The phone was a recipient of this team campaign with this outcome, with the same meaning as a retargeting audience.",
+ "properties": {
+ "field": {
+ "type": "string",
+ "enum": ["campaign"]
+ },
+ "campaignId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "outcome": {
+ "type": "string",
+ "enum": [
+ "delivered",
+ "not_delivered",
+ "read",
+ "not_read",
+ "replied",
+ "not_replied",
+ "failed"
+ ]
+ }
+ },
+ "required": ["field", "campaignId", "outcome"]
+ }
+ ]
+ },
+ "AudienceSegmentPreview": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "matchedCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Profiles that match the rules."
+ },
+ "optedOutCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Matched profiles whose number is on the team's opt-out list."
+ },
+ "consentWithheldCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Matched profiles, not opted out, whose latest consent assertion is `allowed: false`. Launch leaves them out."
+ },
+ "eligibleCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Matched profiles a launch now would send to."
+ },
+ "sample": {
+ "type": "array",
+ "maxItems": 5,
+ "description": "Up to five eligible profiles with the phone masked.",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "phone": {
+ "type": "string",
+ "description": "Masked phone, for example `+49*******12`."
+ },
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": ["phone", "tags"]
+ }
+ },
+ "evaluatedAt": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Evaluation time in Unix milliseconds."
+ }
+ },
+ "required": [
+ "matchedCount",
+ "optedOutCount",
+ "consentWithheldCount",
+ "eligibleCount",
+ "sample",
+ "evaluatedAt"
+ ]
+ },
+ "AudienceSegmentRules": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "Groups combined with `all` or `any`. At most 10 groups, 20 conditions per group, 40 conditions, 5 campaign conditions and 16 KiB.",
+ "properties": {
+ "match": {
+ "type": "string",
+ "enum": ["all", "any"]
+ },
+ "groups": {
+ "type": "array",
+ "minItems": 1,
+ "maxItems": 10,
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "match": {
+ "type": "string",
+ "enum": ["all", "any"]
+ },
+ "negate": {
+ "type": "boolean",
+ "description": "Inverts the group's result. Defaults to false."
+ },
+ "conditions": {
+ "type": "array",
+ "minItems": 1,
+ "maxItems": 20,
+ "items": {
+ "$ref": "#/components/schemas/AudienceSegmentCondition"
+ }
+ }
+ },
+ "required": ["match", "conditions"]
+ }
+ }
+ },
+ "required": ["match", "groups"]
+ },
+ "CampaignDrip": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": ["enrollment", "exitOnReply", "exitOnLinkClick"],
+ "description": "Beta drip settings. Defaults: audience enrollment, exit on reply true, exit on link open false. Opt-outs always stop remaining steps. Cannot combine with a template, A/B variants, weighted alternatives or receipt-timed followUp. Linked-device and test numbers only.",
+ "properties": {
+ "enrollment": {
+ "type": "string",
+ "enum": ["audience", "continuous"],
+ "default": "audience",
+ "description": "Select `audience` for contacts present at launch. Select `continuous` to also accept contacts through the enrollment endpoint while the campaign is running or paused. Setting a continuous drip back to `audience` closes enrollment; the campaign completes after all enrolled contacts finish."
+ },
+ "exitOnReply": {
+ "type": "boolean",
+ "default": true,
+ "description": "When true, a contact who replies to the sending number gets no further steps."
+ },
+ "exitOnLinkClick": {
+ "type": "boolean",
+ "default": false,
+ "description": "When true, a GET request to one of the campaign's tracked links stops the contact's remaining steps. HEAD requests do not count. GET requests from link previews and security scanners also count and do not prove that a person clicked."
+ }
+ }
+ },
+ "CampaignDripInput": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "Beta drip settings. Defaults: audience enrollment, exit on reply true, exit on link open false. Opt-outs always stop remaining steps. Cannot combine with a template, A/B variants, weighted alternatives or receipt-timed followUp. Linked-device and test numbers only.",
+ "properties": {
+ "enrollment": {
+ "type": "string",
+ "enum": ["audience", "continuous"],
+ "default": "audience",
+ "description": "Select `audience` for contacts present at launch. Select `continuous` to also accept contacts through the enrollment endpoint while the campaign is running or paused. Setting a continuous drip back to `audience` closes enrollment; the campaign completes after all enrolled contacts finish."
+ },
+ "exitOnReply": {
+ "type": "boolean",
+ "default": true,
+ "description": "When true, a contact who replies to the sending number gets no further steps."
+ },
+ "exitOnLinkClick": {
+ "type": "boolean",
+ "default": false,
+ "description": "When true, a GET request to one of the campaign's tracked links stops the contact's remaining steps. HEAD requests do not count. GET requests from link previews and security scanners also count and do not prove that a person clicked."
+ }
+ }
+ },
+ "CampaignDripPatch": {
+ "type": "object",
+ "additionalProperties": false,
+ "description": "Partial drip settings. Omitted fields preserve stored settings. When adding drip to an ordinary draft, omitted fields use the create defaults.",
+ "properties": {
+ "enrollment": {
+ "type": "string",
+ "enum": ["audience", "continuous"],
+ "description": "Select `audience` for contacts present at launch. Select `continuous` to also accept contacts through the enrollment endpoint while the campaign is running or paused. Setting a continuous drip back to `audience` closes enrollment; the campaign completes after all enrolled contacts finish."
+ },
+ "exitOnReply": {
+ "type": "boolean",
+ "description": "When true, a contact who replies to the sending number gets no further steps."
+ },
+ "exitOnLinkClick": {
+ "type": "boolean",
+ "description": "When true, a GET request to one of the campaign's tracked links stops the contact's remaining steps. HEAD requests do not count. GET requests from link previews and security scanners also count and do not prove that a person clicked."
+ }
+ }
+ },
+ "CampaignDripStats": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "enrollment": {
+ "type": "string",
+ "enum": ["audience", "continuous"]
+ },
+ "enrolled": {
+ "type": "integer"
+ },
+ "enrolledByApi": {
+ "type": "integer"
+ },
+ "active": {
+ "type": "integer"
+ },
+ "completed": {
+ "type": "integer"
+ },
+ "exited": {
+ "type": "integer"
+ },
+ "steps": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "step": {
+ "type": "integer"
+ },
+ "entered": {
+ "type": "integer"
+ },
+ "waiting": {
+ "type": "integer"
+ },
+ "sent": {
+ "type": "integer"
+ },
+ "delivered": {
+ "type": "integer"
+ },
+ "read": {
+ "type": "integer"
+ },
+ "replied": {
+ "type": "integer"
+ },
+ "exited": {
+ "type": "integer"
+ },
+ "failed": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "step",
+ "entered",
+ "waiting",
+ "sent",
+ "delivered",
+ "read",
+ "replied",
+ "exited",
+ "failed"
+ ]
+ }
+ }
+ },
+ "required": [
+ "enrollment",
+ "enrolled",
+ "enrolledByApi",
+ "active",
+ "completed",
+ "exited",
+ "steps"
+ ]
+ },
+ "CampaignEnrollment": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "campaignId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "recipientId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "phone": {
+ "type": "string"
+ },
+ "created": {
+ "type": "boolean"
+ },
+ "status": {
+ "type": "string"
+ },
+ "enrolledAt": {
+ "type": "number",
+ "description": "Unix milliseconds."
+ }
+ },
+ "required": [
+ "campaignId",
+ "recipientId",
+ "phone",
+ "created",
+ "status",
+ "enrolledAt"
+ ]
+ },
+ "CampaignSendWindowRange": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "start": {
+ "type": "string",
+ "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$",
+ "description": "Local start time, `HH:MM` in 24-hour time, inclusive.",
+ "example": "09:00"
+ },
+ "end": {
+ "type": "string",
+ "pattern": "^(([01][0-9]|2[0-3]):[0-5][0-9]|24:00)$",
+ "description": "Local end time, `HH:MM` in 24-hour time or `24:00`, exclusive. Must be later than `start`.",
+ "example": "18:00"
+ }
+ },
+ "required": ["start", "end"]
+ },
+ "EnrollCampaignContactRequest": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": ["phone"],
+ "properties": {
+ "projectId": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "phone": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 32,
+ "description": "International phone number."
+ },
+ "variables": {
+ "type": "object",
+ "maxProperties": 50,
+ "additionalProperties": {
+ "oneOf": [
+ {
+ "type": "string",
+ "maxLength": 1024
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "fields": {
+ "CreatePlatformCampaignRequest.segmentId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Beta. Saved audience segment evaluated once when the campaign launches; the matching profiles become its recipients. Cannot be combined with `recipientListId`. Requires a team API key or the dashboard and the audience segments beta."
+ },
+ "CreatePlatformCampaignRequest.drip": {
+ "nullable": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CampaignDripInput"
+ }
+ ],
+ "description": "Beta access is required. Defaults to audience enrollment, exit on reply true and exit on link open false. Null creates an ordinary campaign."
+ },
+ "CampaignMessage.delayUnit": {
+ "type": "string",
+ "enum": ["minutes", "hours", "days"],
+ "description": "Display unit. delayAfterSec must be a whole multiple of this unit."
+ },
+ "CampaignMessage.sendWindow": {
+ "type": "object",
+ "nullable": true,
+ "additionalProperties": false,
+ "required": ["days", "hours"],
+ "description": "Drip steps after the first only. Replaces the campaign weekdays and hours for this step, retaining its time zone settings. Without a campaign window, uses the team time zone saved when the drip was configured.",
+ "properties": {
+ "days": {
+ "type": "array",
+ "minItems": 1,
+ "uniqueItems": true,
+ "items": {
+ "type": "string",
+ "enum": [
+ "monday",
+ "tuesday",
+ "wednesday",
+ "thursday",
+ "friday",
+ "saturday",
+ "sunday"
+ ]
+ }
+ },
+ "hours": {
+ "type": "array",
+ "minItems": 1,
+ "maxItems": 4,
+ "items": {
+ "$ref": "#/components/schemas/CampaignSendWindowRange"
+ }
+ }
+ }
+ },
+ "CampaignMessage.delayAfterSec": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 2592000,
+ "description": "A drip allows up to 30 days; other campaigns allow up to 86400 seconds. Minimum seconds between the previous message being accepted by WhatsApp and this message being sent. Ignored on the first message. Pacing, caps and a paused campaign can make the wait longer."
+ },
+ "PlatformCampaignAnalytics.drip": {
+ "nullable": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CampaignDripStats"
+ }
+ ]
+ },
+ "UpdatePlatformCampaignRequest.drip": {
+ "nullable": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CampaignDripPatch"
+ }
+ ],
+ "description": "Omitted fields preserve stored settings. Null makes the draft an ordinary campaign. Closing continuous enrollment with unchanged exit flags is allowed without beta access when it is the only change."
+ },
+ "UpdatePlatformCampaignRequest.segmentId": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true,
+ "description": "Beta. Saved audience segment to evaluate at launch, or null to clear it. Only while the campaign is an unlaunched draft. Setting a segment clears `recipientListId`; sending both answers `400`. Requires a team API key or the dashboard and the audience segments beta."
+ },
+ "PlatformCampaign.drip": {
+ "nullable": true,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CampaignDrip"
+ }
+ ]
+ },
+ "PlatformCampaign.enrollmentOpen": {
+ "type": "boolean",
+ "nullable": true,
+ "description": "Whether the drip is configured for continuous enrollment. Null for a non-drip. Enrollment also requires running or paused status."
+ },
+ "PlatformCampaign.pauseReason": {
+ "type": "string",
+ "nullable": true,
+ "description": "Current stored pause reason while paused; null when unavailable, for a manual pause without a reason, or for any other status."
+ },
+ "PlatformCampaign.segmentId": {
+ "type": "string",
+ "format": "uuid",
+ "nullable": true,
+ "description": "Saved audience segment the campaign evaluates at launch, or null."
+ },
+ "PlatformCampaign.segmentSnapshot": {
+ "type": "object",
+ "nullable": true,
+ "additionalProperties": false,
+ "description": "What launch froze from the segment: its revision, the evaluation time in Unix milliseconds and the matching profile count. Null before a segment launch.",
+ "properties": {
+ "revision": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "Segment revision that launch evaluated."
+ },
+ "evaluatedAt": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Time launch evaluated the segment, in Unix milliseconds."
+ },
+ "matchedCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Profiles that matched at launch, before opt-outs and withheld consent were removed."
+ }
+ },
+ "required": ["revision", "evaluatedAt", "matchedCount"]
+ }
+ },
+ "paths": {
+ "/platform/campaigns/{campaignId}/launch": {
+ "post": {
+ "operationId": "launchPlatformCampaign",
+ "tags": ["campaigns"],
+ "summary": "Launch campaign",
+ "description": "Starts a draft campaign. It begins sending at `scheduledAt`, or right away when no start time is set. Launch checks the stored sender selection against live plans: `402 campaigns_not_entitled` when a selected number is missing or its plan does not include Campaigns, or when an unselected campaign's project has no such number; `400 invalid_parameter` on `senderConfig.sessionIds` when a selected number is not connected or the selection mixes sending types; `400 campaign_throughput_capped` when a requested throughput is above its ceiling. A segment campaign requires a team API key or signed-in dashboard session; project tokens answer `403 permission_denied`. Both audience betas must be available, otherwise launch answers `403 feature_unavailable`. An audience change while launch is being authorized answers `409 state_conflict`. Segment evaluation that exceeds its time limit also answers `409 state_conflict`; simplify the rules and retry. A launched campaign whose segment was deleted remains launched and cannot be launched again (`409 state_conflict`). A drip without a sendable composed message answers `400 invalid_parameter` on `messagesArray`. Saving a draft does not apply this check. A composed attachment requires a public `media.url` (`400 invalid_parameter`). The template must be complete (`400 invalid_parameter`) and approved on every Cloud API number (`400 template_not_approved`). Every recipient needs a value or fallback for each variable (`422 campaign_variables_missing`); `skipMissingVariables: true` skips those recipients before the first send. A message that references a `{{link:}}` the campaign does not define, or tracked links on a campaign that would send from Official API numbers, answers `400 invalid_parameter` on `trackedLinks`; tracked links without the campaign link tracking beta answer `403 feature_unavailable`. `409` means the campaign is not a draft, is already launched and waiting for its start time, or its sending numbers changed during the launch. When the team requires approval above a recipient threshold and the launch would send to more recipients, a launch by anyone other than a team owner or admin signed in to the console answers `409 campaign_approval_required`, sends nothing, and records a pending approval request that `GET /platform/campaigns/{campaignId}/approvals` lists. Launching again with the campaign unchanged returns the same request. A launch requested by an AI agent through the hosted MCP server is held the same way, whatever the threshold.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "campaignId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "Idempotency-Key",
+ "in": "header",
+ "required": false,
+ "description": "Optional unique key, 1 to 255 bytes, that makes this request safe to retry for 24 hours. A retry with the same key, credential, `Polymorfa-Version` and request never runs it again: it returns `409 idempotency_completed` when the original succeeded, or the original server error. Reusing the key for a different request returns `409 idempotency_conflict`; a retry while the original is still running returns `409 idempotency_in_progress`, and a retry after an unrecorded outcome returns `409 idempotency_outcome_unknown`.",
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ }
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LaunchPlatformCampaignRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": true,
+ "required": ["id", "status", "operationId"],
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "draft",
+ "running",
+ "paused",
+ "cancelling",
+ "cancelled",
+ "completed",
+ "failed",
+ "archived"
+ ]
+ },
+ "operationId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The operation that carries this lifecycle action."
+ }
+ }
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "402": {
+ "$ref": "#/components/responses/PaymentRequired"
+ },
+ "403": {
+ "$ref": "#/components/responses/CampaignLaunchForbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/CampaignLaunchConflict"
+ },
+ "422": {
+ "$ref": "#/components/responses/CampaignVariablesMissing"
+ },
+ "503": {
+ "$ref": "#/components/responses/CampaignEligibilityUnavailable"
+ }
+ }
+ }
+ },
+ "/platform/campaigns/{campaignId}/enrollments": {
+ "post": {
+ "operationId": "enrollCampaignContact",
+ "tags": ["campaigns"],
+ "summary": "Enroll a contact in a drip",
+ "description": "Beta. Adds one contact to a running or paused continuous drip. Requires campaigns:manage and the drip beta; otherwise 403 feature_unavailable. Idempotent per phone, including contacts who completed or exited: returns created=false without changing variables. Opted-out contacts are skipped. A campaign not accepting enrollment answers 409 state_conflict.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "project",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "campaignId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EnrollCampaignContactRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/CampaignEnrollment"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ },
+ "/platform/audience-segments": {
+ "get": {
+ "operationId": "listAudienceSegments",
+ "tags": ["audience-segments"],
+ "summary": "List audience segments",
+ "description": "Lists the team's saved segments with cursor pagination. Reads stay available after beta withdrawal.\n\nAPI keys require `campaigns:read`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "cursor",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100,
+ "default": 25
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AudienceSegment"
+ }
+ },
+ "page": {
+ "$ref": "#/components/schemas/CursorPageMetadata"
+ }
+ },
+ "required": ["data", "page"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ }
+ }
+ },
+ "post": {
+ "operationId": "createAudienceSegment",
+ "tags": ["audience-segments"],
+ "summary": "Create an audience segment",
+ "description": "Saves a named rule set over the team's audience profiles. A team holds at most 100 segments. Every campaign a rule names must belong to the team. Both audience betas, `campaigns.audience-profiles` and `campaigns.segments`, must be available; otherwise the request answers `403 feature_unavailable`.\n\nAPI keys require `campaigns:manage`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 100
+ },
+ "rules": {
+ "$ref": "#/components/schemas/AudienceSegmentRules"
+ }
+ },
+ "required": ["name", "rules"]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/AudienceSegment"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ },
+ "/platform/audience-segments/preview": {
+ "post": {
+ "operationId": "previewAudienceSegmentRules",
+ "tags": ["audience-segments"],
+ "summary": "Preview audience segment rules",
+ "description": "Evaluates unsaved rules now and returns counts and up to five masked matching profiles. Nothing is saved. A campaign evaluates its segment again when it launches, so counts can change. Both audience betas, `campaigns.audience-profiles` and `campaigns.segments`, must be available; otherwise the request answers `403 feature_unavailable`.\n\nAPI keys require `campaigns:manage`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "rules": {
+ "$ref": "#/components/schemas/AudienceSegmentRules"
+ }
+ },
+ "required": ["rules"]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/AudienceSegmentPreview"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ },
+ "/platform/audience-segments/{segmentId}": {
+ "get": {
+ "operationId": "getAudienceSegment",
+ "tags": ["audience-segments"],
+ "summary": "Get an audience segment",
+ "description": "Returns one saved segment.\n\nAPI keys require `campaigns:read`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "segmentId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/AudienceSegment"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ }
+ }
+ },
+ "patch": {
+ "operationId": "updateAudienceSegment",
+ "tags": ["audience-segments"],
+ "summary": "Update an audience segment",
+ "description": "Replaces the name, the rules or both at the observed revision; a stale revision answers `409`. A draft campaign that uses the segment evaluates the new rules when it launches. Campaigns already launched keep their recipients. Both audience betas, `campaigns.audience-profiles` and `campaigns.segments`, must be available; otherwise the request answers `403 feature_unavailable`.\n\nAPI keys require `campaigns:manage`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "segmentId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "expectedRevision": {
+ "type": "integer",
+ "minimum": 1
+ },
+ "name": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 100
+ },
+ "rules": {
+ "$ref": "#/components/schemas/AudienceSegmentRules"
+ }
+ },
+ "required": ["expectedRevision"]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/AudienceSegment"
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ },
+ "delete": {
+ "operationId": "deleteAudienceSegment",
+ "tags": ["audience-segments"],
+ "summary": "Delete an audience segment",
+ "description": "Deletes the segment at the observed revision. Answers `409` while an unlaunched draft campaign uses it as its audience. Launched campaigns keep their recipients and `segmentSnapshot`; their `segmentId` becomes null. Deletion stays available after beta withdrawal.\n\nAPI keys require `campaigns:manage`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:manage",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "segmentId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "expectedRevision",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 9007199254740991
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "deleted": {
+ "type": "boolean",
+ "enum": [true]
+ },
+ "id": {
+ "type": "string",
+ "format": "uuid"
+ }
+ },
+ "required": ["deleted", "id"]
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ },
+ "/platform/audience-segments/{segmentId}/preview": {
+ "get": {
+ "operationId": "previewAudienceSegment",
+ "tags": ["audience-segments"],
+ "summary": "Preview an audience segment",
+ "description": "Evaluates the saved segment now and returns counts, up to five masked matching profiles and the evaluated `revision`. Both audience betas, `campaigns.audience-profiles` and `campaigns.segments`, must be available; otherwise the request answers `403 feature_unavailable`.\n\nAPI keys require `campaigns:read`. Project tokens are not accepted.",
+ "x-audience": "public",
+ "x-polymorfa-resource-boundary": "team",
+ "x-excluded-from-public": false,
+ "x-required-scope": "campaigns:read",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "ConsoleSession": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "segmentId",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "headers": {
+ "X-Request-Id": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "Stable request correlation identifier."
+ },
+ "X-Trace-Id": {
+ "schema": {
+ "type": "string",
+ "pattern": "^[0-9a-f]{32}$"
+ },
+ "description": "W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one."
+ },
+ "Polymorfa-Version": {
+ "schema": {
+ "type": "string"
+ },
+ "description": "API version applied to this response."
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "matchedCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Profiles that match the rules."
+ },
+ "optedOutCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Matched profiles whose number is on the team's opt-out list."
+ },
+ "consentWithheldCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Matched profiles, not opted out, whose latest consent assertion is `allowed: false`. Launch leaves them out."
+ },
+ "eligibleCount": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Matched profiles a launch now would send to."
+ },
+ "sample": {
+ "type": "array",
+ "maxItems": 5,
+ "description": "Up to five eligible profiles with the phone masked.",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "phone": {
+ "type": "string",
+ "description": "Masked phone, for example `+49*******12`."
+ },
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": ["phone", "tags"]
+ }
+ },
+ "evaluatedAt": {
+ "type": "integer",
+ "minimum": 0,
+ "description": "Evaluation time in Unix milliseconds."
+ },
+ "revision": {
+ "type": "integer",
+ "minimum": 1
+ }
+ },
+ "required": [
+ "matchedCount",
+ "optedOutCount",
+ "consentWithheldCount",
+ "eligibleCount",
+ "sample",
+ "evaluatedAt",
+ "revision"
+ ]
+ }
+ },
+ "required": ["data"]
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/BadRequest"
+ },
+ "401": {
+ "$ref": "#/components/responses/Unauthorized"
+ },
+ "403": {
+ "$ref": "#/components/responses/Forbidden"
+ },
+ "404": {
+ "$ref": "#/components/responses/NotFound"
+ },
+ "409": {
+ "$ref": "#/components/responses/Conflict"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/contracts/history/pre-connections/client-token-ceilings.json b/contracts/history/pre-connections/client-token-ceilings.json
new file mode 100644
index 000000000..eeb9d7498
--- /dev/null
+++ b/contracts/history/pre-connections/client-token-ceilings.json
@@ -0,0 +1,754 @@
+{
+ "repository": "polymorfa/polymorfa",
+ "sourceCommit": "02aee1d010c5009401c0b60ab98eafd3dfd69f08",
+ "family": "platform",
+ "sourcePath": "apps/api/docs/openapi.management.json",
+ "sourceSha256": "34ca9e3be9a71bdecf65a2978170f7d53ff488d8a584f759a45969548b27009c",
+ "published": false,
+ "scope": "Client-token mint ceiling and live rule validation only. Reserved regional actions remain unavailable; reconcile full snapshots and exact API acceptance before publication.",
+ "paths": {
+ "/platform/client-tokens": {
+ "post": {
+ "operationId": "mintClientToken",
+ "tags": ["Client Tokens"],
+ "summary": "Mint a short-lived browser-safe client token",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "x-required-scopes": [
+ "sessions:manage",
+ "messages:write",
+ "contacts:read",
+ "presence:read",
+ "presence:observe",
+ "mcp"
+ ],
+ "x-required-scope-mode": "all",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessMintClientTokenRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Token minted",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessMintClientTokenResponse"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request \u2014 request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "Authenticated but not permitted (missing scope or rule violation)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "sessions:manage messages:write contacts:read presence:read presence:observe mcp "
+ },
+ "description": "**Required scopes (all):** `sessions:manage` \u00b7 `messages:write` \u00b7 `contacts:read` \u00b7 `presence:read` \u00b7 `presence:observe` \u00b7 `mcp`",
+ "x-audience": "public"
+ }
+ },
+ "/platform/sessions/{session}/client-rules": {
+ "put": {
+ "operationId": "setClientRules",
+ "tags": ["Client Tokens"],
+ "summary": "Set client-token rules for a session",
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "x-required-scopes": [
+ "sessions:manage",
+ "messages:write",
+ "contacts:read",
+ "presence:read",
+ "presence:observe",
+ "mcp"
+ ],
+ "x-required-scope-mode": "all",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "required": true,
+ "name": "session",
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessSetClientRulesRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Rules saved",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessSuccessResponse"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request \u2014 request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "Authenticated but not permitted (missing scope or rule violation)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PlatformAccessPublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "sessions:manage messages:write contacts:read presence:read presence:observe mcp "
+ },
+ "description": "**Required scopes (all):** `sessions:manage` \u00b7 `messages:write` \u00b7 `contacts:read` \u00b7 `presence:read` \u00b7 `presence:observe` \u00b7 `mcp`",
+ "x-audience": "public"
+ }
+ }
+ },
+ "schemas": {
+ "PlatformAccessClientToken": {
+ "type": "object",
+ "properties": {
+ "token": {
+ "type": "string",
+ "description": "Client token with pmfa_ct_ prefix"
+ },
+ "expiresAt": {
+ "type": "string"
+ }
+ },
+ "required": ["token", "expiresAt"]
+ },
+ "PlatformAccessMintClientTokenRequest": {
+ "type": "object",
+ "properties": {
+ "session": {
+ "type": "string",
+ "minLength": 1,
+ "description": "ID of the session this token can access. Provide exactly one of `session` or `customer`."
+ },
+ "customer": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Polymorfa Customer ID. The token covers the numbers this Customer owns when it is minted, and only while the Customer still owns each one. Provide exactly one of `session` or `customer`. Requires the `customers:read` scope and enrollment in the Customer-scoped client tokens beta."
+ },
+ "allow": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "mcp",
+ "send_message",
+ "send_reaction",
+ "send_typing",
+ "send_seen",
+ "read_presence",
+ "subscribe_presence",
+ "read_contact",
+ "voip_place",
+ "voip_answer",
+ "voip_signal",
+ "chats_read",
+ "chats_manage",
+ "contact_write",
+ "contact_delete"
+ ]
+ },
+ "minItems": 0,
+ "maxItems": 15,
+ "description": "Immutable action ceiling, intersected with live client rules. Session allow requires the action-ceilings beta. With ceiling issuance enabled, session omission snapshots its configured actions. For a Customer, omission uses the original Customer action set. An empty session allow grants no actions; Customer allow must be non-empty. Regional actions are reserved for enrolled beta access."
+ },
+ "ephemeralId": {
+ "type": "string",
+ "minLength": 1,
+ "description": "Your identifier for the browser or mobile user receiving this token."
+ },
+ "ttlSeconds": {
+ "type": "integer",
+ "description": "Token lifetime in seconds. Must be at least 1 and within the maximum allowed lifetime. Omit to use that maximum."
+ }
+ },
+ "required": ["ephemeralId"]
+ },
+ "PlatformAccessMintClientTokenResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "enum": [true]
+ },
+ "data": {
+ "$ref": "#/components/schemas/PlatformAccessClientToken"
+ }
+ },
+ "required": ["success", "data"]
+ },
+ "PlatformAccessPublicError": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "invalid_request_error",
+ "authentication_error",
+ "permission_error",
+ "conflict_error",
+ "rate_limit_error",
+ "api_error",
+ "upstream_error"
+ ]
+ },
+ "code": {
+ "type": "string",
+ "enum": [
+ "invalid_parameter",
+ "invalid_credential",
+ "entitlement_required",
+ "cloud_template_authority_restricted",
+ "gate_limit_reached",
+ "method_not_allowed",
+ "permission_denied",
+ "missing_scope",
+ "resource_not_found",
+ "hms_not_enabled",
+ "media_fetch_failed",
+ "resource_gone",
+ "feature_unavailable",
+ "stream_cursor_invalid",
+ "stream_cursor_expired",
+ "stream_connection_limit_reached",
+ "state_conflict",
+ "team_deletion_scheduled",
+ "hybrid_routing_paused",
+ "hybrid_choice_required",
+ "hybrid_transition_ineligible",
+ "hybrid_automation_unavailable",
+ "hybrid_group_linked_devices_unavailable",
+ "hybrid_transport_unavailable",
+ "hybrid_target_reference_unavailable",
+ "send_outcome_unknown",
+ "idempotency_conflict",
+ "idempotency_in_progress",
+ "idempotency_completed",
+ "idempotency_outcome_unknown",
+ "call_claimed",
+ "call_not_ringing",
+ "connection_limit",
+ "unsupported_for_connection",
+ "call_permission_required",
+ "invalid_sip_trunk",
+ "calls_disabled",
+ "call_recipient_opted_out",
+ "call_destination_blocked",
+ "call_permission_request_limited",
+ "call_permission_granted",
+ "order_status_transition_invalid",
+ "order_cancellation_failed",
+ "call_opt_out_limit",
+ "number_restricted",
+ "sip_trunk_in_use",
+ "sip_trunk_revision_conflict",
+ "sip_trunk_limit",
+ "sip_unavailable",
+ "voice_not_enabled",
+ "provider_credential_invalid",
+ "provider_unavailable",
+ "asset_not_ready",
+ "voice_asset_in_use",
+ "voice_asset_revision_conflict",
+ "voice_unavailable",
+ "rate_limit_exceeded",
+ "internal_error",
+ "operation_not_supported",
+ "upstream_failure",
+ "service_unavailable",
+ "credential_verification_unavailable",
+ "session_not_ready",
+ "command_dispatch_failed",
+ "result_unknown",
+ "parent_bsuid_not_supported",
+ "recipient_not_on_whatsapp",
+ "conversation_window_closed",
+ "template_not_approved",
+ "media_too_large",
+ "whatsapp_rate_limited",
+ "new_chat_limit_reached",
+ "marketing_disabled_on_cloud_api",
+ "whatsapp_account_restricted",
+ "whatsapp_authorization_required",
+ "whatsapp_payment_method_required",
+ "whatsapp_number_not_registered",
+ "whatsapp_groups_ineligible",
+ "whatsapp_group_creation_paused",
+ "whatsapp_group_limit_reached",
+ "whatsapp_group_full",
+ "whatsapp_group_suspended",
+ "whatsapp_group_has_no_participants",
+ "bansafe_suspended",
+ "bansafe_team_suspended",
+ "bansafe_cold_blocked",
+ "bansafe_cold_held",
+ "bansafe_throttled",
+ "bansafe_daily_allowance_reached",
+ "bansafe_accounting_unavailable",
+ "bansafe_send_outcome_unknown",
+ "campaigns_not_entitled",
+ "campaign_throughput_capped",
+ "campaign_approval_required",
+ "campaign_approval_stale",
+ "campaign_variables_missing"
+ ]
+ },
+ "message": {
+ "type": "string"
+ },
+ "param": {
+ "type": "string",
+ "nullable": true
+ },
+ "request_id": {
+ "type": "string",
+ "description": "Matches the X-Request-Id response header. Include it when you contact support."
+ },
+ "request_log_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "Console page that shows this request. Returned only to team and project credentials whose request was logged."
+ }
+ },
+ "required": ["type", "code", "message", "param", "request_id"]
+ },
+ "data": {
+ "type": "string",
+ "nullable": true,
+ "enum": [null],
+ "description": "Always null for a failed request."
+ },
+ "docs": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": ["error", "data", "docs"]
+ },
+ "PlatformAccessSetClientRulesRequest": {
+ "type": "object",
+ "properties": {
+ "recipientMode": {
+ "type": "string"
+ },
+ "allowedActions": {
+ "type": "string",
+ "maxLength": 1024,
+ "default": ""
+ },
+ "rateLimit": {
+ "type": "integer",
+ "minimum": 0,
+ "default": 0
+ },
+ "maxDaily": {
+ "type": "integer",
+ "minimum": 0,
+ "default": 0
+ },
+ "allowedOrigins": {
+ "type": "string",
+ "maxLength": 8192,
+ "default": ""
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "maxConcurrency": {
+ "type": "integer",
+ "minimum": 0,
+ "default": 0
+ },
+ "allowedNumber": {
+ "type": "string",
+ "maxLength": 8192,
+ "default": ""
+ },
+ "maxSetupsPerMinute": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 600,
+ "default": 0
+ },
+ "conversationTtlSeconds": {
+ "type": "integer",
+ "minimum": 300,
+ "maximum": 604800,
+ "default": 86400,
+ "description": "How long, in seconds, a sender remains replyable in `conversation` mode after their latest inbound message. Must be between 300 (5 minutes) and 604800 (7 days). Defaults to 86400 (24 hours)."
+ }
+ },
+ "required": ["recipientMode", "enabled"]
+ },
+ "PlatformAccessSuccessResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ }
+ },
+ "required": ["success"]
+ }
+ }
+}
diff --git a/contracts/history/pre-connections/testing-phone.json b/contracts/history/pre-connections/testing-phone.json
new file mode 100644
index 000000000..08b6dabb1
--- /dev/null
+++ b/contracts/history/pre-connections/testing-phone.json
@@ -0,0 +1,862 @@
+{
+ "repository": "polymorfa/polymorfa",
+ "commit": "2f1510f901aca1d68398a6dc9dbf243348c672c0",
+ "sourcePath": "apps/api/docs/openapi.json",
+ "sourceSha256": "ea165cf5da67985a8f3c944d4771c6e30a77bb3d081396895454db22b66d9221",
+ "operations": {
+ "getTestingPhone": {
+ "method": "GET",
+ "path": "/messaging/testing/{projectId}/numbers/{session}/phone",
+ "operation": {
+ "operationId": "getTestingPhone",
+ "tags": ["Testing"],
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Get a Test number's phone",
+ "x-required-scope": "sandbox:read",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "required": true,
+ "name": "projectId",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "description": "The Test number's session ID."
+ },
+ "required": true,
+ "name": "session",
+ "in": "path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The simulated phone and its linked companions",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestingPhoneState"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "The session is not a Test number in the project",
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Test numbers access required, or a client token was used",
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Project not found",
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ }
+ },
+ "502": {
+ "description": "The simulated phone could not be read. Retry later.",
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "upstream_error",
+ "code": "upstream_failure",
+ "message": "The messaging provider could not complete the request.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#upstream-failure"
+ }
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "sandbox:read "
+ },
+ "description": "**Required scope:** `sandbox:read`"
+ }
+ },
+ "sendTestingPhoneMessage": {
+ "method": "POST",
+ "path": "/messaging/testing/{projectId}/numbers/{session}/phone/messages",
+ "operation": {
+ "operationId": "sendTestingPhoneMessage",
+ "tags": ["Testing"],
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Send a message from a Test number's phone",
+ "x-required-scope": "sandbox:write",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "required": true,
+ "name": "projectId",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "description": "The Test number's session ID."
+ },
+ "required": true,
+ "name": "session",
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestingPhoneMessageRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "The phone sent the message",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestingPhoneMessage"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "The session or recipient is not a Test number in the project, or the phone is offline",
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Test numbers access required, or a client token was used",
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Project not found",
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Testing rate limit reached",
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "rate_limit_error",
+ "code": "rate_limit_exceeded",
+ "message": "The request limit was reached. Follow Retry-After when supplied.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#rate-limit-exceeded"
+ }
+ }
+ }
+ },
+ "502": {
+ "description": "The phone could not send the message. Retry later.",
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "upstream_error",
+ "code": "upstream_failure",
+ "message": "The messaging provider could not complete the request.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#upstream-failure"
+ }
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "sandbox:write "
+ },
+ "description": "**Required scope:** `sandbox:write`"
+ }
+ },
+ "unlinkTestingPhoneDevice": {
+ "method": "POST",
+ "path": "/messaging/testing/{projectId}/numbers/{session}/phone/devices/{deviceId}/unlink",
+ "operation": {
+ "operationId": "unlinkTestingPhoneDevice",
+ "tags": ["Testing"],
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Unlink a companion from a Test number's phone",
+ "x-required-scope": "sandbox:write",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ },
+ "required": true,
+ "name": "projectId",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256,
+ "description": "The Test number's session ID."
+ },
+ "required": true,
+ "name": "session",
+ "in": "path"
+ },
+ {
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 99,
+ "description": "The companion's device ID, as listed by the phone."
+ },
+ "required": true,
+ "name": "deviceId",
+ "in": "path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The companion was unlinked and logged out",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestingPhoneUnlink"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "The session is not a Test number in the project, or the phone is offline",
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Test numbers access required, or a client token was used",
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Project or companion not found",
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ }
+ },
+ "502": {
+ "description": "The phone could not unlink the companion. Retry later.",
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "upstream_error",
+ "code": "upstream_failure",
+ "message": "The messaging provider could not complete the request.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#upstream-failure"
+ }
+ }
+ }
+ }
+ },
+ "x-mint": {
+ "content": "sandbox:write "
+ },
+ "description": "**Required scope:** `sandbox:write`"
+ }
+ }
+ },
+ "schemas": {
+ "TestingPhoneState": {
+ "type": "object",
+ "properties": {
+ "session": {
+ "type": "string"
+ },
+ "phone": {
+ "type": "string",
+ "description": "The Test number, in E.164 format."
+ },
+ "online": {
+ "type": "boolean",
+ "description": "True while the simulated phone is running."
+ },
+ "devices": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "deviceId": {
+ "type": "integer"
+ }
+ },
+ "required": ["deviceId"]
+ },
+ "description": "Companions linked to the phone, such as Polymorfa's own session and Inspector."
+ }
+ },
+ "required": ["session", "phone", "online", "devices"]
+ },
+ "PublicError": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "invalid_request_error",
+ "authentication_error",
+ "permission_error",
+ "conflict_error",
+ "rate_limit_error",
+ "api_error",
+ "upstream_error"
+ ]
+ },
+ "code": {
+ "type": "string",
+ "enum": [
+ "invalid_parameter",
+ "invalid_credential",
+ "entitlement_required",
+ "cloud_template_authority_restricted",
+ "gate_limit_reached",
+ "method_not_allowed",
+ "permission_denied",
+ "missing_scope",
+ "resource_not_found",
+ "hms_not_enabled",
+ "media_fetch_failed",
+ "resource_gone",
+ "feature_unavailable",
+ "stream_cursor_invalid",
+ "stream_cursor_expired",
+ "stream_connection_limit_reached",
+ "state_conflict",
+ "hybrid_routing_paused",
+ "hybrid_choice_required",
+ "hybrid_transition_ineligible",
+ "hybrid_automation_unavailable",
+ "hybrid_transport_unavailable",
+ "hybrid_target_reference_unavailable",
+ "send_outcome_unknown",
+ "idempotency_conflict",
+ "idempotency_in_progress",
+ "idempotency_completed",
+ "idempotency_outcome_unknown",
+ "call_claimed",
+ "call_not_ringing",
+ "connection_limit",
+ "unsupported_for_connection",
+ "call_permission_required",
+ "invalid_sip_trunk",
+ "calls_disabled",
+ "call_recipient_opted_out",
+ "call_destination_blocked",
+ "call_permission_request_limited",
+ "call_permission_granted",
+ "order_status_transition_invalid",
+ "order_cancellation_failed",
+ "call_opt_out_limit",
+ "number_restricted",
+ "sip_trunk_in_use",
+ "sip_trunk_revision_conflict",
+ "sip_trunk_limit",
+ "sip_unavailable",
+ "voice_not_enabled",
+ "provider_credential_invalid",
+ "provider_unavailable",
+ "asset_not_ready",
+ "voice_asset_in_use",
+ "voice_asset_revision_conflict",
+ "voice_unavailable",
+ "rate_limit_exceeded",
+ "internal_error",
+ "operation_not_supported",
+ "upstream_failure",
+ "service_unavailable",
+ "credential_verification_unavailable",
+ "session_not_ready",
+ "command_dispatch_failed",
+ "result_unknown",
+ "recipient_not_on_whatsapp",
+ "conversation_window_closed",
+ "template_not_approved",
+ "media_too_large",
+ "whatsapp_rate_limited",
+ "new_chat_limit_reached",
+ "whatsapp_account_restricted",
+ "whatsapp_groups_ineligible",
+ "whatsapp_group_creation_paused",
+ "whatsapp_group_limit_reached",
+ "whatsapp_group_full",
+ "whatsapp_group_suspended",
+ "whatsapp_group_has_no_participants",
+ "bansafe_suspended",
+ "bansafe_team_suspended",
+ "bansafe_cold_blocked",
+ "bansafe_cold_held",
+ "bansafe_throttled",
+ "bansafe_daily_allowance_reached",
+ "bansafe_accounting_unavailable",
+ "bansafe_send_outcome_unknown",
+ "campaigns_not_entitled",
+ "campaign_throughput_capped",
+ "campaign_approval_required",
+ "campaign_approval_stale",
+ "campaign_variables_missing"
+ ]
+ },
+ "message": {
+ "type": "string"
+ },
+ "param": {
+ "type": "string",
+ "nullable": true
+ },
+ "request_id": {
+ "type": "string",
+ "description": "Matches the X-Request-Id response header. Include it when you contact support."
+ },
+ "request_log_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "Console page that shows this request. Returned only to team and project credentials whose request was logged."
+ }
+ },
+ "required": ["type", "code", "message", "param", "request_id"]
+ },
+ "data": {
+ "type": "string",
+ "nullable": true,
+ "enum": [null],
+ "description": "Always null for a failed request."
+ },
+ "docs": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": ["error", "data", "docs"]
+ },
+ "TestingPhoneMessageRequest": {
+ "type": "object",
+ "properties": {
+ "to": {
+ "type": "string",
+ "pattern": "^\\+[1-9]\\d{7,14}$",
+ "description": "Another Test number in the same project, in E.164 format."
+ },
+ "text": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4096
+ }
+ },
+ "required": ["to", "text"],
+ "additionalProperties": false
+ },
+ "TestingPhoneMessage": {
+ "type": "object",
+ "properties": {
+ "session": {
+ "type": "string"
+ },
+ "to": {
+ "type": "string"
+ },
+ "messageId": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": ["session", "to", "messageId"]
+ },
+ "TestingPhoneUnlink": {
+ "type": "object",
+ "properties": {
+ "session": {
+ "type": "string"
+ },
+ "deviceId": {
+ "type": "integer"
+ },
+ "unlinked": {
+ "type": "boolean",
+ "enum": [true]
+ }
+ },
+ "required": ["session", "deviceId", "unlinked"]
+ }
+ }
+}
diff --git a/contracts/native-campaign-supplements.json b/contracts/native-campaign-supplements.json
index 444693ff0..142dcb2b2 100644
--- a/contracts/native-campaign-supplements.json
+++ b/contracts/native-campaign-supplements.json
@@ -13,18 +13,18 @@
"supplements": [
{
"path": "contracts/campaign-frequency-cap.json",
- "commit": "9bb1e2ed92d8b4a07ff727f8e7ae185498f0868f",
+ "commit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
"sources": {
- "messaging": "6d5b5477a86a85504f921933bf7b26f2c47506e21380fe73c8a5ff1002163b28",
- "platform": "bf4c6056b75e2fb0293b48edc5d8c12c36cdcbd194b9d11159f59522d30badc3"
+ "messaging": "e84c7ff814c6b59ca7f32c3fda1aedbed3f672e728910adb883f0aa8c6cf3ab7",
+ "platform": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559"
}
},
{
"path": "contracts/campaign-segments-drip.json",
- "commit": "9bb1e2ed92d8b4a07ff727f8e7ae185498f0868f",
+ "commit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
"sources": {
- "messaging": "6d5b5477a86a85504f921933bf7b26f2c47506e21380fe73c8a5ff1002163b28",
- "platform": "bf4c6056b75e2fb0293b48edc5d8c12c36cdcbd194b9d11159f59522d30badc3"
+ "messaging": "e84c7ff814c6b59ca7f32c3fda1aedbed3f672e728910adb883f0aa8c6cf3ab7",
+ "platform": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559"
}
}
],
diff --git a/contracts/native-interactive-messages.json b/contracts/native-interactive-messages.json
index 46b0c160f..d25e1cf75 100644
--- a/contracts/native-interactive-messages.json
+++ b/contracts/native-interactive-messages.json
@@ -11,7 +11,7 @@
},
"baselineUnchanged": true,
"published": false,
- "claim": "Source and synthetic native wire-fixture attribution only. This does not establish runtime acceptance, package publication or customer availability.",
+ "claim": "Source and synthetic native wire-fixture attribution only. This does not establish runtime acceptance, package publication or customer availability. The original baseline attribution remains historical; currentBaseline binds the separate Connection migration.",
"fields": {
"mediaHeader": "/buttonsContent/properties/buttons/properties/media",
"carousel": "/carouselContent/properties/carousel"
@@ -231,5 +231,9 @@
]
}
}
+ },
+ "currentBaseline": {
+ "sourceApiCommit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
+ "operations": 672
}
}
diff --git a/contracts/openapi.messaging.json b/contracts/openapi.messaging.json
index 76416382a..f9110af9d 100644
--- a/contracts/openapi.messaging.json
+++ b/contracts/openapi.messaging.json
@@ -3,7 +3,7 @@
"info": {
"title": "Polymorfa WhatsApp API",
"version": "1.0.0",
- "description": "Public Polymorfa REST API for sessions, messaging, media, webhooks, campaigns, templates, client tokens, QuickLinks, and bridge routing.",
+ "description": "Public Polymorfa REST API for connections, messaging, media, webhooks, campaigns, templates, client tokens, QuickLinks, and bridge routing.",
"contact": {
"name": "Polymorfa API",
"url": "https://docs.polymorfa.com"
@@ -746,14 +746,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -773,7 +773,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -902,14 +902,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -929,7 +929,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -1026,14 +1026,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -1053,7 +1053,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -1067,14 +1067,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -1094,7 +1094,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -1108,14 +1108,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -1135,7 +1135,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -1149,14 +1149,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -1176,7 +1176,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -1190,14 +1190,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -1217,7 +1217,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -1272,14 +1272,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -1299,7 +1299,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -1346,14 +1346,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -1373,18 +1373,18 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
]
},
- "RuntimeSessionStatusPayload": {
+ "RuntimeConnectionStatusPayload": {
"type": "object",
"properties": {
"status": {
"type": "string",
- "description": "Session status: CONNECTING, CONNECTED, DISCONNECTED",
+ "description": "Connection status: CONNECTING, CONNECTED, DISCONNECTED",
"example": "DISCONNECTED"
},
"statusReason": {
@@ -1426,7 +1426,7 @@
"enum": [
"meta"
],
- "description": "Always `meta`: a WhatsApp Business Account notification, not a connection-state change"
+ "description": "Always `meta`: a WhatsApp Business Account notification, not a method-state change"
},
"kind": {
"type": "string",
@@ -1454,17 +1454,17 @@
"value"
]
},
- "SessionStatusPayload": {
+ "ConnectionStatusPayload": {
"anyOf": [
{
- "$ref": "#/components/schemas/RuntimeSessionStatusPayload"
+ "$ref": "#/components/schemas/RuntimeConnectionStatusPayload"
},
{
"$ref": "#/components/schemas/CloudAccountStatusPayload"
}
]
},
- "SessionStatusEvent": {
+ "ConnectionStatusEvent": {
"type": "object",
"properties": {
"id": {
@@ -1472,14 +1472,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -1489,23 +1489,23 @@
"event": {
"type": "string",
"enum": [
- "session.status"
+ "connection.status"
],
"description": "Event type"
},
"payload": {
- "$ref": "#/components/schemas/SessionStatusPayload"
+ "$ref": "#/components/schemas/ConnectionStatusPayload"
}
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
]
},
- "SessionConnectedPayload": {
+ "ConnectionConnectedPayload": {
"type": "object",
"properties": {
"phoneNumber": {
@@ -1530,7 +1530,7 @@
"x-enumDescriptions": {
"android": "WhatsApp or WhatsApp Business on an Android phone.",
"ios": "WhatsApp or WhatsApp Business on an iPhone.",
- "meta_cloud": "Meta hosts the number through Cloud API.",
+ "meta_cloud": "Meta hosts the connection through Cloud API.",
"unknown": "The phone has not reported a recognized platform."
}
},
@@ -1561,7 +1561,7 @@
"accountType"
]
},
- "SessionConnectedEvent": {
+ "ConnectionConnectedEvent": {
"type": "object",
"properties": {
"id": {
@@ -1569,14 +1569,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -1586,23 +1586,23 @@
"event": {
"type": "string",
"enum": [
- "session.connected"
+ "connection.connected"
],
"description": "Event type"
},
"payload": {
- "$ref": "#/components/schemas/SessionConnectedPayload"
+ "$ref": "#/components/schemas/ConnectionConnectedPayload"
}
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
]
},
- "SessionLoggedOutPayload": {
+ "ConnectionLoggedOutPayload": {
"type": "object",
"properties": {
"reason": {
@@ -1612,7 +1612,7 @@
"device_removed",
"unknown"
],
- "description": "Why the session was logged out: `banned` when WhatsApp banned the account, `device_removed` when the linked device was removed from the phone or from another device, `unknown` otherwise (including a locked account).",
+ "description": "Why the connection was logged out: `banned` when WhatsApp banned the account, `device_removed` when the linked device was removed from the phone or from another device, `unknown` otherwise (including a locked account).",
"example": "device_removed"
},
"code": {
@@ -1626,7 +1626,7 @@
"code"
]
},
- "SessionLoggedOutEvent": {
+ "ConnectionLoggedOutEvent": {
"type": "object",
"properties": {
"id": {
@@ -1634,14 +1634,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -1651,23 +1651,23 @@
"event": {
"type": "string",
"enum": [
- "session.logged_out"
+ "connection.logged_out"
],
"description": "Event type"
},
"payload": {
- "$ref": "#/components/schemas/SessionLoggedOutPayload"
+ "$ref": "#/components/schemas/ConnectionLoggedOutPayload"
}
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
]
},
- "SessionPhoneOfflinePayload": {
+ "ConnectionPhoneOfflinePayload": {
"type": "object",
"properties": {
"daysSinceLastSeen": {
@@ -1677,7 +1677,7 @@
},
"daysRemaining": {
"type": "number",
- "description": "Days remaining before WhatsApp disconnects the session (clamped to 0). WhatsApp typically severs the companion link after ~14 days of phone inactivity.",
+ "description": "Days remaining before WhatsApp disconnects the connection (clamped to 0). WhatsApp typically severs the companion link after ~14 days of phone inactivity.",
"example": 3
},
"lastSeen": {
@@ -1688,7 +1688,7 @@
"action": {
"type": "string",
"description": "Human-readable action string to surface to the end user (e.g. ask them to open WhatsApp on their phone).",
- "example": "Open WhatsApp on your phone to keep the session alive"
+ "example": "Open WhatsApp on your phone to keep the connection alive"
}
},
"required": [
@@ -1699,7 +1699,7 @@
],
"description": "Sent once a day while the phone is offline, starting on the webhook's phoneOfflineStartDay (7-13, default 10). WhatsApp signs the linked device out after 14 days without its phone. Warnings stop once the phone is seen again."
},
- "SessionPhoneOfflineEvent": {
+ "ConnectionPhoneOfflineEvent": {
"type": "object",
"properties": {
"id": {
@@ -1707,14 +1707,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -1724,26 +1724,26 @@
"event": {
"type": "string",
"enum": [
- "session.phone_offline"
+ "connection.phone_offline"
],
"description": "Event type"
},
"payload": {
- "$ref": "#/components/schemas/SessionPhoneOfflinePayload"
+ "$ref": "#/components/schemas/ConnectionPhoneOfflinePayload"
}
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
]
},
- "SessionCapabilitiesUpdatedPayload": {
+ "ConnectionCapabilitiesUpdatedPayload": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string",
"maxLength": 256
},
@@ -1849,7 +1849,7 @@
}
},
"required": [
- "session",
+ "connection",
"projectId",
"status",
"syncedAt",
@@ -1860,7 +1860,7 @@
],
"additionalProperties": false
},
- "SessionCapabilitiesUpdatedEvent": {
+ "ConnectionCapabilitiesUpdatedEvent": {
"type": "object",
"properties": {
"id": {
@@ -1868,14 +1868,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -1885,23 +1885,23 @@
"event": {
"type": "string",
"enum": [
- "session.capabilities_updated"
+ "connection.capabilities_updated"
],
"description": "Event type"
},
"payload": {
- "$ref": "#/components/schemas/SessionCapabilitiesUpdatedPayload"
+ "$ref": "#/components/schemas/ConnectionCapabilitiesUpdatedPayload"
}
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
]
},
- "SessionRestrictionUpdatedPayload": {
+ "ConnectionRestrictionUpdatedPayload": {
"type": "object",
"properties": {
"type": {
@@ -1909,7 +1909,7 @@
"enum": [
"reachout_timelock"
],
- "description": "The restriction. `reachout_timelock`: the number can only message or call people it has already chatted with.",
+ "description": "The restriction. `reachout_timelock`: the connection can only message or call people it has already chatted with.",
"example": "reachout_timelock"
},
"active": {
@@ -1943,7 +1943,7 @@
"observedAt"
]
},
- "SessionRestrictionUpdatedEvent": {
+ "ConnectionRestrictionUpdatedEvent": {
"type": "object",
"properties": {
"id": {
@@ -1951,14 +1951,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -1968,17 +1968,17 @@
"event": {
"type": "string",
"enum": [
- "session.restriction_updated"
+ "connection.restriction_updated"
],
"description": "Event type"
},
"payload": {
- "$ref": "#/components/schemas/SessionRestrictionUpdatedPayload"
+ "$ref": "#/components/schemas/ConnectionRestrictionUpdatedPayload"
}
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -2013,7 +2013,7 @@
},
"action": {
"type": "string",
- "description": "What changed, for example `joined` when the Number joins a group with an invite link."
+ "description": "What changed, for example `joined` when the Connection joins a group with an invite link."
},
"requestId": {
"type": "string",
@@ -2063,14 +2063,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -2090,7 +2090,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -2205,14 +2205,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -2232,7 +2232,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -2275,14 +2275,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -2302,7 +2302,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -2414,14 +2414,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -2441,7 +2441,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -2467,21 +2467,21 @@
"description": "The configured keyword the reply matched, in upper case. The message itself is never included.",
"example": "STOP"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session name of the number that received the reply",
+ "description": "Connection name of the connection that received the reply",
"example": "sales-1"
},
"projectId": {
"type": "string",
- "description": "Project that owns the receiving number, when known"
+ "description": "Project that owns the receiving connection, when known"
}
},
"required": [
"phone",
"source",
"keyword",
- "session"
+ "connection"
]
},
"ContactOptedOutEvent": {
@@ -2492,14 +2492,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -2519,7 +2519,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -2533,14 +2533,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -2560,7 +2560,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -2591,14 +2591,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -2618,7 +2618,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -2650,14 +2650,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -2677,7 +2677,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -2706,14 +2706,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -2733,7 +2733,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -2758,14 +2758,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -2785,7 +2785,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -2810,14 +2810,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -2837,7 +2837,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -2857,13 +2857,13 @@
"description": "Whether the offered call advertised video.",
"example": false
},
- "sessionConnection": {
+ "connectionMethod": {
"type": "string",
"enum": [
"linked_device",
"cloud_api"
],
- "description": "Connection of the session that carries the call: a linked device or the WhatsApp Business Cloud API.",
+ "description": "Method that carries the call: a linked device or the WhatsApp Business Cloud API.",
"example": "linked_device"
},
"capabilities": {
@@ -2899,14 +2899,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -2926,7 +2926,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -2959,14 +2959,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -2986,7 +2986,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -3010,13 +3010,13 @@
"type": "boolean",
"description": "Present and `true` when the answering participant claimed the call."
},
- "sessionConnection": {
+ "connectionMethod": {
"type": "string",
"enum": [
"linked_device",
"cloud_api"
],
- "description": "Connection of the session that carries the call: a linked device or the WhatsApp Business Cloud API.",
+ "description": "Method that carries the call: a linked device or the WhatsApp Business Cloud API.",
"example": "linked_device"
},
"capabilities": {
@@ -3051,14 +3051,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -3078,7 +3078,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -3107,14 +3107,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -3134,7 +3134,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -3182,7 +3182,7 @@
},
"reason": {
"type": "string",
- "description": "Termination reason: user_hangup | timeout | lost_connection | rejected | capacity | pod_lost | connection_failed | upstream_failed | call_restricted (WhatsApp refused the call because the number is restricted to calling people it has already chatted with).",
+ "description": "Termination reason: user_hangup | timeout | lost_connection | rejected | capacity | pod_lost | connection_failed | upstream_failed | call_restricted (WhatsApp refused the call because the connection is restricted to calling people it has already chatted with).",
"example": "user_hangup"
},
"direction": {
@@ -3199,13 +3199,13 @@
"description": "Whether the call carried video.",
"example": false
},
- "sessionConnection": {
+ "connectionMethod": {
"type": "string",
"enum": [
"linked_device",
"cloud_api"
],
- "description": "Connection of the session that carries the call: a linked device or the WhatsApp Business Cloud API.",
+ "description": "Method that carries the call: a linked device or the WhatsApp Business Cloud API.",
"example": "linked_device"
}
},
@@ -3226,14 +3226,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -3253,7 +3253,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -3338,14 +3338,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -3365,7 +3365,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -3374,6 +3374,14 @@
"CallParticipant": {
"type": "object",
"properties": {
+ "guest": {
+ "type": "boolean",
+ "description": "Whether the provider identifies this call participant as a guest."
+ },
+ "name": {
+ "type": "string",
+ "description": "Participant display name supplied by the provider. This name is not verified identity."
+ },
"id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,18}$",
@@ -3447,14 +3455,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -3474,7 +3482,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -3488,14 +3496,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -3515,7 +3523,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -3547,14 +3555,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -3574,7 +3582,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -3586,7 +3594,7 @@
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,64}$",
- "description": "Client-chosen connection identifier.",
+ "description": "Client-chosen method identifier.",
"example": "conn_0123456789"
},
"participant": {
@@ -3602,7 +3610,7 @@
"socket",
"sip"
],
- "description": "`webrtc` for a browser connection, `socket` for a server or app connection, `sip` for a SIP trunk."
+ "description": "`webrtc` for a browser method, `socket` for a server or app method, `sip` for a SIP trunk."
}
},
"required": [
@@ -3634,14 +3642,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -3661,7 +3669,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -3759,14 +3767,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -3786,7 +3794,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -3801,7 +3809,7 @@
"connectionId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,64}$",
- "description": "Client-chosen connection identifier.",
+ "description": "Client-chosen method identifier.",
"example": "conn_0123456789"
},
"participant": {
@@ -3823,7 +3831,7 @@
"sip_unavailable",
"sip_auth_failed"
],
- "description": "`left`: the connection left. `replaced`: a reconnect reused the connection id. `claimed`: another participant claimed the call. `sip_busy`, `sip_declined`, `sip_no_answer`, `sip_unavailable` and `sip_auth_failed`: a SIP trunk did not join the call. `call_ended`: the call ended while a SIP trunk was still ringing. A SIP trunk that never joined the call (one of the `sip_*` reasons, or `call_ended` while it was still ringing) reports only `call.connection_left`, with no `call.connection_joined` before it. Connections still open when the call ends are closed by `call.ended` without a separate event.",
+ "description": "`left`: the method left. `replaced`: a reconnect reused the method id. `claimed`: another participant claimed the call. `sip_busy`, `sip_declined`, `sip_no_answer`, `sip_unavailable` and `sip_auth_failed`: a SIP trunk did not join the call. `call_ended`: the call ended while a SIP trunk was still ringing. A SIP trunk that never joined the call (one of the `sip_*` reasons, or `call_ended` while it was still ringing) reports only `call.connection_left`, with no `call.connection_joined` before it. Connections still open when the call ends are closed by `call.ended` without a separate event.",
"example": "left"
}
},
@@ -3842,14 +3850,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -3869,7 +3877,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -3936,7 +3944,7 @@
}
]
},
- "description": "Closed, per-meter attributes. Call meters carry `direction`, `upstream` (`linked_device` or `cloud_api`), `origin`, `participants`, `connections`, `sipLegs` and `video`.",
+ "description": "Closed, per-meter attributes. Call meters carry `direction`, `upstream` (`linked_device` or `cloud_api`), `origin`, `participants`, `methods`, `sipLegs` and `video`.",
"example": {
"direction": "outbound",
"upstream": "linked_device",
@@ -3976,10 +3984,10 @@
"nullable": true,
"format": "uuid"
},
- "session": {
+ "connection": {
"type": "string",
"nullable": true,
- "description": "The number (session name) the usage belongs to."
+ "description": "The connection (connection name) the usage belongs to."
},
"occurredAt": {
"type": "string",
@@ -4037,7 +4045,7 @@
"sourceKind",
"sourceId",
"projectId",
- "session",
+ "connection",
"occurredAt",
"recordedAt",
"revision",
@@ -4054,14 +4062,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -4081,7 +4089,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -4241,14 +4249,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -4268,7 +4276,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -4327,14 +4335,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -4354,7 +4362,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -4436,14 +4444,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -4463,7 +4471,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -4527,14 +4535,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -4554,7 +4562,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -4587,14 +4595,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -4614,7 +4622,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -4647,14 +4655,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -4674,7 +4682,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -4855,14 +4863,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -4882,7 +4890,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -5091,7 +5099,7 @@
"type": "string",
"format": "date-time"
},
- "peerDataRequestSessionId": {
+ "peerDataRequestConnectionId": {
"type": "string"
},
"media": {
@@ -5192,7 +5200,7 @@
"type": "string",
"format": "date-time"
},
- "peerDataRequestSessionId": {
+ "peerDataRequestConnectionId": {
"type": "string"
},
"inline": {
@@ -5238,14 +5246,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -5265,7 +5273,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -5305,14 +5313,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -5332,7 +5340,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -5371,7 +5379,7 @@
"system"
]
},
- "migratedNumberCount": {
+ "migratedConnectionCount": {
"type": "integer",
"minimum": 0
}
@@ -5383,7 +5391,7 @@
"projectId",
"customerId",
"actorKind",
- "migratedNumberCount"
+ "migratedConnectionCount"
],
"additionalProperties": false
},
@@ -5395,14 +5403,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -5422,7 +5430,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -5481,14 +5489,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -5508,7 +5516,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -5581,14 +5589,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -5608,7 +5616,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -5648,7 +5656,7 @@
"system"
]
},
- "blockingNumberCount": {
+ "blockingConnectionCount": {
"type": "integer",
"minimum": 0
},
@@ -5664,7 +5672,7 @@
"projectId",
"customerId",
"actorKind",
- "blockingNumberCount",
+ "blockingConnectionCount",
"revokedPairingLinkCount"
],
"additionalProperties": false
@@ -5677,14 +5685,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -5704,7 +5712,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -5763,14 +5771,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -5790,7 +5798,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -5849,14 +5857,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -5876,7 +5884,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -5940,14 +5948,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -5967,7 +5975,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -6031,14 +6039,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -6058,7 +6066,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -6102,7 +6110,7 @@
"type": "string",
"format": "uuid"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
}
@@ -6115,7 +6123,7 @@
"customerId",
"actorKind",
"pairingLinkId",
- "sessionId"
+ "connectionId"
],
"additionalProperties": false
},
@@ -6127,14 +6135,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -6154,7 +6162,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -6223,14 +6231,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -6250,7 +6258,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -6314,14 +6322,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -6341,7 +6349,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -6414,14 +6422,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -6441,14 +6449,14 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
],
"additionalProperties": false
},
- "CustomerNumberAttachedPayload": {
+ "CustomerConnectionAttachedPayload": {
"type": "object",
"properties": {
"eventId": {
@@ -6481,7 +6489,7 @@
"system"
]
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -6497,11 +6505,11 @@
"projectId",
"customerId",
"actorKind",
- "sessionId"
+ "connectionId"
],
"additionalProperties": false
},
- "CustomerNumberAttachedEvent": {
+ "CustomerConnectionAttachedEvent": {
"type": "object",
"properties": {
"id": {
@@ -6509,14 +6517,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -6526,24 +6534,24 @@
"event": {
"type": "string",
"enum": [
- "customer.number.attached"
+ "customer.connection.attached"
],
"description": "Event type"
},
"payload": {
- "$ref": "#/components/schemas/CustomerNumberAttachedPayload"
+ "$ref": "#/components/schemas/CustomerConnectionAttachedPayload"
}
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
],
"additionalProperties": false
},
- "CustomerNumberTransferredPayload": {
+ "CustomerConnectionTransferredPayload": {
"type": "object",
"properties": {
"eventId": {
@@ -6576,7 +6584,7 @@
"system"
]
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -6592,12 +6600,12 @@
"projectId",
"customerId",
"actorKind",
- "sessionId",
+ "connectionId",
"sourceCustomerId"
],
"additionalProperties": false
},
- "CustomerNumberTransferredEvent": {
+ "CustomerConnectionTransferredEvent": {
"type": "object",
"properties": {
"id": {
@@ -6605,14 +6613,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -6622,24 +6630,24 @@
"event": {
"type": "string",
"enum": [
- "customer.number.transferred"
+ "customer.connection.transferred"
],
"description": "Event type"
},
"payload": {
- "$ref": "#/components/schemas/CustomerNumberTransferredPayload"
+ "$ref": "#/components/schemas/CustomerConnectionTransferredPayload"
}
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
],
"additionalProperties": false
},
- "CustomerNumberDisconnectedPayload": {
+ "CustomerConnectionDisconnectedPayload": {
"type": "object",
"properties": {
"eventId": {
@@ -6672,7 +6680,7 @@
"system"
]
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -6688,12 +6696,12 @@
"projectId",
"customerId",
"actorKind",
- "sessionId",
+ "connectionId",
"reason"
],
"additionalProperties": false
},
- "CustomerNumberDisconnectedEvent": {
+ "CustomerConnectionDisconnectedEvent": {
"type": "object",
"properties": {
"id": {
@@ -6701,14 +6709,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -6718,17 +6726,17 @@
"event": {
"type": "string",
"enum": [
- "customer.number.disconnected"
+ "customer.connection.disconnected"
],
"description": "Event type"
},
"payload": {
- "$ref": "#/components/schemas/CustomerNumberDisconnectedPayload"
+ "$ref": "#/components/schemas/CustomerConnectionDisconnectedPayload"
}
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -6812,14 +6820,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -6839,7 +6847,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -6915,14 +6923,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -6942,7 +6950,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -6987,7 +6995,7 @@
"phoneNumber": {
"type": "string",
"pattern": "^\\+[1-9]\\d{1,14}$",
- "description": "The customer's own number in E.164 format.",
+ "description": "The customer's own phone number in E.164 format.",
"example": "+15551234567"
},
"action": {
@@ -6998,15 +7006,15 @@
"lifted",
"daily_allowance_reached"
],
- "description": "Whether the restriction was newly applied, moved, or removed. `daily_allowance_reached` reports that the number spent its warm-up allowance for the day; nothing on the ladder moved and sending resumes at the next reset."
+ "description": "Whether the restriction was newly applied, moved, or removed. `daily_allowance_reached` reports that the connection spent its warm-up allowance for the day; nothing on the ladder moved and sending resumes at the next reset."
},
"scope": {
"type": "string",
"enum": [
- "number",
+ "connection",
"team"
],
- "description": "Whether this covers one number or every number in the workspace."
+ "description": "Whether this covers one connection or every connection in the workspace."
},
"rung": {
"type": "string",
@@ -7143,14 +7151,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -7170,7 +7178,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -7180,10 +7188,10 @@
"BanSafeHealthThresholdPayload": {
"type": "object",
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid",
- "description": "Session whose present Health crossed the project threshold."
+ "description": "Connection whose present Health crossed the project threshold."
},
"projectId": {
"type": "string",
@@ -7246,7 +7254,7 @@
}
},
"required": [
- "sessionId",
+ "connectionId",
"projectId",
"health",
"threshold",
@@ -7268,14 +7276,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -7295,7 +7303,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -7313,7 +7321,7 @@
"phoneNumber": {
"type": "string",
"pattern": "^\\+[1-9]\\d{1,14}$",
- "description": "The customer's own number in E.164 format.",
+ "description": "The customer's own phone number in E.164 format.",
"example": "+15551234567"
},
"kind": {
@@ -7354,7 +7362,7 @@
"type": "number",
"minimum": 0,
"maximum": 1,
- "description": "How confident Polymorfa is that this restriction was real, from 0 to 1. A restriction WhatsApp announced is 1. A ban you report starts at 0.9 and moves once the number's own sending shows whether it was restricted.",
+ "description": "How confident Polymorfa is that this restriction was real, from 0 to 1. A restriction WhatsApp announced is 1. A ban you report starts at 0.9 and moves once the connection's own sending shows whether it was restricted.",
"example": 1
},
"resolution": {
@@ -7366,7 +7374,7 @@
"phone_switch",
"final"
],
- "description": "How the incident settled. open: still being decided. corroborated: a report and an observed restriction agree. contradicted: the number kept sending, so there was no restriction. phone_switch: the number moved to another phone. final: settled with the confidence shown."
+ "description": "How the incident settled. open: still being decided. corroborated: a report and an observed restriction agree. contradicted: the connection kept sending, so there was no restriction. phone_switch: the connection moved to another phone. final: settled with the confidence shown."
},
"claimId": {
"type": "string",
@@ -7404,14 +7412,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -7431,7 +7439,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -7454,7 +7462,7 @@
"phoneNumber": {
"type": "string",
"pattern": "^\\+[1-9]\\d{1,14}$",
- "description": "The customer's own number in E.164 format.",
+ "description": "The customer's own phone number in E.164 format.",
"example": "+15551234567"
},
"status": {
@@ -7480,7 +7488,7 @@
"simultaneous_calls",
"linked_device_interactive"
],
- "description": "What the ban was attributed to. other_device: another device on the account was sending. customer_conduct: Polymorfa was already restricting this number, or named the same serious problem for a week. shared_network: the number shared its connection with numbers that were being restricted. ours: nothing points at how the number was used. inconclusive: Polymorfa could not see enough of the window to say. simultaneous_calls: simultaneous calls were on for the number inside the window, which voids Ban Credit; the claim is denied when filed. linked_device_interactive: the number sent an interactive message (buttons, lists, product messages, Flows and similar) from a linked device inside the window, which voids Ban Credit; the claim is denied when filed."
+ "description": "What the ban was attributed to. other_device: another device on the account was sending. customer_conduct: Polymorfa was already restricting this connection, or named the same serious problem for a week. shared_network: the connection shared its method with connections that were being restricted. ours: nothing points at how the connection was used. inconclusive: Polymorfa could not see enough of the window to say. simultaneous_calls: simultaneous calls were on for the connection inside the window, which voids Ban Credit; the claim is denied when filed. linked_device_interactive: the connection sent an interactive message (buttons, lists, product messages, Flows and similar) from a linked device inside the window, which voids Ban Credit; the claim is denied when filed."
},
"windowStart": {
"type": "string",
@@ -7496,7 +7504,7 @@
},
"measuredCents": {
"type": "number",
- "description": "Credit quantity this number consumed inside the window, with up to six decimal places.",
+ "description": "Credit quantity this connection consumed inside the window, with up to six decimal places.",
"minimum": 0,
"multipleOf": 0.000001,
"example": 1080
@@ -7564,14 +7572,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -7591,7 +7599,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -7620,7 +7628,7 @@
"type": "string",
"enum": [
"invalid_recipient",
- "session_not_connected",
+ "connection_not_connected",
"ack_timeout",
"send_failed",
"blocked_by_safety"
@@ -7662,14 +7670,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -7689,7 +7697,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -7812,14 +7820,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -7839,7 +7847,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -7977,14 +7985,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -8004,7 +8012,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -8052,14 +8060,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -8079,7 +8087,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -8110,7 +8118,7 @@
},
"phoneNumberId": {
"type": "string",
- "description": "WhatsApp phone number ID of your Number"
+ "description": "WhatsApp phone number ID of your Connection"
}
},
"required": [
@@ -8127,14 +8135,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -8154,7 +8162,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -8187,11 +8195,11 @@
"reason": {
"type": "string",
"description": "Why Polymorfa paused the campaign. Present only on an automatic pause.",
- "example": "WhatsApp lowered the messaging limit of a number this campaign sends from."
+ "example": "WhatsApp lowered the messaging limit of a connection this campaign sends from."
},
"code": {
"type": "string",
- "description": "Stable code for an automatic pause: campaigns_not_entitled, bansafe_team_suspended, bansafe_suspended, campaign_throughput_capped, invalid_parameter, hybrid_campaign_unsupported, blocked_by_safety, number_quality_dropped, or messaging_limit_dropped. Present only on an automatic pause.",
+ "description": "Stable code for an automatic pause: campaigns_not_entitled, bansafe_team_suspended, bansafe_suspended, campaign_throughput_capped, invalid_parameter, hybrid_campaign_unsupported, blocked_by_safety, connection_quality_dropped, or messaging_limit_dropped. Present only on an automatic pause.",
"example": "messaging_limit_dropped"
}
},
@@ -8210,14 +8218,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -8237,7 +8245,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -8283,14 +8291,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -8310,7 +8318,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -8353,14 +8361,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -8380,7 +8388,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -8423,14 +8431,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -8450,7 +8458,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -8496,14 +8504,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -8523,7 +8531,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -8593,14 +8601,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -8620,7 +8628,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -8660,14 +8668,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -8687,7 +8695,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -8711,9 +8719,9 @@
"description": "Recipient phone number in E.164",
"example": "+14155550123"
},
- "sessionKey": {
+ "connectionKey": {
"type": "string",
- "description": "Sending number's session key",
+ "description": "Sending connection's connection key",
"example": "sales-1"
},
"externalMessageId": {
@@ -8744,7 +8752,7 @@
"campaignId",
"recipientId",
"phone",
- "sessionKey",
+ "connectionKey",
"externalMessageId",
"variantKey",
"attempt"
@@ -8758,14 +8766,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -8785,7 +8793,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -8809,9 +8817,9 @@
"description": "Recipient phone number in E.164",
"example": "+14155550123"
},
- "sessionKey": {
+ "connectionKey": {
"type": "string",
- "description": "Sending number's session key",
+ "description": "Sending connection's connection key",
"example": "sales-1"
},
"externalMessageId": {
@@ -8830,7 +8838,7 @@
"campaignId",
"recipientId",
"phone",
- "sessionKey",
+ "connectionKey",
"externalMessageId",
"deliveredAt"
]
@@ -8843,14 +8851,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -8870,7 +8878,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -8894,9 +8902,9 @@
"description": "Recipient phone number in E.164",
"example": "+14155550123"
},
- "sessionKey": {
+ "connectionKey": {
"type": "string",
- "description": "Sending number's session key",
+ "description": "Sending connection's connection key",
"example": "sales-1"
},
"externalMessageId": {
@@ -8915,7 +8923,7 @@
"campaignId",
"recipientId",
"phone",
- "sessionKey",
+ "connectionKey",
"externalMessageId",
"readAt"
]
@@ -8928,14 +8936,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -8955,7 +8963,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -8979,9 +8987,9 @@
"description": "Recipient phone number in E.164",
"example": "+14155550123"
},
- "sessionKey": {
+ "connectionKey": {
"type": "string",
- "description": "Sending number's session key",
+ "description": "Sending connection's connection key",
"example": "sales-1"
},
"externalMessageId": {
@@ -9006,7 +9014,7 @@
"campaignId",
"recipientId",
"phone",
- "sessionKey",
+ "connectionKey",
"externalMessageId",
"repliedAt",
"responseMs"
@@ -9020,14 +9028,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -9047,7 +9055,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -9094,14 +9102,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -9121,7 +9129,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -9185,14 +9193,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -9212,7 +9220,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -9276,14 +9284,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -9303,7 +9311,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -9317,14 +9325,14 @@
"description": "Campaign id",
"example": "01936b2e-5f2a-7c1d-9a3e-8b4c2d1e0f11"
},
- "sessionKey": {
+ "connectionKey": {
"type": "string",
- "description": "Sending number's session key",
+ "description": "Sending connection's connection key",
"example": "sales-1"
},
"reason": {
"type": "string",
- "description": "Why sending was paced: `paced`, `bansafe_throttled`, `daily_allowance_reached`, or `new_chat_limit_reached` (WhatsApp capped this number's new chats for the current cycle)",
+ "description": "Why sending was paced: `paced`, `bansafe_throttled`, `daily_allowance_reached`, or `new_chat_limit_reached` (WhatsApp capped this connection's new chats for the current cycle)",
"example": "bansafe_throttled"
},
"deferredCount": {
@@ -9341,7 +9349,7 @@
},
"required": [
"campaignId",
- "sessionKey",
+ "connectionKey",
"reason",
"deferredCount",
"at"
@@ -9355,14 +9363,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -9382,7 +9390,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -9396,9 +9404,9 @@
"description": "Campaign id",
"example": "01936b2e-5f2a-7c1d-9a3e-8b4c2d1e0f11"
},
- "sessionKey": {
+ "connectionKey": {
"type": "string",
- "description": "Sending number's session key",
+ "description": "Sending connection's connection key",
"example": "sales-1"
},
"phone": {
@@ -9408,7 +9416,7 @@
},
"capType": {
"type": "string",
- "description": "Which cap was reached: `hourly` or `daily` (the campaign's own caps), or `new_chat` (WhatsApp's per-number new-chat cap)",
+ "description": "Which cap was reached: `hourly` or `daily` (the campaign's own caps), or `new_chat` (WhatsApp's per-connection new-chat cap)",
"example": "daily"
},
"capLimit": {
@@ -9431,7 +9439,7 @@
},
"required": [
"campaignId",
- "sessionKey",
+ "connectionKey",
"phone",
"capType",
"capLimit",
@@ -9447,14 +9455,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -9474,7 +9482,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -9532,14 +9540,14 @@
"description": "Unique event identifier",
"example": "0190f2a4-6c1e-7b9d-9f3a-2e8c4d5b6a71"
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session that produced this event",
+ "description": "Connection that produced this event",
"example": "739182640518203"
},
"externalId": {
"type": "string",
- "description": "Integrator reference from the QuickLink that created this session. Included on session lifecycle events when supplied."
+ "description": "Integrator reference from the QuickLink that created this connection. Included on connection lifecycle events when supplied."
},
"timestamp": {
"type": "string",
@@ -9559,7 +9567,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"timestamp",
"event",
"payload"
@@ -9683,7 +9691,7 @@
"code": {
"type": "string",
"enum": [
- "zero_knowledge_session",
+ "zero_knowledge_connection",
"invalid_parameter",
"invalid_credential",
"entitlement_required",
@@ -9734,7 +9742,7 @@
"order_status_transition_invalid",
"order_cancellation_failed",
"call_opt_out_limit",
- "number_restricted",
+ "connection_restricted",
"sip_trunk_in_use",
"sip_trunk_revision_conflict",
"sip_trunk_limit",
@@ -9752,7 +9760,7 @@
"upstream_failure",
"service_unavailable",
"credential_verification_unavailable",
- "session_not_ready",
+ "connection_not_ready",
"command_dispatch_failed",
"result_unknown",
"parent_bsuid_not_supported",
@@ -9887,7 +9895,7 @@
"ticket": {
"type": "string"
},
- "session": {
+ "connection": {
"type": "string"
},
"rpId": {
@@ -9914,7 +9922,7 @@
"required": [
"version",
"ticket",
- "session",
+ "connection",
"rpId",
"challengeB64Url",
"userVerification",
@@ -10000,14 +10008,14 @@
"ticket": {
"type": "string"
},
- "session": {
+ "connection": {
"type": "string"
}
},
"required": [
"ok",
"ticket",
- "session"
+ "connection"
]
},
"SubmitPasskeyAssertionResponse": {
@@ -10244,7 +10252,7 @@
"enum": [
"team",
"project",
- "session"
+ "connection"
]
},
"revision": {
@@ -10450,7 +10458,7 @@
"template",
"target_reference",
"only_eligible_transport",
- "session_rule",
+ "connection_rule",
"project_rule",
"team_rule",
"default_linked_devices"
@@ -10683,7 +10691,7 @@
"type": "string",
"minLength": 4,
"maxLength": 21848,
- "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices numbers only."
+ "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices connections only."
},
"width": {
"type": "integer",
@@ -10763,7 +10771,7 @@
"type": "string",
"minLength": 4,
"maxLength": 21848,
- "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices numbers only."
+ "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices connections only."
},
"width": {
"type": "integer",
@@ -10849,7 +10857,7 @@
"type": "string",
"minLength": 4,
"maxLength": 21848,
- "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices numbers only."
+ "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices connections only."
}
},
"required": [
@@ -11549,7 +11557,7 @@
"type": "string",
"minLength": 4,
"maxLength": 21848,
- "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices numbers only."
+ "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices connections only."
},
"descriptor": {
"$ref": "#/components/schemas/VideoMediaDescriptor"
@@ -11594,7 +11602,7 @@
"type": "string",
"minLength": 4,
"maxLength": 21848,
- "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices numbers only."
+ "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices connections only."
},
"descriptor": {
"$ref": "#/components/schemas/FileMediaDescriptor"
@@ -12541,7 +12549,7 @@
"buttonText",
"sections"
],
- "description": "On an official WhatsApp Business number, `title` is the header (at most 60 characters) and `description` the body (at most 1,024 characters); without `description`, `title` is the body. There, each section title allows at most 24 characters and is required when the list has more than one section, lists allow at most 10 rows in total, row titles at most 24 characters, row IDs at most 200, row descriptions at most 72, `buttonText` at most 20 and `footer` at most 60. Every number also limits `buttonText` to 64 UTF-8 bytes, row `id` to 256 bytes and `title` and `description` to 256 and 4,096 bytes, so multibyte text reaches those byte limits before the character limits. Content outside any limit returns `400`."
+ "description": "On an Official API connection, `title` is the header (at most 60 characters) and `description` the body (at most 1,024 characters); without `description`, `title` is the body. There, each section title allows at most 24 characters and is required when the list has more than one section, lists allow at most 10 rows in total, row titles at most 24 characters, row IDs at most 200, row descriptions at most 72, `buttonText` at most 20 and `footer` at most 60. Every connection also limits `buttonText` to 64 UTF-8 bytes, row `id` to 256 bytes and `title` and `description` to 256 and 4,096 bytes, so multibyte text reaches those byte limits before the character limits. Content outside any limit returns `400`."
}
},
"required": [
@@ -12898,7 +12906,7 @@
"type": "string",
"minLength": 4,
"maxLength": 21848,
- "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices numbers only."
+ "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices connections only."
}
},
"additionalProperties": false
@@ -12969,7 +12977,7 @@
"type": "string",
"minLength": 4,
"maxLength": 21848,
- "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices numbers only."
+ "description": "Base64-encoded JPEG preview shown before the media downloads, at most 16 KiB. Linked Devices connections only."
}
},
"required": [
@@ -13128,7 +13136,7 @@
"body",
"buttons"
],
- "description": "Linked Devices support up to 10 total buttons and at most 3 CTAs. Replies may be mixed with URL and call buttons using a hydrated template; copy/catalog buttons cannot be mixed with replies. An optional image, video or document header requires exactly one URL or base64 source and cannot be combined with a title. On an official WhatsApp Business number, media headers require an approved template, and at most 3 `reply` buttons are sent; other button types return `501`. There, `body` allows at most 1,024 characters, `title` and `footer` at most 60, and each button needs a unique `id` and a unique `text` of at most 20 characters. Every number also limits each button `id` to 256 UTF-8 bytes. Content outside any limit returns `400`."
+ "description": "Linked Devices support up to 10 total buttons and at most 3 CTAs. Replies may be mixed with URL and call buttons using a hydrated template; copy/catalog buttons cannot be mixed with replies. An optional image, video or document header requires exactly one URL or base64 source and cannot be combined with a title. On an Official API connection, media headers require an approved template, and at most 3 `reply` buttons are sent; other button types return `501`. There, `body` allows at most 1,024 characters, `title` and `footer` at most 60, and each button needs a unique `id` and a unique `text` of at most 20 characters. Every connection also limits each button `id` to 256 UTF-8 bytes. Content outside any limit returns `400`."
}
},
"required": [
@@ -13279,7 +13287,7 @@
"body"
],
"additionalProperties": false,
- "description": "Ask the person for permission to call them. Cloud API numbers only; WhatsApp limits how often you can ask."
+ "description": "Ask the person for permission to call them. Cloud API connections only; WhatsApp limits how often you can ask."
}
},
"required": [
@@ -13355,7 +13363,7 @@
"linked_devices",
"official_api"
],
- "description": "Choose a transport or use the Number's routing rules. An explicit choice does not fall back."
+ "description": "Choose a transport or use the Connection's routing rules. An explicit choice does not fall back."
},
"conversation": {
"$ref": "#/components/schemas/ConversationReference"
@@ -13478,7 +13486,7 @@
"template",
"target_reference",
"only_eligible_transport",
- "session_rule",
+ "connection_rule",
"project_rule",
"team_rule",
"default_linked_devices"
@@ -13744,7 +13752,7 @@
},
"description": "The other party, as the call reported it."
},
- "SessionCallRecord": {
+ "ConnectionCallRecord": {
"type": "object",
"properties": {
"callId": {
@@ -13753,9 +13761,9 @@
"projectId": {
"type": "string"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
- "description": "The Number's session name."
+ "description": "The Connection's connection name."
},
"direction": {
"type": "string",
@@ -13820,7 +13828,7 @@
"required": [
"callId",
"projectId",
- "sessionId",
+ "connectionId",
"direction",
"upstream",
"outcome",
@@ -13834,7 +13842,7 @@
"endReason"
]
},
- "ListSessionCallsResponse": {
+ "ListConnectionCallsResponse": {
"type": "object",
"properties": {
"success": {
@@ -13846,7 +13854,7 @@
"data": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/SessionCallRecord"
+ "$ref": "#/components/schemas/ConnectionCallRecord"
}
},
"nextCursor": {
@@ -14171,7 +14179,7 @@
},
"fromMe": {
"type": "boolean",
- "description": "True when the Number sent the message, including from another linked device."
+ "description": "True when the Connection sent the message, including from another linked device."
},
"type": {
"type": "string",
@@ -14371,7 +14379,7 @@
"closed",
"unknown"
],
- "description": "`open`: the person messaged, reacted or called this Number through the Official API in the last 24 hours, so free-form messages can be sent. `closed`: no such activity in the last 24 hours; only approved templates can be sent, and Polymorfa refuses free-form sends with `conversation_window_closed`. `unknown`: Polymorfa cannot prove the window is closed; sends are passed to WhatsApp, which decides."
+ "description": "`open`: the person messaged, reacted or called this Connection through the Official API in the last 24 hours, so free-form messages can be sent. `closed`: no such activity in the last 24 hours; only approved templates can be sent, and Polymorfa refuses free-form sends with `conversation_window_closed`. `unknown`: Polymorfa cannot prove the window is closed; sends are passed to WhatsApp, which decides."
},
"reason": {
"type": "string",
@@ -14383,7 +14391,7 @@
"identity_unlinked",
null
],
- "description": "Why the state is `unknown`, otherwise null. `not_tracked`: no WhatsApp notification has been processed for this connection yet. `tracking_started`: tracking began less than 24 hours ago. `notifications_interrupted`: a WhatsApp notification could not be processed in the last 24 hours. `identity_unlinked`: someone without a phone number (or username ID) wrote in during the last 24 hours and could be this person."
+ "description": "Why the state is `unknown`, otherwise null. `not_tracked`: no WhatsApp notification has been processed for this method yet. `tracking_started`: tracking began less than 24 hours ago. `notifications_interrupted`: a WhatsApp notification could not be processed in the last 24 hours. `identity_unlinked`: someone without a phone number (or username ID) wrote in during the last 24 hours and could be this person."
},
"openedAt": {
"type": "string",
@@ -14572,7 +14580,7 @@
"limits"
],
"additionalProperties": false,
- "description": "Whether this number can send the person a call permission request now, with WhatsApp's limits."
+ "description": "Whether this connection can send the person a call permission request now, with WhatsApp's limits."
},
"CallPermission": {
"type": "object",
@@ -14637,7 +14645,7 @@
"$ref": "#/components/schemas/CallPermissionAction"
},
{
- "description": "Whether this number can call the person now, with WhatsApp's limits."
+ "description": "Whether this connection can call the person now, with WhatsApp's limits."
}
]
}
@@ -14761,7 +14769,7 @@
"$ref": "#/components/schemas/CallPermissionAction"
},
{
- "description": "Whether this number can call the person now, with WhatsApp's limits."
+ "description": "Whether this connection can call the person now, with WhatsApp's limits."
}
]
}
@@ -14784,7 +14792,7 @@
"actions"
],
"additionalProperties": false,
- "description": "The person's call permission on a Cloud API number; null on linked-device numbers."
+ "description": "The person's call permission on a Cloud API connection; null on linked-device connections."
}
},
"required": [
@@ -14815,11 +14823,11 @@
"CallCheckRequest": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string",
"minLength": 1,
"maxLength": 128,
- "description": "The session (number) that would place the call."
+ "description": "The Connection that would place the call."
},
"to": {
"type": "string",
@@ -14829,7 +14837,7 @@
}
},
"required": [
- "session",
+ "connection",
"to"
],
"additionalProperties": false
@@ -14837,7 +14845,7 @@
"VoipCreatedCallLink": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
"token": {
@@ -14852,7 +14860,7 @@
}
},
"required": [
- "session",
+ "connection",
"token",
"url",
"video"
@@ -14879,7 +14887,7 @@
"VoipCreateCallLinkRequest": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string",
"minLength": 1,
"maxLength": 128
@@ -14890,14 +14898,14 @@
}
},
"required": [
- "session"
+ "connection"
],
"additionalProperties": false
},
"VoipPreviewedCallLink": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
"video": {
@@ -14911,11 +14919,11 @@
},
"isAdmin": {
"type": "boolean",
- "description": "Whether WhatsApp reports this Number as a link administrator. This field does not grant API permissions."
+ "description": "Whether WhatsApp reports this Connection as a link administrator. This field does not grant API permissions."
}
},
"required": [
- "session",
+ "connection",
"video",
"creator",
"approvalRequired",
@@ -14943,7 +14951,7 @@
"VoipPreviewCallLinkRequest": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string",
"minLength": 1,
"maxLength": 128
@@ -14959,7 +14967,7 @@
}
},
"required": [
- "session",
+ "connection",
"token"
],
"additionalProperties": false
@@ -15037,7 +15045,7 @@
"connectionId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,64}$",
- "description": "Client-chosen identifier of one media connection. Reusing it replaces that connection.",
+ "description": "Client-chosen identifier of one media connection. Reusing it replaces that media connection.",
"example": "conn_0123456789"
},
"participant": {
@@ -15080,7 +15088,7 @@
"connectionId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,64}$",
- "description": "Client-chosen identifier of one media connection. Reusing it replaces that connection.",
+ "description": "Client-chosen identifier of one media connection. Reusing it replaces that media connection.",
"example": "conn_0123456789"
},
"participant": {
@@ -15101,7 +15109,7 @@
"callId": {
"type": "string"
},
- "session": {
+ "connection": {
"type": "string"
},
"video": {
@@ -15110,7 +15118,7 @@
},
"required": [
"callId",
- "session",
+ "connection",
"video"
]
},
@@ -15135,7 +15143,7 @@
"VoipPlaceCallRequest": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string",
"minLength": 1,
"example": "support"
@@ -15173,7 +15181,7 @@
"example": "agent-7"
}
},
- "description": "Provide exactly one of to, participants or groupId. Group calls require a Linked Device number and 2 to 31 remote recipients.",
+ "description": "Provide exactly one of to, participants or groupId. Group calls require a Linked Devices connection and 2 to 31 remote recipients.",
"oneOf": [
{
"required": [
@@ -15280,7 +15288,7 @@
},
"exclusive": {
"type": "boolean",
- "description": "Claim the call. Other participants then receive `409 call_claimed` for accept and media, and their open connections close."
+ "description": "Claim the call. Other participants then receive `409 call_claimed` for accept and media, and their open methods close."
},
"participant": {
"type": "string",
@@ -15307,7 +15315,7 @@
"connectionId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,64}$",
- "description": "Client-chosen identifier of one media connection. Reusing it replaces that connection.",
+ "description": "Client-chosen identifier of one media connection. Reusing it replaces that media connection.",
"example": "conn_0123456789"
},
"participant": {
@@ -15327,13 +15335,13 @@
"connectionId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,64}$",
- "description": "Client-chosen identifier of one media connection. Reusing it replaces that connection.",
+ "description": "Client-chosen identifier of one media connection. Reusing it replaces that media connection.",
"example": "conn_0123456789"
},
"participant": {
"type": "string",
"pattern": "^[A-Za-z0-9._:@-]{1,128}$",
- "description": "Server credentials only: the participant acting in the call, which must own the connection. Defaults to `default`. Client tokens act as their own participant and must omit this field.",
+ "description": "Server credentials only: the participant acting in the call, which must own the media connection. Defaults to `default`. Client tokens act as their own participant and must omit this field.",
"example": "agent-7"
},
"emoji": {
@@ -15362,13 +15370,13 @@
"connectionId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,64}$",
- "description": "Client-chosen identifier of one media connection. Reusing it replaces that connection.",
+ "description": "Client-chosen identifier of one media connection. Reusing it replaces that media connection.",
"example": "conn_0123456789"
},
"participant": {
"type": "string",
"pattern": "^[A-Za-z0-9._:@-]{1,128}$",
- "description": "Server credentials only: the participant acting in the call, which must own the connection. Defaults to `default`. Client tokens act as their own participant and must omit this field.",
+ "description": "Server credentials only: the participant acting in the call, which must own the media connection. Defaults to `default`. Client tokens act as their own participant and must omit this field.",
"example": "agent-7"
},
"raised": {
@@ -15381,6 +15389,190 @@
],
"additionalProperties": false
},
+ "VoipWaitingRoomControlResult": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "waiting_room_result"
+ ]
+ },
+ "requestId": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9_-]{8,64}$",
+ "description": "Client-chosen identifier of one media connection. Reusing it replaces that media connection.",
+ "example": "conn_0123456789"
+ },
+ "ok": {
+ "type": "boolean"
+ },
+ "code": {
+ "type": "string",
+ "enum": [
+ "invalid_waiting_room_control",
+ "connection_unavailable",
+ "unsupported_operation",
+ "waiting_room_admin_required",
+ "waiting_room_target_unavailable",
+ "waiting_room_unavailable",
+ "waiting_room_control_failed",
+ "waiting_room_control_unknown"
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "requestId",
+ "ok"
+ ],
+ "additionalProperties": false
+ },
+ "VoipWaitingRoomControlResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "enum": [
+ true
+ ]
+ },
+ "data": {
+ "$ref": "#/components/schemas/VoipWaitingRoomControlResult"
+ }
+ },
+ "required": [
+ "success",
+ "data"
+ ]
+ },
+ "VoipWaitingRoomControlRequest": {
+ "type": "object",
+ "properties": {
+ "connectionId": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9_-]{8,64}$",
+ "description": "Client-chosen identifier of one media connection. Reusing it replaces that media connection.",
+ "example": "conn_0123456789"
+ },
+ "participant": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9._:@-]{1,128}$",
+ "description": "Server credentials only: the participant acting in the call, which must own the media connection. Defaults to `default`. Client tokens act as their own participant and must omit this field.",
+ "example": "agent-7"
+ },
+ "control": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "waiting_room_control"
+ ]
+ },
+ "requestId": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9_-]{8,64}$",
+ "description": "Client-chosen identifier of one media connection. Reusing it replaces that media connection.",
+ "example": "conn_0123456789"
+ },
+ "operation": {
+ "type": "string",
+ "enum": [
+ "toggle"
+ ]
+ },
+ "enabled": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "type",
+ "requestId",
+ "operation",
+ "enabled"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "waiting_room_control"
+ ]
+ },
+ "requestId": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9_-]{8,64}$",
+ "description": "Client-chosen identifier of one media connection. Reusing it replaces that media connection.",
+ "example": "conn_0123456789"
+ },
+ "operation": {
+ "type": "string",
+ "enum": [
+ "admit"
+ ]
+ },
+ "participantId": {
+ "type": "string",
+ "pattern": "^[1-9][0-9]{0,18}$"
+ }
+ },
+ "required": [
+ "type",
+ "requestId",
+ "operation",
+ "participantId"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "waiting_room_control"
+ ]
+ },
+ "requestId": {
+ "type": "string",
+ "pattern": "^[A-Za-z0-9_-]{8,64}$",
+ "description": "Client-chosen identifier of one media connection. Reusing it replaces that media connection.",
+ "example": "conn_0123456789"
+ },
+ "operation": {
+ "type": "string",
+ "enum": [
+ "deny"
+ ]
+ },
+ "participantId": {
+ "type": "string",
+ "pattern": "^[1-9][0-9]{0,18}$"
+ }
+ },
+ "required": [
+ "type",
+ "requestId",
+ "operation",
+ "participantId"
+ ],
+ "additionalProperties": false
+ }
+ ]
+ }
+ },
+ "required": [
+ "connectionId",
+ "control"
+ ],
+ "additionalProperties": false
+ },
"VoipAddParticipantRequest": {
"type": "object",
"properties": {
@@ -15478,7 +15670,7 @@
"connectionId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,64}$",
- "description": "Client-chosen identifier of one media connection. Reusing it replaces that connection.",
+ "description": "Client-chosen identifier of one media connection. Reusing it replaces that media connection.",
"example": "conn_0123456789"
},
"participant": {
@@ -15595,14 +15787,14 @@
"type": "integer",
"minimum": 0,
"maximum": 2147483647,
- "description": "Packets lost since the connection started.",
+ "description": "Packets lost since the method started.",
"example": 12
},
"packetsReceived": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647,
- "description": "Packets received since the connection started.",
+ "description": "Packets received since the method started.",
"example": 4810
},
"audioCodec": {
@@ -15631,7 +15823,7 @@
"type": "integer",
"minimum": 0,
"maximum": 1000,
- "description": "Times this connection reconnected so far.",
+ "description": "Times this method reconnected so far.",
"example": 0
}
},
@@ -15651,7 +15843,7 @@
"connectionId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,64}$",
- "description": "Client-chosen identifier of one media connection. Reusing it replaces that connection.",
+ "description": "Client-chosen identifier of one media connection. Reusing it replaces that media connection.",
"example": "conn_0123456789"
},
"participant": {
@@ -15686,7 +15878,7 @@
"connectionId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,64}$",
- "description": "Client-chosen identifier of one media connection. Reusing it replaces that connection.",
+ "description": "Client-chosen identifier of one media connection. Reusing it replaces that media connection.",
"example": "conn_0123456789"
},
"participant": {
@@ -16823,7 +17015,7 @@
"properties": {
"wabaId": {
"type": "string",
- "description": "WhatsApp Business Account of the Number's Official API connection."
+ "description": "WhatsApp Business Account of the Connection's Official API connection."
},
"onboarding": {
"type": "object",
@@ -20202,10 +20394,10 @@
"data"
]
},
- "SessionSafeMode": {
+ "ConnectionSafeMode": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
"projectId": {
@@ -20413,7 +20605,7 @@
}
},
"required": [
- "session",
+ "connection",
"projectId",
"project",
"override",
@@ -20424,7 +20616,7 @@
"entitlementReason"
]
},
- "GetSessionSafeModeResponse": {
+ "GetConnectionSafeModeResponse": {
"type": "object",
"properties": {
"success": {
@@ -20434,7 +20626,7 @@
]
},
"data": {
- "$ref": "#/components/schemas/SessionSafeMode"
+ "$ref": "#/components/schemas/ConnectionSafeMode"
}
},
"required": [
@@ -20442,7 +20634,7 @@
"data"
]
},
- "UpdateSessionSafeModeResponse": {
+ "UpdateConnectionSafeModeResponse": {
"type": "object",
"properties": {
"success": {
@@ -20452,7 +20644,7 @@
]
},
"data": {
- "$ref": "#/components/schemas/SessionSafeMode"
+ "$ref": "#/components/schemas/ConnectionSafeMode"
}
},
"required": [
@@ -20587,7 +20779,7 @@
"minimum": 0,
"maximum": 100
},
- "sessionAction": {
+ "connectionAction": {
"type": "string",
"enum": [
"none",
@@ -20629,7 +20821,7 @@
"version",
"enabled",
"threshold",
- "sessionAction",
+ "connectionAction",
"slowDownMps",
"emailNotification",
"webhookNotification",
@@ -20687,7 +20879,7 @@
"minimum": 0,
"maximum": 100
},
- "sessionAction": {
+ "connectionAction": {
"type": "string",
"enum": [
"none",
@@ -20713,7 +20905,7 @@
"version",
"enabled",
"threshold",
- "sessionAction",
+ "connectionAction",
"slowDownMps",
"emailNotification",
"webhookNotification"
@@ -20843,10 +21035,10 @@
"data"
]
},
- "SessionObservationPolicy": {
+ "ConnectionObservationPolicy": {
"type": "object",
"properties": {
- "sessionName": {
+ "connectionName": {
"type": "string"
},
"projectId": {
@@ -20991,14 +21183,14 @@
}
},
"required": [
- "sessionName",
+ "connectionName",
"projectId",
"project",
"override",
"effective"
]
},
- "GetSessionObservationPolicyResponse": {
+ "GetConnectionObservationPolicyResponse": {
"type": "object",
"properties": {
"success": {
@@ -21008,7 +21200,7 @@
]
},
"data": {
- "$ref": "#/components/schemas/SessionObservationPolicy"
+ "$ref": "#/components/schemas/ConnectionObservationPolicy"
}
},
"required": [
@@ -21040,7 +21232,7 @@
"x-enumDescriptions": {
"android": "WhatsApp or WhatsApp Business on an Android phone.",
"ios": "WhatsApp or WhatsApp Business on an iPhone.",
- "meta_cloud": "Meta hosts the number through Cloud API.",
+ "meta_cloud": "Meta hosts the connection through Cloud API.",
"unknown": "The phone has not reported a recognized platform."
}
},
@@ -21502,7 +21694,7 @@
"tenantId": {
"type": "string"
},
- "session": {
+ "connection": {
"type": "string"
},
"url": {
@@ -21595,7 +21787,7 @@
"CreateWebhookRequest": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
"url": {
@@ -21634,7 +21826,7 @@
"type": "integer",
"minimum": 7,
"maximum": 13,
- "description": "First day without the phone on which this webhook receives session.phone_offline. New webhooks default to 10; on update, omission keeps the stored value. WhatsApp signs the linked device out on day 14. To stop the warning, remove session.phone_offline from events."
+ "description": "First day without the phone on which this webhook receives connection.phone_offline. New webhooks default to 10; on update, omission keeps the stored value. WhatsApp signs the linked device out on day 14. To stop the warning, remove connection.phone_offline from events."
}
},
"required": [
@@ -21718,7 +21910,7 @@
"type": "integer",
"minimum": 7,
"maximum": 13,
- "description": "First day without the phone on which this webhook receives session.phone_offline. New webhooks default to 10; on update, omission keeps the stored value. WhatsApp signs the linked device out on day 14. To stop the warning, remove session.phone_offline from events."
+ "description": "First day without the phone on which this webhook receives connection.phone_offline. New webhooks default to 10; on update, omission keeps the stored value. WhatsApp signs the linked device out on day 14. To stop the warning, remove connection.phone_offline from events."
}
}
},
@@ -21978,7 +22170,7 @@
"id": {
"type": "string"
},
- "session": {
+ "connection": {
"type": "string"
},
"messageId": {
@@ -22000,7 +22192,7 @@
},
"required": [
"id",
- "session",
+ "connection",
"messageId",
"mimeType",
"fileLength",
@@ -22034,7 +22226,7 @@
"tenantId": {
"type": "string"
},
- "session": {
+ "connection": {
"type": "string"
},
"wabaId": {
@@ -22092,7 +22284,7 @@
"required": [
"id",
"tenantId",
- "session",
+ "connection",
"wabaId",
"name",
"language",
@@ -22667,9 +22859,9 @@
"TemplateSubmission": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string",
- "description": "Number the template was submitted for."
+ "description": "Connection the template was submitted for."
},
"status": {
"type": "string",
@@ -22677,11 +22869,11 @@
"PENDING",
"APPROVED"
],
- "description": "PENDING: sent to Meta for review. APPROVED: the number sends this template without Meta review."
+ "description": "PENDING: sent to Meta for review. APPROVED: the connection sends this template without Meta review."
},
"autoApproved": {
"type": "boolean",
- "description": "True when the number does not need Meta approval (any number that is not a Cloud API number). Nothing was sent to Meta."
+ "description": "True when the connection does not need Meta approval (any connection that is not a Cloud API connection). Nothing was sent to Meta."
},
"metaTemplateId": {
"type": "string",
@@ -22690,7 +22882,7 @@
}
},
"required": [
- "session",
+ "connection",
"status",
"autoApproved",
"metaTemplateId"
@@ -22732,13 +22924,13 @@
"SubmitMessageTemplateRequest": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string",
"minLength": 1
}
},
"required": [
- "session"
+ "connection"
]
},
"CampaignMessageVariationBlueprint": {
@@ -23041,7 +23233,7 @@
},
"exitOnReply": {
"type": "boolean",
- "description": "When true, a contact who replies to the sending number gets no further steps."
+ "description": "When true, a contact who replies to the sending connection gets no further steps."
},
"exitOnLinkClick": {
"type": "boolean",
@@ -23250,7 +23442,7 @@
"message"
],
"additionalProperties": false,
- "description": "One optional follow-up, sent from the Number that sent the first message. Null when the campaign has none. Content and timing freeze at launch."
+ "description": "One optional follow-up, sent from the Connection that sent the first message. Null when the campaign has none. Content and timing freeze at launch."
},
"sendWindow": {
"$ref": "#/components/schemas/CampaignSendWindow"
@@ -24002,7 +24194,7 @@
"exitOnReply": {
"type": "boolean",
"default": true,
- "description": "When true, a contact who replies to the sending number gets no further steps."
+ "description": "When true, a contact who replies to the sending connection gets no further steps."
},
"exitOnLinkClick": {
"type": "boolean",
@@ -24054,7 +24246,7 @@
"templateId": {
"type": "string",
"format": "uuid",
- "description": "Template in this project to send instead of composed messages. On Cloud API numbers it must be approved by WhatsApp on every number the campaign can send from before launch."
+ "description": "Template in this project to send instead of composed messages. On Cloud API connections it must be approved by WhatsApp on every connection the campaign can send from before launch."
},
"variableMapping": {
"$ref": "#/components/schemas/CampaignVariableMapping"
@@ -24080,7 +24272,7 @@
},
"minItems": 2,
"maxItems": 5,
- "description": "Two to five message alternatives for linked-device numbers. Each recipient receives one, chosen by weight, and keeps it across retries. Cannot be combined with composed messages, a template or an A/B test. A beta; a team that is not enrolled gets `403 feature_unavailable`."
+ "description": "Two to five message alternatives for linked-device connections. Each recipient receives one, chosen by weight, and keeps it across retries. Cannot be combined with composed messages, a template or an A/B test. A beta; a team that is not enrolled gets `403 feature_unavailable`."
},
"recipientListId": {
"type": "string"
@@ -24110,7 +24302,7 @@
"$ref": "#/components/schemas/CampaignTrackedLink"
},
"maxItems": 5,
- "description": "Beta. Links to track, at most 5. Each message reference `{{link:}}` is replaced with a short link per recipient that redirects to `url`. Only campaigns sent from linked-device numbers track links. Setting links requires the campaign link tracking beta (`403 feature_unavailable` otherwise); `null` or `[]` removes them."
+ "description": "Beta. Links to track, at most 5. Each message reference `{{link:}}` is replaced with a short link per recipient that redirects to `url`. Only campaigns sent from linked-device connections track links. Setting links requires the campaign link tracking beta (`403 feature_unavailable` otherwise); `null` or `[]` removes them."
},
"frequencyCap": {
"allOf": [
@@ -24235,7 +24427,7 @@
},
"exitOnReply": {
"type": "boolean",
- "description": "When true, a contact who replies to the sending number gets no further steps."
+ "description": "When true, a contact who replies to the sending connection gets no further steps."
},
"exitOnLinkClick": {
"type": "boolean",
@@ -24371,7 +24563,7 @@
"$ref": "#/components/schemas/CampaignTrackedLink"
},
"maxItems": 5,
- "description": "Beta. Links to track, at most 5. Each message reference `{{link:}}` is replaced with a short link per recipient that redirects to `url`. Only campaigns sent from linked-device numbers track links. Setting links requires the campaign link tracking beta (`403 feature_unavailable` otherwise); `null` or `[]` removes them. Only a draft, including one waiting for its scheduled start, can change them; a launched campaign must still define every link its messages reference."
+ "description": "Beta. Links to track, at most 5. Each message reference `{{link:}}` is replaced with a short link per recipient that redirects to `url`. Only campaigns sent from linked-device connections track links. Setting links requires the campaign link tracking beta (`403 feature_unavailable` otherwise); `null` or `[]` removes them. Only a draft, including one waiting for its scheduled start, can change them; a launched campaign must still define every link its messages reference."
},
"templateId": {
"type": "string",
@@ -24575,7 +24767,7 @@
"from": {
"type": "object",
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -24584,10 +24776,10 @@
}
},
"required": [
- "sessionId",
+ "connectionId",
"phone"
],
- "description": "The number the test was sent from."
+ "description": "The connection the test was sent from."
},
"to": {
"type": "string",
@@ -24642,16 +24834,16 @@
"CampaignTestSendRequest": {
"type": "object",
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid",
- "description": "The number to send the test from. It must be connected, on a plan that includes Campaigns, and, when the campaign selects numbers, one of them."
+ "description": "The connection to send the test from. It must be connected, on a plan that includes Campaigns, and, when the campaign selects connections, one of them."
},
"to": {
"type": "string",
"minLength": 1,
"maxLength": 32,
- "description": "The seed recipient in international format. It must be the phone of a number connected to your team.",
+ "description": "The seed recipient in international format. It must be the phone of a connection connected to your team.",
"example": "+5511999990000"
},
"sampleRecipientId": {
@@ -24680,7 +24872,7 @@
}
},
"required": [
- "sessionId",
+ "connectionId",
"to"
]
},
@@ -24921,7 +25113,7 @@
"screen"
],
"additionalProperties": false,
- "description": "A published WhatsApp Flow form. Official numbers only."
+ "description": "A published WhatsApp Flow form. Official connections only."
}
]
},
@@ -25247,7 +25439,7 @@
"cold_held",
"campaign_cancelled",
"invalid_recipient",
- "session_not_connected",
+ "connection_not_connected",
"ack_timeout",
"blocked_by_safety",
"send_failed",
@@ -25256,7 +25448,7 @@
"other",
null
],
- "description": "Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the number is on the team's opt-out list. `cold_held`: the number never wrote to the sending number and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the number is not a valid WhatsApp address. `session_not_connected`: the sending number was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `frequency_cap`: the recipient reached the team's or campaign's rolling contact frequency cap. `other`: any other reason. New codes may be added."
+ "description": "Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the phone number is on the team's opt-out list. `cold_held`: the recipient never wrote to the sending connection and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the recipient is not a valid WhatsApp address. `connection_not_connected`: the sending connection was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `frequency_cap`: the recipient reached the team's or campaign's rolling contact frequency cap. `other`: any other reason. New codes may be added."
},
"externalMessageId": {
"type": "string",
@@ -25308,7 +25500,7 @@
"type": "string",
"format": "uuid"
},
- "numberId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -25377,7 +25569,7 @@
},
"required": [
"id",
- "numberId",
+ "connectionId",
"status",
"anchorKind",
"firstDeliveredAt",
@@ -25560,7 +25752,7 @@
"type": "string",
"enum": [
"initial",
- "add_connection",
+ "add_method",
"reauthorization"
]
},
@@ -25571,7 +25763,7 @@
"hybrid"
]
},
- "addConnection": {
+ "addMethod": {
"type": "string",
"enum": [
"linked_devices",
@@ -25584,11 +25776,11 @@
},
"url": {
"type": "string",
- "description": "Hosted connection URL. Share it only with the person holding the phone."
+ "description": "Hosted method URL. Share it only with the person holding the phone."
},
- "session": {
+ "connection": {
"type": "string",
- "description": "Session name that receives the connected number."
+ "description": "Connection name that receives the connected connection."
},
"expiresAt": {
"type": "string",
@@ -25601,7 +25793,7 @@
"connectionGoal",
"id",
"url",
- "session",
+ "connection",
"expiresAt"
]
},
@@ -25672,7 +25864,7 @@
"android",
"ios"
],
- "description": "Primary phone platform the Test number emulates. Defaults to `android`. Not accepted when `accountType` is `meta_cloud`.",
+ "description": "Primary phone platform the Test connection emulates. Defaults to `android`. Not accepted when `accountType` is `meta_cloud`.",
"x-enumDescriptions": {
"android": "An Android phone.",
"ios": "An iPhone."
@@ -25748,7 +25940,7 @@
},
"minItems": 1,
"maxItems": 2,
- "description": "Linked Devices methods offered for this connection."
+ "description": "Linked Devices methods offered for this method."
},
"defaultMethod": {
"type": "string",
@@ -25909,15 +26101,15 @@
"standard",
"zero_knowledge"
],
- "description": "Signal key custody for a new Number. Inherits Customer then Project default; cannot change an existing Number. Customer-owned custody requires beta admission and real Linked Devices."
+ "description": "Signal key custody for a new Connection. Inherits Customer then Project default; cannot change an existing Connection. Customer-owned custody requires beta admission and real Linked Devices."
},
"purpose": {
"type": "string",
"enum": [
"initial",
- "add_connection"
+ "add_method"
],
- "description": "Initial setup, or add a transport to an existing session without replacing the Number."
+ "description": "Initial setup, or add a method to an existing Connection without replacing the Connection."
},
"connectionGoal": {
"type": "string",
@@ -25926,13 +26118,13 @@
"hybrid"
]
},
- "session": {
+ "connection": {
"type": "string",
"minLength": 1,
"maxLength": 128,
- "description": "Existing session name. Required only for add_connection."
+ "description": "Existing connection name. Required only for add_method."
},
- "addConnection": {
+ "addMethod": {
"type": "string",
"enum": [
"linked_devices",
@@ -25942,12 +26134,12 @@
"projectId": {
"type": "string",
"format": "uuid",
- "description": "Project that receives the connected number. Required for team keys with more than one project."
+ "description": "Project that receives the connected connection. Required for team keys with more than one project."
},
"customerId": {
"type": "string",
"format": "uuid",
- "description": "Customer that owns the connected number when Customers is enabled for the project."
+ "description": "Customer that owns the connected connection when Customers is enabled for the project."
},
"billingControls": {
"type": "object",
@@ -25969,14 +26161,14 @@
"priority"
],
"additionalProperties": false,
- "description": "Initial monthly spending limit and funding priority for a real Number. Requires a team key with billing:manage or a live team owner/admin on Pay-As-You-Go. Applied atomically before pairing admission."
+ "description": "Initial monthly spending limit and funding priority for a real Connection. Requires a team key with billing:manage or a live team owner/admin on Pay-As-You-Go. Applied atomically before pairing admission."
},
"externalId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[^\\x00-\\x1f\\x7f]+$",
- "description": "Integrator correlation copied to the resulting session. May repeat across invitations; does not grant access."
+ "description": "Integrator correlation copied to the resulting connection. May repeat across invitations; does not grant access."
},
"configuration": {
"$ref": "#/components/schemas/QuickLinkConfiguration"
@@ -26003,7 +26195,7 @@
"allowed": {
"type": "boolean"
},
- "addConnection": {
+ "addMethod": {
"type": "string",
"nullable": true,
"enum": [
@@ -26012,7 +26204,7 @@
null
]
},
- "connections": {
+ "methods": {
"type": "array",
"items": {
"type": "object",
@@ -26042,8 +26234,8 @@
"required": [
"resumeQuickLinkId",
"allowed",
- "addConnection",
- "connections"
+ "addMethod",
+ "methods"
]
}
},
@@ -26133,7 +26325,7 @@
"type": "string",
"enum": [
"initial",
- "add_connection",
+ "add_method",
"reauthorization"
]
},
@@ -26144,7 +26336,7 @@
"hybrid"
]
},
- "addConnection": {
+ "addMethod": {
"type": "string",
"enum": [
"linked_devices",
@@ -26161,9 +26353,9 @@
"failed",
"cancelled"
],
- "description": "`linked`: for Linked Devices, the device is linked and the recipient has not confirmed; for Meta Cloud API, the number is connected to Meta and is still being made ready to send. For Meta Cloud API, `connected` requires every readiness check to pass, a successful runtime connection, and the recipient's confirmation. `failed` carries the reason in `errorCode`."
+ "description": "`linked`: for Linked Devices, the device is linked and the recipient has not confirmed; for Meta Cloud API, the connection is connected to Meta and is still being made ready to send. For Meta Cloud API, `connected` requires every readiness check to pass, a successful runtime method, and the recipient's confirmation. `failed` carries the reason in `errorCode`."
},
- "session": {
+ "connection": {
"type": "string"
},
"expiresAt": {
@@ -26205,7 +26397,7 @@
"stage": {
"type": "string"
},
- "connection": {
+ "method": {
"type": "string",
"nullable": true
},
@@ -26234,7 +26426,7 @@
},
"required": [
"stage",
- "connection",
+ "method",
"coexistence",
"contactsSync",
"historySync",
@@ -26242,7 +26434,7 @@
"errorCode",
"sync"
],
- "description": "Durable connection and sync progress; omitted when the onboarding service is unavailable, null when no record exists. Sync request and delivery evidence are independent of the connection stage."
+ "description": "Durable method and sync progress; omitted when the onboarding service is unavailable, null when no record exists. Sync request and delivery evidence are independent of the method stage."
}
},
"required": [
@@ -26250,7 +26442,7 @@
"purpose",
"connectionGoal",
"status",
- "session",
+ "connection",
"expiresAt",
"openedAt",
"connectedAt",
@@ -26288,7 +26480,7 @@
"action_required",
"unknown"
],
- "description": "`healthy`: every check passed. `action_required`: a check failed and the Number needs reauthorization or a change in Meta. `unknown`: Meta could not be reached or returned an incomplete answer; the check is retried. `pending`: not checked since the credentials were saved."
+ "description": "`healthy`: every check passed. `action_required`: a check failed and the Connection needs reauthorization or a change in Meta. `unknown`: Meta could not be reached or returned an incomplete answer; the check is retried. `pending`: not checked since the credentials were saved."
},
"checkedAt": {
"type": "string",
@@ -26412,16 +26604,16 @@
},
"url": {
"type": "string",
- "description": "Hosted link. Share it only with the person who manages the Number's Meta assets."
+ "description": "Hosted link. Share it only with the person who manages the Connection's Meta assets."
},
- "session": {
+ "connection": {
"type": "string"
}
},
"required": [
"quicklinkId",
"url",
- "session"
+ "connection"
]
},
"CloudReauthorizationResponse": {
@@ -26599,7 +26791,7 @@
"android",
"ios"
],
- "description": "Primary phone platform the Test number emulates. Defaults to `android`. Not accepted when `accountType` is `meta_cloud`.",
+ "description": "Primary phone platform the Test connection emulates. Defaults to `android`. Not accepted when `accountType` is `meta_cloud`.",
"x-enumDescriptions": {
"android": "An Android phone.",
"ios": "An iPhone."
@@ -26709,7 +26901,7 @@
"type": "string",
"enum": [
"initial",
- "add_connection",
+ "add_method",
"reauthorization"
]
},
@@ -26720,7 +26912,7 @@
"hybrid"
]
},
- "addConnection": {
+ "addMethod": {
"type": "string",
"nullable": true,
"enum": [
@@ -26750,7 +26942,7 @@
"format": "uri",
"description": "Snapshotted failure callback for a failed link. Omitted for non-failed states."
},
- "connections": {
+ "connectionChoices": {
"type": "array",
"items": {
"type": "string",
@@ -26807,7 +26999,7 @@
"stage": {
"type": "string"
},
- "connection": {
+ "method": {
"type": "string",
"nullable": true
},
@@ -26836,7 +27028,7 @@
},
"required": [
"stage",
- "connection",
+ "method",
"coexistence",
"contactsSync",
"historySync",
@@ -26941,18 +27133,18 @@
"allowChange": {
"type": "boolean"
},
- "noNumber": {
+ "noConnection": {
"type": "boolean"
},
- "allowNoNumber": {
+ "allowNoConnection": {
"type": "boolean"
}
},
"required": [
"confirmed",
"allowChange",
- "noNumber",
- "allowNoNumber"
+ "noConnection",
+ "allowNoConnection"
]
},
"prefillPhone": {
@@ -27007,9 +27199,9 @@
},
"customer": {
"type": "boolean",
- "description": "True when the link assigns the number to a Customer."
+ "description": "True when the link assigns the connection to a Customer."
},
- "session": {
+ "connection": {
"type": "object",
"properties": {
"status": {
@@ -27028,7 +27220,7 @@
"qrSvg": {
"type": "string",
"nullable": true,
- "description": "Inline SVG of the current WhatsApp QR code, when the QR method is offered and the number is not linked yet."
+ "description": "Inline SVG of the current WhatsApp QR code, when the QR method is offered and the connection is not linked yet."
},
"passkeyAvailable": {
"type": "boolean",
@@ -27123,10 +27315,10 @@
"status",
"purpose",
"connectionGoal",
- "addConnection",
+ "addMethod",
"hybridPhase",
"expiresAt",
- "connections",
+ "connectionChoices",
"selectedConnection",
"connectionPreference",
"connectionEnforcement",
@@ -27152,7 +27344,7 @@
"prefillPhone",
"phoneIdentity",
"customer",
- "session",
+ "connection",
"qrSvg",
"errorCode"
]
@@ -27283,8 +27475,8 @@
"call.received",
"call.missed",
"call.ended",
- "session.status",
- "session.restriction_updated",
+ "connection.status",
+ "connection.restriction_updated",
"template.status"
]
},
@@ -27322,12 +27514,12 @@
"call.received",
"call.missed",
"call.ended",
- "session.status",
- "session.restriction_updated",
+ "connection.status",
+ "connection.restriction_updated",
"template.status"
]
},
- "session": {
+ "connection": {
"type": "string"
},
"delivery": {
@@ -27352,7 +27544,7 @@
},
"required": [
"event",
- "session",
+ "connection",
"delivery",
"eventId",
"source"
@@ -27407,7 +27599,7 @@
"type": "string",
"enum": [
"invalid_recipient",
- "session_not_connected",
+ "connection_not_connected",
"ack_timeout",
"send_failed",
"blocked_by_safety"
@@ -27486,8 +27678,8 @@
"call.received",
"call.missed",
"call.ended",
- "session.status",
- "session.restriction_updated",
+ "connection.status",
+ "connection.restriction_updated",
"template.status"
],
"description": "Fixture name. Each name is the event type it produces."
@@ -27495,11 +27687,11 @@
"overrides": {
"$ref": "#/components/schemas/TestEventOverrides"
},
- "fromNumber": {
+ "fromConnection": {
"type": "string",
"minLength": 1,
"maxLength": 128,
- "description": "message.received only. Send a simulated text message from this other connected Test number in the same project instead of generating an event."
+ "description": "message.received only. Send a simulated text message from this other connected Test connection in the same project instead of generating an event."
}
},
"required": [
@@ -27510,7 +27702,7 @@
"TestingPhoneState": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
"phone": {
@@ -27534,11 +27726,11 @@
"deviceId"
]
},
- "description": "Companions linked to the phone, such as Polymorfa's own session and Inspector."
+ "description": "Companions linked to the phone, such as Polymorfa's own connection and Inspector."
}
},
"required": [
- "session",
+ "connection",
"phone",
"online",
"devices"
@@ -27547,7 +27739,7 @@
"TestingPhoneMessage": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
"to": {
@@ -27559,7 +27751,7 @@
}
},
"required": [
- "session",
+ "connection",
"to",
"messageId"
]
@@ -27570,7 +27762,7 @@
"to": {
"type": "string",
"pattern": "^\\+[1-9]\\d{7,14}$",
- "description": "Another Test number in the same project, in E.164 format."
+ "description": "The phone number of another Test connection in the same project, in E.164 format."
},
"text": {
"type": "string",
@@ -27587,7 +27779,7 @@
"TestingPhoneUnlink": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
"deviceId": {
@@ -27601,7 +27793,7 @@
}
},
"required": [
- "session",
+ "connection",
"deviceId",
"unlinked"
]
@@ -27609,7 +27801,7 @@
"TestingAccountMode": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
"accountType": {
@@ -27644,18 +27836,18 @@
},
"changed": {
"type": "boolean",
- "description": "False when the Test number already used this mode. Nothing was unlinked."
+ "description": "False when the Test connection already used this mode. Nothing was unlinked."
},
"unlinkedDevices": {
"type": "array",
"items": {
"type": "integer"
},
- "description": "Companions the phone unlinked. Each must pair again, including Polymorfa's own session."
+ "description": "Companions the phone unlinked. Each must pair again, including Polymorfa's own connection."
}
},
"required": [
- "session",
+ "connection",
"accountType",
"primaryPlatform",
"changed",
@@ -27687,7 +27879,7 @@
"android",
"ios"
],
- "description": "Primary phone platform the Test number emulates. Defaults to `android`. Not accepted when `accountType` is `meta_cloud`.",
+ "description": "Primary phone platform the Test connection emulates. Defaults to `android`. Not accepted when `accountType` is `meta_cloud`.",
"x-enumDescriptions": {
"android": "An Android phone.",
"ios": "An iPhone."
@@ -27727,7 +27919,7 @@
"BearerAuth": {
"type": "http",
"scheme": "bearer",
- "description": "Polymorfa team key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Team keys and project tokens may be personal or service-account owned and enforce selected action scopes. Team keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules and immutable mint-time action ceiling. Treat all credentials as opaque strings. Never parse them or assume a fixed length; store at least 512 characters. Server keys use issuance-record lookup; short-lived client tokens carry a signed permission ceiling."
+ "description": "Polymorfa team key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Team keys and project tokens may be personal or service-account owned and enforce selected action scopes. Team keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and connection and enforce their client rules and immutable mint-time action ceiling. Treat all credentials as opaque strings. Never parse them or assume a fixed length; store at least 512 characters. Server keys use issuance-record lookup; short-lived client tokens carry a signed permission ceiling."
}
}
},
@@ -27994,9 +28186,6 @@
}
}
},
- "x-mint": {
- "content": "bridge:connect "
- },
"description": "**Required scope:** `bridge:connect`"
}
},
@@ -28085,7 +28274,7 @@
"ticket": {
"type": "string"
},
- "session": {
+ "connection": {
"type": "string"
},
"teamId": {
@@ -28138,7 +28327,7 @@
"phoneMasked": {
"type": "string",
"nullable": true,
- "description": "The number being linked with only the country code and last four digits visible, for example `+55 •• ••••• 4321`. Null when the pairing link has not collected a number."
+ "description": "The phone number being linked with only the country code and last four digits visible, for example `+55 •• ••••• 4321`. Null when the pairing link has not collected a phone number."
}
},
"required": [
@@ -28152,7 +28341,7 @@
"allowCredentials",
"version",
"ticket",
- "session",
+ "connection",
"teamId",
"projectId",
"attemptId",
@@ -28755,20 +28944,20 @@
}
}
},
- "/messaging/{session}/passkey/challenge": {
+ "/messaging/{connection}/passkey/challenge": {
"post": {
"operationId": "issuePasskeyChallenge",
"tags": [
"Passkey"
],
- "summary": "Issue a single-use WebAuthn challenge ticket for a session",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:manage`\n\nYour team must have direct-pairing access for the target Number. Use [QuickLink](/numbers/quicklink) for standard connections. Binds a WhatsApp-originated passkey challenge to one session with a short TTL. The extension runs the ceremony and the assertion comes back to the redeem endpoint.",
+ "summary": "Issue a single-use WebAuthn challenge ticket for a connection",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:manage`\n\nYour team must have direct-pairing access for the target Connection. Use [QuickLink](/connections/quicklink) for standard methods. Binds a WhatsApp-originated passkey challenge to one connection with a short TTL. The extension runs the ceremony and the assertion comes back to the redeem endpoint.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -28776,7 +28965,7 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -28940,7 +29129,7 @@
}
},
"409": {
- "description": "No passkey challenge pending for this session",
+ "description": "No passkey challenge pending for this connection",
"content": {
"application/json": {
"schema": {
@@ -29164,28 +29353,25 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/passkey/challenge/{ticketId}": {
+ "/messaging/{connection}/passkey/challenge/{ticketId}": {
"get": {
"operationId": "getPasskeyChallenge",
"tags": [
"Passkey"
],
"summary": "Read a live passkey challenge ticket",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:manage`\n\nYour team must have direct-pairing access for the target Number. Returns the ceremony options for a ticket that has not expired and has not been redeemed.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:manage`\n\nYour team must have direct-pairing access for the target Connection. Returns the ceremony options for a ticket that has not expired and has not been redeemed.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -29193,7 +29379,7 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -29357,7 +29543,7 @@
}
},
"409": {
- "description": "No passkey challenge pending for this session",
+ "description": "No passkey challenge pending for this connection",
"content": {
"application/json": {
"schema": {
@@ -29549,28 +29735,25 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/passkey/assertion": {
+ "/messaging/{connection}/passkey/assertion": {
"post": {
"operationId": "submitPasskeyAssertion",
"tags": [
"Passkey"
],
"summary": "Redeem a passkey ticket with the ceremony assertion",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:manage`\n\nThe complete HTTP body is limited to 1048576 UTF-8 bytes before JSON parsing. Credential IDs allow at most 1023 decoded bytes; user handles allow 64. Opaque assertion fields share the body budget without independent small caps. Your team must have direct-pairing access for the target Number. Single-use: verifies the assertion is bound to the ticket challenge, forwards it to the session runner, and consumes the ticket once acknowledged.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:manage`\n\nThe complete HTTP body is limited to 1048576 UTF-8 bytes before JSON parsing. Credential IDs allow at most 1023 decoded bytes; user handles allow 64. Opaque assertion fields share the body budget without independent small caps. Your team must have direct-pairing access for the target Connection. Single-use: verifies the assertion is bound to the ticket challenge, forwards it to the connection runner, and consumes the ticket once acknowledged.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -29578,7 +29761,7 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -29742,7 +29925,7 @@
}
},
"409": {
- "description": "No passkey challenge pending for this session",
+ "description": "No passkey challenge pending for this connection",
"content": {
"application/json": {
"schema": {
@@ -29966,15 +30149,12 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/passkey/confirmation": {
+ "/messaging/{connection}/passkey/confirmation": {
"post": {
"operationId": "confirmPasskey",
"tags": [
@@ -29986,8 +30166,8 @@
"BearerAuth": []
}
],
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:manage`\n\nConfirm only after comparing the displayed code with the phone. Omit code only when the current runner reports skipHandoffUX. An accepted confirmation still waits for pairing completion.",
- "x-required-scope": "sessions:manage",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:manage`\n\nConfirm only after comparing the displayed code with the phone. Omit code only when the current runner reports skipHandoffUX. An accepted confirmation still waits for pairing completion.",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -29995,7 +30175,7 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -30174,7 +30354,7 @@
}
},
"409": {
- "description": "No passkey challenge pending for this session",
+ "description": "No passkey challenge pending for this connection",
"content": {
"application/json": {
"schema": {
@@ -30398,9 +30578,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:manage "
- },
"x-protocols": [
"Linked Device API"
]
@@ -30410,14 +30587,14 @@
"tags": [
"Passkey"
],
- "summary": "Read the passkey round-trip state for a session",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:manage`\n\nYour team must have direct-pairing access for the target Number. Reports where the ceremony stands: no round-trip, challenge pending, assertion submitted, code available for comparison, confirmation sending, waiting for pairing, completed, or failed.",
+ "summary": "Read the passkey round-trip state for a connection",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:manage`\n\nYour team must have direct-pairing access for the target Connection. Reports where the ceremony stands: no round-trip, challenge pending, assertion submitted, code available for comparison, confirmation sending, waiting for pairing, completed, or failed.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -30425,7 +30602,7 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -30580,7 +30757,7 @@
}
},
"409": {
- "description": "No passkey challenge pending for this session",
+ "description": "No passkey challenge pending for this connection",
"content": {
"application/json": {
"schema": {
@@ -30772,35 +30949,32 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/pair/qr": {
+ "/messaging/{connection}/pair/qr": {
"get": {
"operationId": "getQRCode",
"tags": [
"Pairing"
],
"summary": "Get QR code for device pairing",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:manage`\n\nDirect-pairing access must be enabled for the team that owns this Number. Use [QuickLink](/numbers/quicklink) when direct pairing is unavailable. Requests without access return 403.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:manage`\n\nDirect-pairing access must be enabled for the team that owns this Connection. Use [QuickLink](/connections/quicklink) when direct pairing is unavailable. Requests without access return 403.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -30910,7 +31084,7 @@
}
},
"403": {
- "description": "Direct-pairing access is required for this Number. Use QuickLink when it is unavailable.",
+ "description": "Direct-pairing access is required for this Connection. Use QuickLink when it is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -31006,35 +31180,32 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/pair/code": {
+ "/messaging/{connection}/pair/code": {
"post": {
"operationId": "requestPairCode",
"tags": [
"Pairing"
],
"summary": "Request a pairing code for a phone number",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:manage`\n\nDirect-pairing access must be enabled for the team that owns this Number. Use [QuickLink](/numbers/quicklink) when direct pairing is unavailable. Requests without access return 403.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:manage`\n\nDirect-pairing access must be enabled for the team that owns this Connection. Use [QuickLink](/connections/quicklink) when direct pairing is unavailable. Requests without access return 403.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -31134,7 +31305,7 @@
}
},
"403": {
- "description": "Direct-pairing access is required for this Number. Use QuickLink when it is unavailable.",
+ "description": "Direct-pairing access is required for this Connection. Use QuickLink when it is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -31230,9 +31401,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:manage "
- },
"x-protocols": [
"Linked Device API"
]
@@ -31244,13 +31412,13 @@
"tags": [
"Messages"
],
- "summary": "Read a team, project or Number routing policy",
+ "summary": "Read a team, project or Connection routing policy",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -31258,7 +31426,7 @@
"enum": [
"team",
"project",
- "session"
+ "connection"
]
},
"required": true,
@@ -31281,7 +31449,7 @@
"maxLength": 256
},
"required": false,
- "name": "session",
+ "name": "connection",
"in": "query"
}
],
@@ -31455,10 +31623,7 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
- "description": "**Required scope:** `sessions:read`"
+ "description": "**Required scope:** `connections:read`"
},
"put": {
"operationId": "setHybridRoutingPolicy",
@@ -31471,7 +31636,7 @@
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -31479,7 +31644,7 @@
"enum": [
"team",
"project",
- "session"
+ "connection"
]
},
"required": true,
@@ -31502,7 +31667,7 @@
"maxLength": 256
},
"required": false,
- "name": "session",
+ "name": "connection",
"in": "query"
}
],
@@ -31685,25 +31850,22 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
- "description": "**Required scope:** `sessions:manage`"
+ "description": "**Required scope:** `connections:manage`"
}
},
- "/messaging/{session}/hybrid-link": {
+ "/messaging/{connection}/hybrid-link": {
"get": {
"operationId": "getHybridLinkState",
"tags": [
- "Sessions"
+ "Connections"
],
- "summary": "Read the Number's Hybrid connection state",
+ "summary": "Read the Connection's Hybrid connection state",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -31711,7 +31873,7 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -31885,18 +32047,15 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:read "
- },
"x-protocols": [
"Linked Device API"
],
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:read`"
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:read`"
},
"put": {
"operationId": "setHybridLinkPaused",
"tags": [
- "Sessions"
+ "Connections"
],
"summary": "Pause or resume Hybrid sending",
"security": [
@@ -31904,7 +32063,7 @@
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -31912,7 +32071,7 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -32109,23 +32268,20 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:manage "
- },
"x-protocols": [
"Linked Device API"
],
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:manage`"
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:manage`"
}
},
- "/messaging/{session}/messages/send": {
+ "/messaging/{connection}/messages/send": {
"post": {
"operationId": "sendMessage",
"tags": [
"Messages"
],
"summary": "Send a message",
- "description": "**Protocols:** Linked Device API · Meta Cloud API · Polymorfa Hybrid Link\n\n**Required scope:** `messages:write`\n\nSend a message to a conversation. Put exactly one message kind inside content. The complete JSON request body is limited to 72 MiB before parsing; decoded media remains limited to 50 MiB. Testing sessions send only to active testing numbers in the same project; supply the recipient phoneNumber.",
+ "description": "**Protocols:** Linked Device API · Meta Cloud API · Polymorfa Hybrid Link\n\n**Required scope:** `messages:write`\n\nSend a message to a conversation. Put exactly one message kind inside content. The complete JSON request body is limited to 72 MiB before parsing; decoded media remains limited to 50 MiB. Testing connections send only to active testing connections in the same project; supply the recipient phoneNumber.",
"security": [
{
"BearerAuth": []
@@ -32138,7 +32294,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -32320,7 +32476,7 @@
}
},
"402": {
- "description": "`billing_credit_required`: credit is unavailable for this number. Add credit or review team billing.",
+ "description": "`billing_credit_required`: credit is unavailable for this connection. Add credit or review team billing.",
"content": {
"application/json": {
"schema": {
@@ -32330,7 +32486,7 @@
"error": {
"type": "billing_error",
"code": "billing_credit_required",
- "message": "Credit is unavailable for this number. Add credit or review team billing.",
+ "message": "Credit is unavailable for this connection. Add credit or review team billing.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -32394,7 +32550,7 @@
}
},
"409": {
- "description": "`unsupported_for_connection`: call permission requests need a Cloud API number; `call_permission_granted`: the person already granted permanent permission. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "description": "`unsupported_for_connection`: call permission requests need a Cloud API connection; `call_permission_granted`: the person already granted permanent permission. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
"content": {
"application/json": {
"schema": {
@@ -32404,7 +32560,7 @@
"error": {
"type": "conflict_error",
"code": "unsupported_for_connection",
- "message": "The session's connection does not support this call operation.",
+ "message": "The connection's connection does not support this call operation.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -32547,7 +32703,7 @@
"error": {
"type": "rate_limit_error",
"code": "call_permission_request_limited",
- "message": "WhatsApp limits how often this number can ask this person for call permission. Follow Retry-After when supplied.",
+ "message": "WhatsApp limits how often this connection can ask this person for call permission. Follow Retry-After when supplied.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -32602,7 +32758,7 @@
}
},
"501": {
- "description": "`operation_not_supported`: the number's connection cannot send this content, such as a poll, or a URL, call or copy-code button on an official WhatsApp Business number",
+ "description": "`operation_not_supported`: the selected method cannot send this content, such as a poll, or a URL, call or copy-code button on an Official API connection",
"content": {
"application/json": {
"schema": {
@@ -32678,7 +32834,7 @@
}
},
"503": {
- "description": "Session or service unavailable. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend",
+ "description": "Connection or service unavailable. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend",
"content": {
"application/json": {
"schema": {
@@ -32773,9 +32929,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API Meta Cloud API Polymorfa Hybrid Link messages:write "
- },
"x-protocols": [
"Linked Device API",
"Meta Cloud API",
@@ -32783,7 +32936,7 @@
]
}
},
- "/messaging/{session}/messages/seen": {
+ "/messaging/{connection}/messages/seen": {
"post": {
"operationId": "sendSeen",
"tags": [
@@ -32802,7 +32955,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -32901,7 +33054,7 @@
}
},
"402": {
- "description": "`billing_credit_required`: credit is unavailable for this number. Add credit or review team billing.",
+ "description": "`billing_credit_required`: credit is unavailable for this connection. Add credit or review team billing.",
"content": {
"application/json": {
"schema": {
@@ -32911,7 +33064,7 @@
"error": {
"type": "billing_error",
"code": "billing_credit_required",
- "message": "Credit is unavailable for this number. Add credit or review team billing.",
+ "message": "Credit is unavailable for this connection. Add credit or review team billing.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -33038,7 +33191,7 @@
}
},
"503": {
- "description": "Session or service unavailable",
+ "description": "Connection or service unavailable",
"content": {
"application/json": {
"schema": {
@@ -33080,9 +33233,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API Meta Cloud API Polymorfa Hybrid Link messages:write "
- },
"x-protocols": [
"Linked Device API",
"Meta Cloud API",
@@ -33091,14 +33241,14 @@
"description": "**Protocols:** Linked Device API · Meta Cloud API · Polymorfa Hybrid Link\n\n**Required scope:** `messages:write`"
}
},
- "/messaging/{session}/messages/typing": {
+ "/messaging/{connection}/messages/typing": {
"post": {
"operationId": "setTyping",
"tags": [
"Messages"
],
"summary": "Set typing indicator for a chat",
- "description": "**Protocols:** Linked Device API · Meta Cloud API\n\n**Required scope:** `messages:write`\n\nOn a Linked Devices number, `state` sets typing, recording or paused. On an official WhatsApp Business number, send `state: \"typing\"` with the `id` of a message you received; this marks that message read and shows a typing indicator until you reply or 25 seconds pass. On a Number with both connections, this method uses the Linked Devices connection; use the Graph API status request for official typing. Other states return `501`, and a missing `id` returns `400`.",
+ "description": "**Protocols:** Linked Device API · Meta Cloud API\n\n**Required scope:** `messages:write`\n\nOn a Linked Devices connection, `state` sets typing, recording or paused. On an Official API connection, send `state: \"typing\"` with the `id` of a message you received; this marks that message read and shows a typing indicator until you reply or 25 seconds pass. On a Connection with both methods, this operation uses Linked Devices; use the Graph API status request for official typing. Other states return `501`, and a missing `id` returns `400`.",
"security": [
{
"BearerAuth": []
@@ -33111,7 +33261,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -33210,7 +33360,7 @@
}
},
"402": {
- "description": "`billing_credit_required`: credit is unavailable for this number. Add credit or review team billing.",
+ "description": "`billing_credit_required`: credit is unavailable for this connection. Add credit or review team billing.",
"content": {
"application/json": {
"schema": {
@@ -33220,7 +33370,7 @@
"error": {
"type": "billing_error",
"code": "billing_credit_required",
- "message": "Credit is unavailable for this number. Add credit or review team billing.",
+ "message": "Credit is unavailable for this connection. Add credit or review team billing.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -33326,7 +33476,7 @@
}
},
"501": {
- "description": "`operation_not_supported`: official WhatsApp Business numbers support only the `typing` state",
+ "description": "`operation_not_supported`: Official API connections support only the `typing` state",
"content": {
"application/json": {
"schema": {
@@ -33379,7 +33529,7 @@
}
},
"503": {
- "description": "Session or service unavailable",
+ "description": "Connection or service unavailable",
"content": {
"application/json": {
"schema": {
@@ -33421,16 +33571,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API Meta Cloud API messages:write "
- },
"x-protocols": [
"Linked Device API",
"Meta Cloud API"
]
}
},
- "/messaging/{session}/messages/react": {
+ "/messaging/{connection}/messages/react": {
"post": {
"operationId": "sendReaction",
"tags": [
@@ -33449,7 +33596,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -33623,7 +33770,7 @@
}
},
"402": {
- "description": "`billing_credit_required`: credit is unavailable for this number. Add credit or review team billing.",
+ "description": "`billing_credit_required`: credit is unavailable for this connection. Add credit or review team billing.",
"content": {
"application/json": {
"schema": {
@@ -33633,7 +33780,7 @@
"error": {
"type": "billing_error",
"code": "billing_credit_required",
- "message": "Credit is unavailable for this number. Add credit or review team billing.",
+ "message": "Credit is unavailable for this connection. Add credit or review team billing.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -33879,7 +34026,7 @@
}
},
"503": {
- "description": "Session or service unavailable. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend",
+ "description": "Connection or service unavailable. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend",
"content": {
"application/json": {
"schema": {
@@ -33974,9 +34121,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API Meta Cloud API Polymorfa Hybrid Link messages:write "
- },
"x-protocols": [
"Linked Device API",
"Meta Cloud API",
@@ -33985,7 +34129,7 @@
"description": "**Protocols:** Linked Device API · Meta Cloud API · Polymorfa Hybrid Link\n\n**Required scope:** `messages:write`"
}
},
- "/messaging/{session}/messages/star": {
+ "/messaging/{connection}/messages/star": {
"post": {
"operationId": "starMessage",
"tags": [
@@ -34004,7 +34148,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -34103,7 +34247,7 @@
}
},
"402": {
- "description": "`billing_credit_required`: credit is unavailable for this number. Add credit or review team billing.",
+ "description": "`billing_credit_required`: credit is unavailable for this connection. Add credit or review team billing.",
"content": {
"application/json": {
"schema": {
@@ -34113,7 +34257,7 @@
"error": {
"type": "billing_error",
"code": "billing_credit_required",
- "message": "Credit is unavailable for this number. Add credit or review team billing.",
+ "message": "Credit is unavailable for this connection. Add credit or review team billing.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -34240,7 +34384,7 @@
}
},
"503": {
- "description": "Session or service unavailable",
+ "description": "Connection or service unavailable",
"content": {
"application/json": {
"schema": {
@@ -34282,16 +34426,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API messages:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `messages:write`"
}
},
- "/messaging/{session}/operations/{operationId}": {
+ "/messaging/{connection}/operations/{operationId}": {
"get": {
"operationId": "getMessageOperation",
"tags": [
@@ -34311,7 +34452,7 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -34473,16 +34614,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API operations:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `operations:read`"
}
},
- "/messaging/{session}/chats/{conversation}/messages/{messageId}": {
+ "/messaging/{connection}/chats/{conversation}/messages/{messageId}": {
"put": {
"operationId": "editMessage",
"tags": [
@@ -34501,7 +34639,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -34945,9 +35083,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API chats:manage "
- },
"x-protocols": [
"Linked Device API"
],
@@ -34971,7 +35106,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -35419,9 +35554,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API chats:manage "
- },
"x-protocols": [
"Linked Device API"
],
@@ -35445,10 +35577,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -35564,7 +35696,7 @@
}
},
"404": {
- "description": "The Number or conversation is unavailable, or hosted message storage is not enabled (`hms_not_enabled`).",
+ "description": "The Connection or conversation is unavailable, or hosted message storage is not enabled (`hms_not_enabled`).",
"content": {
"application/json": {
"schema": {
@@ -35585,7 +35717,7 @@
}
},
"503": {
- "description": "The history service for the Number's data region is unavailable.",
+ "description": "The history service for the Connection's data region is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -35606,15 +35738,12 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API messages:read "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/chats/{conversation}/archive": {
+ "/messaging/{connection}/chats/{conversation}/archive": {
"post": {
"operationId": "archiveChat",
"tags": [
@@ -35633,7 +35762,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -35828,16 +35957,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API chats:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `chats:manage`"
}
},
- "/messaging/{session}/chats/{conversation}/unarchive": {
+ "/messaging/{connection}/chats/{conversation}/unarchive": {
"post": {
"operationId": "unarchiveChat",
"tags": [
@@ -35856,7 +35982,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -36051,16 +36177,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API chats:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `chats:manage`"
}
},
- "/messaging/{session}/chats/{conversation}/disappearing": {
+ "/messaging/{connection}/chats/{conversation}/disappearing": {
"put": {
"operationId": "setChatDisappearingTimer",
"tags": [
@@ -36079,7 +36202,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -36283,36 +36406,33 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API chats:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `chats:manage`"
}
},
- "/messaging/{session}/calls": {
+ "/messaging/{connection}/calls": {
"get": {
- "operationId": "listSessionCalls",
+ "operationId": "listConnectionCalls",
"tags": [
"Calls"
],
- "summary": "List a number's calls",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:read`\n\nCalls on this number, newest first, with the other party's identity. Records are stored and served in the number's data region. Client tokens need the `read_calls` action.",
+ "summary": "List a connection's calls",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:read`\n\nCalls on this connection, newest first, with the other party's identity. Records are stored and served in the connection's data region. Client tokens need the `read_calls` action.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -36382,7 +36502,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ListSessionCallsResponse"
+ "$ref": "#/components/schemas/ListConnectionCallsResponse"
}
}
},
@@ -36559,15 +36679,12 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:read "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/stickers": {
+ "/messaging/{connection}/stickers": {
"get": {
"operationId": "listStoredStickers",
"tags": [
@@ -36590,10 +36707,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -36724,7 +36841,7 @@
}
},
"404": {
- "description": "The Number or conversation is unavailable, or hosted message storage is not enabled (`hms_not_enabled`).",
+ "description": "The Connection or conversation is unavailable, or hosted message storage is not enabled (`hms_not_enabled`).",
"content": {
"application/json": {
"schema": {
@@ -36745,7 +36862,7 @@
}
},
"503": {
- "description": "The history service for the Number's data region is unavailable.",
+ "description": "The history service for the Connection's data region is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -36766,22 +36883,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API messages:read media:read "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/chats": {
+ "/messaging/{connection}/chats": {
"get": {
"operationId": "listChats",
"tags": [
"Chats"
],
"summary": "List stored conversations",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `chats:read`\n\nLists conversations with stored messages for a Number with hosted message storage, most recent activity first. Beta: requires team enrollment.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `chats:read`\n\nLists conversations with stored messages for a Connection with hosted message storage, most recent activity first. Beta: requires team enrollment.",
"security": [
{
"BearerAuth": []
@@ -36793,10 +36907,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -36952,7 +37066,7 @@
}
},
"404": {
- "description": "The Number or conversation is unavailable, or hosted message storage is not enabled (`hms_not_enabled`).",
+ "description": "The Connection or conversation is unavailable, or hosted message storage is not enabled (`hms_not_enabled`).",
"content": {
"application/json": {
"schema": {
@@ -36973,7 +37087,7 @@
}
},
"503": {
- "description": "The history service for the Number's data region is unavailable.",
+ "description": "The history service for the Connection's data region is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -36994,15 +37108,12 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API chats:read "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/chats/{conversation}": {
+ "/messaging/{connection}/chats/{conversation}": {
"get": {
"operationId": "getChat",
"tags": [
@@ -37021,10 +37132,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -37129,7 +37240,7 @@
}
},
"404": {
- "description": "The Number or conversation is unavailable, or hosted message storage is not enabled (`hms_not_enabled`).",
+ "description": "The Connection or conversation is unavailable, or hosted message storage is not enabled (`hms_not_enabled`).",
"content": {
"application/json": {
"schema": {
@@ -37150,7 +37261,7 @@
}
},
"503": {
- "description": "The history service for the Number's data region is unavailable.",
+ "description": "The history service for the Connection's data region is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -37171,15 +37282,12 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API chats:read "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/chats/{conversation}/messages": {
+ "/messaging/{connection}/chats/{conversation}/messages": {
"get": {
"operationId": "listChatMessages",
"tags": [
@@ -37198,10 +37306,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -37279,7 +37387,7 @@
"inbound",
"outbound"
],
- "description": "`inbound` returns messages from contacts; `outbound` returns messages sent by the Number."
+ "description": "`inbound` returns messages from contacts; `outbound` returns messages sent by the Connection."
},
"required": false,
"name": "direction",
@@ -37389,7 +37497,7 @@
}
},
"404": {
- "description": "The Number or conversation is unavailable, or hosted message storage is not enabled (`hms_not_enabled`).",
+ "description": "The Connection or conversation is unavailable, or hosted message storage is not enabled (`hms_not_enabled`).",
"content": {
"application/json": {
"schema": {
@@ -37410,7 +37518,7 @@
}
},
"503": {
- "description": "The history service for the Number's data region is unavailable.",
+ "description": "The history service for the Connection's data region is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -37431,15 +37539,12 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API messages:read "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/chats/{conversation}/messages/{messageId}/media": {
+ "/messaging/{connection}/chats/{conversation}/messages/{messageId}/media": {
"get": {
"operationId": "getChatMessageMedia",
"tags": [
@@ -37462,10 +37567,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -37582,7 +37687,7 @@
}
},
"404": {
- "description": "The Number, conversation or message is unavailable, no stored copy exists, or hosted message storage is not enabled (`hms_not_enabled`).",
+ "description": "The Connection, conversation or message is unavailable, no stored copy exists, or hosted message storage is not enabled (`hms_not_enabled`).",
"content": {
"application/json": {
"schema": {
@@ -37603,7 +37708,7 @@
}
},
"503": {
- "description": "The history service for the Number's data region is unavailable.",
+ "description": "The history service for the Connection's data region is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -37624,22 +37729,19 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API messages:read media:read "
- },
"x-protocols": [
"Meta Cloud API"
]
}
},
- "/messaging/{session}/chats/{conversation}/service-window": {
+ "/messaging/{connection}/chats/{conversation}/service-window": {
"get": {
"operationId": "getCustomerServiceWindow",
"tags": [
"Chats"
],
"summary": "Get the customer service window",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `chats:read`\n\nReturns whether free-form messages can be sent to a person from a Number's active Official API connection. WhatsApp's customer service window opens for 24 hours when the person messages or calls the Number. Outside it, only approved templates can be sent. Beta: requires team enrollment.",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `chats:read`\n\nReturns whether free-form messages can be sent to a person from a Connection's active Official API method. WhatsApp's customer service window opens for 24 hours when the person messages or calls the Connection. Outside it, only approved templates can be sent. Beta: requires team enrollment.",
"security": [
{
"BearerAuth": []
@@ -37651,10 +37753,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -37753,7 +37855,7 @@
}
},
"404": {
- "description": "The Number or conversation is unavailable.",
+ "description": "The Connection or conversation is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -37774,7 +37876,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`).",
+ "description": "The Connection has no Official API method (`unsupported_for_connection`).",
"content": {
"application/json": {
"schema": {
@@ -37795,7 +37897,7 @@
}
},
"503": {
- "description": "The Number's regional evidence service is temporarily unavailable.",
+ "description": "The Connection's regional evidence service is temporarily unavailable.",
"content": {
"application/json": {
"schema": {
@@ -37816,37 +37918,34 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API chats:read "
- },
"x-protocols": [
"Meta Cloud API"
]
}
},
- "/messaging/{session}/meta-pricing": {
+ "/messaging/{connection}/meta-pricing": {
"get": {
"operationId": "getMetaPricingSummary",
"tags": [
- "Sessions"
+ "Connections"
],
"summary": "Summarize Meta-reported pricing",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `sessions:read`\n\nCounts the messages sent from the Number's active Official API connection generation by the pricing classification WhatsApp reported for each one. Meta bills your WhatsApp Business Account directly. These counts are not a Polymorfa charge and contain no prices. Each message is counted in the period of its first pricing report. Beta: requires team enrollment.",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `connections:read`\n\nCounts the messages sent from the Connection's active Official API method generation by the pricing classification WhatsApp reported for each one. Meta bills your WhatsApp Business Account directly. These counts are not a Polymorfa charge and contain no prices. Each message is counted in the period of its first pricing report. Beta: requires team enrollment.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -37956,7 +38055,7 @@
}
},
"404": {
- "description": "The Number is unavailable.",
+ "description": "The Connection is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -37977,7 +38076,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`).",
+ "description": "The Connection has no Official API method (`unsupported_for_connection`).",
"content": {
"application/json": {
"schema": {
@@ -37998,7 +38097,7 @@
}
},
"503": {
- "description": "The Number's regional evidence service is temporarily unavailable.",
+ "description": "The Connection's regional evidence service is temporarily unavailable.",
"content": {
"application/json": {
"schema": {
@@ -38019,35 +38118,32 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API sessions:read "
- },
"x-protocols": [
"Meta Cloud API"
]
}
},
- "/messaging/{session}/call-permissions/{to}": {
+ "/messaging/{connection}/call-permissions/{to}": {
"get": {
"operationId": "getCallPermission",
"tags": [
"Calls"
],
"summary": "Get a person's call permission",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `sessions:read`\n\nReturns whether the person has allowed this number to call them. On Cloud API numbers WhatsApp is asked on every request and the answer includes its limits on permission requests and calls. Linked-device numbers return `409 unsupported_for_connection`.",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `connections:read`\n\nReturns whether the person has allowed this connection to call them. On Cloud API connections WhatsApp is asked on every request and the answer includes its limits on permission requests and calls. Linked-device connections return `409 unsupported_for_connection`.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -38211,7 +38307,7 @@
}
},
"409": {
- "description": "`unsupported_for_connection`: the number is not a Cloud API number.",
+ "description": "`unsupported_for_connection`: the connection is not a Cloud API connection.",
"content": {
"application/json": {
"schema": {
@@ -38221,7 +38317,7 @@
"error": {
"type": "conflict_error",
"code": "unsupported_for_connection",
- "message": "The session's connection does not support this call operation.",
+ "message": "The connection's connection does not support this call operation.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -38275,9 +38371,6 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API sessions:read "
- },
"x-protocols": [
"Meta Cloud API"
]
@@ -38290,13 +38383,13 @@
"Calls"
],
"summary": "Check whether a call can be placed",
- "description": "**Required scope:** `sessions:read`\n\nRuns the checks a call placement runs, without calling: the number's calling switch, the team's do-not-call list and blocked country codes, and on Cloud API numbers the person's call permission and WhatsApp's call limits. If WhatsApp's permission status is unavailable and no other refusal is known, returns 503 service_unavailable. Server credentials only.",
+ "description": "**Required scope:** `connections:read`\n\nRuns the checks a call placement runs, without calling: the connection's calling switch, the team's do-not-call list and blocked country codes, and on Cloud API connections the person's call permission and WhatsApp's call limits. If WhatsApp's permission status is unavailable and no other refusal is known, returns 503 service_unavailable. Server credentials only.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"requestBody": {
"required": true,
"content": {
@@ -38521,9 +38614,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:read "
}
}
},
@@ -38534,13 +38624,13 @@
"VoIP"
],
"summary": "Create a WhatsApp call link",
- "description": "**Required scope:** `sessions:manage`\n\nRequires a server credential with sessions:manage and a Linked Device Number with calling enabled. Client tokens and Cloud API-only Numbers are refused. This operation does not place or join a call. Idempotency-Key is not supported; do not automatically retry an unknown outcome. Keep call-link tokens and URLs private.",
+ "description": "**Required scope:** `connections:manage`\n\nRequires a server credential with connections:manage and a Linked Device Connection with calling enabled. Client tokens and Cloud API-only Connections are refused. This operation does not place or join a call. Idempotency-Key is not supported; do not automatically retry an unknown outcome. Keep call-link tokens and URLs private.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"requestBody": {
"required": true,
"content": {
@@ -38798,7 +38888,7 @@
}
},
"503": {
- "description": "Calling settings, Number authority or the connection are unavailable",
+ "description": "Calling settings, Connection authority or the connection are unavailable",
"content": {
"application/json": {
"schema": {
@@ -38829,9 +38919,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
@@ -38842,13 +38929,13 @@
"VoIP"
],
"summary": "Preview a WhatsApp call link",
- "description": "**Required scope:** `sessions:manage`\n\nRequires a server credential with sessions:manage and a Linked Device Number with calling enabled. Client tokens and Cloud API-only Numbers are refused. This operation does not place or join a call. Idempotency-Key is not supported; do not automatically retry an unknown outcome. Keep call-link tokens and URLs private.",
+ "description": "**Required scope:** `connections:manage`\n\nRequires a server credential with connections:manage and a Linked Device Connection with calling enabled. Client tokens and Cloud API-only Connections are refused. This operation does not place or join a call. Idempotency-Key is not supported; do not automatically retry an unknown outcome. Keep call-link tokens and URLs private.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"requestBody": {
"required": true,
"content": {
@@ -39106,7 +39193,7 @@
}
},
"503": {
- "description": "Calling settings, Number authority or the connection are unavailable",
+ "description": "Calling settings, Connection authority or the connection are unavailable",
"content": {
"application/json": {
"schema": {
@@ -39137,9 +39224,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
@@ -39150,14 +39234,14 @@
"tags": [
"VoIP"
],
- "summary": "Attach a WebRTC connection and receive the pod's answer + ICE servers",
- "description": "**Required scope:** `sessions:manage`\n\nSubmits the SDP offer for one connection. The offer carries one audio transceiver, a data channel negotiated out of band with label `pmfa.calls` and id 0, and one or more video transceivers. Reusing a `connectionId` replaces that connection.",
+ "summary": "Attach a WebRTC method and receive the pod's answer + ICE servers",
+ "description": "**Required scope:** `connections:manage`\n\nSubmits the SDP offer for one method. The offer carries one audio transceiver, a data channel negotiated out of band with label `pmfa.calls` and id 0, and one or more video transceivers. Reusing a `connectionId` replaces that method.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -39331,7 +39415,7 @@
}
},
"409": {
- "description": "`call_claimed` when another participant claimed the call, `connection_limit` when the call has no free connection, or `state_conflict` when the call is not ready",
+ "description": "`call_claimed` when another participant claimed the call, `connection_limit` when the call has no free method, or `state_conflict` when the call is not ready",
"content": {
"application/json": {
"schema": {
@@ -39490,9 +39574,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
@@ -39503,14 +39584,14 @@
"tags": [
"VoIP"
],
- "summary": "Re-offer on an established connection and receive the pod's answer",
- "description": "**Required scope:** `sessions:manage`\n\nRenegotiates one connection, for example to add video, add receive transceivers after `video_slots_exhausted`, or restart ICE.",
+ "summary": "Re-offer on an established method and receive the pod's answer",
+ "description": "**Required scope:** `connections:manage`\n\nRenegotiates one method, for example to add video, add receive transceivers after `video_slots_exhausted`, or restart ICE.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -39535,7 +39616,7 @@
},
"responses": {
"200": {
- "description": "SDP answer for the re-offer, on the same peer connection",
+ "description": "SDP answer for the re-offer, on the same peer method",
"content": {
"application/json": {
"schema": {
@@ -39684,7 +39765,7 @@
}
},
"409": {
- "description": "`call_claimed` when another participant claimed the call, `connection_limit` when the call has no free connection, or `state_conflict` when the call is not ready",
+ "description": "`call_claimed` when another participant claimed the call, `connection_limit` when the call has no free method, or `state_conflict` when the call is not ready",
"content": {
"application/json": {
"schema": {
@@ -39811,9 +39892,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
@@ -39823,14 +39901,14 @@
"tags": [
"VoIP"
],
- "summary": "Place an outbound call from a session",
- "description": "**Required scope:** `sessions:manage`\n\nOriginates a WhatsApp call to `to`, an ad-hoc group call to `participants` (2 to 31 distinct E.164 phone numbers or public user IDs), or every remote member of `groupId` (a public group ID). Group rosters must contain 2 to 31 remote members; a membership change during placement refuses the call. Provide exactly one destination form. Group calls require a Linked Device number and check every recipient against the team policy and number restrictions before dialing. The call is owned by the placing participant and rings on the callee's device: `call.accepted` follows when they pick up and `call.ended` when either side hangs up. Carry its audio and video with a Polymorfa Calls SDK. `exclusive: true` claims the call for the placing participant. Client tokens place from their bound session; server credentials must name one. Outbound starts share a rate limit per team and source session across server credentials and client tokens; client-token rules also apply.",
+ "summary": "Place an outbound call from a connection",
+ "description": "**Required scope:** `connections:manage`\n\nOriginates a WhatsApp call to `to`, an ad-hoc group call to `participants` (2 to 31 distinct E.164 phone numbers or public user IDs), or every remote member of `groupId` (a public group ID). Group rosters must contain 2 to 31 remote members; a membership change during placement refuses the call. Provide exactly one destination form. Group calls require a Linked Devices connection and check every recipient against the team policy and number restrictions before dialing. The call is owned by the placing participant and rings on the callee's device: `call.accepted` follows when they pick up and `call.ended` when either side hangs up. Carry its audio and video with a Polymorfa Calls SDK. `exclusive: true` claims the call for the placing participant. Client tokens place from their bound connection; server credentials must name one. Outbound starts share a rate limit per team and source connection across server credentials and client tokens; client-token rules also apply.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"requestBody": {
"required": true,
"content": {
@@ -39960,7 +40038,7 @@
}
},
"403": {
- "description": "`call_permission_required` when the recipient has not granted this business permission to call them, `number_restricted` when WhatsApp restricts the number to calling people it has already chatted with and the callee is not one of them (`Retry-After` gives the seconds until the restriction ends, when known), or the credential is not permitted",
+ "description": "`call_permission_required` when the recipient has not granted this business permission to call them, `connection_restricted` when WhatsApp restricts the connection to calling people it has already chatted with and the callee is not one of them (`Retry-After` gives the seconds until the restriction ends, when known), or the credential is not permitted",
"content": {
"application/json": {
"schema": {
@@ -40024,7 +40102,7 @@
}
},
"409": {
- "description": "`unsupported_for_connection` when the session's connection cannot place this call (Cloud API calls are audio only), or `state_conflict` when the named session cannot place an outbound call yet",
+ "description": "`unsupported_for_connection` when the connection's method cannot place this call (Cloud API calls are audio only), or `state_conflict` when the named connection cannot place an outbound call yet",
"content": {
"application/json": {
"schema": {
@@ -40034,7 +40112,7 @@
"error": {
"type": "conflict_error",
"code": "unsupported_for_connection",
- "message": "The session's connection does not support this call operation.",
+ "message": "The connection's connection does not support this call operation.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -40088,7 +40166,7 @@
}
},
"429": {
- "description": "Outbound call rate exceeded for this team and source session, which every credential shares, or a client token's own request rate (`rateLimit`) was exceeded.",
+ "description": "Outbound call rate exceeded for this team and source connection, which every credential shares, or a client token's own request rate (`rateLimit`) was exceeded.",
"content": {
"application/json": {
"schema": {
@@ -40247,9 +40325,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
@@ -40260,13 +40335,329 @@
"VoIP"
],
"summary": "Answer or join a call",
- "description": "**Required scope:** `sessions:manage`\n\nThe first accept answers a ringing call. `exclusive: true` claims it: other participants then receive `409 call_claimed` for accept and media, and their open connections close. Without a claim, later accepts join the answered call. Retrying with the same participant returns the same result. An exclusive request from another participant on a shared call is refused with `409 call_claimed`.",
+ "description": "**Required scope:** `connections:manage`\n\nThe first accept answers a ringing call. `exclusive: true` claims it: other participants then receive `409 call_claimed` for accept and media, and their open methods close. Without a claim, later accepts join the answered call. Retrying with the same participant returns the same result. An exclusive request from another participant on a shared call is refused with `409 call_claimed`.",
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-required-scope": "connections:manage",
+ "parameters": [
+ {
+ "schema": {
+ "type": "string",
+ "minLength": 1,
+ "example": "call-123"
+ },
+ "required": true,
+ "name": "id",
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VoipAcceptCallRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Call answered or joined",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VoipAcceptCallResponse"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request — request body or params failed validation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "invalid_parameter",
+ "message": "Correct the invalid request field.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "401": {
+ "description": "Missing or invalid authentication token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "authentication_error",
+ "code": "invalid_credential",
+ "message": "Supply a valid credential.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "403": {
+ "description": "Authenticated but not permitted (missing scope or rule violation)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "permission_error",
+ "code": "permission_denied",
+ "message": "The credential does not have access to this resource.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_not_found",
+ "message": "The resource is unavailable to this caller.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "409": {
+ "description": "`call_claimed` when another participant claimed the call, or `state_conflict` when the call is not ready",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "conflict_error",
+ "code": "call_claimed",
+ "message": "Another participant claimed this call.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#call-claimed"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "410": {
+ "description": "Call ended — the pod that owned its media is gone (pod_lost)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "invalid_request_error",
+ "code": "resource_gone",
+ "message": "The requested retained resource has expired or was removed.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#resource-gone"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "internal_error",
+ "message": "An unexpected service failure occurred. Keep the request ID for support.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#internal-error"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ },
+ "503": {
+ "description": "Call unavailable — the owning pod is at capacity or draining, or call authority cannot be verified",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PublicError"
+ },
+ "example": {
+ "error": {
+ "type": "api_error",
+ "code": "service_unavailable",
+ "message": "A required service is unavailable. Check completion before repeating a write.",
+ "param": null,
+ "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
+ },
+ "data": null,
+ "docs": "https://docs.polymorfa.com/api/errors#service-unavailable"
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "$ref": "#/components/headers/X-RateLimit-Limit"
+ },
+ "X-RateLimit-Remaining": {
+ "$ref": "#/components/headers/X-RateLimit-Remaining"
+ },
+ "X-RateLimit-Reset": {
+ "$ref": "#/components/headers/X-RateLimit-Reset"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/messaging/voip/calls/{id}/reject": {
+ "post": {
+ "operationId": "voipRejectCall",
+ "tags": [
+ "VoIP"
+ ],
+ "summary": "Decline a ringing call",
+ "description": "**Required scope:** `connections:manage`\n\nDeclines a ringing call and releases it. Returns `409 call_not_ringing` when the call is not ringing.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -40283,18 +40674,18 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/VoipAcceptCallRequest"
+ "$ref": "#/components/schemas/VoipRejectCallRequest"
}
}
}
},
"responses": {
- "200": {
- "description": "Call answered or joined",
+ "202": {
+ "description": "Call declined",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/VoipAcceptCallResponse"
+ "$ref": "#/components/schemas/SuccessResponse"
}
}
},
@@ -40439,7 +40830,7 @@
}
},
"409": {
- "description": "`call_claimed` when another participant claimed the call, or `state_conflict` when the call is not ready",
+ "description": "`call_not_ringing` when the call was already answered, declined, or ended",
"content": {
"application/json": {
"schema": {
@@ -40448,13 +40839,13 @@
"example": {
"error": {
"type": "conflict_error",
- "code": "call_claimed",
- "message": "Another participant claimed this call.",
+ "code": "call_not_ringing",
+ "message": "The call is no longer ringing.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
"data": null,
- "docs": "https://docs.polymorfa.com/api/errors#call-claimed"
+ "docs": "https://docs.polymorfa.com/api/errors#call-not-ringing"
}
}
},
@@ -40566,26 +40957,23 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
- "/messaging/voip/calls/{id}/reject": {
+ "/messaging/voip/calls/{id}/leave": {
"post": {
- "operationId": "voipRejectCall",
+ "operationId": "voipLeaveCall",
"tags": [
"VoIP"
],
- "summary": "Decline a ringing call",
- "description": "**Required scope:** `sessions:manage`\n\nDeclines a ringing call and releases it. Returns `409 call_not_ringing` when the call is not ringing.",
+ "summary": "Close one method without ending the call",
+ "description": "**Required scope:** `connections:manage`\n\nDisconnects the named method. The call and the participant's other methods continue. Use `DELETE /voip/calls/{id}` to end the call for everyone.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -40599,17 +40987,18 @@
}
],
"requestBody": {
+ "required": true,
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/VoipRejectCallRequest"
+ "$ref": "#/components/schemas/VoipLeaveRequest"
}
}
}
},
"responses": {
"202": {
- "description": "Call declined",
+ "description": "Connection closed",
"content": {
"application/json": {
"schema": {
@@ -40758,7 +41147,7 @@
}
},
"409": {
- "description": "`call_not_ringing` when the call was already answered, declined, or ended",
+ "description": "Call not ready — no media connection on the owning pod yet",
"content": {
"application/json": {
"schema": {
@@ -40767,13 +41156,13 @@
"example": {
"error": {
"type": "conflict_error",
- "code": "call_not_ringing",
- "message": "The call is no longer ringing.",
+ "code": "state_conflict",
+ "message": "The request conflicts with the resource state.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
"data": null,
- "docs": "https://docs.polymorfa.com/api/errors#call-not-ringing"
+ "docs": "https://docs.polymorfa.com/api/errors#state-conflict"
}
}
},
@@ -40885,26 +41274,23 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
- "/messaging/voip/calls/{id}/leave": {
+ "/messaging/voip/calls/{id}/reaction": {
"post": {
- "operationId": "voipLeaveCall",
+ "operationId": "sendCallReaction",
"tags": [
"VoIP"
],
- "summary": "Close one connection without ending the call",
- "description": "**Required scope:** `sessions:manage`\n\nDisconnects the named connection. The call and the participant's other connections continue. Use `DELETE /voip/calls/{id}` to end the call for everyone.",
+ "summary": "Send or clear a call reaction",
+ "description": "**Required scope:** `connections:manage`\n\nRequires an attached method owned by the acting participant, connections:manage, and voip_signal for client tokens. Linked-device calls only; unsupported backends return 409 unsupported_for_connection. Reactions are transient and are not replayed. Hand state is shared by the Connection and restored on media reconnection. Do not automatically retry an uncertain result.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -40922,14 +41308,14 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/VoipLeaveRequest"
+ "$ref": "#/components/schemas/VoipReactionRequest"
}
}
}
},
"responses": {
"202": {
- "description": "Connection closed",
+ "description": "Reaction accepted",
"content": {
"application/json": {
"schema": {
@@ -41078,7 +41464,7 @@
}
},
"409": {
- "description": "Call not ready — no media session on the owning pod yet",
+ "description": "The call is not ready (`state_conflict`), or the calling backend does not support this action (`unsupported_for_connection`).",
"content": {
"application/json": {
"schema": {
@@ -41205,26 +41591,23 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
- "/messaging/voip/calls/{id}/reaction": {
+ "/messaging/voip/calls/{id}/hand": {
"post": {
- "operationId": "sendCallReaction",
+ "operationId": "setCallHandRaised",
"tags": [
"VoIP"
],
- "summary": "Send or clear a call reaction",
- "description": "**Required scope:** `sessions:manage`\n\nRequires an attached connection owned by the acting participant, sessions:manage, and voip_signal for client tokens. Linked-device calls only; unsupported backends return 409 unsupported_for_connection. Reactions are transient and are not replayed. Hand state is shared by the Number and restored on media reconnection. Do not automatically retry an uncertain result.",
+ "summary": "Raise or lower the Connection's hand in a call",
+ "description": "**Required scope:** `connections:manage`\n\nRequires an attached method owned by the acting participant, connections:manage, and voip_signal for client tokens. Linked-device calls only; unsupported backends return 409 unsupported_for_connection. Reactions are transient and are not replayed. Hand state is shared by the Connection and restored on media reconnection. Do not automatically retry an uncertain result.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -41242,14 +41625,14 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/VoipReactionRequest"
+ "$ref": "#/components/schemas/VoipHandRequest"
}
}
}
},
"responses": {
"202": {
- "description": "Reaction accepted",
+ "description": "Hand state accepted",
"content": {
"application/json": {
"schema": {
@@ -41525,26 +41908,23 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
- "/messaging/voip/calls/{id}/hand": {
+ "/messaging/voip/calls/{id}/waiting-room": {
"post": {
- "operationId": "setCallHandRaised",
+ "operationId": "controlCallWaitingRoom",
"tags": [
"VoIP"
],
- "summary": "Raise or lower the Number's hand in a call",
- "description": "**Required scope:** `sessions:manage`\n\nRequires an attached connection owned by the acting participant, sessions:manage, and voip_signal for client tokens. Linked-device calls only; unsupported backends return 409 unsupported_for_connection. Reactions are transient and are not replayed. Hand state is shared by the Number and restored on media reconnection. Do not automatically retry an uncertain result.",
+ "summary": "Moderate a call waiting room",
+ "description": "**Required scope:** `connections:manage`\n\nReauthorizes the credential and current Connection/project on each request. Requires the answering participant's attached method and current provider administrator authority. A result with ok=false reports a refusal or unknown outcome. Never replay uncertain moderation.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -41562,18 +41942,18 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/VoipHandRequest"
+ "$ref": "#/components/schemas/VoipWaitingRoomControlRequest"
}
}
}
},
"responses": {
- "202": {
- "description": "Hand state accepted",
+ "200": {
+ "description": "Correlated provider outcome; inspect data.ok and data.code",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SuccessResponse"
+ "$ref": "#/components/schemas/VoipWaitingRoomControlResponse"
}
}
},
@@ -41845,9 +42225,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
@@ -41858,13 +42235,13 @@
"VoIP"
],
"summary": "Ring an existing call participant again",
- "description": "**Required scope:** `sessions:manage`\n\nRings one non-connected participant already in the upstream call roster. Does not add a participant or change the roster optimistically. Requires the same destination permission as an invitation. Cloud API calls do not support this operation.",
+ "description": "**Required scope:** `connections:manage`\n\nRings one non-connected participant already in the upstream call roster. Does not add a participant or change the roster optimistically. Requires the same destination permission as an invitation. Cloud API calls do not support this operation.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -42197,9 +42574,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
@@ -42210,13 +42584,13 @@
"VoIP"
],
"summary": "Invite another party into a live call",
- "description": "**Required scope:** `sessions:manage`\n\nRings `to` (an E.164 phone number or a user ID) into the call, turning a 1:1 call into a group call. The invitee enters the roster as `invited`; roster changes reach media sockets as `participant_joined` / `participant_state` / `participant_left` frames. 409 until the call has a live leg.",
+ "description": "**Required scope:** `connections:manage`\n\nRings `to` (an E.164 phone number or a user ID) into the call, turning a 1:1 call into a group call. The invitee enters the roster as `invited`; roster changes reach media sockets as `participant_joined` / `participant_state` / `participant_left` frames. 409 until the call has a live leg.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -42325,7 +42699,7 @@
}
},
"403": {
- "description": "`number_restricted` when WhatsApp restricts the number to calling people it has already chatted with and the invitee is not one of them (`Retry-After` gives the seconds until the restriction ends, when known), or the credential is not permitted",
+ "description": "`connection_restricted` when WhatsApp restricts the connection to calling people it has already chatted with and the invitee is not one of them (`Retry-After` gives the seconds until the restriction ends, when known), or the credential is not permitted",
"content": {
"application/json": {
"schema": {
@@ -42334,13 +42708,13 @@
"example": {
"error": {
"type": "permission_error",
- "code": "number_restricted",
- "message": "WhatsApp restricts this number to calling people it has already chatted with. The restriction lifts on its own; follow Retry-After when supplied.",
+ "code": "connection_restricted",
+ "message": "WhatsApp restricts this connection to calling people it has already chatted with. The restriction lifts on its own; follow Retry-After when supplied.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
"data": null,
- "docs": "https://docs.polymorfa.com/api/errors#number-restricted"
+ "docs": "https://docs.polymorfa.com/api/errors#connection-restricted"
}
}
},
@@ -42389,7 +42763,7 @@
}
},
"409": {
- "description": "`unsupported_for_connection` when the session connects through the Cloud API, which has no group calls, or `state_conflict` when the call has no live leg yet",
+ "description": "`unsupported_for_connection` when the connection connects through the Cloud API, which has no group calls, or `state_conflict` when the call has no live leg yet",
"content": {
"application/json": {
"schema": {
@@ -42399,7 +42773,7 @@
"error": {
"type": "conflict_error",
"code": "unsupported_for_connection",
- "message": "The session's connection does not support this call operation.",
+ "message": "The connection's connection does not support this call operation.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -42548,9 +42922,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
@@ -42561,13 +42932,13 @@
"tags": [
"VoIP"
],
- "summary": "Trickle a local ICE candidate to one connection",
+ "summary": "Trickle a local ICE candidate to one method",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -42741,7 +43112,7 @@
}
},
"409": {
- "description": "Call not ready — no media session on the owning pod yet",
+ "description": "Call not ready — no media connection on the owning pod yet",
"content": {
"application/json": {
"schema": {
@@ -42869,10 +43240,7 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
- "description": "**Required scope:** `sessions:manage`"
+ "description": "**Required scope:** `connections:manage`"
}
},
"/messaging/voip/calls/{id}/candidates": {
@@ -42888,7 +43256,7 @@
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -43052,7 +43420,7 @@
}
},
"409": {
- "description": "Call not ready — no media session on the owning pod yet",
+ "description": "Call not ready — no media connection on the owning pod yet",
"content": {
"application/json": {
"schema": {
@@ -43180,10 +43548,7 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
- "description": "**Required scope:** `sessions:manage`"
+ "description": "**Required scope:** `connections:manage`"
}
},
"/messaging/voip/calls/{id}/reports": {
@@ -43193,13 +43558,13 @@
"VoIP"
],
"summary": "Report call diagnostics from your app",
- "description": "**Required scope:** `sessions:manage`\n\nRecords quality figures or an error that your app measured for one of its connections. The Console shows the latest quality report and the reported errors of each connection on the call. Reports are optional and are accepted while the call is live and for 10 minutes after it ends. Each connection can send one quality report every 5 seconds and 20 error reports per minute. At most 200 reports are kept per call: at that limit a quality report replaces the same connection's oldest quality report. A quality report from a connection with no stored quality report, and every error report, is accepted but not stored.",
+ "description": "**Required scope:** `connections:manage`\n\nRecords quality figures or an error that your app measured for one of its methods. The Console shows the latest quality report and the reported errors of each method on the call. Reports are optional and are accepted while the call is live and for 10 minutes after it ends. Each method can send one quality report every 5 seconds and 20 error reports per minute. At most 200 reports are kept per call: at that limit a quality report replaces the same method's oldest quality report. A quality report from a method with no stored quality report, and every error report, is accepted but not stored.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -43437,7 +43802,7 @@
}
},
"429": {
- "description": "The connection exceeded its report limit: one quality report every 5 seconds or 20 error reports per minute",
+ "description": "The method exceeded its report limit: one quality report every 5 seconds or 20 error reports per minute",
"content": {
"application/json": {
"schema": {
@@ -43532,9 +43897,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
@@ -43545,13 +43907,13 @@
"VoIP"
],
"summary": "End a call for everyone",
- "description": "**Required scope:** `sessions:manage`\n\nEnds the call and closes every connection. Repeating the request succeeds.",
+ "description": "**Required scope:** `connections:manage`\n\nEnds the call and closes every method. Repeating the request succeeds.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -43715,7 +44077,7 @@
}
},
"409": {
- "description": "Call not ready — no media session on the owning pod yet",
+ "description": "Call not ready — no media connection on the owning pod yet",
"content": {
"application/json": {
"schema": {
@@ -43842,13 +44204,10 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
- "/messaging/{session}/calls/{callId}/reject": {
+ "/messaging/{connection}/calls/{callId}/reject": {
"post": {
"operationId": "rejectCall",
"tags": [
@@ -43867,7 +44226,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -44073,22 +44432,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API chats:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `chats:manage`"
}
},
- "/messaging/{session}/groups": {
+ "/messaging/{connection}/groups": {
"get": {
"operationId": "listGroups",
"tags": [
"Groups"
],
- "summary": "List groups the session is a member of",
+ "summary": "List groups the connection is a member of",
"security": [
{
"BearerAuth": []
@@ -44101,7 +44457,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -44288,9 +44644,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -44314,7 +44667,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -44510,16 +44863,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/join-info": {
+ "/messaging/{connection}/groups/join-info": {
"get": {
"operationId": "getGroupJoinInfo",
"tags": [
@@ -44538,7 +44888,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -44734,16 +45084,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`"
}
},
- "/messaging/{session}/groups/join": {
+ "/messaging/{connection}/groups/join": {
"post": {
"operationId": "joinGroup",
"tags": [
@@ -44762,7 +45109,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -44958,16 +45305,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/capabilities": {
+ "/messaging/{connection}/groups/{id}/capabilities": {
"get": {
"operationId": "getGroupCapabilities",
"tags": [
@@ -44986,7 +45330,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -45001,7 +45345,7 @@
],
"responses": {
"200": {
- "description": "Account-bound stored group capabilities. Unknown until successful number and group syncs for the linked account. Requires current group membership and the enrolled number-capabilities beta.",
+ "description": "Account-bound stored group capabilities. Unknown until successful connection and group syncs for the linked account. Requires current group membership and the enrolled connection-capabilities beta.",
"content": {
"application/json": {
"schema": {
@@ -45214,16 +45558,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`"
}
},
- "/messaging/{session}/groups/{id}": {
+ "/messaging/{connection}/groups/{id}": {
"get": {
"operationId": "getGroup",
"tags": [
@@ -45242,7 +45583,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -45438,9 +45779,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -45464,7 +45802,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -45660,16 +45998,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/leave": {
+ "/messaging/{connection}/groups/{id}/leave": {
"post": {
"operationId": "leaveGroup",
"tags": [
@@ -45688,7 +46023,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -45884,16 +46219,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/subject": {
+ "/messaging/{connection}/groups/{id}/subject": {
"put": {
"operationId": "setGroupSubject",
"tags": [
@@ -45912,7 +46244,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -46117,16 +46449,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/description": {
+ "/messaging/{connection}/groups/{id}/description": {
"put": {
"operationId": "setGroupDescription",
"tags": [
@@ -46145,7 +46474,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -46350,16 +46679,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/invite-code": {
+ "/messaging/{connection}/groups/{id}/invite-code": {
"get": {
"operationId": "getGroupInviteCode",
"tags": [
@@ -46378,7 +46704,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -46574,16 +46900,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`"
}
},
- "/messaging/{session}/groups/{id}/invite-code/revoke": {
+ "/messaging/{connection}/groups/{id}/invite-code/revoke": {
"post": {
"operationId": "revokeGroupInviteCode",
"tags": [
@@ -46602,7 +46925,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -46798,16 +47121,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/participants": {
+ "/messaging/{connection}/groups/{id}/participants": {
"get": {
"operationId": "getGroupParticipants",
"tags": [
@@ -46826,7 +47146,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -47022,16 +47342,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`"
}
},
- "/messaging/{session}/groups/{id}/participants/add": {
+ "/messaging/{connection}/groups/{id}/participants/add": {
"post": {
"operationId": "addGroupParticipants",
"tags": [
@@ -47050,7 +47367,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -47255,16 +47572,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/participants/remove": {
+ "/messaging/{connection}/groups/{id}/participants/remove": {
"post": {
"operationId": "removeGroupParticipants",
"tags": [
@@ -47283,7 +47597,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -47488,16 +47802,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/admin/promote": {
+ "/messaging/{connection}/groups/{id}/admin/promote": {
"post": {
"operationId": "promoteGroupAdmin",
"tags": [
@@ -47516,7 +47827,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -47721,16 +48032,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/admin/demote": {
+ "/messaging/{connection}/groups/{id}/admin/demote": {
"post": {
"operationId": "demoteGroupAdmin",
"tags": [
@@ -47749,7 +48057,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -47954,16 +48262,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/picture": {
+ "/messaging/{connection}/groups/{id}/picture": {
"put": {
"operationId": "setGroupPicture",
"tags": [
@@ -47982,7 +48287,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -48187,16 +48492,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/settings/info-edit": {
+ "/messaging/{connection}/groups/{id}/settings/info-edit": {
"put": {
"operationId": "setGroupInfoEditing",
"tags": [
@@ -48215,7 +48517,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -48420,16 +48722,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/settings/messages": {
+ "/messaging/{connection}/groups/{id}/settings/messages": {
"put": {
"operationId": "setGroupMessaging",
"tags": [
@@ -48448,7 +48747,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -48653,16 +48952,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/settings/member-add": {
+ "/messaging/{connection}/groups/{id}/settings/member-add": {
"put": {
"operationId": "setGroupMemberAddMode",
"tags": [
@@ -48681,7 +48977,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -48886,16 +49182,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/groups/{id}/settings/join-approval": {
+ "/messaging/{connection}/groups/{id}/settings/join-approval": {
"put": {
"operationId": "setGroupJoinApproval",
"tags": [
@@ -48914,7 +49207,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -49119,23 +49412,20 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`"
}
},
- "/messaging/{session}/official-groups": {
+ "/messaging/{connection}/official-groups": {
"get": {
"operationId": "listOfficialGroups",
"tags": [
"Official groups"
],
"summary": "List Official groups",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`\n\nLists the active groups this Number created through the Official API, newest first as WhatsApp returns them. Beta: requires team enrollment and a Number with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`\n\nLists the active groups this Connection created through the Official API, newest first as WhatsApp returns them. Beta: requires team enrollment and a Connection with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
"security": [
{
"BearerAuth": []
@@ -49147,10 +49437,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -49271,7 +49561,7 @@
}
},
"403": {
- "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the number is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
+ "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the connection is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
"content": {
"application/json": {
"schema": {
@@ -49292,7 +49582,7 @@
}
},
"404": {
- "description": "The Number or group is unavailable.",
+ "description": "The Connection or group is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -49313,7 +49603,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`).",
+ "description": "The Connection has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`).",
"content": {
"application/json": {
"schema": {
@@ -49334,7 +49624,7 @@
}
},
"429": {
- "description": "WhatsApp is limiting group requests from this number (`whatsapp_rate_limited`).",
+ "description": "WhatsApp is limiting group requests from this connection (`whatsapp_rate_limited`).",
"content": {
"application/json": {
"schema": {
@@ -49397,9 +49687,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:read "
- },
"x-protocols": [
"Linked Device API"
]
@@ -49410,7 +49697,7 @@
"Official groups"
],
"summary": "Create an Official group",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nAsks WhatsApp to create a group. WhatsApp creates it asynchronously and sends a `group.update` event with the group's conversation ID and invite link. A Number can create at most 10,000 groups, and each group holds at most 8 participants besides your business. Beta: requires team enrollment and a Number with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nAsks WhatsApp to create a group. WhatsApp creates it asynchronously and sends a `group.update` event with the group's conversation ID and invite link. A Connection can create at most 10,000 groups, and each group holds at most 8 participants besides your business. Beta: requires team enrollment and a Connection with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
"security": [
{
"BearerAuth": []
@@ -49422,10 +49709,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -49545,7 +49832,7 @@
}
},
"403": {
- "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the number is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
+ "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the connection is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
"content": {
"application/json": {
"schema": {
@@ -49566,7 +49853,7 @@
}
},
"404": {
- "description": "The Number or group is unavailable.",
+ "description": "The Connection or group is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -49587,7 +49874,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "description": "The Connection has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
"content": {
"application/json": {
"schema": {
@@ -49658,7 +49945,7 @@
}
},
"429": {
- "description": "WhatsApp is limiting group requests from this number (`whatsapp_rate_limited`).",
+ "description": "WhatsApp is limiting group requests from this connection (`whatsapp_rate_limited`).",
"content": {
"application/json": {
"schema": {
@@ -49728,22 +50015,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/official-groups/{group}": {
+ "/messaging/{connection}/official-groups/{group}": {
"get": {
"operationId": "getOfficialGroup",
"tags": [
"Official groups"
],
"summary": "Get an Official group",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`\n\nReturns the group's subject, description, participants, suspension and join approval setting. Beta: requires team enrollment and a Number with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`\n\nReturns the group's subject, description, participants, suspension and join approval setting. Beta: requires team enrollment and a Connection with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
"security": [
{
"BearerAuth": []
@@ -49755,10 +50039,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -49859,7 +50143,7 @@
}
},
"403": {
- "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the number is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
+ "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the connection is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
"content": {
"application/json": {
"schema": {
@@ -49880,7 +50164,7 @@
}
},
"404": {
- "description": "The Number or group is unavailable.",
+ "description": "The Connection or group is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -49901,7 +50185,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`).",
+ "description": "The Connection has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`).",
"content": {
"application/json": {
"schema": {
@@ -49922,7 +50206,7 @@
}
},
"429": {
- "description": "WhatsApp is limiting group requests from this number (`whatsapp_rate_limited`).",
+ "description": "WhatsApp is limiting group requests from this connection (`whatsapp_rate_limited`).",
"content": {
"application/json": {
"schema": {
@@ -49985,9 +50269,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:read "
- },
"x-protocols": [
"Linked Device API"
]
@@ -49998,7 +50279,7 @@
"Official groups"
],
"summary": "Update an Official group",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nChanges the group's subject or description. A `group.update` event with action `settings_updated` reports which changes WhatsApp applied. Beta: requires team enrollment and a Number with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nChanges the group's subject or description. A `group.update` event with action `settings_updated` reports which changes WhatsApp applied. Beta: requires team enrollment and a Connection with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
"security": [
{
"BearerAuth": []
@@ -50010,10 +50291,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -50144,7 +50425,7 @@
}
},
"403": {
- "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the number is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
+ "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the connection is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
"content": {
"application/json": {
"schema": {
@@ -50165,7 +50446,7 @@
}
},
"404": {
- "description": "The Number or group is unavailable.",
+ "description": "The Connection or group is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -50186,7 +50467,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "description": "The Connection has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
"content": {
"application/json": {
"schema": {
@@ -50257,7 +50538,7 @@
}
},
"429": {
- "description": "WhatsApp is limiting group requests from this number (`whatsapp_rate_limited`).",
+ "description": "WhatsApp is limiting group requests from this connection (`whatsapp_rate_limited`).",
"content": {
"application/json": {
"schema": {
@@ -50327,9 +50608,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
]
@@ -50340,7 +50618,7 @@
"Official groups"
],
"summary": "Delete an Official group",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nDeletes the group and removes every participant, including your business. Nobody can message the group afterwards. A `group.update` event with action `deleted` confirms it. Beta: requires team enrollment and a Number with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nDeletes the group and removes every participant, including your business. Nobody can message the group afterwards. A `group.update` event with action `deleted` confirms it. Beta: requires team enrollment and a Connection with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
"security": [
{
"BearerAuth": []
@@ -50352,10 +50630,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -50476,7 +50754,7 @@
}
},
"403": {
- "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the number is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
+ "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the connection is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
"content": {
"application/json": {
"schema": {
@@ -50497,7 +50775,7 @@
}
},
"404": {
- "description": "The Number or group is unavailable.",
+ "description": "The Connection or group is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -50518,7 +50796,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "description": "The Connection has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
"content": {
"application/json": {
"schema": {
@@ -50589,7 +50867,7 @@
}
},
"429": {
- "description": "WhatsApp is limiting group requests from this number (`whatsapp_rate_limited`).",
+ "description": "WhatsApp is limiting group requests from this connection (`whatsapp_rate_limited`).",
"content": {
"application/json": {
"schema": {
@@ -50659,22 +50937,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/official-groups/{group}/invite-link": {
+ "/messaging/{connection}/official-groups/{group}/invite-link": {
"get": {
"operationId": "getOfficialGroupInviteLink",
"tags": [
"Official groups"
],
"summary": "Get an Official group invite link",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`\n\nReturns the link people open to join the group. Participants can only join with the link. Beta: requires team enrollment and a Number with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`\n\nReturns the link people open to join the group. Participants can only join with the link. Beta: requires team enrollment and a Connection with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
"security": [
{
"BearerAuth": []
@@ -50686,10 +50961,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -50790,7 +51065,7 @@
}
},
"403": {
- "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the number is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
+ "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the connection is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
"content": {
"application/json": {
"schema": {
@@ -50811,7 +51086,7 @@
}
},
"404": {
- "description": "The Number or group is unavailable.",
+ "description": "The Connection or group is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -50832,7 +51107,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`).",
+ "description": "The Connection has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`).",
"content": {
"application/json": {
"schema": {
@@ -50853,7 +51128,7 @@
}
},
"429": {
- "description": "WhatsApp is limiting group requests from this number (`whatsapp_rate_limited`).",
+ "description": "WhatsApp is limiting group requests from this connection (`whatsapp_rate_limited`).",
"content": {
"application/json": {
"schema": {
@@ -50916,22 +51191,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:read "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/official-groups/{group}/invite-link/reset": {
+ "/messaging/{connection}/official-groups/{group}/invite-link/reset": {
"post": {
"operationId": "resetOfficialGroupInviteLink",
"tags": [
"Official groups"
],
"summary": "Reset an Official group invite link",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nCreates a new invite link. Every earlier link stops working. Beta: requires team enrollment and a Number with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nCreates a new invite link. Every earlier link stops working. Beta: requires team enrollment and a Connection with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
"security": [
{
"BearerAuth": []
@@ -50943,10 +51215,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -51067,7 +51339,7 @@
}
},
"403": {
- "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the number is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
+ "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the connection is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
"content": {
"application/json": {
"schema": {
@@ -51088,7 +51360,7 @@
}
},
"404": {
- "description": "The Number or group is unavailable.",
+ "description": "The Connection or group is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -51109,7 +51381,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "description": "The Connection has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
"content": {
"application/json": {
"schema": {
@@ -51180,7 +51452,7 @@
}
},
"429": {
- "description": "WhatsApp is limiting group requests from this number (`whatsapp_rate_limited`).",
+ "description": "WhatsApp is limiting group requests from this connection (`whatsapp_rate_limited`).",
"content": {
"application/json": {
"schema": {
@@ -51250,22 +51522,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/official-groups/{group}/participants/remove": {
+ "/messaging/{connection}/official-groups/{group}/participants/remove": {
"post": {
"operationId": "removeOfficialGroupParticipants",
"tags": [
"Official groups"
],
"summary": "Remove Official group participants",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nRemoves up to eight participants. A removed participant cannot rejoin with the invite link. A `group.participant` event reports each removal. Beta: requires team enrollment and a Number with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nRemoves up to eight participants. A removed participant cannot rejoin with the invite link. A `group.participant` event reports each removal. Beta: requires team enrollment and a Connection with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
"security": [
{
"BearerAuth": []
@@ -51277,10 +51546,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -51411,7 +51680,7 @@
}
},
"403": {
- "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the number is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
+ "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the connection is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
"content": {
"application/json": {
"schema": {
@@ -51432,7 +51701,7 @@
}
},
"404": {
- "description": "The Number or group is unavailable.",
+ "description": "The Connection or group is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -51453,7 +51722,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "description": "The Connection has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
"content": {
"application/json": {
"schema": {
@@ -51524,7 +51793,7 @@
}
},
"429": {
- "description": "WhatsApp is limiting group requests from this number (`whatsapp_rate_limited`).",
+ "description": "WhatsApp is limiting group requests from this connection (`whatsapp_rate_limited`).",
"content": {
"application/json": {
"schema": {
@@ -51594,22 +51863,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/official-groups/{group}/join-requests": {
+ "/messaging/{connection}/official-groups/{group}/join-requests": {
"get": {
"operationId": "listOfficialGroupJoinRequests",
"tags": [
"Official groups"
],
"summary": "List Official group join requests",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`\n\nLists open requests to join a group that requires join approval. Beta: requires team enrollment and a Number with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`\n\nLists open requests to join a group that requires join approval. Beta: requires team enrollment and a Connection with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
"security": [
{
"BearerAuth": []
@@ -51621,10 +51887,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -51745,7 +52011,7 @@
}
},
"403": {
- "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the number is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
+ "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the connection is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
"content": {
"application/json": {
"schema": {
@@ -51766,7 +52032,7 @@
}
},
"404": {
- "description": "The Number or group is unavailable.",
+ "description": "The Connection or group is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -51787,7 +52053,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`).",
+ "description": "The Connection has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`).",
"content": {
"application/json": {
"schema": {
@@ -51808,7 +52074,7 @@
}
},
"429": {
- "description": "WhatsApp is limiting group requests from this number (`whatsapp_rate_limited`).",
+ "description": "WhatsApp is limiting group requests from this connection (`whatsapp_rate_limited`).",
"content": {
"application/json": {
"schema": {
@@ -51871,22 +52137,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:read "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/official-groups/{group}/join-requests/approve": {
+ "/messaging/{connection}/official-groups/{group}/join-requests/approve": {
"post": {
"operationId": "approveOfficialGroupJoinRequests",
"tags": [
"Official groups"
],
"summary": "Approve Official group join requests",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nApproves open join requests. Approved people can join with the invite link. Requests WhatsApp could not approve are listed in `failed`. Beta: requires team enrollment and a Number with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nApproves open join requests. Approved people can join with the invite link. Requests WhatsApp could not approve are listed in `failed`. Beta: requires team enrollment and a Connection with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
"security": [
{
"BearerAuth": []
@@ -51898,10 +52161,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -52032,7 +52295,7 @@
}
},
"403": {
- "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the number is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
+ "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the connection is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
"content": {
"application/json": {
"schema": {
@@ -52053,7 +52316,7 @@
}
},
"404": {
- "description": "The Number or group is unavailable.",
+ "description": "The Connection or group is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -52074,7 +52337,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "description": "The Connection has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
"content": {
"application/json": {
"schema": {
@@ -52145,7 +52408,7 @@
}
},
"429": {
- "description": "WhatsApp is limiting group requests from this number (`whatsapp_rate_limited`).",
+ "description": "WhatsApp is limiting group requests from this connection (`whatsapp_rate_limited`).",
"content": {
"application/json": {
"schema": {
@@ -52215,22 +52478,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/official-groups/{group}/join-requests/reject": {
+ "/messaging/{connection}/official-groups/{group}/join-requests/reject": {
"post": {
"operationId": "rejectOfficialGroupJoinRequests",
"tags": [
"Official groups"
],
"summary": "Reject Official group join requests",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nRejects open join requests. The person can request to join again. Requests WhatsApp could not reject are listed in `failed`. Beta: requires team enrollment and a Number with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nRejects open join requests. The person can request to join again. Requests WhatsApp could not reject are listed in `failed`. Beta: requires team enrollment and a Connection with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
"security": [
{
"BearerAuth": []
@@ -52242,10 +52502,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -52376,7 +52636,7 @@
}
},
"403": {
- "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the number is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
+ "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the connection is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
"content": {
"application/json": {
"schema": {
@@ -52397,7 +52657,7 @@
}
},
"404": {
- "description": "The Number or group is unavailable.",
+ "description": "The Connection or group is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -52418,7 +52678,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "description": "The Connection has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
"content": {
"application/json": {
"schema": {
@@ -52489,7 +52749,7 @@
}
},
"429": {
- "description": "WhatsApp is limiting group requests from this number (`whatsapp_rate_limited`).",
+ "description": "WhatsApp is limiting group requests from this connection (`whatsapp_rate_limited`).",
"content": {
"application/json": {
"schema": {
@@ -52559,22 +52819,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/official-groups/{group}/picture": {
+ "/messaging/{connection}/official-groups/{group}/picture": {
"put": {
"operationId": "setOfficialGroupPicture",
"tags": [
"Official groups"
],
"summary": "Set an Official group picture",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `groups:manage`\n\nReplaces the group's profile picture. Send `multipart/form-data` with one `file` part: a square JPEG of at least 192 x 192 pixels and at most 5 MB. A `group.update` event with action `settings_updated` reports whether WhatsApp applied it. Repeating the same upload is safe. Beta: requires team enrollment and a Number with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `groups:manage`\n\nReplaces the group's profile picture. Send `multipart/form-data` with one `file` part: a square JPEG of at least 192 x 192 pixels and at most 5 MB. A `group.update` event with action `settings_updated` reports whether WhatsApp applied it. Repeating the same upload is safe. Beta: requires team enrollment and a Connection with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
"security": [
{
"BearerAuth": []
@@ -52586,10 +52843,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -52700,7 +52957,7 @@
}
},
"403": {
- "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the number is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
+ "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the connection is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
"content": {
"application/json": {
"schema": {
@@ -52721,7 +52978,7 @@
}
},
"404": {
- "description": "The Number or group is unavailable.",
+ "description": "The Connection or group is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -52742,7 +52999,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`).",
+ "description": "The Connection has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`).",
"content": {
"application/json": {
"schema": {
@@ -52784,7 +53041,7 @@
}
},
"429": {
- "description": "WhatsApp is limiting group requests from this number (`whatsapp_rate_limited`).",
+ "description": "WhatsApp is limiting group requests from this connection (`whatsapp_rate_limited`).",
"content": {
"application/json": {
"schema": {
@@ -52868,22 +53125,19 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API groups:manage "
- },
"x-protocols": [
"Meta Cloud API"
]
}
},
- "/messaging/{session}/official-groups/{group}/pins": {
+ "/messaging/{connection}/official-groups/{group}/pins": {
"post": {
"operationId": "pinOfficialGroupMessage",
"tags": [
"Official groups"
],
"summary": "Pin or unpin an Official group message",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nPins a message for 1 to 30 days, or unpins it. At most three messages stay pinned; a new pin unpins the oldest. Beta: requires team enrollment and a Number with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:manage`\n\nPins a message for 1 to 30 days, or unpins it. At most three messages stay pinned; a new pin unpins the oldest. Beta: requires team enrollment and a Connection with an Official API connection whose WhatsApp Business Account is an Official Business Account.",
"security": [
{
"BearerAuth": []
@@ -52895,10 +53149,10 @@
"schema": {
"type": "string",
"minLength": 1,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -53029,7 +53283,7 @@
}
},
"403": {
- "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the number is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
+ "description": "The credential lacks the scope, the team is not enrolled in the beta (`feature_unavailable`), the connection is not eligible for groups (`whatsapp_groups_ineligible`), group creation is paused (`whatsapp_group_creation_paused`), or the group is suspended (`whatsapp_group_suspended`).",
"content": {
"application/json": {
"schema": {
@@ -53050,7 +53304,7 @@
}
},
"404": {
- "description": "The Number or group is unavailable.",
+ "description": "The Connection or group is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -53071,7 +53325,7 @@
}
},
"409": {
- "description": "The Number has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "description": "The Connection has no Official API connection (`unsupported_for_connection`), or a WhatsApp group limit was reached (`whatsapp_group_limit_reached`, `whatsapp_group_full`). The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
"content": {
"application/json": {
"schema": {
@@ -53142,7 +53396,7 @@
}
},
"429": {
- "description": "WhatsApp is limiting group requests from this number (`whatsapp_rate_limited`).",
+ "description": "WhatsApp is limiting group requests from this connection (`whatsapp_rate_limited`).",
"content": {
"application/json": {
"schema": {
@@ -53212,38 +53466,35 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API groups:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/marketing-messages/status": {
+ "/messaging/{connection}/marketing-messages/status": {
"get": {
"operationId": "getMarketingMessagesStatus",
"tags": [
"Marketing Messages"
],
"summary": "Get Marketing Messages onboarding status",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `sessions:read`\n\nReads WhatsApp's Marketing Messages onboarding status, terms of service state and Cloud API marketing setting for the Number's WhatsApp Business Account. The status can change between this read and a send; WhatsApp decides each send. Beta: requires team enrollment and a Number with an Official API connection.",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `connections:read`\n\nReads WhatsApp's Marketing Messages onboarding status, terms of service state and Cloud API marketing setting for the Connection's WhatsApp Business Account. The status can change between this read and a send; WhatsApp decides each send. Beta: requires team enrollment and a Connection with an Official API connection.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
- "description": "Number ID."
+ "description": "Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -53270,7 +53521,7 @@
}
},
"400": {
- "description": "The Number ID fails validation (`invalid_parameter`); it must contain 1 to 128 characters.",
+ "description": "The Connection ID fails validation (`invalid_parameter`); it must contain 1 to 128 characters.",
"content": {
"application/json": {
"schema": {
@@ -53312,7 +53563,7 @@
}
},
"403": {
- "description": "The credential lacks `sessions:read`, or the team is not enrolled in the beta (`feature_unavailable`).",
+ "description": "The credential lacks `connections:read`, or the team is not enrolled in the beta (`feature_unavailable`).",
"content": {
"application/json": {
"schema": {
@@ -53333,7 +53584,7 @@
}
},
"404": {
- "description": "The Number is unavailable.",
+ "description": "The Connection is unavailable.",
"content": {
"application/json": {
"schema": {
@@ -53354,7 +53605,7 @@
}
},
"409": {
- "description": "The Number has no connected Official API account, for example a Linked Devices or test Number (`unsupported_for_connection`).",
+ "description": "The Connection has no connected Official API account, for example a Linked Devices or test Connection (`unsupported_for_connection`).",
"content": {
"application/json": {
"schema": {
@@ -53417,21 +53668,18 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API sessions:read "
- },
"x-protocols": [
"Meta Cloud API"
]
}
},
- "/messaging/{session}/contacts": {
+ "/messaging/{connection}/contacts": {
"get": {
"operationId": "listContacts",
"tags": [
"Contacts"
],
- "summary": "List all contacts known to the session",
+ "summary": "List all contacts known to the connection",
"security": [
{
"BearerAuth": []
@@ -53444,7 +53692,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -53631,16 +53879,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API contacts:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `contacts:read`"
}
},
- "/messaging/{session}/contacts/check": {
+ "/messaging/{connection}/contacts/check": {
"get": {
"operationId": "checkContacts",
"tags": [
@@ -53659,7 +53904,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -53867,16 +54112,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API contacts:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `contacts:read`"
}
},
- "/messaging/{session}/contacts/blocked": {
+ "/messaging/{connection}/contacts/blocked": {
"get": {
"operationId": "getBlocklist",
"tags": [
@@ -53895,7 +54137,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -54082,16 +54324,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API contacts:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `contacts:read`"
}
},
- "/messaging/{session}/contacts/{contactId}": {
+ "/messaging/{connection}/contacts/{contactId}": {
"get": {
"operationId": "getContact",
"tags": [
@@ -54110,7 +54349,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -54306,16 +54545,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API contacts:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `contacts:read`"
}
},
- "/messaging/{session}/contacts/{contactId}/picture": {
+ "/messaging/{connection}/contacts/{contactId}/picture": {
"get": {
"operationId": "getContactPicture",
"tags": [
@@ -54334,7 +54570,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -54530,16 +54766,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API contacts:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `contacts:read`"
}
},
- "/messaging/{session}/contacts/{contactId}/info": {
+ "/messaging/{connection}/contacts/{contactId}/info": {
"get": {
"operationId": "getUserInfo",
"tags": [
@@ -54558,7 +54791,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -54754,16 +54987,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API contacts:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `contacts:read`"
}
},
- "/messaging/{session}/contacts/{contactId}/devices": {
+ "/messaging/{connection}/contacts/{contactId}/devices": {
"get": {
"operationId": "getUserDevices",
"tags": [
@@ -54782,7 +55012,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -54978,16 +55208,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API contacts:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `contacts:read`"
}
},
- "/messaging/{session}/contacts/{contactId}/business-profile": {
+ "/messaging/{connection}/contacts/{contactId}/business-profile": {
"get": {
"operationId": "getBusinessProfile",
"tags": [
@@ -55006,7 +55233,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -55202,16 +55429,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API contacts:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `contacts:read`"
}
},
- "/messaging/{session}/contacts/{contactId}/block": {
+ "/messaging/{connection}/contacts/{contactId}/block": {
"post": {
"operationId": "blockContact",
"tags": [
@@ -55230,7 +55454,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -55426,16 +55650,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API contacts:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `contacts:manage`"
}
},
- "/messaging/{session}/contacts/{contactId}/unblock": {
+ "/messaging/{connection}/contacts/{contactId}/unblock": {
"post": {
"operationId": "unblockContact",
"tags": [
@@ -55454,7 +55675,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -55650,16 +55871,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API contacts:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `contacts:manage`"
}
},
- "/messaging/{session}/stickers/favorite": {
+ "/messaging/{connection}/stickers/favorite": {
"put": {
"security": [
{
@@ -55679,7 +55897,7 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -55908,16 +56126,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/stickers/recents/remove": {
+ "/messaging/{connection}/stickers/recents/remove": {
"post": {
"security": [
{
@@ -55937,7 +56152,7 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -56166,16 +56381,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/stickers/reuploads": {
+ "/messaging/{connection}/stickers/reuploads": {
"post": {
"security": [
{
@@ -56196,7 +56408,7 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -56425,15 +56637,12 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API media:read "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/stickers/recents/bootstrap": {
+ "/messaging/{connection}/stickers/recents/bootstrap": {
"post": {
"security": [
{
@@ -56454,7 +56663,7 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -56673,15 +56882,12 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API messages:read "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/business/linked-accounts": {
+ "/messaging/{connection}/business/linked-accounts": {
"get": {
"operationId": "getBusinessLinkedAccounts",
"tags": [
@@ -56700,7 +56906,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -56887,16 +57093,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API business:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `business:read`"
}
},
- "/messaging/{session}/business/eligibility": {
+ "/messaging/{connection}/business/eligibility": {
"get": {
"operationId": "getBusinessEligibility",
"tags": [
@@ -56915,7 +57118,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -57102,16 +57305,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API business:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `business:read`"
}
},
- "/messaging/{session}/business/profile": {
+ "/messaging/{connection}/business/profile": {
"get": {
"operationId": "getOwnBusinessProfile",
"tags": [
@@ -57130,7 +57330,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -57317,9 +57517,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -57343,7 +57540,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -57540,16 +57737,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/profile/cover-photo": {
+ "/messaging/{connection}/business/profile/cover-photo": {
"put": {
"operationId": "setBusinessCoverPhoto",
"tags": [
@@ -57568,7 +57762,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -57765,16 +57959,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/profile/cover-photo/{coverPhotoId}": {
+ "/messaging/{connection}/business/profile/cover-photo/{coverPhotoId}": {
"delete": {
"operationId": "deleteBusinessCoverPhoto",
"tags": [
@@ -57793,7 +57984,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -57990,16 +58181,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/compliance": {
+ "/messaging/{connection}/business/compliance": {
"get": {
"operationId": "getBusinessMerchantCompliance",
"tags": [
@@ -58018,7 +58206,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -58205,9 +58393,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -58231,7 +58416,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -58428,16 +58613,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/quick-replies": {
+ "/messaging/{connection}/business/quick-replies": {
"post": {
"operationId": "createBusinessQuickReply",
"tags": [
@@ -58456,7 +58638,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -58653,9 +58835,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
@@ -58679,7 +58858,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -58866,16 +59045,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:read`"
}
},
- "/messaging/{session}/business/quick-replies/{quickReplyId}": {
+ "/messaging/{connection}/business/quick-replies/{quickReplyId}": {
"put": {
"operationId": "setBusinessQuickReply",
"tags": [
@@ -58894,7 +59070,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -59102,9 +59278,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
@@ -59128,7 +59301,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -59326,16 +59499,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/catalog": {
+ "/messaging/{connection}/business/catalog": {
"get": {
"operationId": "getBusinessCatalog",
"tags": [
@@ -59354,7 +59524,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -59622,9 +59792,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API business:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -59648,7 +59815,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -59835,16 +60002,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/catalog/cart": {
+ "/messaging/{connection}/business/catalog/cart": {
"patch": {
"operationId": "setBusinessCartEnabled",
"tags": [
@@ -59863,7 +60027,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -60060,16 +60224,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/products/{productId}": {
+ "/messaging/{connection}/business/products/{productId}": {
"get": {
"operationId": "getBusinessProduct",
"tags": [
@@ -60088,7 +60249,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -60326,9 +60487,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API business:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -60352,7 +60510,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -60558,9 +60716,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
@@ -60584,7 +60739,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -60780,16 +60935,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/products": {
+ "/messaging/{connection}/business/products": {
"post": {
"operationId": "createBusinessProduct",
"tags": [
@@ -60808,7 +60960,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -61005,16 +61157,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/products/{productId}/visibility": {
+ "/messaging/{connection}/business/products/{productId}/visibility": {
"patch": {
"operationId": "setBusinessProductVisibility",
"tags": [
@@ -61033,7 +61182,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -61239,16 +61388,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/products/{productId}/appeal": {
+ "/messaging/{connection}/business/products/{productId}/appeal": {
"post": {
"operationId": "appealBusinessProduct",
"tags": [
@@ -61267,7 +61413,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -61473,16 +61619,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/collections": {
+ "/messaging/{connection}/business/collections": {
"get": {
"operationId": "getBusinessCollections",
"tags": [
@@ -61501,7 +61644,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -61779,9 +61922,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API business:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -61805,7 +61945,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -62002,16 +62142,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/collections/{collectionId}": {
+ "/messaging/{connection}/business/collections/{collectionId}": {
"get": {
"operationId": "getBusinessCollection",
"tags": [
@@ -62030,7 +62167,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -62307,9 +62444,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API business:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -62333,7 +62467,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -62539,9 +62673,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
@@ -62565,7 +62696,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -62761,16 +62892,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/collections/reorder": {
+ "/messaging/{connection}/business/collections/reorder": {
"post": {
"operationId": "reorderBusinessCollections",
"tags": [
@@ -62789,7 +62917,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -62986,16 +63114,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/collections/{collectionId}/appeal": {
+ "/messaging/{connection}/business/collections/{collectionId}/appeal": {
"post": {
"operationId": "appealBusinessCollection",
"tags": [
@@ -63014,7 +63139,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -63220,16 +63345,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/business/orders/{orderId}/lookup": {
+ "/messaging/{connection}/business/orders/{orderId}/lookup": {
"post": {
"operationId": "getBusinessOrder",
"tags": [
@@ -63248,7 +63370,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -63486,16 +63608,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API business:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `business:read`"
}
},
- "/messaging/{session}/identities/resolve": {
+ "/messaging/{connection}/identities/resolve": {
"get": {
"operationId": "resolveIdentity",
"tags": [
@@ -63514,7 +63633,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -63737,16 +63856,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API contacts:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `contacts:read`"
}
},
- "/messaging/{session}/users/{id}/security-code": {
+ "/messaging/{connection}/users/{id}/security-code": {
"get": {
"operationId": "getUserSecurityCode",
"tags": [
@@ -63765,7 +63881,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -63961,22 +64077,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API contacts:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `contacts:read`"
}
},
- "/messaging/{session}/channels": {
+ "/messaging/{connection}/channels": {
"get": {
"operationId": "listChannels",
"tags": [
"Channels"
],
- "summary": "List channels the session follows",
+ "summary": "List channels the connection follows",
"security": [
{
"BearerAuth": []
@@ -63989,7 +64102,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -64176,9 +64289,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API channels:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -64202,7 +64312,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -64398,16 +64508,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API channels:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `channels:manage`"
}
},
- "/messaging/{session}/channels/{id}": {
+ "/messaging/{connection}/channels/{id}": {
"get": {
"operationId": "getChannel",
"tags": [
@@ -64426,7 +64533,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -64622,9 +64729,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API channels:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -64648,7 +64752,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -64876,16 +64980,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API channels:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `channels:manage`"
}
},
- "/messaging/{session}/channels/{id}/messages": {
+ "/messaging/{connection}/channels/{id}/messages": {
"get": {
"operationId": "listChannelMessages",
"tags": [
@@ -64904,7 +65005,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -65121,16 +65222,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API channels:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `channels:read`"
}
},
- "/messaging/{session}/channels/{id}/message-updates": {
+ "/messaging/{connection}/channels/{id}/message-updates": {
"get": {
"operationId": "listChannelMessageUpdates",
"tags": [
@@ -65149,7 +65247,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -65376,16 +65474,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API channels:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `channels:read`"
}
},
- "/messaging/{session}/channels/{id}/messages/{messageId}/viewed": {
+ "/messaging/{connection}/channels/{id}/messages/{messageId}/viewed": {
"post": {
"operationId": "markChannelMessageViewed",
"tags": [
@@ -65404,7 +65499,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -65609,16 +65704,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API channels:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `channels:manage`"
}
},
- "/messaging/{session}/channels/{id}/messages/{messageId}/reaction": {
+ "/messaging/{connection}/channels/{id}/messages/{messageId}/reaction": {
"post": {
"operationId": "reactToChannelMessage",
"tags": [
@@ -65637,7 +65729,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -65990,16 +66082,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API channels:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `channels:manage`"
}
},
- "/messaging/{session}/channels/{id}/live-updates": {
+ "/messaging/{connection}/channels/{id}/live-updates": {
"post": {
"operationId": "subscribeChannelLiveUpdates",
"tags": [
@@ -66018,7 +66107,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -66214,16 +66303,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API channels:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `channels:read`"
}
},
- "/messaging/{session}/channels/{id}/follow": {
+ "/messaging/{connection}/channels/{id}/follow": {
"post": {
"operationId": "followChannel",
"tags": [
@@ -66242,7 +66328,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -66438,16 +66524,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API channels:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `channels:manage`"
}
},
- "/messaging/{session}/channels/{id}/unfollow": {
+ "/messaging/{connection}/channels/{id}/unfollow": {
"post": {
"operationId": "unfollowChannel",
"tags": [
@@ -66466,7 +66549,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -66662,16 +66745,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API channels:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `channels:manage`"
}
},
- "/messaging/{session}/channels/{id}/mute": {
+ "/messaging/{connection}/channels/{id}/mute": {
"post": {
"operationId": "muteChannel",
"tags": [
@@ -66690,7 +66770,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -66886,16 +66966,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API channels:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `channels:manage`"
}
},
- "/messaging/{session}/channels/{id}/unmute": {
+ "/messaging/{connection}/channels/{id}/unmute": {
"post": {
"operationId": "unmuteChannel",
"tags": [
@@ -66914,7 +66991,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -67110,22 +67187,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API channels:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `channels:manage`"
}
},
- "/messaging/{session}/presence": {
+ "/messaging/{connection}/presence": {
"post": {
"operationId": "setPresence",
"tags": [
"Presence"
],
- "summary": "Set the session's own presence (available / unavailable)",
+ "summary": "Set the connection's own presence (available / unavailable)",
"security": [
{
"BearerAuth": []
@@ -67138,7 +67212,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -67355,9 +67429,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API presence:write "
- },
"x-protocols": [
"Linked Device API"
],
@@ -67368,7 +67439,7 @@
"tags": [
"Presence"
],
- "summary": "Get the session's own presence",
+ "summary": "Get the connection's own presence",
"security": [
{
"BearerAuth": []
@@ -67381,7 +67452,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -67568,16 +67639,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API presence:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `presence:read`"
}
},
- "/messaging/{session}/presence/{conversation}": {
+ "/messaging/{connection}/presence/{conversation}": {
"get": {
"operationId": "getChatPresence",
"tags": [
@@ -67596,7 +67664,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -67791,16 +67859,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API presence:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `presence:read`"
}
},
- "/messaging/{session}/presence/{conversation}/subscribe": {
+ "/messaging/{connection}/presence/{conversation}/subscribe": {
"post": {
"operationId": "subscribePresence",
"tags": [
@@ -67819,7 +67884,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -68003,7 +68068,7 @@
}
},
"429": {
- "description": "Observation limit exceeded, or the session is inside the suspension window that follows",
+ "description": "Observation limit exceeded, or the connection is inside the suspension window that follows",
"content": {
"application/json": {
"schema": {
@@ -68067,9 +68132,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API presence:observe "
- },
"x-protocols": [
"Linked Device API"
],
@@ -68088,7 +68150,7 @@
"BearerAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -68283,10 +68345,7 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
- "description": "**Required scope:** `sessions:read`"
+ "description": "**Required scope:** `connections:read`"
},
"put": {
"operationId": "updateProjectSafeMode",
@@ -68294,13 +68353,13 @@
"Safe Mode"
],
"summary": "Set a project's Safe Mode ceiling",
- "description": "**Required scope:** `sessions:manage`\n\nSets the most visible behaviour any number in this project may use. Presence and read receipts are visible to the people this number messages: turning them on makes the number appear online, exposes last-seen subject to the account's privacy settings, and puts blue ticks on incoming messages. Every axis is off by default and only this request changes it.",
+ "description": "**Required scope:** `connections:manage`\n\nSets the most visible behaviour any connection in this project may use. Presence and read receipts are visible to the people this connection messages: turning them on makes the connection appear online, exposes last-seen subject to the account's privacy settings, and puts blue ticks on incoming messages. Every axis is off by default and only this request changes it.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -68453,7 +68512,7 @@
}
},
"402": {
- "description": "`safe_mode_not_entitled`: Safe Mode is part of BanSafe Lite, which is not included on this number's plan",
+ "description": "`safe_mode_not_entitled`: Safe Mode is part of BanSafe Lite, which is not included on this connection's plan",
"content": {
"application/json": {
"schema": {
@@ -68463,7 +68522,7 @@
"error": {
"type": "billing_error",
"code": "safe_mode_not_entitled",
- "message": "Safe Mode is not included on this number’s plan.",
+ "message": "Safe Mode is not included on this connection’s plan.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -68581,7 +68640,7 @@
}
},
"503": {
- "description": "Stored, but a connected number did not confirm the policy; retry the request",
+ "description": "Stored, but a connected connection did not confirm the policy; retry the request",
"content": {
"application/json": {
"schema": {
@@ -68612,25 +68671,22 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
- "/messaging/{session}/safe-mode": {
+ "/messaging/{connection}/safe-mode": {
"get": {
- "operationId": "getSessionSafeMode",
+ "operationId": "getConnectionSafeMode",
"tags": [
"Safe Mode"
],
- "summary": "Get a number's effective Safe Mode",
+ "summary": "Get a connection's effective Safe Mode",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -68638,17 +68694,17 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
"responses": {
"200": {
- "description": "Project ceiling, number override, the effective policy, and whether the plan includes BanSafe Lite",
+ "description": "Project ceiling, connection override, the effective policy, and whether the plan includes BanSafe Lite",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GetSessionSafeModeResponse"
+ "$ref": "#/components/schemas/GetConnectionSafeModeResponse"
}
}
},
@@ -68825,27 +68881,24 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:read "
- },
"x-protocols": [
"Linked Device API"
],
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:read`"
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:read`"
},
"put": {
- "operationId": "updateSessionSafeMode",
+ "operationId": "updateConnectionSafeMode",
"tags": [
"Safe Mode"
],
- "summary": "Set a number's Safe Mode override",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:manage`\n\nSets one number's Safe Mode. Each axis accepts `inherit` to follow the project ceiling. An override may only be equally or more conservative than the ceiling; a more visible value is refused with `safe_mode_exceeds_project_ceiling`.",
+ "summary": "Set a connection's Safe Mode override",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:manage`\n\nSets one connection's Safe Mode. Each axis accepts `inherit` to follow the project ceiling. An override may only be equally or more conservative than the ceiling; a more visible value is refused with `safe_mode_exceeds_project_ceiling`.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -68853,7 +68906,7 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -68907,11 +68960,11 @@
},
"responses": {
"200": {
- "description": "Number Safe Mode override updated",
+ "description": "Connection Safe Mode override updated",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UpdateSessionSafeModeResponse"
+ "$ref": "#/components/schemas/UpdateConnectionSafeModeResponse"
}
}
},
@@ -68992,7 +69045,7 @@
}
},
"402": {
- "description": "`safe_mode_not_entitled`: Safe Mode is part of BanSafe Lite, which is not included on this number's plan",
+ "description": "`safe_mode_not_entitled`: Safe Mode is part of BanSafe Lite, which is not included on this connection's plan",
"content": {
"application/json": {
"schema": {
@@ -69002,7 +69055,7 @@
"error": {
"type": "billing_error",
"code": "safe_mode_not_entitled",
- "message": "Safe Mode is not included on this number’s plan.",
+ "message": "Safe Mode is not included on this connection’s plan.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -69120,7 +69173,7 @@
}
},
"503": {
- "description": "Stored, but a connected number did not confirm the policy; retry the request",
+ "description": "Stored, but a connected connection did not confirm the policy; retry the request",
"content": {
"application/json": {
"schema": {
@@ -69152,9 +69205,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:manage "
- },
"x-protocols": [
"Linked Device API"
]
@@ -69172,7 +69222,7 @@
"BearerAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -69367,10 +69417,7 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
- "description": "**Required scope:** `sessions:read`"
+ "description": "**Required scope:** `connections:read`"
},
"put": {
"operationId": "updateProjectWarmupPlan",
@@ -69378,13 +69425,13 @@
"Warm-up plan"
],
"summary": "Set a project's warm-up plan",
- "description": "**Required scope:** `sessions:manage`\n\nTurns the warm-up plan on or off for a project and sets how long the ramp takes and how many messages a number may send on its first day. While the plan is on, a send past a number's allowance is refused with `bansafe_daily_allowance_reached` and campaign recipients are deferred to the next reset.",
+ "description": "**Required scope:** `connections:manage`\n\nTurns the warm-up plan on or off for a project and sets how long the ramp takes and how many messages a connection may send on its first day. While the plan is on, a send past a connection's allowance is refused with `bansafe_daily_allowance_reached` and campaign recipients are deferred to the next reset.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -69636,7 +69683,7 @@
}
},
"503": {
- "description": "Stored, but a connected number did not confirm the plan; retry the request",
+ "description": "Stored, but a connected connection did not confirm the plan; retry the request",
"content": {
"application/json": {
"schema": {
@@ -69667,9 +69714,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
@@ -69685,7 +69729,7 @@
"BearerAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -69880,10 +69924,7 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
- "description": "**Required scope:** `sessions:read`"
+ "description": "**Required scope:** `connections:read`"
},
"put": {
"operationId": "updateProjectHealthPolicy",
@@ -69891,13 +69932,13 @@
"BanSafe"
],
"summary": "Set a project's health policy",
- "description": "**Required scope:** `sessions:manage`\n\nReplaces the project policy when version matches the stored version. The rule triggers only when an available health estimate is below threshold. Stopping disconnects a session while retaining its linked credentials; logging out requires relinking.",
+ "description": "**Required scope:** `connections:manage`\n\nReplaces the project policy when version matches the stored version. The rule triggers only when an available health estimate is below threshold. Stopping disconnects a connection while retaining its linked credentials; logging out requires relinking.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -70133,9 +70174,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
@@ -70146,13 +70184,13 @@
"Ban insurance"
],
"summary": "Get Ban Credit evidence setting",
- "description": "**Required scope:** `sessions:read`\n\nBan Credit evidence lets Polymorfa measure what the other devices linked to a number do with it: how many messages they send, to how many people, how fast, and in which hours. Only counts are kept, never messages, contacts, or device names. With it off, a claim can still be filed, but Polymorfa cannot say whether another device caused the ban and a person decides the claim.",
+ "description": "**Required scope:** `connections:read`\n\nBan Credit evidence lets Polymorfa measure what the other devices linked to a connection do with it: how many messages they send, to how many people, how fast, and in which hours. Only counts are kept, never messages, contacts, or device names. With it off, a claim can still be filed, but Polymorfa cannot say whether another device caused the ban and a person decides the claim.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -70346,9 +70384,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:read "
}
},
"put": {
@@ -70357,13 +70392,13 @@
"Ban insurance"
],
"summary": "Set Ban Credit evidence setting",
- "description": "**Required scope:** `sessions:manage`\n\nBan Credit evidence lets Polymorfa measure what the other devices linked to a number do with it: how many messages they send, to how many people, how fast, and in which hours. Only counts are kept, never messages, contacts, or device names. With it off, a claim can still be filed, but Polymorfa cannot say whether another device caused the ban and a person decides the claim.",
+ "description": "**Required scope:** `connections:manage`\n\nBan Credit evidence lets Polymorfa measure what the other devices linked to a connection do with it: how many messages they send, to how many people, how fast, and in which hours. Only counts are kept, never messages, contacts, or device names. With it off, a claim can still be filed, but Polymorfa cannot say whether another device caused the ban and a person decides the claim.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -70576,7 +70611,7 @@
}
},
"503": {
- "description": "Stored, but a connected number did not confirm the change; retry the request",
+ "description": "Stored, but a connected connection did not confirm the change; retry the request",
"content": {
"application/json": {
"schema": {
@@ -70607,9 +70642,6 @@
}
}
}
- },
- "x-mint": {
- "content": "sessions:manage "
}
}
},
@@ -70821,15 +70853,12 @@
}
}
},
- "x-mint": {
- "content": "presence:read "
- },
"description": "**Required scope:** `presence:read`"
}
},
- "/messaging/{session}/observation-policy": {
+ "/messaging/{connection}/observation-policy": {
"get": {
- "operationId": "getSessionObservationPolicy",
+ "operationId": "getConnectionObservationPolicy",
"tags": [
"Presence",
"Labels",
@@ -70848,17 +70877,17 @@
"minLength": 1
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
"responses": {
"200": {
- "description": "Effective session observation policy",
+ "description": "Effective connection observation policy",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/GetSessionObservationPolicyResponse"
+ "$ref": "#/components/schemas/GetConnectionObservationPolicyResponse"
}
}
},
@@ -71035,22 +71064,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API presence:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `presence:read`"
}
},
- "/messaging/{session}/profile": {
+ "/messaging/{connection}/profile": {
"get": {
"operationId": "getProfile",
"tags": [
"Profile"
],
- "summary": "Get the session's own profile",
+ "summary": "Get the connection's own profile",
"security": [
{
"BearerAuth": []
@@ -71063,7 +71089,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -71250,16 +71276,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:read`"
}
},
- "/messaging/{session}/profile/name": {
+ "/messaging/{connection}/profile/name": {
"put": {
"operationId": "setProfileName",
"tags": [
@@ -71278,7 +71301,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -71474,16 +71497,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/profile/status": {
+ "/messaging/{connection}/profile/status": {
"put": {
"operationId": "setProfileStatus",
"tags": [
@@ -71502,7 +71522,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -71698,16 +71718,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/profile/picture": {
+ "/messaging/{connection}/profile/picture": {
"put": {
"operationId": "setProfilePicture",
"tags": [
@@ -71726,7 +71743,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -71922,9 +71939,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
@@ -71948,7 +71962,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -72135,16 +72149,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/privacy": {
+ "/messaging/{connection}/privacy": {
"get": {
"operationId": "getPrivacySettings",
"tags": [
@@ -72163,7 +72174,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -72350,16 +72361,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:read`"
}
},
- "/messaging/{session}/privacy/disappearing/default": {
+ "/messaging/{connection}/privacy/disappearing/default": {
"put": {
"operationId": "setDefaultDisappearingTimer",
"tags": [
@@ -72378,7 +72386,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -72574,16 +72582,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/privacy/{setting}": {
+ "/messaging/{connection}/privacy/{setting}": {
"put": {
"operationId": "setPrivacySetting",
"tags": [
@@ -72602,7 +72607,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -72818,22 +72823,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API profile:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `profile:write`"
}
},
- "/messaging/{session}/labels": {
+ "/messaging/{connection}/labels": {
"get": {
"operationId": "listLabels",
"tags": [
"Labels"
],
- "summary": "List labels defined for the session",
+ "summary": "List labels defined for the connection",
"security": [
{
"BearerAuth": []
@@ -72846,7 +72848,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -73045,9 +73047,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API labels:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -73071,7 +73070,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -73267,16 +73266,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API labels:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `labels:manage`"
}
},
- "/messaging/{session}/labels/{labelId}": {
+ "/messaging/{connection}/labels/{labelId}": {
"put": {
"operationId": "updateLabel",
"tags": [
@@ -73295,7 +73291,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -73467,7 +73463,7 @@
}
},
"409": {
- "description": "The session has no authoritative view of its labels yet. Retry once a cached or project-retained snapshot is complete.",
+ "description": "The connection has no authoritative view of its labels yet. Retry once a cached or project-retained snapshot is complete.",
"content": {
"application/json": {
"schema": {
@@ -73531,9 +73527,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API labels:manage "
- },
"x-protocols": [
"Linked Device API"
],
@@ -73557,7 +73550,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -73752,16 +73745,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API labels:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `labels:manage`"
}
},
- "/messaging/{session}/labels/chats/{conversation}": {
+ "/messaging/{connection}/labels/chats/{conversation}": {
"get": {
"operationId": "getChatLabels",
"tags": [
@@ -73780,7 +73770,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -73987,9 +73977,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API labels:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -74013,7 +74000,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -74185,7 +74172,7 @@
}
},
"409": {
- "description": "The session has no authoritative view of its labels yet. Retry once a cached or project-retained snapshot is complete.",
+ "description": "The connection has no authoritative view of its labels yet. Retry once a cached or project-retained snapshot is complete.",
"content": {
"application/json": {
"schema": {
@@ -74249,9 +74236,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API labels:manage "
- },
"x-protocols": [
"Linked Device API"
],
@@ -74454,9 +74438,6 @@
}
}
},
- "x-mint": {
- "content": "webhooks:manage "
- },
"description": "**Required scope:** `webhooks:manage`"
},
"post": {
@@ -74663,9 +74644,6 @@
}
}
},
- "x-mint": {
- "content": "webhooks:manage "
- },
"description": "**Required scope:** `webhooks:manage`"
}
},
@@ -74875,9 +74853,6 @@
}
}
},
- "x-mint": {
- "content": "webhooks:manage "
- },
"description": "**Required scope:** `webhooks:manage`"
},
"put": {
@@ -75094,9 +75069,6 @@
}
}
},
- "x-mint": {
- "content": "webhooks:manage "
- },
"description": "**Required scope:** `webhooks:manage`"
},
"delete": {
@@ -75304,33 +75276,30 @@
}
}
},
- "x-mint": {
- "content": "webhooks:manage "
- },
"description": "**Required scope:** `webhooks:manage`"
}
},
- "/messaging/{session}/history/chunks/retry": {
+ "/messaging/{connection}/history/chunks/retry": {
"post": {
"operationId": "retryHistoryChunk",
"tags": [
"History"
],
"summary": "Request a history chunk again",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:manage`\n\nRequires Polymorfa-Version 2026-10-14 or later, a server credential and accepted history consent. Requests the account's primary device to resend a chunk; it does not download or retain history. Linked Devices numbers only. The device decides whether the chunk is available.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:manage`\n\nRequires Polymorfa-Version 2026-10-14 or later, a server credential and accepted history consent. Requests the account's primary device to resend a chunk; it does not download or retain history. Linked Devices connections only. The device decides whether the chunk is available.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -75598,35 +75567,32 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/history/media/delete": {
+ "/messaging/{connection}/history/media/delete": {
"post": {
"operationId": "deleteHistoryMedia",
"tags": [
"History"
],
"summary": "Delete a downloaded history chunk from WhatsApp",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sessions:manage`\n\nRequires Polymorfa-Version 2026-10-14 or later and a server credential. After you have downloaded and verified a chunk, ask the Linked Devices connection to delete that history blob. This operation never addresses ordinary message attachments or deletes your local copy.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `connections:manage`\n\nRequires Polymorfa-Version 2026-10-14 or later and a server credential. After you have downloaded and verified a chunk, ask the Linked Devices connection to delete that history blob. This operation never addresses ordinary message attachments or deletes your local copy.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -75894,22 +75860,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sessions:manage "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/media/uploads": {
+ "/messaging/{connection}/media/uploads": {
"post": {
"operationId": "uploadEncryptedMedia",
"tags": [
"Media"
],
- "summary": "Upload encrypted media through the session",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `messages:write`\n\nUpload media you encrypted with WhatsApp media encryption. Send the ciphertext followed by its 10-byte MAC as the request body. Polymorfa uploads it to WhatsApp from the session's own network and never receives the media key. Use the returned `url` and `directPath`, with your media key and hashes, as `descriptor` when you send the message. The body must state Content-Length and be at most 52428800 bytes; for larger files, create an upload grant. Linked Devices numbers only.",
+ "summary": "Upload encrypted media through the connection",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `messages:write`\n\nUpload media you encrypted with WhatsApp media encryption. Send the ciphertext followed by its 10-byte MAC as the request body. Polymorfa uploads it to WhatsApp from the connection's own network and never receives the media key. Use the returned `url` and `directPath`, with your media key and hashes, as `descriptor` when you send the message. The body must state Content-Length and be at most 52428800 bytes; for larger files, create an upload grant. Linked Devices connections only.",
"security": [
{
"BearerAuth": []
@@ -75922,7 +75885,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -76087,7 +76050,7 @@
}
},
"404": {
- "description": "Session not found",
+ "description": "Connection not found",
"content": {
"application/json": {
"schema": {
@@ -76108,7 +76071,7 @@
}
},
"409": {
- "description": "`unsupported_for_connection`: the Number has no Linked Devices connection",
+ "description": "`unsupported_for_connection`: the Connection has no Linked Devices connection",
"content": {
"application/json": {
"schema": {
@@ -76118,7 +76081,7 @@
"error": {
"type": "conflict_error",
"code": "unsupported_for_connection",
- "message": "The session's connection does not support this call operation.",
+ "message": "The connection's connection does not support this call operation.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -76193,7 +76156,7 @@
}
},
"429": {
- "description": "WhatsApp or Polymorfa is limiting uploads for this session. Follow Retry-After when supplied.",
+ "description": "WhatsApp or Polymorfa is limiting uploads for this connection. Follow Retry-After when supplied.",
"content": {
"application/json": {
"schema": {
@@ -76235,7 +76198,7 @@
}
},
"503": {
- "description": "Session or service unavailable",
+ "description": "Connection or service unavailable",
"content": {
"application/json": {
"schema": {
@@ -76277,22 +76240,19 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API messages:write "
- },
"x-protocols": [
"Linked Device API"
]
}
},
- "/messaging/{session}/media/upload-grants": {
+ "/messaging/{connection}/media/upload-grants": {
"post": {
"operationId": "createMediaUploadGrant",
"tags": [
"Media"
],
"summary": "Create a media upload grant",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `messages:write`\n\nGet a short-lived WhatsApp upload URL for one encrypted file so you can upload it from your own network. The URL carries the session's WhatsApp upload authorization; treat it as a secret. Uploading from a network other than the session's may be treated differently by WhatsApp; the relay upload avoids that. Server credentials only; client tokens are refused. Linked Devices numbers only.",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `messages:write`\n\nGet a short-lived WhatsApp upload URL for one encrypted file so you can upload it from your own network. The URL carries the connection's WhatsApp upload authorization; treat it as a secret. Uploading from a network other than the connection's may be treated differently by WhatsApp; the relay upload avoids that. Server credentials only; client tokens are refused. Linked Devices connections only.",
"security": [
{
"BearerAuth": []
@@ -76305,7 +76265,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -76426,7 +76386,7 @@
}
},
"404": {
- "description": "Session not found",
+ "description": "Connection not found",
"content": {
"application/json": {
"schema": {
@@ -76447,7 +76407,7 @@
}
},
"409": {
- "description": "`unsupported_for_connection`: the Number has no Linked Devices connection",
+ "description": "`unsupported_for_connection`: the Connection has no Linked Devices connection",
"content": {
"application/json": {
"schema": {
@@ -76457,7 +76417,7 @@
"error": {
"type": "conflict_error",
"code": "unsupported_for_connection",
- "message": "The session's connection does not support this call operation.",
+ "message": "The connection's connection does not support this call operation.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -76479,7 +76439,7 @@
}
},
"429": {
- "description": "WhatsApp or Polymorfa is limiting uploads for this session. Follow Retry-After when supplied.",
+ "description": "WhatsApp or Polymorfa is limiting uploads for this connection. Follow Retry-After when supplied.",
"content": {
"application/json": {
"schema": {
@@ -76521,7 +76481,7 @@
}
},
"503": {
- "description": "Session or service unavailable",
+ "description": "Connection or service unavailable",
"content": {
"application/json": {
"schema": {
@@ -76563,9 +76523,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API messages:write "
- },
"x-protocols": [
"Linked Device API"
]
@@ -76784,9 +76741,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API media:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -76999,9 +76953,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API media:read "
- },
"x-protocols": [
"Linked Device API"
],
@@ -77214,23 +77165,20 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API media:manage "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `media:manage`"
}
},
- "/messaging/{session}/templates": {
+ "/messaging/{connection}/templates": {
"get": {
"operationId": "listTemplates",
"tags": [
"Templates"
],
- "summary": "List templates for a Number",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `messages:write`\n\nFor a real Official API Number, including a Hybrid Number, reads the complete template catalog of its WhatsApp Business Account from Meta, stores it, and returns it. A test-mode Cloud Number uses its simulated catalog. A Number with only a Linked Devices connection receives 400. If a catalog read is incomplete, the request fails with 502 and the stored templates are unchanged.",
+ "summary": "List templates for a Connection",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `messages:write`\n\nFor a real Official API Connection, including a Hybrid Connection, reads the complete template catalog of its WhatsApp Business Account from Meta, stores it, and returns it. A test-mode Cloud Connection uses its simulated catalog. A Connection with only a Linked Devices connection receives 400. If a catalog read is incomplete, the request fails with 502 and the stored templates are unchanged.",
"security": [
{
"BearerAuth": []
@@ -77243,7 +77191,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -77462,7 +77410,7 @@
}
},
"503": {
- "description": "The Number's WhatsApp Business Account is not available",
+ "description": "The Connection's WhatsApp Business Account is not available",
"content": {
"application/json": {
"schema": {
@@ -77494,9 +77442,6 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API messages:write "
- },
"x-protocols": [
"Meta Cloud API"
]
@@ -77506,8 +77451,8 @@
"tags": [
"Templates"
],
- "summary": "Create a template for a Number",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `messages:write`\n\nSubmits the template to Meta for a real Official API Number, including a Hybrid Number, or to the simulator for a test-mode Cloud Number, then stores the receipt. If the provider accepts the template but the receipt cannot be stored, the API imports it from one catalog read; if that also fails, it returns 500 with `template was submitted but could not be stored`. Do not resubmit in that case: list templates to load it. Keep the first response. A retry with the same `Idempotency-Key` does not submit the template again while its receipt is retained. Opaque responses are not retained by default; missing replay data returns `503 idempotency_replay_unavailable` without another provider write. Reconcile the catalog after any uncertain outcome. The returned status is the one in the response, or `PENDING` when none is returned. For real Official API Numbers, later approval, rejection and quality changes arrive as `template.status` webhook events and appear in the next list. A Number with only a Linked Devices connection receives 400.",
+ "summary": "Create a template for a Connection",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `messages:write`\n\nSubmits the template to Meta for a real Official API Connection, including a Hybrid Connection, or to the simulator for a test-mode Cloud Connection, then stores the receipt. If the provider accepts the template but the receipt cannot be stored, the API imports it from one catalog read; if that also fails, it returns 500 with `template was submitted but could not be stored`. Do not resubmit in that case: list templates to load it. Keep the first response. A retry with the same `Idempotency-Key` does not submit the template again while its receipt is retained. Opaque responses are not retained by default; missing replay data returns `503 idempotency_replay_unavailable` without another provider write. Reconcile the catalog after any uncertain outcome. The returned status is the one in the response, or `PENDING` when none is returned. For real Official API Connections, later approval, rejection and quality changes arrive as `template.status` webhook events and appear in the next list. A Connection with only a Linked Devices connection receives 400.",
"security": [
{
"BearerAuth": []
@@ -77520,7 +77465,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -77849,7 +77794,7 @@
}
},
"503": {
- "description": "The Number's WhatsApp Business Account is not available. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend",
+ "description": "The Connection's WhatsApp Business Account is not available. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend",
"content": {
"application/json": {
"schema": {
@@ -77920,22 +77865,19 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API messages:write "
- },
"x-protocols": [
"Meta Cloud API"
]
}
},
- "/messaging/{session}/templates/{name}": {
+ "/messaging/{connection}/templates/{name}": {
"get": {
"operationId": "getTemplate",
"tags": [
"Templates"
],
"summary": "Get a template by name",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `messages:write`\n\nRefreshes the Number's provider or simulated template catalog and returns the template with this name and language. `language` defaults to `en_US`. Fails with 502 if the catalog read is incomplete. Real Official API Numbers, including Hybrid Numbers, and test-mode Cloud Numbers are supported. A Number with only a Linked Devices connection receives 400.",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `messages:write`\n\nRefreshes the Connection's provider or simulated template catalog and returns the template with this name and language. `language` defaults to `en_US`. Fails with 502 if the catalog read is incomplete. Real Official API Connections, including Hybrid Connections, and test-mode Cloud Connections are supported. A Connection with only a Linked Devices connection receives 400.",
"security": [
{
"BearerAuth": []
@@ -77948,7 +77890,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -78183,7 +78125,7 @@
}
},
"503": {
- "description": "The Number's WhatsApp Business Account is not available",
+ "description": "The Connection's WhatsApp Business Account is not available",
"content": {
"application/json": {
"schema": {
@@ -78215,9 +78157,6 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API messages:write "
- },
"x-protocols": [
"Meta Cloud API"
]
@@ -78228,7 +78167,7 @@
"Templates"
],
"summary": "Submit a change to a Meta template",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `messages:write`\n\nChanges the components of one template language in the Number's owned WhatsApp Business Account. A 202 response means Meta accepted the edit request; read the template status to establish whether it is available to send. If the outcome is unknown, read the template again before deciding whether to retry. The Number needs an active Official API connection, including when it also has a Linked Devices connection. A test-mode Cloud Number or a Number with only a Linked Devices connection receives 400.",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `messages:write`\n\nChanges the components of one template language in the Connection's owned WhatsApp Business Account. A 202 response means Meta accepted the edit request; read the template status to establish whether it is available to send. If the outcome is unknown, read the template again before deciding whether to retry. The Connection needs an active Official API connection, including when it also has a Linked Devices connection. A test-mode Cloud Connection or a Connection with only a Linked Devices connection receives 400.",
"security": [
{
"BearerAuth": []
@@ -78241,7 +78180,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -78613,9 +78552,6 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API messages:write "
- },
"x-protocols": [
"Meta Cloud API"
]
@@ -78626,7 +78562,7 @@
"Templates"
],
"summary": "Delete a template",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `messages:write`\n\nDeletes every language of the named template from Meta for a real Official API Number, including a Hybrid Number, or from the simulated catalog for a test-mode Cloud Number, then removes the stored copies. A confirmed provider deletion succeeds even if local cleanup fails; the next complete catalog read reconciles the mirror. If the provider rejects the deletion or its result is unknown, the stored templates are kept. A Number with only a Linked Devices connection receives 400.",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `messages:write`\n\nDeletes every language of the named template from Meta for a real Official API Connection, including a Hybrid Connection, or from the simulated catalog for a test-mode Cloud Connection, then removes the stored copies. A confirmed provider deletion succeeds even if local cleanup fails; the next complete catalog read reconciles the mirror. If the provider rejects the deletion or its result is unknown, the stored templates are kept. A Connection with only a Linked Devices connection receives 400.",
"security": [
{
"BearerAuth": []
@@ -78639,7 +78575,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -79037,22 +78973,19 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API messages:write "
- },
"x-protocols": [
"Meta Cloud API"
]
}
},
- "/messaging/{session}/catalogs": {
+ "/messaging/{connection}/catalogs": {
"get": {
"operationId": "listCloudCatalogs",
"tags": [
"Catalogs"
],
- "summary": "List synced catalogs for an Official API Number",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `business:read`\n\nReturns the catalogs this project has synced for the WhatsApp Business Account of the Number's active Official connection, with each sync's state. It does not call Meta.",
+ "summary": "List synced catalogs for an Official API Connection",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `business:read`\n\nReturns the catalogs this project has synced for the WhatsApp Business Account of the Connection's active Official connection, with each sync's state. It does not call Meta.",
"security": [
{
"BearerAuth": []
@@ -79065,7 +78998,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -79252,7 +79185,7 @@
}
},
"503": {
- "description": "Catalog access or the Number's WhatsApp Business Account is unavailable",
+ "description": "Catalog access or the Connection's WhatsApp Business Account is unavailable",
"content": {
"application/json": {
"schema": {
@@ -79284,15 +79217,12 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API business:read "
- },
"x-protocols": [
"Meta Cloud API"
]
}
},
- "/messaging/{session}/catalogs/{catalogId}": {
+ "/messaging/{connection}/catalogs/{catalogId}": {
"get": {
"operationId": "getCloudCatalog",
"tags": [
@@ -79311,7 +79241,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -79508,7 +79438,7 @@
}
},
"503": {
- "description": "Catalog access or the Number's WhatsApp Business Account is unavailable",
+ "description": "Catalog access or the Connection's WhatsApp Business Account is unavailable",
"content": {
"application/json": {
"schema": {
@@ -79540,23 +79470,20 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API business:read "
- },
"x-protocols": [
"Meta Cloud API"
],
"description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `business:read`"
}
},
- "/messaging/{session}/catalogs/{catalogId}/sync": {
+ "/messaging/{connection}/catalogs/{catalogId}/sync": {
"post": {
"operationId": "syncCloudCatalog",
"tags": [
"Catalogs"
],
"summary": "Sync a linked catalog from Meta",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `business:read`\n\nReads every product of a catalog linked to the Number's WhatsApp Business Account, up to 5,000, and replaces the stored copy only when the read is complete. A failed or incomplete read leaves the stored products unchanged. One sync per catalog can start every 2 minutes.",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `business:read`\n\nReads every product of a catalog linked to the Connection's WhatsApp Business Account, up to 5,000, and replaces the stored copy only when the read is complete. A failed or incomplete read leaves the stored products unchanged. One sync per catalog can start every 2 minutes.",
"security": [
{
"BearerAuth": []
@@ -79569,7 +79496,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -79702,7 +79629,7 @@
}
},
"404": {
- "description": "The Number was not found, or Meta does not list the catalog for this WhatsApp Business Account (`catalog_not_linked`). Stored products for it are removed.",
+ "description": "The Connection was not found, or Meta does not list the catalog for this WhatsApp Business Account (`catalog_not_linked`). Stored products for it are removed.",
"content": {
"application/json": {
"schema": {
@@ -79894,7 +79821,7 @@
}
},
"503": {
- "description": "Catalog access or the Number's WhatsApp Business Account is unavailable",
+ "description": "Catalog access or the Connection's WhatsApp Business Account is unavailable",
"content": {
"application/json": {
"schema": {
@@ -79926,15 +79853,12 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API business:read "
- },
"x-protocols": [
"Meta Cloud API"
]
}
},
- "/messaging/{session}/catalogs/{catalogId}/products": {
+ "/messaging/{connection}/catalogs/{catalogId}/products": {
"get": {
"operationId": "listCloudCatalogProducts",
"tags": [
@@ -79954,7 +79878,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -80204,7 +80128,7 @@
}
},
"503": {
- "description": "Catalog access or the Number's WhatsApp Business Account is unavailable",
+ "description": "Catalog access or the Connection's WhatsApp Business Account is unavailable",
"content": {
"application/json": {
"schema": {
@@ -80236,9 +80160,6 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API business:read "
- },
"x-protocols": [
"Meta Cloud API"
]
@@ -80450,9 +80371,6 @@
}
}
},
- "x-mint": {
- "content": "templates:read "
- },
"description": "**Required scope:** `templates:read`"
},
"post": {
@@ -80669,9 +80587,6 @@
}
}
},
- "x-mint": {
- "content": "templates:manage "
- },
"description": "**Required scope:** `templates:manage`"
}
},
@@ -80889,9 +80804,6 @@
}
}
},
- "x-mint": {
- "content": "templates:read "
- },
"description": "**Required scope:** `templates:read`"
},
"patch": {
@@ -81116,9 +81028,6 @@
}
}
},
- "x-mint": {
- "content": "templates:manage "
- },
"description": "**Required scope:** `templates:manage`"
},
"delete": {
@@ -81334,9 +81243,6 @@
}
}
},
- "x-mint": {
- "content": "templates:manage "
- },
"description": "**Required scope:** `templates:manage`"
}
},
@@ -81563,9 +81469,6 @@
}
}
},
- "x-mint": {
- "content": "templates:read "
- },
"description": "**Required scope:** `templates:read`"
}
},
@@ -81576,7 +81479,7 @@
"Templates"
],
"summary": "Submit a project template for approval",
- "description": "**Required scope:** `templates:manage`\n\nAccepts any number, so one integration handles both connection types; check `submission` in the response. A Cloud API number needs Meta approval: the template is rendered into a Meta create-template payload, submitted through that number, recorded as a per-number approval pointer (cloudLinks), and returned with `submission.status` PENDING. Read the Number's template catalog for Meta's review result. Any other number needs no review: nothing is sent to Meta and the template is returned with `submission.status` APPROVED and `submission.autoApproved` true. Incomplete or invalid definitions return 400 for every number; passing local validation does not guarantee Meta approval.",
+ "description": "**Required scope:** `templates:manage`\n\nAccepts any connection, so one integration handles both connection types; check `submission` in the response. A Cloud API connection needs Meta approval: the template is rendered into a Meta create-template payload, submitted through that connection, recorded as a per-connection approval pointer (cloudLinks), and returned with `submission.status` PENDING. Read the Connection's template catalog for Meta's review result. Any other number needs no review: nothing is sent to Meta and the template is returned with `submission.status` APPROVED and `submission.autoApproved` true. Incomplete or invalid definitions return 400 for every connection; passing local validation does not guarantee Meta approval.",
"security": [
{
"BearerAuth": []
@@ -81612,7 +81515,7 @@
},
"responses": {
"200": {
- "description": "Submitted to Meta (Cloud API number) or approved automatically (any other number)",
+ "description": "Submitted to Meta (Cloud API connection) or approved automatically (any other number)",
"content": {
"application/json": {
"schema": {
@@ -81792,9 +81695,6 @@
}
}
}
- },
- "x-mint": {
- "content": "templates:manage "
}
}
},
@@ -82004,9 +81904,6 @@
}
}
},
- "x-mint": {
- "content": "campaigns:read "
- },
"description": "**Required scope:** `campaigns:read`"
},
"post": {
@@ -82015,7 +81912,7 @@
"Campaigns"
],
"summary": "Create a campaign",
- "description": "**Required scope:** `campaigns:manage`\n\nCreates a draft campaign on any plan. `senderConfig.sessionIds` may name numbers that are not yet on a plan that includes Campaigns; launch checks the selection. It is refused with `403 bansafe_team_suspended` while the team is suspended and `400` when `senderConfig.sessionIds` is malformed or a per-number cap is above its safety ceiling.",
+ "description": "**Required scope:** `campaigns:manage`\n\nCreates a draft campaign on any plan. `senderConfig.connectionIds` may name connections that are not yet on a plan that includes Campaigns; launch checks the selection. It is refused with `403 bansafe_team_suspended` while the team is suspended and `400` when `senderConfig.connectionIds` is malformed or a per-connection cap is above its safety ceiling.",
"security": [
{
"BearerAuth": []
@@ -82362,9 +82259,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -82582,9 +82476,6 @@
}
}
},
- "x-mint": {
- "content": "campaigns:read "
- },
"description": "**Required scope:** `campaigns:read`"
},
"patch": {
@@ -82716,7 +82607,7 @@
}
},
"402": {
- "description": "`campaigns_not_entitled`: a new sender selection on a launched campaign names a number whose plan does not include Campaigns",
+ "description": "`campaigns_not_entitled`: a new sender selection on a launched campaign names a connection whose plan does not include Campaigns",
"content": {
"application/json": {
"schema": {
@@ -82726,7 +82617,7 @@
"error": {
"type": "billing_error",
"code": "campaigns_not_entitled",
- "message": "This number’s plan does not include Campaigns.",
+ "message": "This connection’s plan does not include Campaigns.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -82812,7 +82703,7 @@
}
},
"409": {
- "description": "`state_conflict`: the campaign has launched and the audience or start time can no longer change, it launched while its sending numbers were being changed, its send window cannot change in the current state or while sends are in progress, or its tracked links cannot change after sending started",
+ "description": "`state_conflict`: the campaign has launched and the audience or start time can no longer change, it launched while its sending connections were being changed, its send window cannot change in the current state or while sends are in progress, or its tracked links cannot change after sending started",
"content": {
"application/json": {
"schema": {
@@ -82876,7 +82767,7 @@
}
},
"503": {
- "description": "`service_unavailable`: number eligibility for a launched campaign's new sender selection could not be checked. Nothing was changed",
+ "description": "`service_unavailable`: connection eligibility for a launched campaign's new sender selection could not be checked. Nothing was changed",
"content": {
"application/json": {
"schema": {
@@ -82907,9 +82798,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -83127,9 +83015,6 @@
}
}
},
- "x-mint": {
- "content": "campaigns:read "
- },
"description": "**Required scope:** `campaigns:read`"
}
},
@@ -83347,9 +83232,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:read "
}
}
},
@@ -83610,9 +83492,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -83623,7 +83502,7 @@
"Campaigns"
],
"summary": "Launch a campaign",
- "description": "**Required scope:** `campaigns:manage`\n\nStarts a draft campaign. It begins sending at `scheduledAt`, or right away when no start time is set. Launch checks the saved sender selection against live plans: `402 campaigns_not_entitled` when a selected number is missing or its plan does not include Campaigns, or when an unselected campaign's project has no such number; `400 invalid_parameter` on `senderConfig.sessionIds` when a selected number is not connected or the selection mixes sending types; `400 campaign_throughput_capped` when a requested throughput is above its ceiling. Segment campaigns require a team API key; project tokens answer `403 permission_denied`, and unavailable audience betas answer `403 feature_unavailable`. An audience change during launch answers `409 state_conflict`. Segment evaluation that exceeds its time limit also answers `409 state_conflict`; simplify the rules and retry. A launched campaign whose segment was deleted remains launched and cannot be launched again (`409 state_conflict`). A message that references a `{{link:}}` the campaign does not define, or tracked links on a campaign that would send from Official API numbers, answers `400 invalid_parameter` on `trackedLinks`; tracked links without the campaign link tracking beta answer `403 feature_unavailable`. A drip without a sendable composed message answers `400 invalid_parameter` on `messagesArray`. Saving a draft does not apply this check. The template must be complete and approved on every Cloud API number; every recipient needs a value or fallback for each variable unless `skipMissingVariables` is true. When the team requires approval above a recipient threshold and the launch would send to more recipients, it answers `409 campaign_approval_required`, sends nothing, and records a pending approval request for a team owner or admin. Launching again with the campaign unchanged returns the same request. A launch requested by an AI agent through the hosted MCP server is held the same way, whatever the threshold. The response returns the campaign as it was when the launch was accepted.",
+ "description": "**Required scope:** `campaigns:manage`\n\nStarts a draft campaign. It begins sending at `scheduledAt`, or right away when no start time is set. Launch checks the saved sender selection against live plans: `402 campaigns_not_entitled` when a selected connection is missing or its plan does not include Campaigns, or when an unselected campaign's project has no such number; `400 invalid_parameter` on `senderConfig.connectionIds` when a selected connection is not connected or the selection mixes sending types; `400 campaign_throughput_capped` when a requested throughput is above its ceiling. Segment campaigns require a team API key; project tokens answer `403 permission_denied`, and unavailable audience betas answer `403 feature_unavailable`. An audience change during launch answers `409 state_conflict`. Segment evaluation that exceeds its time limit also answers `409 state_conflict`; simplify the rules and retry. A launched campaign whose segment was deleted remains launched and cannot be launched again (`409 state_conflict`). A message that references a `{{link:}}` the campaign does not define, or tracked links on a campaign that would send from Official API connections, answers `400 invalid_parameter` on `trackedLinks`; tracked links without the campaign link tracking beta answer `403 feature_unavailable`. A drip without a sendable composed message answers `400 invalid_parameter` on `messagesArray`. Saving a draft does not apply this check. The template must be complete and approved on every Cloud API connection; every recipient needs a value or fallback for each variable unless `skipMissingVariables` is true. When the team requires approval above a recipient threshold and the launch would send to more recipients, it answers `409 campaign_approval_required`, sends nothing, and records a pending approval request for a team owner or admin. Launching again with the campaign unchanged returns the same request. A launch requested by an AI agent through the hosted MCP server is held the same way, whatever the threshold. The response returns the campaign as it was when the launch was accepted.",
"security": [
{
"BearerAuth": []
@@ -83700,7 +83579,7 @@
}
},
"400": {
- "description": "`invalid_parameter` naming the field: an unconnected or mixed sender selection (`senderConfig.sessionIds`), an incomplete or authentication template (`templateId`), a composed attachment without a public URL, or a `{{link:}}` the campaign does not define or tracked links on Official API numbers (`trackedLinks`). `campaign_throughput_capped` when a requested throughput is above its ceiling; `template_not_approved` when a Cloud API number has not approved the template.",
+ "description": "`invalid_parameter` naming the field: an unconnected or mixed sender selection (`senderConfig.connectionIds`), an incomplete or authentication template (`templateId`), a composed attachment without a public URL, or a `{{link:}}` the campaign does not define or tracked links on Official API connections (`trackedLinks`). `campaign_throughput_capped` when a requested throughput is above its ceiling; `template_not_approved` when a Cloud API connection has not approved the template.",
"content": {
"application/json": {
"schema": {
@@ -83764,7 +83643,7 @@
}
},
"402": {
- "description": "`campaigns_not_entitled`: a selected number is missing or its plan does not include Campaigns, or the project has no number on such a plan. Drafts are saved on every plan.",
+ "description": "`campaigns_not_entitled`: a selected connection is missing or its plan does not include Campaigns, or the project has no connection on such a plan. Drafts are saved on every plan.",
"content": {
"application/json": {
"schema": {
@@ -83774,7 +83653,7 @@
"error": {
"type": "billing_error",
"code": "campaigns_not_entitled",
- "message": "This number’s plan does not include Campaigns.",
+ "message": "This connection’s plan does not include Campaigns.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -83860,7 +83739,7 @@
}
},
"409": {
- "description": "`campaign_approval_required`: the launch is held for a team owner or admin and nothing was sent; the message names the approval request. `state_conflict`: the campaign is not a draft, is already launched and waiting for its start time, its sending numbers or audience changed during launch, or segment evaluation exceeded its time limit (simplify the rules and retry). A launched campaign whose segment was deleted cannot be launched again. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "description": "`campaign_approval_required`: the launch is held for a team owner or admin and nothing was sent; the message names the approval request. `state_conflict`: the campaign is not a draft, is already launched and waiting for its start time, its sending connections or audience changed during launch, or segment evaluation exceeded its time limit (simplify the rules and retry). A launched campaign whose segment was deleted cannot be launched again. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
"content": {
"application/json": {
"schema": {
@@ -83975,7 +83854,7 @@
}
},
"503": {
- "description": "`service_unavailable`: the selected numbers' plans could not be checked; retry. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend",
+ "description": "`service_unavailable`: the selected connections' plans could not be checked; retry. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend",
"content": {
"application/json": {
"schema": {
@@ -84013,9 +83892,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -84373,9 +84249,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -84733,9 +84606,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -85093,9 +84963,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -85106,7 +84973,7 @@
"Campaigns"
],
"summary": "Send a test of a draft campaign",
- "description": "**Required scopes (all):** `campaigns:manage` · `campaigns:read`\n\nRequires campaigns:manage and campaigns:read because the test can use stored recipient samples. Sends one copy of a draft campaign's content to a seed recipient, through the same rendering, sending, and BanSafe checks as a launched campaign. The seed recipient must be a number connected to your team. A test is not a campaign recipient and is not counted in the campaign's statistics or webhooks. A team can send 20 tests an hour, and at most 5 an hour to one seed recipient.",
+ "description": "**Required scopes (all):** `campaigns:manage` · `campaigns:read`\n\nRequires campaigns:manage and campaigns:read because the test can use stored recipient samples. Sends one copy of a draft campaign's content to a seed recipient, through the same rendering, sending, and BanSafe checks as a launched campaign. The seed recipient must be the phone of a Connection connected to your team. A test is not a campaign recipient and is not counted in the campaign's statistics or webhooks. A team can send 20 tests an hour, and at most 5 an hour to one seed recipient.",
"security": [
{
"BearerAuth": []
@@ -85252,7 +85119,7 @@
}
},
"402": {
- "description": "`campaigns_not_entitled`: the sending number's plan does not include Campaigns.",
+ "description": "`campaigns_not_entitled`: the sending connection's plan does not include Campaigns.",
"content": {
"application/json": {
"schema": {
@@ -85262,7 +85129,7 @@
"error": {
"type": "billing_error",
"code": "campaigns_not_entitled",
- "message": "This number’s plan does not include Campaigns.",
+ "message": "This connection’s plan does not include Campaigns.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -85348,7 +85215,7 @@
}
},
"409": {
- "description": "`state_conflict`: The campaign is not a draft or has A/B or weighted content alternatives, the sending number is a Hybrid Link number, or the seed recipient opted out. `bansafe_cold_held`: the seed recipient has never written to the sending number and the campaign holds first messages. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
+ "description": "`state_conflict`: The campaign is not a draft or has A/B or weighted content alternatives, the sending connection is a Hybrid Link connection, or the seed recipient opted out. `bansafe_cold_held`: the seed recipient has never written to the sending connection and the campaign holds first messages. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)",
"content": {
"application/json": {
"schema": {
@@ -85431,7 +85298,7 @@
}
},
"429": {
- "description": "The team or seed recipient reached its test-send limit (`rate_limit_exceeded`), or BanSafe is pacing the sending number. Follow `Retry-After`.",
+ "description": "The team or seed recipient reached its test-send limit (`rate_limit_exceeded`), or BanSafe is pacing the sending connection. Follow `Retry-After`.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before retrying.",
@@ -85534,7 +85401,7 @@
}
},
"503": {
- "description": "The test was not sent: the sending number is not connected (`session_not_ready`), test sends or the send path are unavailable (`service_unavailable`, `command_dispatch_failed`), or the sending number's allowance could not be checked (`bansafe_accounting_unavailable`). Retry later. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend",
+ "description": "The test was not sent: the sending connection is not connected (`connection_not_ready`), test sends or the send path are unavailable (`service_unavailable`, `command_dispatch_failed`), or the sending connection's allowance could not be checked (`bansafe_accounting_unavailable`). Retry later. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend",
"content": {
"application/json": {
"schema": {
@@ -85604,9 +85471,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage campaigns:read "
}
}
},
@@ -85974,9 +85838,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -86203,9 +86064,6 @@
}
}
},
- "x-mint": {
- "content": "campaigns:manage "
- },
"description": "**Required scope:** `campaigns:manage`"
}
},
@@ -86457,9 +86315,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -86678,9 +86533,6 @@
}
}
},
- "x-mint": {
- "content": "campaigns:read "
- },
"description": "**Required scope:** `campaigns:read`"
}
},
@@ -86941,9 +86793,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -87003,7 +86852,7 @@
"cold_held",
"campaign_cancelled",
"invalid_recipient",
- "session_not_connected",
+ "connection_not_connected",
"ack_timeout",
"blocked_by_safety",
"send_failed",
@@ -87220,9 +87069,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:read "
}
},
"post": {
@@ -87536,9 +87382,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:manage "
}
}
},
@@ -87598,7 +87441,7 @@
"cold_held",
"campaign_cancelled",
"invalid_recipient",
- "session_not_connected",
+ "connection_not_connected",
"ack_timeout",
"blocked_by_safety",
"send_failed",
@@ -87857,9 +87700,6 @@
}
}
}
- },
- "x-mint": {
- "content": "campaigns:read "
}
}
},
@@ -87870,7 +87710,7 @@
"QuickLink"
],
"summary": "Create a QuickLink",
- "description": "**Required scope:** `quicklink:manage`\n\nCreates a persistent hosted link that connects one WhatsApp number to a new session in the project.",
+ "description": "**Required scope:** `quicklink:manage`\n\nCreates a persistent hosted link that connects one WhatsApp number to a new connection in the project.",
"security": [
{
"BearerAuth": []
@@ -88068,9 +87908,6 @@
}
}
}
- },
- "x-mint": {
- "content": "quicklink:manage "
}
}
},
@@ -88080,7 +87917,7 @@
"tags": [
"QuickLink"
],
- "summary": "Read connection addition availability",
+ "summary": "Read method addition availability",
"security": [
{
"BearerAuth": []
@@ -88104,7 +87941,7 @@
"maxLength": 128
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "query"
}
],
@@ -88291,9 +88128,6 @@
}
}
},
- "x-mint": {
- "content": "quicklink:manage "
- },
"description": "**Required scope:** `quicklink:manage`"
}
},
@@ -88503,9 +88337,6 @@
}
}
},
- "x-mint": {
- "content": "quicklink:manage "
- },
"description": "**Required scope:** `quicklink:manage`"
},
"delete": {
@@ -88514,7 +88345,7 @@
"QuickLink"
],
"summary": "Cancel a QuickLink",
- "description": "**Required scope:** `quicklink:manage`\n\nCancels pending onboarding. Initial Number cleanup is accepted asynchronously and completes only after runtime teardown. Supplementary and reauthorization links cancel only their pending attempts; the existing Number remains. Accepted provider work must finish before cancellation.",
+ "description": "**Required scope:** `quicklink:manage`\n\nCancels pending onboarding. Initial Connection cleanup is accepted asynchronously and completes only after runtime teardown. Supplementary and reauthorization links cancel only their pending attempts; the existing Connection remains. Accepted provider work must finish before cancellation.",
"security": [
{
"BearerAuth": []
@@ -88569,7 +88400,7 @@
}
},
"202": {
- "description": "QuickLink invalidated; Number cleanup pending",
+ "description": "QuickLink invalidated; Connection cleanup pending",
"content": {
"application/json": {
"schema": {
@@ -88764,26 +88595,23 @@
}
}
}
- },
- "x-mint": {
- "content": "quicklink:manage "
}
}
},
- "/messaging/{session}/cloud-credentials": {
+ "/messaging/{connection}/cloud-credentials": {
"get": {
"operationId": "getCloudCredentialHealth",
"tags": [
- "Sessions"
+ "Connections"
],
"summary": "Read Meta Cloud API credential health",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `sessions:read`\n\nReturns the latest recurring validation of the Number's Meta Cloud API credentials: token validity, required permissions, phone registration and webhook subscription.",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `connections:read`\n\nReturns the latest recurring validation of the Connection's Meta Cloud API credentials: token validity, required permissions, phone registration and webhook subscription.",
"security": [
{
"BearerAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -88792,7 +88620,7 @@
"maxLength": 128
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -88966,22 +88794,19 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API sessions:read "
- },
"x-protocols": [
"Meta Cloud API"
]
}
},
- "/messaging/{session}/cloud-credentials/reauthorize": {
+ "/messaging/{connection}/cloud-credentials/reauthorize": {
"post": {
"operationId": "reauthorizeCloudCredentials",
"tags": [
- "Sessions"
+ "Connections"
],
"summary": "Start guided Meta Cloud API reauthorization",
- "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `quicklink:manage`\n\nRequires a project token with `quicklink:manage`. Creates a QuickLink with purpose `reauthorization` that renews the Number's Meta authorization through Embedded Signup. The link is bound to the same Number and phone number and always uses the Meta Cloud API. The Number must be stopped or disconnected; this request never stops it. Cancelling the link before Meta work starts keeps the Number.",
+ "description": "**Protocols:** Meta Cloud API\n\n**Required scope:** `quicklink:manage`\n\nRequires a project token with `quicklink:manage`. Creates a QuickLink with purpose `reauthorization` that renews the Connection's Meta authorization through Embedded Signup. The link is bound to the same Connection and phone number and always uses the Meta Cloud API. The Connection must be stopped or disconnected; this request never stops it. Cancelling the link before Meta work starts keeps the Connection.",
"security": [
{
"BearerAuth": []
@@ -88996,7 +88821,7 @@
"maxLength": 128
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -89223,9 +89048,6 @@
}
}
},
- "x-mint": {
- "content": "Meta Cloud API quicklink:manage "
- },
"x-protocols": [
"Meta Cloud API"
]
@@ -89261,7 +89083,7 @@
"type": "string",
"maxLength": 32
},
- "noNumber": {
+ "noConnection": {
"type": "boolean",
"enum": [
true
@@ -89516,14 +89338,14 @@
}
}
},
- "/quicklink/{token}/connection": {
+ "/quicklink/{token}/method": {
"post": {
- "operationId": "selectQuickLinkConnection",
+ "operationId": "selectQuickLinkMethod",
"tags": [
"QuickLink"
],
"security": [],
- "summary": "Select an allowed connection type",
+ "summary": "Select an allowed method type",
"parameters": [
{
"schema": {
@@ -89542,7 +89364,7 @@
"schema": {
"type": "object",
"properties": {
- "connection": {
+ "method": {
"type": "string",
"enum": [
"cloud",
@@ -89551,7 +89373,7 @@
}
},
"required": [
- "connection"
+ "method"
],
"additionalProperties": false
}
@@ -89569,7 +89391,7 @@
"data": {
"type": "object",
"properties": {
- "connection": {
+ "method": {
"type": "string",
"enum": [
"cloud",
@@ -89578,7 +89400,7 @@
}
},
"required": [
- "connection"
+ "method"
]
}
},
@@ -90020,7 +89842,7 @@
"android",
"ios"
],
- "description": "Primary phone platform the Test number emulates. Defaults to `android`. Not accepted when `accountType` is `meta_cloud`.",
+ "description": "Primary phone platform the Test connection emulates. Defaults to `android`. Not accepted when `accountType` is `meta_cloud`.",
"x-enumDescriptions": {
"android": "An Android phone.",
"ios": "An iPhone."
@@ -90173,7 +89995,7 @@
],
"responses": {
"200": {
- "description": "Current test connection state",
+ "description": "Current test method state",
"content": {
"application/json": {
"schema": {
@@ -90281,7 +90103,7 @@
],
"security": [],
"summary": "Read QuickLink state",
- "description": "Returns the hosted page state for a QuickLink. Public; the token in the URL is the credential. Starts linked-device pairing after an allowed connection type has been selected.",
+ "description": "Returns the hosted page state for a QuickLink. Public; the token in the URL is the credential. Starts linked-device pairing after an allowed method type has been selected.",
"parameters": [
{
"schema": {
@@ -90883,7 +90705,7 @@
}
},
"202": {
- "description": "QuickLink invalidated; Number cleanup pending",
+ "description": "QuickLink invalidated; Connection cleanup pending",
"content": {
"application/json": {
"schema": {
@@ -91193,7 +91015,7 @@
],
"security": [],
"summary": "Redeem a pending passkey ceremony for a QuickLink",
- "description": "The complete HTTP body is limited to 1048576 UTF-8 bytes before JSON parsing. Credential IDs allow at most 1023 decoded bytes; user handles allow 64. Opaque assertion fields share the body budget without independent small caps. Redeems a pending passkey ceremony challenge for the session bound to this QuickLink.",
+ "description": "The complete HTTP body is limited to 1048576 UTF-8 bytes before JSON parsing. Credential IDs allow at most 1023 decoded bytes; user handles allow 64. Opaque assertion fields share the body budget without independent small caps. Redeems a pending passkey ceremony challenge for the connection bound to this QuickLink.",
"parameters": [
{
"schema": {
@@ -91351,7 +91173,7 @@
}
},
"502": {
- "description": "Session runner rejected the assertion",
+ "description": "Connection runner rejected the assertion",
"content": {
"application/json": {
"schema": {
@@ -91570,7 +91392,7 @@
}
},
"410": {
- "description": "Direct session signup was retired; create a QuickLink first",
+ "description": "Direct connection signup was retired; create a QuickLink first",
"headers": {
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
@@ -91634,9 +91456,6 @@
}
}
},
- "x-mint": {
- "content": "quicklink:manage "
- },
"description": "**Required scope:** `quicklink:manage`"
}
},
@@ -91877,9 +91696,6 @@
}
}
},
- "x-mint": {
- "content": "sandbox:write "
- },
"description": "**Required scope:** `sandbox:write`"
}
},
@@ -91951,13 +91767,10 @@
}
}
},
- "x-mint": {
- "content": "sandbox:read "
- },
"description": "**Required scope:** `sandbox:read`"
}
},
- "/messaging/{session}/test-events": {
+ "/messaging/{connection}/test-events": {
"post": {
"operationId": "triggerTestEvent",
"tags": [
@@ -91968,7 +91781,7 @@
"BearerAuth": []
}
],
- "summary": "Trigger a test event for a Test number",
+ "summary": "Trigger a test event for a Test connection",
"x-required-scope": "sandbox:write",
"parameters": [
{
@@ -91976,10 +91789,10 @@
"type": "string",
"minLength": 1,
"maxLength": 128,
- "description": "Test Number ID."
+ "description": "Test Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -92058,7 +91871,7 @@
}
},
"403": {
- "description": "Test numbers access required, or a client token was used",
+ "description": "Test connections access required, or a client token was used",
"headers": {
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
@@ -92186,16 +91999,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sandbox:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `sandbox:write`"
}
},
- "/messaging/{session}/phone": {
+ "/messaging/{connection}/phone": {
"get": {
"operationId": "getTestingPhone",
"tags": [
@@ -92206,7 +92016,7 @@
"BearerAuth": []
}
],
- "summary": "Get a Test number's phone",
+ "summary": "Get a Test connection's phone",
"x-required-scope": "sandbox:read",
"parameters": [
{
@@ -92214,10 +92024,10 @@
"type": "string",
"minLength": 1,
"maxLength": 256,
- "description": "The Test number's session ID."
+ "description": "The Test connection's connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -92244,7 +92054,7 @@
}
},
"403": {
- "description": "Test numbers access required, or a client token was used",
+ "description": "Test connections access required, or a client token was used",
"headers": {
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
@@ -92340,16 +92150,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sandbox:read "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `sandbox:read`"
}
},
- "/messaging/{session}/phone/messages": {
+ "/messaging/{connection}/phone/messages": {
"post": {
"operationId": "sendTestingPhoneMessage",
"tags": [
@@ -92360,7 +92167,7 @@
"BearerAuth": []
}
],
- "summary": "Send a message from a Test number's phone",
+ "summary": "Send a message from a Test connection's phone",
"x-required-scope": "sandbox:write",
"parameters": [
{
@@ -92368,10 +92175,10 @@
"type": "string",
"minLength": 1,
"maxLength": 256,
- "description": "The Test number's session ID."
+ "description": "The Test connection's connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -92440,7 +92247,7 @@
}
},
"403": {
- "description": "Test numbers access required, or a client token was used",
+ "description": "Test connections access required, or a client token was used",
"headers": {
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
@@ -92568,16 +92375,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sandbox:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `sandbox:write`"
}
},
- "/messaging/{session}/phone/devices/{deviceId}/unlink": {
+ "/messaging/{connection}/phone/devices/{deviceId}/unlink": {
"post": {
"operationId": "unlinkTestingPhoneDevice",
"tags": [
@@ -92588,7 +92392,7 @@
"BearerAuth": []
}
],
- "summary": "Unlink a companion from a Test number's phone",
+ "summary": "Unlink a companion from a Test connection's phone",
"x-required-scope": "sandbox:write",
"parameters": [
{
@@ -92596,10 +92400,10 @@
"type": "string",
"minLength": 1,
"maxLength": 256,
- "description": "The Test number's session ID."
+ "description": "The Test connection's connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -92669,7 +92473,7 @@
}
},
"403": {
- "description": "Test numbers access required, or a client token was used",
+ "description": "Test connections access required, or a client token was used",
"headers": {
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
@@ -92765,16 +92569,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sandbox:write "
- },
"x-protocols": [
"Linked Device API"
],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `sandbox:write`"
}
},
- "/messaging/{session}/phone/account-mode": {
+ "/messaging/{connection}/phone/account-mode": {
"put": {
"operationId": "setTestingAccountMode",
"tags": [
@@ -92785,8 +92586,8 @@
"BearerAuth": []
}
],
- "summary": "Change a Test number's account type or phone platform",
- "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sandbox:write`\n\nChanges how the Test number presents itself. A change unlinks every companion, including the Number's own session, so each must pair again. Repeating the current mode changes nothing.",
+ "summary": "Change a Test connection's account type or phone platform",
+ "description": "**Protocols:** Linked Device API\n\n**Required scope:** `sandbox:write`\n\nChanges how the Test connection presents itself. A change unlinks every companion, including the Connection's own connection, so each must pair again. Repeating the current mode changes nothing.",
"x-required-scope": "sandbox:write",
"parameters": [
{
@@ -92794,10 +92595,10 @@
"type": "string",
"minLength": 1,
"maxLength": 256,
- "description": "The Test number's session ID."
+ "description": "The Test connection's connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -92866,7 +92667,7 @@
}
},
"403": {
- "description": "Test numbers access required, or a client token was used",
+ "description": "Test connections access required, or a client token was used",
"headers": {
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
@@ -92930,7 +92731,7 @@
}
},
"409": {
- "description": "The Test number is claimed in Inspector, or another mode change is pending. Unclaim it or retry.",
+ "description": "The Test connection is claimed in Inspector, or another mode change is pending. Unclaim it or retry.",
"headers": {
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
@@ -92994,9 +92795,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sandbox:write "
- },
"x-protocols": [
"Linked Device API"
]
@@ -93220,10 +93018,10 @@
}
}
},
- "session.status": {
+ "connection.status": {
"post": {
- "operationId": "onSessionStatus",
- "summary": "Session status change",
+ "operationId": "onConnectionStatus",
+ "summary": "Connection status change",
"tags": [
"Webhooks"
],
@@ -93232,7 +93030,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SessionStatusEvent"
+ "$ref": "#/components/schemas/ConnectionStatusEvent"
}
}
}
@@ -93244,10 +93042,10 @@
}
}
},
- "session.connected": {
+ "connection.connected": {
"post": {
- "operationId": "onSessionConnected",
- "summary": "Session connected to WhatsApp",
+ "operationId": "onConnectionConnected",
+ "summary": "Connection connected to WhatsApp",
"tags": [
"Webhooks"
],
@@ -93256,7 +93054,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SessionConnectedEvent"
+ "$ref": "#/components/schemas/ConnectionConnectedEvent"
}
}
}
@@ -93268,10 +93066,10 @@
}
}
},
- "session.logged_out": {
+ "connection.logged_out": {
"post": {
- "operationId": "onSessionLoggedOut",
- "summary": "Session logged out",
+ "operationId": "onConnectionLoggedOut",
+ "summary": "Connection logged out",
"tags": [
"Webhooks"
],
@@ -93280,7 +93078,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SessionLoggedOutEvent"
+ "$ref": "#/components/schemas/ConnectionLoggedOutEvent"
}
}
}
@@ -93292,9 +93090,9 @@
}
}
},
- "session.phone_offline": {
+ "connection.phone_offline": {
"post": {
- "operationId": "onSessionPhoneOffline",
+ "operationId": "onConnectionPhoneOffline",
"summary": "Primary phone has been offline for an extended period",
"tags": [
"Webhooks"
@@ -93304,7 +93102,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SessionPhoneOfflineEvent"
+ "$ref": "#/components/schemas/ConnectionPhoneOfflineEvent"
}
}
}
@@ -93316,10 +93114,10 @@
}
}
},
- "session.capabilities_updated": {
+ "connection.capabilities_updated": {
"post": {
- "operationId": "onSessionCapabilitiesUpdated",
- "summary": "The number’s WhatsApp capabilities changed",
+ "operationId": "onConnectionCapabilitiesUpdated",
+ "summary": "The connection’s WhatsApp capabilities changed",
"tags": [
"Webhooks"
],
@@ -93328,7 +93126,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SessionCapabilitiesUpdatedEvent"
+ "$ref": "#/components/schemas/ConnectionCapabilitiesUpdatedEvent"
}
}
}
@@ -93340,10 +93138,10 @@
}
}
},
- "session.restriction_updated": {
+ "connection.restriction_updated": {
"post": {
- "operationId": "onSessionRestrictionUpdated",
- "summary": "A WhatsApp restriction on the number started, changed or ended",
+ "operationId": "onConnectionRestrictionUpdated",
+ "summary": "A WhatsApp restriction on the connection started, changed or ended",
"tags": [
"Webhooks"
],
@@ -93352,7 +93150,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SessionRestrictionUpdatedEvent"
+ "$ref": "#/components/schemas/ConnectionRestrictionUpdatedEvent"
}
}
}
@@ -94444,10 +94242,10 @@
}
}
},
- "customer.number.attached": {
+ "customer.connection.attached": {
"post": {
- "operationId": "onCustomerNumberAttached",
- "summary": "Number attached to a Customer",
+ "operationId": "onCustomerConnectionAttached",
+ "summary": "Connection attached to a Customer",
"tags": [
"Webhooks"
],
@@ -94456,7 +94254,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CustomerNumberAttachedEvent"
+ "$ref": "#/components/schemas/CustomerConnectionAttachedEvent"
}
}
}
@@ -94468,10 +94266,10 @@
}
}
},
- "customer.number.transferred": {
+ "customer.connection.transferred": {
"post": {
- "operationId": "onCustomerNumberTransferred",
- "summary": "Number transferred to a Customer",
+ "operationId": "onCustomerConnectionTransferred",
+ "summary": "Connection transferred to a Customer",
"tags": [
"Webhooks"
],
@@ -94480,7 +94278,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CustomerNumberTransferredEvent"
+ "$ref": "#/components/schemas/CustomerConnectionTransferredEvent"
}
}
}
@@ -94492,10 +94290,10 @@
}
}
},
- "customer.number.disconnected": {
+ "customer.connection.disconnected": {
"post": {
- "operationId": "onCustomerNumberDisconnected",
- "summary": "Customer Number disconnected",
+ "operationId": "onCustomerConnectionDisconnected",
+ "summary": "Customer Connection disconnected",
"tags": [
"Webhooks"
],
@@ -94504,7 +94302,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CustomerNumberDisconnectedEvent"
+ "$ref": "#/components/schemas/CustomerConnectionDisconnectedEvent"
}
}
}
@@ -94567,7 +94365,7 @@
"bansafe.action": {
"post": {
"operationId": "onBansafeAction",
- "summary": "Polymorfa applied, changed, or lifted a safety restriction on a number",
+ "summary": "Polymorfa applied, changed, or lifted a safety restriction on a connection",
"tags": [
"Webhooks"
],
@@ -94615,7 +94413,7 @@
"bansafe.incident": {
"post": {
"operationId": "onBansafeIncident",
- "summary": "A restriction was recorded on a number, or the record of one settled",
+ "summary": "A restriction was recorded on a connection, or the record of one settled",
"tags": [
"Webhooks"
],
@@ -95143,7 +94941,7 @@
"campaign.cap_reached": {
"post": {
"operationId": "onCampaignCapReached",
- "summary": "A sending number reached its hourly or daily cap",
+ "summary": "A sending connection reached its hourly or daily cap",
"tags": [
"Webhooks"
],
diff --git a/contracts/openapi.platform.json b/contracts/openapi.platform.json
index 24e089803..0fc52c8a5 100644
--- a/contracts/openapi.platform.json
+++ b/contracts/openapi.platform.json
@@ -3,7 +3,7 @@
"info": {
"title": "Polymorfa Console & Management API",
"version": "1.0.0",
- "description": "Complete console/management surface. Resource-oriented REST: `{param}` path variables, single-word action sub-resources.\n\nNamespaces decide inclusion:\n- `/platform/…` — **public registry** (283 endpoints): each endpoint declares either a scoped `pmfa_` team key or a verified live dashboard JWT, or dashboard-only authorization when a specific user's authority is required. Only implemented handlers are published to customers and SDKs.\n- `/console/…` — **console-only** (130 endpoints): verified dashboard identity. EXCLUDED from the published spec; reason per endpoint.\n\nThe published customer spec = this document filtered to `x-audience: public` endpoints with an implemented runtime handler.\nMost transitional body/response schemas remain loose (`additionalProperties: true`); session-control operations use explicit strict schemas."
+ "description": "Complete console/management surface. Resource-oriented REST: `{param}` path variables, single-word action sub-resources.\n\nNamespaces decide inclusion:\n- `/platform/…` — **public registry** (283 endpoints): each endpoint declares either a scoped `pmfa_` team key or a verified live dashboard JWT, or dashboard-only authorization when a specific user's authority is required. Only implemented handlers are published to customers and SDKs.\n- `/console/…` — **console-only** (130 endpoints): verified dashboard identity. EXCLUDED from the published spec; reason per endpoint.\n\nThe published customer spec = this document filtered to `x-audience: public` endpoints with an implemented runtime handler.\nMost transitional body/response schemas remain loose (`additionalProperties: true`); connection-control operations use explicit strict schemas."
},
"servers": [
{
@@ -292,7 +292,7 @@
"/api/account/cloud-health": {
"get": {
"operationId": "getAccountCloudHealth",
- "summary": "Read a Number's redacted Meta account health",
+ "summary": "Read a Connection's redacted Meta account health",
"tags": [
"Account"
],
@@ -315,7 +315,7 @@
}
},
{
- "name": "session",
+ "name": "connection",
"in": "query",
"required": true,
"schema": {
@@ -335,7 +335,7 @@
}
},
"400": {
- "description": "Invalid project or Number"
+ "description": "Invalid project or Connection"
},
"401": {
"description": "Missing or invalid dashboard JWT, or identity no longer active",
@@ -362,7 +362,7 @@
"/api/account/cloud-health/export": {
"get": {
"operationId": "exportAccountCloudHealth",
- "summary": "Download a Number's redacted Meta account health",
+ "summary": "Download a Connection's redacted Meta account health",
"tags": [
"Account"
],
@@ -385,7 +385,7 @@
}
},
{
- "name": "session",
+ "name": "connection",
"in": "query",
"required": true,
"schema": {
@@ -413,7 +413,7 @@
}
},
"400": {
- "description": "Invalid project or Number"
+ "description": "Invalid project or Connection"
},
"401": {
"description": "Missing or invalid dashboard JWT, or identity no longer active",
@@ -441,7 +441,7 @@
"get": {
"operationId": "getRegionalDataSettings",
"summary": "Read regional data settings for one scope",
- "description": "Returns the saved values at one scope (team, project, Customer or Number) and, for a Number, the effective values with the scope each field came from.",
+ "description": "Returns the saved values at one scope (team, project, Customer or Connection) and, for a Connection, the effective values with the scope each field came from.",
"tags": [
"Regional data"
],
@@ -473,7 +473,7 @@
"team",
"project",
"customer",
- "number"
+ "connection"
]
}
},
@@ -481,7 +481,7 @@
"name": "scopeId",
"in": "query",
"required": false,
- "description": "Required for `customer` and `number`; for `project`, omit it or pass the project ID.",
+ "description": "Required for `customer` and `connection`; for `project`, omit it or pass the project ID.",
"schema": {
"type": "string",
"format": "uuid"
@@ -523,7 +523,7 @@
}
},
"404": {
- "description": "`project_not_found`, `scope_not_found` or `number_not_found`",
+ "description": "`project_not_found`, `scope_not_found` or `connection_not_found`",
"content": {
"application/json": {
"schema": {
@@ -557,7 +557,7 @@
"put": {
"operationId": "putRegionalDataSettings",
"summary": "Save regional data settings for one scope",
- "description": "Revision-guarded write with exact replay. Turning Contacts, Chats or media on requires accepting the purpose. The response reports whether capture already follows the saved settings for every affected Number (`applied`) or is still being brought in line (`pending`). A change that would move a Number's existing regional data to another region is refused.",
+ "description": "Revision-guarded write with exact replay. Turning Contacts, Chats or media on requires accepting the purpose. The response reports whether capture already follows the saved settings for every affected Connection (`applied`) or is still being brought in line (`pending`). A change that would move a Connection's existing regional data to another region is refused.",
"tags": [
"Regional data"
],
@@ -589,7 +589,7 @@
"team",
"project",
"customer",
- "number"
+ "connection"
]
}
},
@@ -597,7 +597,7 @@
"name": "scopeId",
"in": "query",
"required": false,
- "description": "Required for `customer` and `number`; for `project`, omit it or pass the project ID.",
+ "description": "Required for `customer` and `connection`; for `project`, omit it or pass the project ID.",
"schema": {
"type": "string",
"format": "uuid"
@@ -649,7 +649,7 @@
}
},
"404": {
- "description": "`project_not_found`, `scope_not_found` or `number_not_found`",
+ "description": "`project_not_found`, `scope_not_found` or `connection_not_found`",
"content": {
"application/json": {
"schema": {
@@ -659,7 +659,7 @@
}
},
"409": {
- "description": "`stale_revision`, `terms_activation_blocked` when `acceptTerms` is supplied while these terms cannot be accepted yet, or `region_change_unsupported` when a Number's regional data already lives in another region",
+ "description": "`stale_revision`, `terms_activation_blocked` when `acceptTerms` is supplied while these terms cannot be accepted yet, or `region_change_unsupported` when a Connection's regional data already lives in another region",
"content": {
"application/json": {
"schema": {
@@ -736,8 +736,8 @@
"/console/projects/{projectId}/regional-data/client-tokens": {
"post": {
"operationId": "issueConsoleRegionalClientToken",
- "summary": "Issue a session-bound regional Console client token",
- "description": "Default-off Console beta. Platform issues a 60-second signed v1 binary client token bound to the live human/dashboard session, team, one region, one project, exact Number set (at most 64), origin and action ceiling. The dashboard JWT stays on Platform. The old access exchange remains supported until Phase 3 acceptance.",
+ "summary": "Issue a connection-bound regional Console client token",
+ "description": "Default-off Console beta. Platform issues a 60-second signed v1 binary client token bound to the live human/dashboard session, team, one region, one project, exact Connection set (at most 64), origin and action ceiling. The dashboard JWT stays on Platform. The old access exchange remains supported until Phase 3 acceptance.",
"tags": [
"Regional data"
],
@@ -768,16 +768,16 @@
"type": "object",
"additionalProperties": false,
"required": [
- "numberIds",
+ "connectionIds",
"permissions"
],
"properties": {
"region": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{0,31}$",
- "description": "Omission derives the region from the first Number; all Numbers must share it."
+ "description": "Omission derives the region from the first Connection; all Connections must share it."
},
- "numberIds": {
+ "connectionIds": {
"type": "array",
"minItems": 1,
"maxItems": 64,
@@ -821,7 +821,7 @@
}
},
"400": {
- "description": "invalid_access_request, including empty, duplicate or oversized Number sets",
+ "description": "invalid_access_request, including empty, duplicate or oversized Connection sets",
"content": {
"application/json": {
"schema": {
@@ -844,7 +844,7 @@
}
},
"404": {
- "description": "number_not_found",
+ "description": "connection_not_found",
"content": {
"application/json": {
"schema": {
@@ -899,8 +899,8 @@
"/console/projects/{projectId}/regional-data/access": {
"post": {
"operationId": "issueRegionalDataAccess",
- "summary": "Issue short-lived regional access for one Number",
- "description": "Returns a token of at most 60 seconds for reading and editing one Number's regional Contacts, reading its Chats, sending text messages, or archiving, pinning and changing the read state of a retained chat, directly from its region. Requires the Console origin, the purpose's feature and an applied regional grant. Reads and edits need an accepted purpose; `messages.send` needs the Chats feature and a team owner or admin, but no storage purpose; `chats.manage` needs the Chats feature, the accepted Chats purpose and a team owner or admin.",
+ "summary": "Issue short-lived regional access for one Connection",
+ "description": "Returns a token of at most 60 seconds for reading and editing one Connection's regional Contacts, reading its Chats, sending text messages, or archiving, pinning and changing the read state of a retained chat, directly from its region. Requires the Console origin, the purpose's feature and an applied regional grant. Reads and edits need an accepted purpose; `messages.send` needs the Chats feature and a team owner or admin, but no storage purpose; `chats.manage` needs the Chats feature, the accepted Chats purpose and a team owner or admin.",
"tags": [
"Regional data"
],
@@ -939,11 +939,11 @@
"type": "object",
"additionalProperties": false,
"required": [
- "numberId",
+ "connectionId",
"permissions"
],
"properties": {
- "numberId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -1004,7 +1004,7 @@
}
},
"404": {
- "description": "`project_not_found` or `number_not_found`",
+ "description": "`project_not_found` or `connection_not_found`",
"content": {
"application/json": {
"schema": {
@@ -1112,16 +1112,16 @@
}
}
},
- "/console/projects/{projectId}/numbers/{session}/catalogs": {
+ "/console/projects/{projectId}/connections/{connection}/catalogs": {
"get": {
"operationId": "listConsoleCloudCatalogs",
- "summary": "Read cached catalog metadata for a Console Number",
+ "summary": "Read cached catalog metadata for a Console Connection",
"tags": [
"Catalogs"
],
"x-audience": "console",
"x-dashboard-only": true,
- "x-excluded-reason": "Private dashboard catalog adapter. Live team membership, exact project/Number and existing catalog beta required; sync requires live owner/admin membership. Not a machine-credential operation.",
+ "x-excluded-reason": "Private dashboard catalog adapter. Live team membership, exact project/Connection and existing catalog beta required; sync requires live owner/admin membership. Not a machine-credential operation.",
"security": [
{
"ConsoleSession": []
@@ -1223,7 +1223,7 @@
}
},
"400": {
- "description": "Invalid selector/cursor or unsupported Number"
+ "description": "Invalid selector/cursor or unsupported Connection"
},
"401": {
"description": "Live dashboard JWT required"
@@ -1232,7 +1232,7 @@
"description": "feature_unavailable, or permission_denied for a sync by a non-manager"
},
"404": {
- "description": "Number/project missing, catalog_not_synced, or catalog_not_linked after confirmed unlink"
+ "description": "Connection/project missing, catalog_not_synced, or catalog_not_linked after confirmed unlink"
},
"409": {
"description": "team_context_changed, catalog_snapshot_changed (restart without cursor), or catalog_sync_superseded"
@@ -1281,7 +1281,7 @@
}
},
{
- "name": "session",
+ "name": "connection",
"in": "path",
"required": true,
"schema": {
@@ -1289,22 +1289,22 @@
"minLength": 1,
"maxLength": 128
},
- "description": "Stable Number name in this project."
+ "description": "Stable Connection name in this project."
}
],
"description": "Uses the same catalog response and errors as the native Messaging API. Reads never call Meta. The catalog beta must be available; 403 feature_unavailable means hide this surface. Send the expected team header on every request. No request body for sync."
}
},
- "/console/projects/{projectId}/numbers/{session}/catalogs/{catalogId}": {
+ "/console/projects/{projectId}/connections/{connection}/catalogs/{catalogId}": {
"get": {
"operationId": "getConsoleCloudCatalog",
- "summary": "Read cached catalog metadata for a Console Number",
+ "summary": "Read cached catalog metadata for a Console Connection",
"tags": [
"Catalogs"
],
"x-audience": "console",
"x-dashboard-only": true,
- "x-excluded-reason": "Private dashboard catalog adapter. Live team membership, exact project/Number and existing catalog beta required; sync requires live owner/admin membership. Not a machine-credential operation.",
+ "x-excluded-reason": "Private dashboard catalog adapter. Live team membership, exact project/Connection and existing catalog beta required; sync requires live owner/admin membership. Not a machine-credential operation.",
"security": [
{
"ConsoleSession": []
@@ -1394,7 +1394,7 @@
}
},
"400": {
- "description": "Invalid selector/cursor or unsupported Number"
+ "description": "Invalid selector/cursor or unsupported Connection"
},
"401": {
"description": "Live dashboard JWT required"
@@ -1403,7 +1403,7 @@
"description": "feature_unavailable, or permission_denied for a sync by a non-manager"
},
"404": {
- "description": "Number/project missing, catalog_not_synced, or catalog_not_linked after confirmed unlink"
+ "description": "Connection/project missing, catalog_not_synced, or catalog_not_linked after confirmed unlink"
},
"409": {
"description": "team_context_changed, catalog_snapshot_changed (restart without cursor), or catalog_sync_superseded"
@@ -1452,7 +1452,7 @@
}
},
{
- "name": "session",
+ "name": "connection",
"in": "path",
"required": true,
"schema": {
@@ -1460,7 +1460,7 @@
"minLength": 1,
"maxLength": 128
},
- "description": "Stable Number name in this project."
+ "description": "Stable Connection name in this project."
},
{
"name": "catalogId",
@@ -1475,16 +1475,16 @@
"description": "Uses the same catalog response and errors as the native Messaging API. Reads never call Meta. The catalog beta must be available; 403 feature_unavailable means hide this surface. Send the expected team header on every request. No request body for sync."
}
},
- "/console/projects/{projectId}/numbers/{session}/catalogs/{catalogId}/sync": {
+ "/console/projects/{projectId}/connections/{connection}/catalogs/{catalogId}/sync": {
"post": {
"operationId": "syncConsoleCloudCatalog",
- "summary": "Sync a linked catalog for a Console Number",
+ "summary": "Sync a linked catalog for a Console Connection",
"tags": [
"Catalogs"
],
"x-audience": "console",
"x-dashboard-only": true,
- "x-excluded-reason": "Private dashboard catalog adapter. Live team membership, exact project/Number and existing catalog beta required; sync requires live owner/admin membership. Not a machine-credential operation.",
+ "x-excluded-reason": "Private dashboard catalog adapter. Live team membership, exact project/Connection and existing catalog beta required; sync requires live owner/admin membership. Not a machine-credential operation.",
"security": [
{
"ConsoleSession": []
@@ -1574,7 +1574,7 @@
}
},
"400": {
- "description": "Invalid selector/cursor or unsupported Number"
+ "description": "Invalid selector/cursor or unsupported Connection"
},
"401": {
"description": "Live dashboard JWT required"
@@ -1583,7 +1583,7 @@
"description": "feature_unavailable, or permission_denied for a sync by a non-manager"
},
"404": {
- "description": "Number/project missing, catalog_not_synced, or catalog_not_linked after confirmed unlink"
+ "description": "Connection/project missing, catalog_not_synced, or catalog_not_linked after confirmed unlink"
},
"409": {
"description": "team_context_changed, catalog_snapshot_changed (restart without cursor), or catalog_sync_superseded"
@@ -1632,7 +1632,7 @@
}
},
{
- "name": "session",
+ "name": "connection",
"in": "path",
"required": true,
"schema": {
@@ -1640,7 +1640,7 @@
"minLength": 1,
"maxLength": 128
},
- "description": "Stable Number name in this project."
+ "description": "Stable Connection name in this project."
},
{
"name": "catalogId",
@@ -1655,16 +1655,16 @@
"description": "Uses the same catalog response and errors as the native Messaging API. Reads never call Meta. The catalog beta must be available; 403 feature_unavailable means hide this surface. Send the expected team header on every request. No request body for sync."
}
},
- "/console/projects/{projectId}/numbers/{session}/catalogs/{catalogId}/products": {
+ "/console/projects/{projectId}/connections/{connection}/catalogs/{catalogId}/products": {
"get": {
"operationId": "listConsoleCloudCatalogProducts",
- "summary": "Read cached catalog metadata for a Console Number",
+ "summary": "Read cached catalog metadata for a Console Connection",
"tags": [
"Catalogs"
],
"x-audience": "console",
"x-dashboard-only": true,
- "x-excluded-reason": "Private dashboard catalog adapter. Live team membership, exact project/Number and existing catalog beta required; sync requires live owner/admin membership. Not a machine-credential operation.",
+ "x-excluded-reason": "Private dashboard catalog adapter. Live team membership, exact project/Connection and existing catalog beta required; sync requires live owner/admin membership. Not a machine-credential operation.",
"security": [
{
"ConsoleSession": []
@@ -1811,7 +1811,7 @@
}
},
"400": {
- "description": "Invalid selector/cursor or unsupported Number"
+ "description": "Invalid selector/cursor or unsupported Connection"
},
"401": {
"description": "Live dashboard JWT required"
@@ -1820,7 +1820,7 @@
"description": "feature_unavailable, or permission_denied for a sync by a non-manager"
},
"404": {
- "description": "Number/project missing, catalog_not_synced, or catalog_not_linked after confirmed unlink"
+ "description": "Connection/project missing, catalog_not_synced, or catalog_not_linked after confirmed unlink"
},
"409": {
"description": "team_context_changed, catalog_snapshot_changed (restart without cursor), or catalog_sync_superseded"
@@ -1869,7 +1869,7 @@
}
},
{
- "name": "session",
+ "name": "connection",
"in": "path",
"required": true,
"schema": {
@@ -1877,7 +1877,7 @@
"minLength": 1,
"maxLength": 128
},
- "description": "Stable Number name in this project."
+ "description": "Stable Connection name in this project."
},
{
"name": "catalogId",
@@ -2548,8 +2548,8 @@
"ConsoleSession": []
}
],
- "description": "**Required scope:** `sessions:read`\n\nReturns published feature terms and this scope's acceptance. Pending terms have no text or acceptance requirement. Terms that cannot be activated yet stay pending even after publication. Accepting terms grants no feature access. Requires a team API key or a signed-in team member. Number scope IDs are Number resource UUIDs.",
- "x-required-scope": "sessions:read",
+ "description": "**Required scope:** `connections:read`\n\nReturns published feature terms and this scope's acceptance. Pending terms have no text or acceptance requirement. Terms that cannot be activated yet stay pending even after publication. Accepting terms grants no feature access. Requires a team API key or a signed-in team member. Connection scope IDs are Connection resource UUIDs.",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -2558,7 +2558,7 @@
"team",
"project",
"customer",
- "number"
+ "connection"
],
"default": "team"
},
@@ -2570,10 +2570,10 @@
"schema": {
"type": "string",
"format": "uuid",
- "description": "Required for project, customer and number scopes. Defaults to the authenticated team for team scope."
+ "description": "Required for project, customer and connection scopes. Defaults to the authenticated team for team scope."
},
"required": false,
- "description": "Required for project, customer and number scopes. Defaults to the authenticated team for team scope.",
+ "description": "Required for project, customer and connection scopes. Defaults to the authenticated team for team scope.",
"name": "scopeId",
"in": "query"
},
@@ -2782,9 +2782,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
"x-audience": "console",
"x-dashboard-only": true,
"x-excluded-reason": "Live dashboard membership; acceptance and withdrawal require a team owner or admin."
@@ -2802,8 +2799,8 @@
"ConsoleSession": []
}
],
- "description": "**Required scope:** `sessions:manage`\n\nRecords the exact published version, locale and text digest for this scope. Requires a team API key with sessions:manage, or a signed-in team owner or admin. Preview enrollment terms require a signed-in team owner or admin. Staff cannot accept for a customer. A repeated acceptance returns the existing record. This does not turn the feature on.",
- "x-required-scope": "sessions:manage",
+ "description": "**Required scope:** `connections:manage`\n\nRecords the exact published version, locale and text digest for this scope. Requires a team API key with connections:manage, or a signed-in team owner or admin. Preview enrollment terms require a signed-in team owner or admin. Staff cannot accept for a customer. A repeated acceptance returns the existing record. This does not turn the feature on.",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -2831,7 +2828,7 @@
"team",
"project",
"customer",
- "number"
+ "connection"
]
},
"id": {
@@ -3064,9 +3061,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "console",
"x-dashboard-only": true,
"x-excluded-reason": "Live dashboard membership; acceptance and withdrawal require a team owner or admin."
@@ -3084,8 +3078,8 @@
"ConsoleSession": []
}
],
- "description": "**Required scope:** `sessions:manage`\n\nAppends a withdrawal without changing the acceptance record. Requires a team API key with sessions:manage, or a signed-in team owner or admin. Preview enrollment terms require a signed-in team owner or admin. No current terms are required. Repeated withdrawals return the existing record; no previous acceptance returns null. Preview Contacts/Chats withdrawals reconcile capture before success; 503 service_unavailable means the withdrawal is recorded but capture is pending. Retrying the same withdrawal is safe. Other features must also be turned off through their settings to stop their work.",
- "x-required-scope": "sessions:manage",
+ "description": "**Required scope:** `connections:manage`\n\nAppends a withdrawal without changing the acceptance record. Requires a team API key with connections:manage, or a signed-in team owner or admin. Preview enrollment terms require a signed-in team owner or admin. No current terms are required. Repeated withdrawals return the existing record; no previous acceptance returns null. Preview Contacts/Chats withdrawals reconcile capture before success; 503 service_unavailable means the withdrawal is recorded but capture is pending. Retrying the same withdrawal is safe. Other features must also be turned off through their settings to stop their work.",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -3113,7 +3107,7 @@
"team",
"project",
"customer",
- "number"
+ "connection"
]
},
"id": {
@@ -3327,9 +3321,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "console",
"x-dashboard-only": true,
"x-excluded-reason": "Live dashboard membership; acceptance and withdrawal require a team owner or admin."
@@ -3363,7 +3354,7 @@
"schema": {
"type": "string",
"description": "Comma-separated event types to include, or repeat the parameter. A trailing `*` matches a prefix, such as `message.*`. Omit for every type. At most 32 filters.",
- "example": "message.*,session.connected"
+ "example": "message.*,connection.connected"
},
"required": false,
"name": "types",
@@ -3612,9 +3603,6 @@
}
}
},
- "x-mint": {
- "content": "events:listen "
- },
"x-audience": "public"
}
},
@@ -3865,9 +3853,6 @@
}
}
},
- "x-mint": {
- "content": "events:listen "
- },
"x-audience": "public"
}
},
@@ -3878,14 +3863,14 @@
"Client Tokens"
],
"summary": "Mint a short-lived browser-safe client token",
- "description": "**Required scopes (all):** `sessions:manage` · `messages:write` · `contacts:read` · `presence:read` · `presence:observe` · `mcp`\n\nMinting requires an active, unrevoked issuer with the required scopes and current resource ownership. A human-owned issuer must belong to a current team owner or admin who is not banned. Service-account credentials can delegate only actions allowed by the issuing credential's live scopes. Test-key clients remain restricted to test numbers. Issuance eligibility denials return 403; unavailable issuance checks return 503 and no token.",
+ "description": "**Required scopes (all):** `connections:manage` · `messages:write` · `contacts:read` · `presence:read` · `presence:observe` · `mcp`\n\nMinting requires an active, unrevoked issuer with the required scopes and current resource ownership. A human-owned issuer must belong to a current team owner or admin who is not banned. Service-account credentials can delegate only actions allowed by the issuing credential's live scopes. Test-key clients remain restricted to test connections. Issuance eligibility denials return 403; unavailable issuance checks return 503 and no token.",
"security": [
{
"ApiKeyAuth": []
}
],
"x-required-scopes": [
- "sessions:manage",
+ "connections:manage",
"messages:write",
"contacts:read",
"presence:read",
@@ -4085,32 +4070,29 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage messages:write contacts:read presence:read presence:observe mcp "
- },
"x-audience": "public"
}
},
- "/platform/sessions/{session}/client-rules": {
+ "/platform/connections/{connection}/client-rules": {
"get": {
"operationId": "getClientRules",
"tags": [
"Client Tokens"
],
- "summary": "Get client-token rules for a session",
+ "summary": "Get client-token rules for a connection",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -4297,10 +4279,7 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
- "description": "**Required scope:** `sessions:manage`",
+ "description": "**Required scope:** `connections:manage`",
"x-audience": "public"
},
"put": {
@@ -4308,14 +4287,14 @@
"tags": [
"Client Tokens"
],
- "summary": "Set client-token rules for a session",
+ "summary": "Set client-token rules for a connection",
"security": [
{
"ApiKeyAuth": []
}
],
"x-required-scopes": [
- "sessions:manage",
+ "connections:manage",
"messages:write",
"contacts:read",
"presence:read",
@@ -4329,7 +4308,7 @@
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -4525,10 +4504,7 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage messages:write contacts:read presence:read presence:observe mcp "
- },
- "description": "**Required scopes (all):** `sessions:manage` · `messages:write` · `contacts:read` · `presence:read` · `presence:observe` · `mcp`",
+ "description": "**Required scopes (all):** `connections:manage` · `messages:write` · `contacts:read` · `presence:read` · `presence:observe` · `mcp`",
"x-audience": "public"
},
"delete": {
@@ -4536,20 +4512,20 @@
"tags": [
"Client Tokens"
],
- "summary": "Delete client-token rules for a session",
+ "summary": "Delete client-token rules for a connection",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -4736,26 +4712,23 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
- "description": "**Required scope:** `sessions:manage`",
+ "description": "**Required scope:** `connections:manage`",
"x-audience": "public"
}
},
- "/platform/sessions/{session}/call-settings": {
+ "/platform/connections/{connection}/call-settings": {
"get": {
"operationId": "getCallSettings",
"tags": [
"Calls"
],
- "summary": "Get call settings for a session",
+ "summary": "Get call settings for a connection",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -4764,13 +4737,13 @@
"maxLength": 128
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
"responses": {
"200": {
- "description": "Call settings. Sessions without saved settings return the defaults.",
+ "description": "Call settings. Connections without saved settings return the defaults.",
"content": {
"application/json": {
"schema": {
@@ -4951,10 +4924,7 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
- "description": "**Required scope:** `sessions:read`",
+ "description": "**Required scope:** `connections:read`",
"x-audience": "public"
},
"put": {
@@ -4962,14 +4932,14 @@
"tags": [
"Calls"
],
- "summary": "Update call settings for a session",
- "description": "**Required scope:** `sessions:manage`\n\nChanges the settings you send; omitted settings keep their current values. Send `expectedRevision` to refuse the update when someone else changed the settings after you read them.",
+ "summary": "Update call settings for a connection",
+ "description": "**Required scope:** `connections:manage`\n\nChanges the settings you send; omitted settings keep their current values. Send `expectedRevision` to refuse the update when someone else changed the settings after you read them.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -4978,7 +4948,7 @@
"maxLength": 128
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -5207,9 +5177,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "public"
}
},
@@ -5220,13 +5187,13 @@
"Calls"
],
"summary": "Get your team's call data retention",
- "description": "**Required scope:** `sessions:read`\n\nReturns how long Polymorfa keeps your team's call data. Teams without a saved setting return the default.",
+ "description": "**Required scope:** `connections:read`\n\nReturns how long Polymorfa keeps your team's call data. Teams without a saved setting return the default.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"responses": {
"200": {
"description": "The team's call data retention.",
@@ -5410,9 +5377,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
"x-audience": "public"
},
"put": {
@@ -5421,13 +5385,13 @@
"Calls"
],
"summary": "Update your team's call data retention",
- "description": "**Required scope:** `sessions:manage`\n\nRecords how long Polymorfa keeps your team's call data. Requires a team API key. Deletion of call data older than the period starts on a date Polymorfa announces in the changelog; until then, saving a period deletes nothing. Once deletion runs, a shorter period also applies to call data already stored, and deleted data cannot be recovered. Send `expectedRevision` to refuse the update when someone else changed the setting after you read it.",
+ "description": "**Required scope:** `connections:manage`\n\nRecords how long Polymorfa keeps your team's call data. Requires a team API key. Deletion of call data older than the period starts on a date Polymorfa announces in the changelog; until then, saving a period deletes nothing. Once deletion runs, a shorter period also applies to call data already stored, and deleted data cannot be recovered. Send `expectedRevision` to refuse the update when someone else changed the setting after you read it.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"requestBody": {
"required": true,
"content": {
@@ -5653,9 +5617,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "public"
}
},
@@ -5666,13 +5627,13 @@
"Calls"
],
"summary": "Export call records",
- "description": "**Required scope:** `sessions:read`\n\nReturns up to 1,000 call detail records per request as CSV or newline-delimited JSON, newest first, with the same fields and filters as List call records. The other party appears only as `peerRef`, a team-specific pseudonym. Each CSV page starts with a header row. When more records match, the `Polymorfa-Next-Cursor` response header carries the cursor for the next page; it is absent on the last page.",
+ "description": "**Required scope:** `connections:read`\n\nReturns up to 1,000 call detail records per request as CSV or newline-delimited JSON, newest first, with the same fields and filters as List call records. The other party appears only as `peerRef`, a team-specific pseudonym. Each CSV page starts with a header row. When more records match, the `Polymorfa-Next-Cursor` response header carries the cursor for the next page; it is absent on the last page.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -5690,11 +5651,11 @@
"type": "string",
"minLength": 1,
"maxLength": 128,
- "description": "Session name of one number."
+ "description": "Connection name of one connection."
},
"required": false,
- "description": "Session name of one number.",
- "name": "sessionId",
+ "description": "Connection name of one connection.",
+ "name": "connectionId",
"in": "query"
},
{
@@ -5716,10 +5677,10 @@
"linked_device",
"cloud_api"
],
- "description": "How the number connects to WhatsApp."
+ "description": "How the connection connects to WhatsApp."
},
"required": false,
- "description": "How the number connects to WhatsApp.",
+ "description": "How the connection connects to WhatsApp.",
"name": "upstream",
"in": "query"
},
@@ -5827,7 +5788,7 @@
"text/csv": {
"schema": {
"type": "string",
- "description": "Header row, then one row per call. Columns: callId, projectId, sessionId, direction, upstream, outcome, state, hasVideo, peerRef, startedAt, connectedAt, endedAt, durationSeconds, endReason. Empty fields are null. Text that begins with =, +, -, @, tab or carriage return is prefixed with an apostrophe."
+ "description": "Header row, then one row per call. Columns: callId, projectId, connectionId, direction, upstream, outcome, state, hasVideo, peerRef, startedAt, connectedAt, endedAt, durationSeconds, endReason. Empty fields are null. Text that begins with =, +, -, @, tab or carriage return is prefixed with an apostrophe."
}
},
"application/x-ndjson": {
@@ -5999,9 +5960,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
"x-audience": "public"
}
},
@@ -6012,14 +5970,14 @@
"Analytics"
],
"summary": "Export analytics metrics",
- "description": "**Required scope:** `sessions:read`\n\nAuthenticated metrics for a customer's Prometheus or OpenTelemetry Collector. Requires live Analytics enablement. Disabled Analytics returns only enablement and export-window metrics, with no business measurements. All samples are gauges: counts describe an overlapping window, not monotonic counters. Do not use rate() or increase() on them. Labels contain number/project record IDs and bounded categories, never contact identities or message content. Null or unmeasured values are omitted; coverage and observation timestamps are included. API request vitals retain project/team scope even when filtering a number.",
+ "description": "**Required scope:** `connections:read`\n\nAuthenticated metrics for a customer's Prometheus or OpenTelemetry Collector. Requires live Analytics enablement. Disabled Analytics returns only enablement and export-window metrics, with no business measurements. All samples are gauges: counts describe an overlapping window, not monotonic counters. Do not use rate() or increase() on them. Labels contain connection/project record IDs and bounded categories, never contact identities or message content. Null or unmeasured values are omitted; coverage and observation timestamps are included. API request vitals retain project/team scope even when filtering a connection.",
"security": [
{
"ApiKeyAuth": []
}
],
"x-polymorfa-resource-boundary": "project",
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -6034,11 +5992,11 @@
"schema": {
"type": "string",
"format": "uuid",
- "description": "One number record UUID, within the authorized project or team."
+ "description": "One connection record UUID, within the authorized project or team."
},
"required": false,
- "description": "One number record UUID, within the authorized project or team.",
- "name": "sessionId",
+ "description": "One connection record UUID, within the authorized project or team.",
+ "name": "connectionId",
"in": "query"
},
{
@@ -6305,9 +6263,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
"x-audience": "public"
}
},
@@ -6318,14 +6273,14 @@
"Analytics"
],
"summary": "Export project analytics metrics",
- "description": "**Required scope:** `sessions:read`\n\nAuthenticated metrics for a customer's Prometheus or OpenTelemetry Collector. Requires live Analytics enablement. Disabled Analytics returns only enablement and export-window metrics, with no business measurements. All samples are gauges: counts describe an overlapping window, not monotonic counters. Do not use rate() or increase() on them. Labels contain number/project record IDs and bounded categories, never contact identities or message content. Null or unmeasured values are omitted; coverage and observation timestamps are included. API request vitals retain project/team scope even when filtering a number.",
+ "description": "**Required scope:** `connections:read`\n\nAuthenticated metrics for a customer's Prometheus or OpenTelemetry Collector. Requires live Analytics enablement. Disabled Analytics returns only enablement and export-window metrics, with no business measurements. All samples are gauges: counts describe an overlapping window, not monotonic counters. Do not use rate() or increase() on them. Labels contain connection/project record IDs and bounded categories, never contact identities or message content. Null or unmeasured values are omitted; coverage and observation timestamps are included. API request vitals retain project/team scope even when filtering a connection.",
"security": [
{
"ApiKeyAuth": []
}
],
"x-polymorfa-resource-boundary": "project",
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -6340,11 +6295,11 @@
"schema": {
"type": "string",
"format": "uuid",
- "description": "One number record UUID, within the authorized project or team."
+ "description": "One connection record UUID, within the authorized project or team."
},
"required": false,
- "description": "One number record UUID, within the authorized project or team.",
- "name": "sessionId",
+ "description": "One connection record UUID, within the authorized project or team.",
+ "name": "connectionId",
"in": "query"
},
{
@@ -6611,9 +6566,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
"x-audience": "public"
}
},
@@ -6624,13 +6576,13 @@
"SIP Trunks"
],
"summary": "Get the SIP address",
- "description": "**Required scope:** `sessions:read`\n\nReturns the host and ports your PBX sends SIP to, and the RTP port range to allow for call audio. When this environment does not host SIP, `status` is `sip_not_hosted` and no address is returned. The address is the same for every trunk of every project.",
+ "description": "**Required scope:** `connections:read`\n\nReturns the host and ports your PBX sends SIP to, and the RTP port range to allow for call audio. When this environment does not host SIP, `status` is `sip_not_hosted` and no address is returned. The address is the same for every trunk of every project.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"responses": {
"200": {
"description": "The SIP address, or `sip_not_hosted`.",
@@ -6814,9 +6766,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
"x-audience": "public"
}
},
@@ -6827,13 +6776,13 @@
"SIP Trunks"
],
"summary": "List SIP trunks",
- "description": "**Required scope:** `sessions:read`\n\nLists the SIP trunks of a project. Passwords are never returned.",
+ "description": "**Required scope:** `connections:read`\n\nLists the SIP trunks of a project. Passwords are never returned.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -7029,9 +6978,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
"x-audience": "public"
},
"post": {
@@ -7040,13 +6986,13 @@
"SIP Trunks"
],
"summary": "Create a SIP trunk",
- "description": "**Required scope:** `sessions:manage`\n\nConnects a PBX or SIP trunk to WhatsApp calls. An `outbound` trunk receives the incoming WhatsApp calls of sessions whose call settings route to it. An `inbound` trunk lets your PBX place WhatsApp calls through a session. For trunks that accept calls from your PBX, the response contains the digest credentials once.",
+ "description": "**Required scope:** `connections:manage`\n\nConnects a PBX or SIP trunk to WhatsApp calls. An `outbound` trunk receives the incoming WhatsApp calls of connections whose call settings route to it. An `inbound` trunk lets your PBX place WhatsApp calls through a connection. For trunks that accept calls from your PBX, the response contains the digest credentials once.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"requestBody": {
"required": true,
"content": {
@@ -7304,9 +7250,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "public"
}
},
@@ -7322,7 +7265,7 @@
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -7517,10 +7460,7 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
- "description": "**Required scope:** `sessions:read`",
+ "description": "**Required scope:** `connections:read`",
"x-audience": "public"
},
"patch": {
@@ -7529,13 +7469,13 @@
"SIP Trunks"
],
"summary": "Update a SIP trunk",
- "description": "**Required scope:** `sessions:manage`\n\nChanges the fields you send and keeps the others. Send `expectedRevision` to refuse the change with `409 sip_trunk_revision_conflict` when the trunk changed since you read it. Changes apply to new calls within about a minute; calls in progress continue.",
+ "description": "**Required scope:** `connections:manage`\n\nChanges the fields you send and keeps the others. Send `expectedRevision` to refuse the change with `409 sip_trunk_revision_conflict` when the trunk changed since you read it. Changes apply to new calls within about a minute; calls in progress continue.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -7804,9 +7744,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "public"
},
"delete": {
@@ -7815,13 +7752,13 @@
"SIP Trunks"
],
"summary": "Delete a SIP trunk",
- "description": "**Required scope:** `sessions:manage`\n\nDeletes the trunk and its credentials. Returns `409 sip_trunk_in_use` while a session's call settings route incoming calls to it.",
+ "description": "**Required scope:** `connections:manage`\n\nDeletes the trunk and its credentials. Returns `409 sip_trunk_in_use` while a connection's call settings route incoming calls to it.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -7984,7 +7921,7 @@
}
},
"409": {
- "description": "`sip_trunk_in_use`: a session's call settings route incoming calls to the trunk.",
+ "description": "`sip_trunk_in_use`: a connection's call settings route incoming calls to the trunk.",
"content": {
"application/json": {
"schema": {
@@ -7994,7 +7931,7 @@
"error": {
"type": "conflict_error",
"code": "sip_trunk_in_use",
- "message": "A session still sends incoming calls to this SIP trunk.",
+ "message": "A connection still sends incoming calls to this SIP trunk.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -8048,9 +7985,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "public"
}
},
@@ -8061,13 +7995,13 @@
"SIP Trunks"
],
"summary": "Rotate SIP trunk credentials",
- "description": "**Required scope:** `sessions:manage`\n\nReplaces the password your PBX uses to place calls. The previous password stops working within about a minute. Returns `409 state_conflict` for `outbound` trunks.",
+ "description": "**Required scope:** `connections:manage`\n\nReplaces the password your PBX uses to place calls. The previous password stops working within about a minute. Returns `409 state_conflict` for `outbound` trunks.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -8326,9 +8260,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "public"
}
},
@@ -8339,13 +8270,13 @@
"Call Consent"
],
"summary": "Get the team's call policy",
- "description": "**Required scope:** `sessions:read`\n\nReturns the team's blocked country codes and the size of its do-not-call list.",
+ "description": "**Required scope:** `connections:read`\n\nReturns the team's blocked country codes and the size of its do-not-call list.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"responses": {
"200": {
"description": "The call policy.",
@@ -8529,9 +8460,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
"x-audience": "public"
},
"put": {
@@ -8540,13 +8468,13 @@
"Call Consent"
],
"summary": "Update the team's blocked country codes",
- "description": "**Required scope:** `sessions:manage`\n\nReplaces the blocked country codes. New calls are checked against the new list at once; calls in progress continue.",
+ "description": "**Required scope:** `connections:manage`\n\nReplaces the blocked country codes. New calls are checked against the new list at once; calls in progress continue.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"requestBody": {
"required": true,
"content": {
@@ -8772,9 +8700,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "public"
}
},
@@ -8785,13 +8710,13 @@
"Call Consent"
],
"summary": "List the do-not-call list",
- "description": "**Required scope:** `sessions:read`\n\nLists the team's do-not-call entries, newest first.",
+ "description": "**Required scope:** `connections:read`\n\nLists the team's do-not-call entries, newest first.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -9019,9 +8944,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
"x-audience": "public"
},
"post": {
@@ -9030,13 +8952,13 @@
"Call Consent"
],
"summary": "Add a person to the do-not-call list",
- "description": "**Required scope:** `sessions:manage`\n\nAdds a phone number or BSUID. Calls to it are refused with `403 call_recipient_opted_out` from then on. Adding an entry that already exists returns it with `200`.",
+ "description": "**Required scope:** `connections:manage`\n\nAdds a phone number or BSUID. Calls to it are refused with `403 call_recipient_opted_out` from then on. Adding an entry that already exists returns it with `200`.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"requestBody": {
"required": true,
"content": {
@@ -9283,9 +9205,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "public"
}
},
@@ -9296,13 +9215,13 @@
"Call Consent"
],
"summary": "Import do-not-call entries",
- "description": "**Required scope:** `sessions:manage`\n\nAdds up to 5,000 entries in one request. Valid entries are added together; invalid ones are listed in `rejected`. If the valid entries would take the list past its limit, nothing is added and the request fails with `409 call_opt_out_limit`.",
+ "description": "**Required scope:** `connections:manage`\n\nAdds up to 5,000 entries in one request. Valid entries are added together; invalid ones are listed in `rejected`. If the valid entries would take the list past its limit, nothing is added and the request fails with `409 call_opt_out_limit`.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"requestBody": {
"required": true,
"content": {
@@ -9528,9 +9447,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "public"
}
},
@@ -9541,13 +9457,13 @@
"Call Consent"
],
"summary": "Remove a person from the do-not-call list",
- "description": "**Required scope:** `sessions:manage`\n\nRemoves one entry. The person can be called again.",
+ "description": "**Required scope:** `connections:manage`\n\nRemoves one entry. The person can be called again.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -9742,9 +9658,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "public"
}
},
@@ -9986,9 +9899,6 @@
}
}
},
- "x-mint": {
- "content": "voice:read "
- },
"x-audience": "public"
},
"post": {
@@ -10293,9 +10203,6 @@
}
}
},
- "x-mint": {
- "content": "voice:manage "
- },
"x-audience": "public"
}
},
@@ -10634,9 +10541,6 @@
}
}
},
- "x-mint": {
- "content": "voice:manage "
- },
"x-audience": "public"
}
},
@@ -10912,9 +10816,6 @@
}
}
},
- "x-mint": {
- "content": "voice:manage "
- },
"x-audience": "public"
}
},
@@ -11125,9 +11026,6 @@
}
}
},
- "x-mint": {
- "content": "voice:read "
- },
"description": "**Required scope:** `voice:read`",
"x-audience": "public"
},
@@ -11380,9 +11278,6 @@
}
}
},
- "x-mint": {
- "content": "voice:manage "
- },
"x-audience": "public"
},
"delete": {
@@ -11624,9 +11519,6 @@
}
}
},
- "x-mint": {
- "content": "voice:manage "
- },
"x-audience": "public"
}
},
@@ -11902,9 +11794,6 @@
}
}
},
- "x-mint": {
- "content": "voice:read "
- },
"x-audience": "public"
}
},
@@ -12117,9 +12006,6 @@
}
}
},
- "x-mint": {
- "content": "voice:read "
- },
"x-audience": "public"
},
"post": {
@@ -12456,9 +12342,6 @@
}
}
},
- "x-mint": {
- "content": "voice:manage "
- },
"x-audience": "public"
}
},
@@ -12669,9 +12552,6 @@
}
}
},
- "x-mint": {
- "content": "voice:read "
- },
"description": "**Required scope:** `voice:read`",
"x-audience": "public"
},
@@ -12882,9 +12762,6 @@
}
}
},
- "x-mint": {
- "content": "voice:manage "
- },
"x-audience": "public"
}
},
@@ -13128,9 +13005,6 @@
}
}
},
- "x-mint": {
- "content": "voice:manage "
- },
"x-audience": "public"
}
},
@@ -13146,8 +13020,8 @@
"ApiKeyAuth": []
}
],
- "description": "**Required scope:** `sessions:read`\n\nReturns published feature terms and this scope's acceptance. Pending terms have no text or acceptance requirement. Terms that cannot be activated yet stay pending even after publication. Accepting terms grants no feature access. Requires a team API key or a signed-in team member. Number scope IDs are Number resource UUIDs.",
- "x-required-scope": "sessions:read",
+ "description": "**Required scope:** `connections:read`\n\nReturns published feature terms and this scope's acceptance. Pending terms have no text or acceptance requirement. Terms that cannot be activated yet stay pending even after publication. Accepting terms grants no feature access. Requires a team API key or a signed-in team member. Connection scope IDs are Connection resource UUIDs.",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
@@ -13156,7 +13030,7 @@
"team",
"project",
"customer",
- "number"
+ "connection"
],
"default": "team"
},
@@ -13168,10 +13042,10 @@
"schema": {
"type": "string",
"format": "uuid",
- "description": "Required for project, customer and number scopes. Defaults to the authenticated team for team scope."
+ "description": "Required for project, customer and connection scopes. Defaults to the authenticated team for team scope."
},
"required": false,
- "description": "Required for project, customer and number scopes. Defaults to the authenticated team for team scope.",
+ "description": "Required for project, customer and connection scopes. Defaults to the authenticated team for team scope.",
"name": "scopeId",
"in": "query"
},
@@ -13380,9 +13254,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
"x-audience": "public"
}
},
@@ -13398,8 +13269,8 @@
"ApiKeyAuth": []
}
],
- "description": "**Required scope:** `sessions:manage`\n\nRecords the exact published version, locale and text digest for this scope. Requires a team API key with sessions:manage, or a signed-in team owner or admin. Preview enrollment terms require a signed-in team owner or admin. Staff cannot accept for a customer. A repeated acceptance returns the existing record. This does not turn the feature on.",
- "x-required-scope": "sessions:manage",
+ "description": "**Required scope:** `connections:manage`\n\nRecords the exact published version, locale and text digest for this scope. Requires a team API key with connections:manage, or a signed-in team owner or admin. Preview enrollment terms require a signed-in team owner or admin. Staff cannot accept for a customer. A repeated acceptance returns the existing record. This does not turn the feature on.",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -13427,7 +13298,7 @@
"team",
"project",
"customer",
- "number"
+ "connection"
]
},
"id": {
@@ -13660,9 +13531,6 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "public"
}
},
@@ -13678,8 +13546,8 @@
"ApiKeyAuth": []
}
],
- "description": "**Required scope:** `sessions:manage`\n\nAppends a withdrawal without changing the acceptance record. Requires a team API key with sessions:manage, or a signed-in team owner or admin. Preview enrollment terms require a signed-in team owner or admin. No current terms are required. Repeated withdrawals return the existing record; no previous acceptance returns null. Preview Contacts/Chats withdrawals reconcile capture before success; 503 service_unavailable means the withdrawal is recorded but capture is pending. Retrying the same withdrawal is safe. Other features must also be turned off through their settings to stop their work.",
- "x-required-scope": "sessions:manage",
+ "description": "**Required scope:** `connections:manage`\n\nAppends a withdrawal without changing the acceptance record. Requires a team API key with connections:manage, or a signed-in team owner or admin. Preview enrollment terms require a signed-in team owner or admin. No current terms are required. Repeated withdrawals return the existing record; no previous acceptance returns null. Preview Contacts/Chats withdrawals reconcile capture before success; 503 service_unavailable means the withdrawal is recorded but capture is pending. Retrying the same withdrawal is safe. Other features must also be turned off through their settings to stop their work.",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
@@ -13707,7 +13575,7 @@
"team",
"project",
"customer",
- "number"
+ "connection"
]
},
"id": {
@@ -13921,42 +13789,39 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "public"
}
},
- "/platform/sessions/{sessionId}": {
+ "/platform/connections/{connectionId}": {
"get": {
- "operationId": "getSession",
+ "operationId": "getConnection",
"tags": [
- "Sessions"
+ "Connections"
],
- "summary": "Get session details",
+ "summary": "Get connection details",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "sessionId",
+ "name": "connectionId",
"in": "path"
}
],
"responses": {
"200": {
- "description": "Session details",
+ "description": "Connection details",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PlatformAccessGetSessionResponse"
+ "$ref": "#/components/schemas/PlatformAccessGetConnectionResponse"
}
}
},
@@ -14133,31 +13998,28 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
- "description": "**Required scope:** `sessions:read`",
+ "description": "**Required scope:** `connections:read`",
"x-audience": "public"
},
"put": {
- "operationId": "updateSession",
+ "operationId": "updateConnection",
"tags": [
- "Sessions"
+ "Connections"
],
- "summary": "Update session configuration",
+ "summary": "Update connection configuration",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "sessionId",
+ "name": "connectionId",
"in": "path"
}
],
@@ -14165,7 +14027,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PlatformAccessUpdateSessionRequest"
+ "$ref": "#/components/schemas/PlatformAccessUpdateConnectionRequest"
}
}
}
@@ -14176,7 +14038,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PlatformAccessUpdateSessionResponse"
+ "$ref": "#/components/schemas/PlatformAccessUpdateConnectionResponse"
}
}
},
@@ -14385,7 +14247,7 @@
}
},
"503": {
- "description": "Session configuration persistence is unavailable",
+ "description": "Connection configuration persistence is unavailable",
"content": {
"application/json": {
"schema": {
@@ -14417,23 +14279,20 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
- "description": "**Required scope:** `sessions:manage`",
+ "description": "**Required scope:** `connections:manage`",
"x-audience": "public"
},
"delete": {
- "operationId": "deletePlatformSession",
+ "operationId": "deletePlatformConnection",
"tags": [
- "sessions"
+ "connections"
],
- "summary": "Remove a session",
- "description": "Permanently removes a testing number. Production-number deletion requires support and returns 409 without removing the number.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Remove a connection",
+ "description": "Permanently removes a testing connection. Production-connection deletion requires support and returns 409 without removing the connection.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
- "x-polymorfa-resource-boundary": "session",
+ "x-polymorfa-resource-boundary": "connection",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -14444,12 +14303,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
}
],
@@ -14484,7 +14343,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionRemoveResult"
+ "$ref": "#/components/schemas/ConnectionRemoveResult"
}
},
"required": [
@@ -14509,16 +14368,16 @@
}
},
"patch": {
- "operationId": "setSessionTierOverride",
+ "operationId": "setConnectionTierOverride",
"tags": [
- "sessions"
+ "connections"
],
- "summary": "Confirm a number tier change",
- "description": "Confirms a previously reviewed tier quote. An upgrade purchases a full fresh 24-hour window without refunding remaining time. A downgrade applies at the paid-window end. Poll the tier quote until applied or rejected; accepting the request does not grant the new tier.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Confirm a connection tier change",
+ "description": "Confirms a previously reviewed tier quote. An upgrade purchases a full fresh 24-hour window without refunding remaining time. A downgrade applies at the paid-window end. Poll the tier quote until applied or rejected; accepting the request does not grant the new tier.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
- "x-polymorfa-resource-boundary": "session",
+ "x-polymorfa-resource-boundary": "connection",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -14529,12 +14388,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
}
],
@@ -14543,7 +14402,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SessionTierOverrideRequest"
+ "$ref": "#/components/schemas/ConnectionTierOverrideRequest"
}
}
}
@@ -14579,7 +14438,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/NumberTierChange"
+ "$ref": "#/components/schemas/ConnectionTierChange"
}
},
"required": [
@@ -14607,27 +14466,27 @@
}
}
},
- "/platform/sessions/{sessionId}/restart": {
+ "/platform/connections/{connectionId}/restart": {
"post": {
- "operationId": "restartSession",
+ "operationId": "restartConnection",
"tags": [
- "Sessions"
+ "Connections"
],
- "summary": "Restart a session",
- "description": "**Required scope:** `sessions:manage`\n\nTesting Numbers wait for confirmed stop before starting the same Number again. An accepted request remains pending until the Number connects. Repeating a pending request retains the same attempt; unconfirmed cleanup must be resolved before another attempt.",
+ "summary": "Restart a connection",
+ "description": "**Required scope:** `connections:manage`\n\nTesting Connections wait for confirmed stop before starting the same Connection again. An accepted request remains pending until the Connection connects. Repeating a pending request retains the same attempt; unconfirmed cleanup must be resolved before another attempt.",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "sessionId",
+ "name": "connectionId",
"in": "path"
}
],
@@ -14814,38 +14673,35 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
"x-audience": "public"
}
},
- "/platform/sessions/{sessionId}/logout": {
+ "/platform/connections/{connectionId}/logout": {
"post": {
- "operationId": "logoutSession",
+ "operationId": "logoutConnection",
"tags": [
- "Sessions"
+ "Connections"
],
- "summary": "Log the session out of WhatsApp",
+ "summary": "Log the connection out of WhatsApp",
"security": [
{
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "sessionId",
+ "name": "connectionId",
"in": "path"
}
],
"responses": {
"202": {
- "description": "Session logout scheduled",
+ "description": "Connection logout scheduled",
"content": {
"application/json": {
"schema": {
@@ -15026,18 +14882,15 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
- "description": "**Required scope:** `sessions:manage`",
+ "description": "**Required scope:** `connections:manage`",
"x-audience": "public"
}
},
- "/platform/sessions/{sessionId}/me": {
+ "/platform/connections/{connectionId}/me": {
"get": {
- "operationId": "getSessionAccount",
+ "operationId": "getConnectionAccount",
"tags": [
- "Sessions"
+ "Connections"
],
"summary": "Get the connected WhatsApp account info",
"security": [
@@ -15045,14 +14898,14 @@
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "sessionId",
+ "name": "connectionId",
"in": "path"
}
],
@@ -15062,7 +14915,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PlatformAccessGetSessionAccountResponse"
+ "$ref": "#/components/schemas/PlatformAccessGetConnectionAccountResponse"
}
}
},
@@ -15239,18 +15092,15 @@
}
}
},
- "x-mint": {
- "content": "sessions:read "
- },
- "description": "**Required scope:** `sessions:read`",
+ "description": "**Required scope:** `connections:read`",
"x-audience": "public"
}
},
- "/platform/sessions/{sessionId}/handoff-keys": {
+ "/platform/connections/{connectionId}/handoff-keys": {
"post": {
- "operationId": "sessionHandoffKeys",
+ "operationId": "connectionHandoffKeys",
"tags": [
- "Sessions"
+ "Connections"
],
"summary": "Initiate M↔P toggle: fetch the destination Curve25519 pubkey",
"security": [
@@ -15258,14 +15108,14 @@
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "sessionId",
+ "name": "connectionId",
"in": "path"
}
],
@@ -15452,18 +15302,15 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
- "description": "**Required scope:** `sessions:manage`",
+ "description": "**Required scope:** `connections:manage`",
"x-audience": "public"
}
},
- "/platform/sessions/{sessionId}/handoff-import": {
+ "/platform/connections/{connectionId}/handoff-import": {
"post": {
- "operationId": "sessionHandoffImport",
+ "operationId": "connectionHandoffImport",
"tags": [
- "Sessions"
+ "Connections"
],
"summary": "Ship a sealed SignalStoreSnapshot from customer Baileys to the runner",
"security": [
@@ -15471,14 +15318,14 @@
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "sessionId",
+ "name": "connectionId",
"in": "path"
}
],
@@ -15674,18 +15521,15 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
- "description": "**Required scope:** `sessions:manage`",
+ "description": "**Required scope:** `connections:manage`",
"x-audience": "public"
}
},
- "/platform/sessions/{sessionId}/upload-appstate-keys": {
+ "/platform/connections/{connectionId}/upload-appstate-keys": {
"post": {
- "operationId": "sessionUploadAppStateKeys",
+ "operationId": "connectionUploadAppStateKeys",
"tags": [
- "Sessions"
+ "Connections"
],
"summary": "Upload selected AppStateSyncKeys (Track P+ tier)",
"security": [
@@ -15693,14 +15537,14 @@
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "sessionId",
+ "name": "connectionId",
"in": "path"
}
],
@@ -15896,18 +15740,15 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
- "description": "**Required scope:** `sessions:manage`",
+ "description": "**Required scope:** `connections:manage`",
"x-audience": "public"
}
},
- "/platform/sessions/{sessionId}/handoff-ack": {
+ "/platform/connections/{connectionId}/handoff-ack": {
"post": {
- "operationId": "sessionHandoffAck",
+ "operationId": "connectionHandoffAck",
"tags": [
- "Sessions"
+ "Connections"
],
"summary": "Acknowledge receipt of an M→P export; API flips bartenderMode after hash verify",
"security": [
@@ -15915,14 +15756,14 @@
"ApiKeyAuth": []
}
],
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
- "name": "sessionId",
+ "name": "connectionId",
"in": "path"
}
],
@@ -16118,10 +15959,7 @@
}
}
},
- "x-mint": {
- "content": "sessions:manage "
- },
- "description": "**Required scope:** `sessions:manage`",
+ "description": "**Required scope:** `connections:manage`",
"x-audience": "public"
}
},
@@ -17773,11 +17611,11 @@
"signal-custody"
],
"summary": "Read Project Signal custody default",
- "description": "Returns the custody default for future Number reservations. Existing Number custody is immutable. Customer null defaults inherit the Project default.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns the custody default for future Connection reservations. Existing Connection custody is immutable. Customer null defaults inherit the Project default.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -17858,11 +17696,11 @@
"signal-custody"
],
"summary": "Update Project Signal custody default",
- "description": "Changes the default for future Number reservations with a revision check. Customer-owned custody requires beta admission and runtime availability. Existing Numbers keep their custody. Dashboard writes require a team owner or admin. Setting a Customer default to null restores Project inheritance.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Changes the default for future Connection reservations with a revision check. Customer-owned custody requires beta admission and runtime availability. Existing Connections keep their custody. Dashboard writes require a team owner or admin. Setting a Customer default to null restores Project inheritance.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -17958,11 +17796,11 @@
"signal-custody"
],
"summary": "Read Customer Signal custody default",
- "description": "Returns the custody default for future Number reservations. Existing Number custody is immutable. Customer null defaults inherit the Project default.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns the custody default for future Connection reservations. Existing Connection custody is immutable. Customer null defaults inherit the Project default.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -18052,11 +17890,11 @@
"signal-custody"
],
"summary": "Update Customer Signal custody default",
- "description": "Changes the default for future Number reservations with a revision check. Customer-owned custody requires beta admission and runtime availability. Existing Numbers keep their custody. Dashboard writes require a team owner or admin. Setting a Customer default to null restores Project inheritance.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Changes the default for future Connection reservations with a revision check. Customer-owned custody requires beta admission and runtime availability. Existing Connections keep their custody. Dashboard writes require a team owner or admin. Setting a Customer default to null restores Project inheritance.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -18154,18 +17992,18 @@
}
}
},
- "/platform/session-configuration": {
+ "/platform/connection-configuration": {
"get": {
- "operationId": "getSessionConfigurationDefaults",
+ "operationId": "getConnectionConfigurationDefaults",
"tags": [
- "session-configuration"
+ "connection-configuration"
],
- "summary": "Read session configuration defaults",
- "description": "Returns effective team or project defaults, explicit overrides, and their source.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "Read connection configuration defaults",
+ "description": "Returns effective team or project defaults, explicit overrides, and their source.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -18215,7 +18053,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionConfigurationView"
+ "$ref": "#/components/schemas/ConnectionConfigurationView"
}
},
"required": [
@@ -18237,16 +18075,16 @@
}
},
"put": {
- "operationId": "updateSessionConfigurationDefaults",
+ "operationId": "updateConnectionConfigurationDefaults",
"tags": [
- "session-configuration"
+ "connection-configuration"
],
- "summary": "Update session configuration defaults",
- "description": "Updates explicit defaults using a revision check. Existing sessions inherit fields they have not overridden. Switching an existing Number to descriptor history delivery requires confirmed cleanup; otherwise the entire update returns 409 and nothing is saved. A reset can inherit descriptor delivery and has the same requirement. Runtime application is asynchronous.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Update connection configuration defaults",
+ "description": "Updates explicit defaults using a revision check. Existing connections inherit fields they have not overridden. Switching an existing Connection to descriptor history delivery requires confirmed cleanup; otherwise the entire update returns 409 and nothing is saved. A reset can inherit descriptor delivery and has the same requirement. Runtime application is asynchronous.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -18260,7 +18098,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SessionConfigurationUpdateRequest"
+ "$ref": "#/components/schemas/ConnectionConfigurationUpdateRequest"
}
}
}
@@ -18296,7 +18134,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionConfigurationView"
+ "$ref": "#/components/schemas/ConnectionConfigurationView"
}
},
"required": [
@@ -18324,18 +18162,18 @@
}
}
},
- "/console/session-configuration/{sessionId}": {
+ "/console/connection-configuration/{connectionId}": {
"get": {
- "operationId": "getSessionConfiguration",
+ "operationId": "getConnectionConfiguration",
"tags": [
- "session-configuration"
+ "connection-configuration"
],
- "summary": "Read session configuration",
- "description": "Returns effective configuration, overrides, and runtime application status for an owned session.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
+ "summary": "Read connection configuration",
+ "description": "Returns effective configuration, overrides, and runtime application status for an owned connection.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
- "x-exclusion-reason": "Private Console session configuration; requires live dashboard membership.",
+ "x-exclusion-reason": "Private Console connection configuration; requires live dashboard membership.",
"security": [
{
"ConsoleSession": []
@@ -18343,12 +18181,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
},
{
@@ -18391,7 +18229,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionConfigurationView"
+ "$ref": "#/components/schemas/ConnectionConfigurationView"
}
},
"required": [
@@ -18413,16 +18251,16 @@
}
},
"put": {
- "operationId": "updateSessionConfiguration",
+ "operationId": "updateConnectionConfiguration",
"tags": [
- "session-configuration"
+ "connection-configuration"
],
- "summary": "Update session configuration",
- "description": "Sets or resets explicit configuration for an owned session using a revision check. Switching to descriptor history delivery requires confirmed cleanup; otherwise the update returns 409 and nothing is saved. A reset inherits project or team settings and can have the same requirement.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
+ "summary": "Update connection configuration",
+ "description": "Sets or resets explicit configuration for an owned connection using a revision check. Switching to descriptor history delivery requires confirmed cleanup; otherwise the update returns 409 and nothing is saved. A reset inherits project or team settings and can have the same requirement.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
- "x-exclusion-reason": "Private Console session configuration; requires live dashboard membership.",
+ "x-exclusion-reason": "Private Console connection configuration; requires live dashboard membership.",
"security": [
{
"ConsoleSession": []
@@ -18430,12 +18268,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
}
],
@@ -18444,7 +18282,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SessionConfigurationUpdateRequest"
+ "$ref": "#/components/schemas/ConnectionConfigurationUpdateRequest"
}
}
}
@@ -18480,7 +18318,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionConfigurationView"
+ "$ref": "#/components/schemas/ConnectionConfigurationView"
}
},
"required": [
@@ -18508,18 +18346,18 @@
}
}
},
- "/console/call-settings/{sessionId}": {
+ "/console/call-settings/{connectionId}": {
"get": {
- "operationId": "getSessionCallSettings",
+ "operationId": "getConnectionCallSettings",
"tags": [
"calls"
],
- "summary": "Read session call settings",
- "description": "Returns the call settings for an owned session. Sessions without saved settings return the defaults and a null `updatedAt`.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
+ "summary": "Read connection call settings",
+ "description": "Returns the call settings for an owned connection. Connections without saved settings return the defaults and a null `updatedAt`.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
- "x-exclusion-reason": "Private Console call settings; requires live dashboard membership. The Platform API publishes the same settings under /platform/sessions/{session}/call-settings.",
+ "x-exclusion-reason": "Private Console call settings; requires live dashboard membership. The Platform API publishes the same settings under /platform/connections/{connection}/call-settings.",
"security": [
{
"ConsoleSession": []
@@ -18527,12 +18365,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
},
{
@@ -18575,7 +18413,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionCallSettings"
+ "$ref": "#/components/schemas/ConnectionCallSettings"
}
},
"required": [
@@ -18600,16 +18438,16 @@
}
},
"put": {
- "operationId": "updateSessionCallSettings",
+ "operationId": "updateConnectionCallSettings",
"tags": [
"calls"
],
- "summary": "Update session call settings",
- "description": "Updates the call settings for an owned session. Omitted fields keep their values. New calls use the saved settings. Routing to a SIP trunk requires a trunk in the session's project that can receive calls. `expectedRevision` refuses an update to settings that changed since they were read.\n\nRequires a verified dashboard bearer and current team authorization. The signed-in member must be a team owner or admin. Team keys and project tokens are not accepted.",
+ "summary": "Update connection call settings",
+ "description": "Updates the call settings for an owned connection. Omitted fields keep their values. New calls use the saved settings. Routing to a SIP trunk requires a trunk in the connection's project that can receive calls. `expectedRevision` refuses an update to settings that changed since they were read.\n\nRequires a verified dashboard bearer and current team authorization. The signed-in member must be a team owner or admin. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
- "x-exclusion-reason": "Private Console call settings; requires live dashboard membership. The Platform API publishes the same settings under /platform/sessions/{session}/call-settings.",
+ "x-exclusion-reason": "Private Console call settings; requires live dashboard membership. The Platform API publishes the same settings under /platform/connections/{connection}/call-settings.",
"x-required-team-role": "owner_or_admin",
"security": [
{
@@ -18618,12 +18456,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
}
],
@@ -18632,7 +18470,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UpdateSessionCallSettingsRequest"
+ "$ref": "#/components/schemas/UpdateConnectionCallSettingsRequest"
}
}
}
@@ -18668,7 +18506,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionCallSettings"
+ "$ref": "#/components/schemas/ConnectionCallSettings"
}
},
"required": [
@@ -19199,7 +19037,7 @@
"calls"
],
"summary": "Delete a SIP trunk",
- "description": "Deletes a SIP trunk that no session routes incoming calls to.\n\nRequires a verified dashboard bearer and current team authorization. The signed-in member must be a team owner or admin. Team keys and project tokens are not accepted.",
+ "description": "Deletes a SIP trunk that no connection routes incoming calls to.\n\nRequires a verified dashboard bearer and current team authorization. The signed-in member must be a team owner or admin. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
@@ -21125,20 +20963,20 @@
}
}
},
- "/platform/sessions": {
+ "/platform/connections": {
"get": {
- "operationId": "listPlatformSessions",
+ "operationId": "listPlatformConnections",
"tags": [
- "sessions"
+ "connections"
],
- "summary": "List sessions",
- "description": "Lists sessions in the authenticated team or selected project, including disconnected sessions and their latest status reason. A Test key returns only test numbers in its project, or an empty list when there are none. Other project tokens return all sessions in their own project.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "List connections",
+ "description": "Lists connections in the authenticated team or selected project, including disconnected connections and their latest status reason. A Test key returns only test connections in its project, or an empty list when there are none. Other project tokens return all connections in their own project.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"x-merged-endpoints": [
- "listSessionsByTeam"
+ "listConnectionsByTeam"
],
"security": [
{
@@ -21191,7 +21029,7 @@
"data": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/PlatformSession"
+ "$ref": "#/components/schemas/PlatformConnection"
}
}
},
@@ -21214,18 +21052,18 @@
}
}
},
- "/platform/sessions/{sessionId}/start": {
+ "/platform/connections/{connectionId}/start": {
"post": {
- "operationId": "startPlatformSession",
+ "operationId": "startPlatformConnection",
"tags": [
- "sessions"
+ "connections"
],
- "summary": "Start a session",
- "description": "Requests an asynchronous start. Testing Numbers retain the original attempt: a ready Number resumes the same runtime, while a stopped Number requires confirmed cleanup before a successor starts. Acceptance does not mean the Number is connected. An unfinished testing invitation must resume through its original link. A hosted paid number must reserve credit before connecting; insufficient available credit returns 402. A new paid window is charged only after the messaging connection succeeds. Monthly project and number credit limits also apply: a new charge that would exceed either limit returns 409 state_conflict. Already-paid service remains available until its paid window ends. The identifier may be the session UUID or stable session slug.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Start a connection",
+ "description": "Requests an asynchronous start. Testing Connections retain the original attempt: a ready Connection resumes the same runtime, while a stopped Connection requires confirmed cleanup before a successor starts. Acceptance does not mean the Connection is connected. An unfinished testing invitation must resume through its original link. A hosted paid number must reserve credit before connecting; insufficient available credit returns 402. A new paid window is charged only after the messaging method succeeds. Monthly project and number credit limits also apply: a new charge that would exceed either limit returns 409 state_conflict. Already-paid service remains available until its paid window ends. The identifier may be the connection UUID or stable connection slug.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
- "x-polymorfa-resource-boundary": "session",
+ "x-polymorfa-resource-boundary": "connection",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -21236,12 +21074,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
}
],
@@ -21250,7 +21088,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SessionProjectContext"
+ "$ref": "#/components/schemas/ConnectionProjectContext"
}
}
}
@@ -21286,7 +21124,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionStartResult"
+ "$ref": "#/components/schemas/ConnectionStartResult"
}
},
"required": [
@@ -21317,18 +21155,18 @@
}
}
},
- "/platform/sessions/{sessionId}/stop": {
+ "/platform/connections/{connectionId}/stop": {
"post": {
- "operationId": "stopPlatformSession",
+ "operationId": "stopPlatformConnection",
"tags": [
- "sessions"
+ "connections"
],
- "summary": "Stop a session",
- "description": "Requests an asynchronous stop for one session. The identifier may be the session UUID or stable session slug.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Stop a connection",
+ "description": "Requests an asynchronous stop for one connection. The identifier may be the connection UUID or stable connection slug.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
- "x-polymorfa-resource-boundary": "session",
+ "x-polymorfa-resource-boundary": "connection",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -21339,12 +21177,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
}
],
@@ -21353,7 +21191,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SessionProjectContext"
+ "$ref": "#/components/schemas/ConnectionProjectContext"
}
}
}
@@ -21389,7 +21227,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionStopResult"
+ "$ref": "#/components/schemas/ConnectionStopResult"
}
},
"required": [
@@ -21414,18 +21252,18 @@
}
}
},
- "/platform/sessions/{sessionId}/tier-quotes": {
+ "/platform/connections/{connectionId}/tier-quotes": {
"post": {
- "operationId": "quoteSessionTierChange",
+ "operationId": "quoteConnectionTierChange",
"tags": [
- "sessions"
+ "connections"
],
- "summary": "Preview a number tier change",
- "description": "Returns the full credit charge and effective time before confirmation. Null tierOverride restores project inheritance. Creating a quote does not change the number or consume credit. Quotes expire after ten minutes and are invalidated when the number or price changes.\n\n**Hybrid Link.** A Hybrid Link Number leaving Pro requires `hybridResolution`: keep one connection, or split the Number into two Standard Numbers; without it the quote returns `409` with code `hybrid_choice_required`. The choice runs when the paid Pro window ends. An upgrade to Pro can merge two same-number Numbers with `hybridMerge`; the Number in the path keeps its ID. An ineligible change returns `409` with code `hybrid_transition_ineligible`.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Preview a connection tier change",
+ "description": "Returns the full credit charge and effective time before confirmation. Null tierOverride restores project inheritance. Creating a quote does not change the connection or consume credit. Quotes expire after ten minutes and are invalidated when the connection or price changes.\n\n**Hybrid Link.** A Hybrid Link Connection leaving Pro requires `hybridResolution`: keep one method, or split the Connection into two Standard Connections; without it the quote returns `409` with code `hybrid_choice_required`. The choice runs when the paid Pro window ends. An upgrade to Pro can merge two same-number Connections with `hybridMerge`; the Connection in the path keeps its ID. An ineligible change returns `409` with code `hybrid_transition_ineligible`.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
- "x-polymorfa-resource-boundary": "session",
+ "x-polymorfa-resource-boundary": "connection",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -21436,12 +21274,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
}
],
@@ -21450,7 +21288,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/NumberTierQuoteRequest"
+ "$ref": "#/components/schemas/ConnectionTierQuoteRequest"
}
}
}
@@ -21486,7 +21324,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/NumberTierChange"
+ "$ref": "#/components/schemas/ConnectionTierChange"
}
},
"required": [
@@ -21514,18 +21352,18 @@
}
}
},
- "/platform/sessions/{sessionId}/tier-quotes/{quoteId}": {
+ "/platform/connections/{connectionId}/tier-quotes/{quoteId}": {
"get": {
- "operationId": "getSessionTierChange",
+ "operationId": "getConnectionTierChange",
"tags": [
- "sessions"
+ "connections"
],
- "summary": "Read a number tier change",
- "description": "Reads the quote and durable result for a number in the authenticated project scope.\n\n**Hybrid Link.** For a Hybrid Link change, `quote.hybridTransition.status` reports the connection change separately from the tier change: `scheduled`, `running`, `completed`, `failed` or `cancelled`.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "Read a connection tier change",
+ "description": "Reads the quote and durable result for a connection in the authenticated project scope.\n\n**Hybrid Link.** For a Hybrid Link change, `quote.hybridTransition.status` reports the method change separately from the tier change: `scheduled`, `running`, `completed`, `failed` or `cancelled`.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
- "x-polymorfa-resource-boundary": "session",
+ "x-polymorfa-resource-boundary": "connection",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -21536,12 +21374,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
},
{
@@ -21584,7 +21422,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/NumberTierChange"
+ "$ref": "#/components/schemas/ConnectionTierChange"
}
},
"required": [
@@ -21609,18 +21447,18 @@
}
}
},
- "/platform/sessions/{sessionId}/capabilities": {
+ "/platform/connections/{connectionId}/capabilities": {
"get": {
- "operationId": "getSessionCapabilities",
+ "operationId": "getConnectionCapabilities",
"tags": [
- "sessions"
+ "connections"
],
- "summary": "Get a number's WhatsApp capabilities",
- "description": "Returns which WhatsApp features WhatsApp has enabled for this number, and the limits it applies, as of the number's last configuration sync. Each value reflects WhatsApp's configuration at `syncedAt`, not a live check. Values describe the WhatsApp account last linked to the number, whether or not it is connected now; read the session for its connection status. Before the first sync, from the first sync attempt of another linked WhatsApp account until its configuration is synced, and when Polymorfa cannot tell whether the stored configuration belongs to the account linked now, `status` is `unknown` and every value is null. Values come from a linked-device connection: a number that has never had one (Official API only) reports `unknown`, and a number whose linked-device connection was removed keeps the values last synced. A capability reports what WhatsApp allows the number; it does not mean the Polymorfa API offers an operation for that feature. This is a beta: teams that are not enrolled receive 403.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "Get a connection's WhatsApp capabilities",
+ "description": "Returns which WhatsApp features WhatsApp has enabled for this connection, and the limits it applies, as of the connection's last configuration sync. Each value reflects WhatsApp's configuration at `syncedAt`, not a live check. Values describe the WhatsApp account last linked to the connection, whether or not it is connected now; read the connection for its method status. Before the first sync, from the first sync attempt of another linked WhatsApp account until its configuration is synced, and when Polymorfa cannot tell whether the stored configuration belongs to the account linked now, `status` is `unknown` and every value is null. Values come from a linked-device method: a connection that has never had one (Official API only) reports `unknown`, and a connection whose linked-device method was removed keeps the values last synced. A capability reports what WhatsApp allows the connection; it does not mean the Polymorfa API offers an operation for that feature. This is a beta: teams that are not enrolled receive 403.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
- "x-polymorfa-resource-boundary": "session",
+ "x-polymorfa-resource-boundary": "connection",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -21631,12 +21469,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
}
],
@@ -21671,7 +21509,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionCapabilities"
+ "$ref": "#/components/schemas/ConnectionCapabilities"
}
},
"required": [
@@ -21696,19 +21534,19 @@
}
}
},
- "/platform/sessions/{sessionId}/inspector/claim/release": {
+ "/platform/connections/{connectionId}/inspector/claim/release": {
"post": {
- "operationId": "releaseSessionInspectorClaim",
+ "operationId": "releaseConnectionInspectorClaim",
"tags": [
- "sessions"
+ "connections"
],
- "summary": "Unclaim a Number in Inspector",
- "description": "Releases the Number's Inspector claim. Polymorfa first removes the claimant's Inspector device from the Number; the claim is released only after that succeeds. On a real Number, only the Inspector device is removed: your phone and Polymorfa's own linked device stay connected. Any team member can then claim the Number by pairing it in Inspector. A Number that is already unclaimed returns `released: false`. Pass `expectedClaimedAt` from your last read to avoid releasing a newer claim; a different current claim returns `409`. When the device cannot be removed, the Number stays claimed and the request returns `503` with `Retry-After`; repeating it is safe.\n\nA test Number requires `sandbox:write`; a real Number requires `sessions:manage`. Project tokens only access Numbers in their own project. A signed-in Console member must be the claimant or a team owner or admin.",
+ "summary": "Unclaim a Connection in Inspector",
+ "description": "Releases the Connection's Inspector claim. Polymorfa first removes the claimant's Inspector device from the Connection; the claim is released only after that succeeds. On a real Connection, only the Inspector device is removed: your phone and Polymorfa's own linked device stay connected. Any team member can then claim the Connection by pairing it in Inspector. A Connection that is already unclaimed returns `released: false`. Pass `expectedClaimedAt` from your last read to avoid releasing a newer claim; a different current claim returns `409`. When the device cannot be removed, the Connection stays claimed and the request returns `503` with `Retry-After`; repeating it is safe.\n\nA test Connection requires `sandbox:write`; a real Connection requires `connections:manage`. Project tokens only access Connections in their own project. A signed-in Console member must be the claimant or a team owner or admin.",
"x-audience": "public",
- "x-polymorfa-resource-boundary": "session",
+ "x-polymorfa-resource-boundary": "connection",
"x-excluded-from-public": false,
"x-required-scopes": [
- "sessions:manage",
+ "connections:manage",
"sandbox:write"
],
"x-required-scope-mode": "any",
@@ -21722,12 +21560,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
}
],
@@ -21803,18 +21641,18 @@
}
}
},
- "/platform/sessions/stop": {
+ "/platform/connections/stop": {
"post": {
- "operationId": "stopSessions",
+ "operationId": "stopConnections",
"tags": [
- "sessions"
+ "connections"
],
- "summary": "Stop multiple sessions",
- "description": "Requests asynchronous stops for up to 100 session UUIDs or slugs in the authenticated project scope.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Stop multiple connections",
+ "description": "Requests asynchronous stops for up to 100 connection UUIDs or slugs in the authenticated project scope.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -21828,7 +21666,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SessionBatchRequest"
+ "$ref": "#/components/schemas/ConnectionBatchRequest"
}
}
}
@@ -21864,7 +21702,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionBatchStopResult"
+ "$ref": "#/components/schemas/ConnectionBatchStopResult"
}
},
"required": [
@@ -21889,18 +21727,18 @@
}
}
},
- "/platform/sessions/delete": {
+ "/platform/connections/delete": {
"post": {
- "operationId": "deleteSessions",
+ "operationId": "deleteConnections",
"tags": [
- "sessions"
+ "connections"
],
- "summary": "Remove multiple sessions",
- "description": "Permanently removes up to 100 testing numbers. A batch containing a production number returns 409 without removing any number.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Remove multiple connections",
+ "description": "Permanently removes up to 100 testing connections. A batch containing a production connection returns 409 without removing any connection.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -21914,7 +21752,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/SessionBatchRequest"
+ "$ref": "#/components/schemas/ConnectionBatchRequest"
}
}
}
@@ -21950,7 +21788,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionBatchRemoveResult"
+ "$ref": "#/components/schemas/ConnectionBatchRemoveResult"
}
},
"required": [
@@ -21977,16 +21815,16 @@
},
"/platform/bans": {
"get": {
- "operationId": "listSessionBans",
+ "operationId": "listConnectionBans",
"tags": [
"bans"
],
- "summary": "List session bans",
- "description": "Public Management API. Team keys require `sessions:read`. Project tokens are not accepted.",
+ "summary": "List connection bans",
+ "description": "Public Management API. Team keys require `connections:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -22041,16 +21879,16 @@
},
"/platform/bans/active": {
"get": {
- "operationId": "listActiveSessionBans",
+ "operationId": "listActiveConnectionBans",
"tags": [
"bans"
],
- "summary": "List active session bans",
- "description": "Public Management API. Team keys require `sessions:read`. Project tokens are not accepted.",
+ "summary": "List active connection bans",
+ "description": "Public Management API. Team keys require `connections:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -22109,12 +21947,12 @@
"tags": [
"bansafe"
],
- "summary": "List number safety",
- "description": "Lists present Health, findings counts, and the active Polymorfa restriction for every number in one project. Health is a 0 to 100 estimate from rules v1 or a validated learned model. It remains null until enough fresh evidence is available.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "List connection safety",
+ "description": "Lists present Health, findings counts, and the active Polymorfa restriction for every connection in one project. Health is a 0 to 100 estimate from rules v1 or a validated learned model. It remains null until enough fresh evidence is available.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -22185,7 +22023,7 @@
"data": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BanSafeNumber"
+ "$ref": "#/components/schemas/BanSafeConnection"
}
},
"page": {
@@ -22215,18 +22053,18 @@
}
}
},
- "/platform/bansafe/health/{session}": {
+ "/platform/bansafe/health/{connection}": {
"get": {
"operationId": "getBanSafeHealth",
"tags": [
"bansafe"
],
- "summary": "Get number safety",
- "description": "Returns one number's present Health estimate and model metadata, retained open and acknowledged findings with their observation times, directly observed account state, the active Polymorfa restriction, and how that restriction lifts. Recorded findings and observed state remain separate from the estimate.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "Get connection safety",
+ "description": "Returns one connection's present Health estimate and model metadata, retained open and acknowledged findings with their observation times, directly observed account state, the active Polymorfa restriction, and how that restriction lifts. Recorded findings and observed state remain separate from the estimate.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -22237,7 +22075,7 @@
],
"parameters": [
{
- "name": "session",
+ "name": "connection",
"in": "path",
"required": true,
"schema": {
@@ -22276,7 +22114,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/BanSafeNumberDetail"
+ "$ref": "#/components/schemas/BanSafeConnectionDetail"
}
},
"required": [
@@ -22301,18 +22139,18 @@
}
}
},
- "/platform/bansafe/health/{session}/history": {
+ "/platform/bansafe/health/{connection}/history": {
"get": {
"operationId": "listBanSafeHealthHistory",
"tags": [
"bansafe"
],
- "summary": "List number health history",
- "description": "Returns the newest Health evaluations since the requested date, up to the limit, ordered oldest to newest. Each point carries its estimator source and version, evidence coverage, reliability, and availability reason.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "List connection health history",
+ "description": "Returns the newest Health evaluations since the requested date, up to the limit, ordered oldest to newest. Each point carries its estimator source and version, evidence coverage, reliability, and availability reason.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -22323,7 +22161,7 @@
],
"parameters": [
{
- "name": "session",
+ "name": "connection",
"in": "path",
"required": true,
"schema": {
@@ -22414,11 +22252,11 @@
"bansafe"
],
"summary": "List BanSafe telemetry signals",
- "description": "Lists the bounded numeric, boolean, enum, histogram, and error-code aggregate signals that BanSafe can return. The catalogue contains no message content, recipient identifiers, or raw telemetry records.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Lists the bounded numeric, boolean, enum, histogram, and error-code aggregate signals that BanSafe can return. The catalogue contains no message content, recipient identifiers, or raw telemetry records.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -22486,18 +22324,18 @@
}
}
},
- "/platform/bansafe/telemetry/{session}": {
+ "/platform/bansafe/telemetry/{connection}": {
"get": {
"operationId": "getBanSafeTelemetry",
"tags": [
"bansafe"
],
"summary": "Get latest BanSafe telemetry",
- "description": "Returns collection availability and the latest supported telemetry snapshot for one number. Empty collection is reported as not collected, not as a disabled collector.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns collection availability and the latest supported telemetry snapshot for one connection. Empty collection is reported as not collected, not as a disabled collector.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -22508,7 +22346,7 @@
],
"parameters": [
{
- "name": "session",
+ "name": "connection",
"in": "path",
"required": true,
"schema": {
@@ -22572,18 +22410,18 @@
}
}
},
- "/platform/bansafe/telemetry/{session}/history": {
+ "/platform/bansafe/telemetry/{connection}/history": {
"get": {
"operationId": "listBanSafeTelemetryHistory",
"tags": [
"bansafe"
],
"summary": "List BanSafe telemetry history",
- "description": "Returns the newest supported telemetry snapshots for one number. Signals are fixed-schema safe aggregates with explicit measured state; raw records and identifiers inside them are not returned.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns the newest supported telemetry snapshots for one connection. Signals are fixed-schema safe aggregates with explicit measured state; raw records and identifiers inside them are not returned.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -22594,7 +22432,7 @@
],
"parameters": [
{
- "name": "session",
+ "name": "connection",
"in": "path",
"required": true,
"schema": {
@@ -22709,11 +22547,11 @@
"bansafe"
],
"summary": "List BanSafe collection status",
- "description": "Lists telemetry collection freshness for the numbers in one project. Status is derived from ingested records and does not guess whether a collector flag is configured.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Lists telemetry collection freshness for the connections in one project. Status is derived from ingested records and does not guess whether a collector flag is configured.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -22784,7 +22622,7 @@
"data": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BanSafeCollectionSession"
+ "$ref": "#/components/schemas/BanSafeCollectionConnection"
}
},
"page": {
@@ -22821,11 +22659,11 @@
"bansafe"
],
"summary": "List Health rule actions",
- "description": "Lists the durable customer-visible outcomes of project Health rule actions, newest first. Internal leases, retry bookkeeping, runtime identifiers, and free-form outcomes are omitted.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Lists the durable customer-visible outcomes of project Health rule actions, newest first. Internal leases, retry bookkeeping, runtime identifiers, and free-form outcomes are omitted.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -22844,7 +22682,7 @@
}
},
{
- "name": "session",
+ "name": "connection",
"in": "query",
"required": false,
"schema": {
@@ -22958,11 +22796,11 @@
"bansafe"
],
"summary": "List safety findings",
- "description": "Lists safety findings across the team, filterable by project, number, status, and severity. Evidence is numbers only and never contains message content or a recipient identifier.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Lists safety findings across the team, filterable by project, number, status, and severity. Evidence is connections only and never contains message content or a recipient identifier.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -22981,7 +22819,7 @@
}
},
{
- "name": "session",
+ "name": "connection",
"in": "query",
"required": false,
"schema": {
@@ -23200,11 +23038,11 @@
"bansafe"
],
"summary": "List number restrictions",
- "description": "Lists every number Polymorfa is currently restricting, what the restriction blocks, and the exact condition that lifts it.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Lists every connection Polymorfa is currently restricting, what the restriction blocks, and the exact condition that lifts it.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -23320,14 +23158,14 @@
}
}
},
- "/console/bansafe/enforcement/{session}/appeal": {
+ "/console/bansafe/enforcement/{connection}/appeal": {
"post": {
"operationId": "appealBanSafeEnforcement",
"tags": [
"bansafe"
],
- "summary": "Appeal a number restriction",
- "description": "Files one appeal against a number's restriction. Every open finding on the number must be acknowledged first, otherwise the request is refused with `findings_unacknowledged`. Filing an appeal does not change the restriction. Requires a signed-in team owner, admin, or developer.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
+ "summary": "Appeal a connection restriction",
+ "description": "Files one appeal against a connection's restriction. Every open finding on the connection must be acknowledged first, otherwise the request is refused with `findings_unacknowledged`. Filing an appeal does not change the restriction. Requires a signed-in team owner, admin, or developer.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": true,
@@ -23339,7 +23177,7 @@
],
"parameters": [
{
- "name": "session",
+ "name": "connection",
"in": "path",
"required": true,
"schema": {
@@ -23423,11 +23261,11 @@
"bansafe"
],
"summary": "List safety incidents",
- "description": "Lists the WhatsApp restrictions and customer reports recorded for the team's numbers.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Lists the WhatsApp restrictions and customer reports recorded for the team's connections.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -23446,7 +23284,7 @@
}
},
{
- "name": "session",
+ "name": "connection",
"in": "query",
"required": false,
"schema": {
@@ -23543,11 +23381,11 @@
"bansafe"
],
"summary": "Report a ban",
- "description": "Records that WhatsApp restricted or banned one of your numbers. Send the same `Idempotency-Key` to retry safely for the same number; a repeat returns the original report. Reusing the key for a different number returns `422 bansafe_incident_idempotency_scope_conflict`.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Records that WhatsApp restricted or banned one of your connections. Send the same `Idempotency-Key` to retry safely for the same connection; a repeat returns the original report. Reusing the key for a different connection returns `422 bansafe_incident_idempotency_scope_conflict`.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -23647,11 +23485,11 @@
"bansafe"
],
"summary": "Withdraw a ban report",
- "description": "Withdraws a customer report and returns its incident record. Repeating the request returns the closed record. An incident observed from WhatsApp cannot be withdrawn and returns `409 bansafe_incident_not_a_report`. An unknown incident returns 404.\n\nTeam keys require `sessions:manage`. Project tokens are not accepted.",
+ "description": "Withdraws a customer report and returns its incident record. Repeating the request returns the closed record. An incident observed from WhatsApp cannot be withdrawn and returns `409 bansafe_incident_not_a_report`. An unknown incident returns 404.\n\nTeam keys require `connections:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -23736,11 +23574,11 @@
"bansafe"
],
"summary": "List Ban Credit claims",
- "description": "Lists the Ban Credit claims filed on your numbers, newest first. A claim is filed automatically when a ban is recorded on a number whose plan includes Ban Credit; there is no request to file one.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Lists the Ban Credit claims filed on your connections, newest first. A claim is filed automatically when a ban is recorded on a connection whose plan includes Ban Credit; there is no request to file one.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -23759,7 +23597,7 @@
}
},
{
- "name": "session",
+ "name": "connection",
"in": "query",
"required": false,
"schema": {
@@ -23874,11 +23712,11 @@
"bansafe"
],
"summary": "Get a Ban Credit claim",
- "description": "Returns one claim: the 30 days it covers, the credits that number consumed in them, the most the plan returns, what the claim returns, what the ban was attributed to, and the evidence counts behind that.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns one claim: the 30 days it covers, the credits that connection consumed in them, the most the plan returns, what the claim returns, what the ban was attributed to, and the evidence counts behind that.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -23960,11 +23798,11 @@
"bansafe"
],
"summary": "Get a project's Safe Mode ceiling",
- "description": "Returns the most visible sending behaviour any number in this project may use. Every setting is off by default. `entitled` reports whether the plan includes BanSafe Lite, which Safe Mode is part of, and `entitlementReason` gives the reason a raise would be refused.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns the most visible sending behaviour any connection in this project may use. Every setting is off by default. `entitled` reports whether the plan includes BanSafe Lite, which Safe Mode is part of, and `entitlementReason` gives the reason a raise would be refused.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -24045,11 +23883,11 @@
"bansafe"
],
"summary": "Set a project's Safe Mode ceiling",
- "description": "Sets the most visible behaviour any number in this project may use. Send only the settings you want to change. Presence and read receipts are visible to the people these numbers message: turning them on makes a number appear online, exposes last seen subject to the account's privacy settings, and puts blue ticks on incoming messages. Raising a setting requires a plan that includes BanSafe Lite, and lowering one is always allowed. A signed-in caller must be a team owner, admin, or developer.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Sets the most visible behaviour any connection in this project may use. Send only the settings you want to change. Presence and read receipts are visible to the people these connections message: turning them on makes a connection appear online, exposes last seen subject to the account's privacy settings, and puts blue ticks on incoming messages. Raising a setting requires a plan that includes BanSafe Lite, and lowering one is always allowed. A signed-in caller must be a team owner, admin, or developer.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -24141,18 +23979,18 @@
}
}
},
- "/platform/sessions/{sessionId}/safe-mode": {
+ "/platform/connections/{connectionId}/safe-mode": {
"get": {
- "operationId": "getNumberSafeMode",
+ "operationId": "getPlatformConnectionSafeMode",
"tags": [
"bansafe"
],
- "summary": "Get a number's Safe Mode",
- "description": "Returns the project ceiling, this number's override, the policy in force, and what the number last reported it is running. `mismatch` is true when the two differ. `entitled` reports whether the plan includes BanSafe Lite, which Safe Mode is part of, and `entitlementReason` gives the reason a raise would be refused.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "Get a connection's Safe Mode",
+ "description": "Returns the project ceiling, this connection's override, the policy in force, and what the connection last reported it is running. `mismatch` is true when the two differ. `entitled` reports whether the plan includes BanSafe Lite, which Safe Mode is part of, and `entitlementReason` gives the reason a raise would be refused.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
- "x-polymorfa-resource-boundary": "session",
+ "x-polymorfa-resource-boundary": "connection",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -24163,12 +24001,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
}
],
@@ -24203,7 +24041,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionSafeMode"
+ "$ref": "#/components/schemas/ConnectionSafeMode"
}
},
"required": [
@@ -24228,16 +24066,16 @@
}
},
"put": {
- "operationId": "updateNumberSafeMode",
+ "operationId": "updatePlatformConnectionSafeMode",
"tags": [
"bansafe"
],
- "summary": "Set a number's Safe Mode",
- "description": "Sets one number's Safe Mode. Each setting accepts `inherit` to follow the project ceiling. An override may only be equally or more conservative than the ceiling; a more visible value is refused with `safe_mode_exceeds_project_ceiling`. Raising a setting requires a plan that includes BanSafe Lite, and lowering one is always allowed. A signed-in caller must be a team owner, admin, or developer.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Set a connection's Safe Mode",
+ "description": "Sets one connection's Safe Mode. Each setting accepts `inherit` to follow the project ceiling. An override may only be equally or more conservative than the ceiling; a more visible value is refused with `safe_mode_exceeds_project_ceiling`. Raising a setting requires a plan that includes BanSafe Lite, and lowering one is always allowed. A signed-in caller must be a team owner, admin, or developer.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
- "x-polymorfa-resource-boundary": "session",
+ "x-polymorfa-resource-boundary": "connection",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -24248,12 +24086,12 @@
],
"parameters": [
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
}
],
@@ -24262,7 +24100,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UpdateSessionSafeModeInput"
+ "$ref": "#/components/schemas/UpdateConnectionSafeModeInput"
}
}
}
@@ -24298,7 +24136,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/SessionSafeMode"
+ "$ref": "#/components/schemas/ConnectionSafeMode"
}
},
"required": [
@@ -24336,11 +24174,11 @@
"bansafe"
],
"summary": "Get a project's warm-up plan",
- "description": "Returns whether numbers in this project have a daily allowance, the two settings that shape the ramp, the per-number daily cap it climbs to, and the projected allowance day by day. `entitled` reports whether the plan includes BanSafe Lite, which the warm-up plan is part of.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns whether connections in this project have a daily allowance, the two settings that shape the ramp, the per-connection daily cap it climbs to, and the projected allowance day by day. `entitled` reports whether the plan includes BanSafe Lite, which the warm-up plan is part of.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -24421,11 +24259,11 @@
"bansafe"
],
"summary": "Set a project's warm-up plan",
- "description": "Turns the warm-up plan on or off for a project and sets how long the ramp takes and how many messages a number may send on its first day. Send only the settings you want to change. While the plan is on, a send past a number's allowance is refused with `bansafe_daily_allowance_reached` and campaign recipients are deferred to the next reset. Turning the plan on requires a plan that includes BanSafe Lite; turning it off is always allowed. A signed-in caller must be a team owner, admin, or developer.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Turns the warm-up plan on or off for a project and sets how long the ramp takes and how many messages a connection may send on its first day. Send only the settings you want to change. While the plan is on, a send past a connection's allowance is refused with `bansafe_daily_allowance_reached` and campaign recipients are deferred to the next reset. Turning the plan on requires a plan that includes BanSafe Lite; turning it off is always allowed. A signed-in caller must be a team owner, admin, or developer.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -24524,11 +24362,11 @@
"bansafe"
],
"summary": "Get a project's health policy",
- "description": "Returns the health threshold and the actions configured for numbers in this project. Integration flags report whether email and webhook delivery are ready to use.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns the health threshold and the actions configured for connections in this project. Integration flags report whether email and webhook delivery are ready to use.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -24609,11 +24447,11 @@
"bansafe"
],
"summary": "Set a project's health policy",
- "description": "Replaces the project policy when the supplied version matches the stored version. The rule applies only when an available health estimate is below the threshold; an unavailable estimate triggers no action. Stopping disconnects a session and retains its linked credentials. Logging out requires relinking.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Replaces the project policy when the supplied version matches the stored version. The rule applies only when an available health estimate is below the threshold; an unavailable estimate triggers no action. Stopping disconnects a connection and retains its linked credentials. Logging out requires relinking.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -24709,11 +24547,11 @@
"bansafe"
],
"summary": "Get a project's Ban Credit evidence setting",
- "description": "Returns whether evidence collection about other linked devices is enabled and whether any number in the project has Ban Credit included in its plan. Collection is off until explicitly enabled.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns whether evidence collection about other linked devices is enabled and whether any connection in the project has Ban Credit included in its plan. Collection is off until explicitly enabled.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -24794,11 +24632,11 @@
"bansafe"
],
"summary": "Set a project's Ban Credit evidence setting",
- "description": "Enables or disables collection of counts about other linked devices. Collection never includes messages, recipient identities, or device names. Disabling collection discards stored device evidence. A 503 `propagation_pending` means the setting was stored but a connected number has not confirmed it; retry the request. A signed-in caller must be an team owner, admin, or developer.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Enables or disables collection of counts about other linked devices. Collection never includes messages, recipient identities, or device names. Disabling collection discards stored device evidence. A 503 `propagation_pending` means the setting was stored but a connected connection has not confirmed it; retry the request. A signed-in caller must be an team owner, admin, or developer.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -24989,7 +24827,7 @@
"campaigns"
],
"summary": "Create campaign",
- "description": "Creates a draft campaign on any plan. `messagesArray` holds up to 10 composed messages, with each `delayAfterSec` from 0 to 86400, or 2592000 for a drip. `drip` requires the default-off drip sequences beta (`403 feature_unavailable`). Only an unlaunched draft can change drip settings, except a running or paused continuous drip can close enrollment by setting enrollment to audience with the same exit settings. `senderConfig.sessionIds` may name numbers that are not yet on a plan that includes Campaigns; launch checks the selection. `templateId` must name a template in the campaign's project, and a malformed `variableMapping` answers `400 invalid_parameter` naming the field. It is refused with `403 bansafe_team_suspended` while the team is suspended, `400 invalid_parameter` when `senderConfig.sessionIds` is malformed, and `400 campaign_throughput_capped` when a per-number cap is above its safety ceiling. Setting `trackedLinks` requires the campaign link tracking beta and otherwise answers `403 feature_unavailable`. `variants` and `variantStrategy` make an A/B test, a beta: without enrollment it answers `403 feature_unavailable`, and a template with variants answers `400 invalid_parameter`.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
+ "description": "Creates a draft campaign on any plan. `messagesArray` holds up to 10 composed messages, with each `delayAfterSec` from 0 to 86400, or 2592000 for a drip. `drip` requires the default-off drip sequences beta (`403 feature_unavailable`). Only an unlaunched draft can change drip settings, except a running or paused continuous drip can close enrollment by setting enrollment to audience with the same exit settings. `senderConfig.connectionIds` may name connections that are not yet on a plan that includes Campaigns; launch checks the selection. `templateId` must name a template in the campaign's project, and a malformed `variableMapping` answers `400 invalid_parameter` naming the field. It is refused with `403 bansafe_team_suspended` while the team is suspended, `400 invalid_parameter` when `senderConfig.connectionIds` is malformed, and `400 campaign_throughput_capped` when a per-connection cap is above its safety ceiling. Setting `trackedLinks` requires the campaign link tracking beta and otherwise answers `403 feature_unavailable`. `variants` and `variantStrategy` make an A/B test, a beta: without enrollment it answers `403 feature_unavailable`, and a template with variants answers `400 invalid_parameter`.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
@@ -25392,7 +25230,7 @@
"campaigns"
],
"summary": "Launch campaign",
- "description": "Starts a draft campaign. It begins sending at `scheduledAt`, or right away when no start time is set. Launch checks the stored sender selection against live plans: `402 campaigns_not_entitled` when a selected number is missing or its plan does not include Campaigns, or when an unselected campaign's project has no such number; `400 invalid_parameter` on `senderConfig.sessionIds` when a selected number is not connected or the selection mixes sending types; `400 campaign_throughput_capped` when a requested throughput is above its ceiling. A segment campaign requires a team API key or signed-in dashboard session; project tokens answer `403 permission_denied`. Both audience betas must be available, otherwise launch answers `403 feature_unavailable`. An audience change while launch is being authorized answers `409 state_conflict`. Segment evaluation that exceeds its time limit also answers `409 state_conflict`; simplify the rules and retry. A launched campaign whose segment was deleted remains launched and cannot be launched again (`409 state_conflict`). A drip without a sendable composed message answers `400 invalid_parameter` on `messagesArray`. Saving a draft does not apply this check. A composed attachment requires a public `media.url` (`400 invalid_parameter`). The template must be complete (`400 invalid_parameter`) and approved on every Cloud API number (`400 template_not_approved`). Every recipient needs a value or fallback for each variable (`422 campaign_variables_missing`); `skipMissingVariables: true` skips those recipients before the first send. A message that references a `{{link:}}` the campaign does not define, or tracked links on a campaign that would send from Official API numbers, answers `400 invalid_parameter` on `trackedLinks`; tracked links without the campaign link tracking beta answer `403 feature_unavailable`. `409` means the campaign is not a draft, is already launched and waiting for its start time, or its sending numbers changed during the launch. When the team requires approval above a recipient threshold and the launch would send to more recipients, a launch by anyone other than a team owner or admin signed in to the console answers `409 campaign_approval_required`, sends nothing, and records a pending approval request that `GET /platform/campaigns/{campaignId}/approvals` lists. Launching again with the campaign unchanged returns the same request. A launch requested by an AI agent through the hosted MCP server is held the same way, whatever the threshold.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
+ "description": "Starts a draft campaign. It begins sending at `scheduledAt`, or right away when no start time is set. Launch checks the stored sender selection against live plans: `402 campaigns_not_entitled` when a selected connection is missing or its plan does not include Campaigns, or when an unselected campaign's project has no such number; `400 invalid_parameter` on `senderConfig.connectionIds` when a selected connection is not connected or the selection mixes sending types; `400 campaign_throughput_capped` when a requested throughput is above its ceiling. A segment campaign requires a team API key or signed-in dashboard session; project tokens answer `403 permission_denied`. Both audience betas must be available, otherwise launch answers `403 feature_unavailable`. An audience change while launch is being authorized answers `409 state_conflict`. Segment evaluation that exceeds its time limit also answers `409 state_conflict`; simplify the rules and retry. A launched campaign whose segment was deleted remains launched and cannot be launched again (`409 state_conflict`). A drip without a sendable composed message answers `400 invalid_parameter` on `messagesArray`. Saving a draft does not apply this check. A composed attachment requires a public `media.url` (`400 invalid_parameter`). The template must be complete (`400 invalid_parameter`) and approved on every Cloud API connection (`400 template_not_approved`). Every recipient needs a value or fallback for each variable (`422 campaign_variables_missing`); `skipMissingVariables: true` skips those recipients before the first send. A message that references a `{{link:}}` the campaign does not define, or tracked links on a campaign that would send from Official API connections, answers `400 invalid_parameter` on `trackedLinks`; tracked links without the campaign link tracking beta answer `403 feature_unavailable`. `409` means the campaign is not a draft, is already launched and waiting for its start time, or its sending connections changed during the launch. When the team requires approval above a recipient threshold and the launch would send to more recipients, a launch by anyone other than a team owner or admin signed in to the console answers `409 campaign_approval_required`, sends nothing, and records a pending approval request that `GET /platform/campaigns/{campaignId}/approvals` lists. Launching again with the campaign unchanged returns the same request. A launch requested by an AI agent through the hosted MCP server is held the same way, whatever the threshold.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
@@ -25572,7 +25410,7 @@
}
},
"503": {
- "description": "`idempotency_replay_unavailable`: the recorded response cannot be read. The original request is not run again, and its execution fence remains in place. Keep the first response; do not switch keys to resend. The selected numbers' plans can also fail to be checked (`service_unavailable`), before anything is launched or saved.",
+ "description": "`idempotency_replay_unavailable`: the recorded response cannot be read. The original request is not run again, and its execution fence remains in place. Keep the first response; do not switch keys to resend. The selected connections' plans can also fail to be checked (`service_unavailable`), before anything is launched or saved.",
"headers": {
"X-Request-Id": {
"schema": {
@@ -26756,7 +26594,7 @@
"campaigns"
],
"summary": "Send a test of a draft campaign",
- "description": "Requires campaigns:manage and campaigns:read because the test can use stored recipient samples. Sends one copy of a draft campaign's content to a seed recipient, through the same rendering, sending and BanSafe checks as a launched campaign. The seed recipient must be a number connected to your team. The sending number must be connected, on a plan that includes Campaigns and, when the campaign selects numbers, one of them. A test is not a campaign recipient and is not counted in the campaign's statistics or webhooks. A team can send 20 tests an hour, and at most 5 an hour to one seed recipient. `429` means one of these limits was reached or BanSafe is pacing the sending number; follow `Retry-After`. `409 bansafe_cold_held` means the seed recipient has never written to the sending number and the campaign holds first messages. `409 state_conflict` means the campaign is not a draft or has A/B or weighted content alternatives, the sending number is a Hybrid Link number, or the seed recipient opted out. `504 result_unknown` means the outcome was not received in time and the test may still arrive. Send `projectId` in the body when using a team API key. `422 campaign_variables_missing` means the test's sample values, the mapped recipient value and the fallback all leave a variable in the campaign content empty.\n\nRequires `campaigns:manage` and `campaigns:read`. Project tokens only access resources in their own project.",
+ "description": "Requires campaigns:manage and campaigns:read because the test can use stored recipient samples. Sends one copy of a draft campaign's content to a seed recipient, through the same rendering, sending and BanSafe checks as a launched campaign. The seed recipient must be the phone of a Connection connected to your team. The sending connection must be connected, on a plan that includes Campaigns and, when the campaign selects connections, one of them. A test is not a campaign recipient and is not counted in the campaign's statistics or webhooks. A team can send 20 tests an hour, and at most 5 an hour to one seed recipient. `429` means one of these limits was reached or BanSafe is pacing the sending connection; follow `Retry-After`. `409 bansafe_cold_held` means the seed recipient has never written to the sending connection and the campaign holds first messages. `409 state_conflict` means the campaign is not a draft or has A/B or weighted content alternatives, the sending connection is a Hybrid Link connection, or the seed recipient opted out. `504 result_unknown` means the outcome was not received in time and the test may still arrive. Send `projectId` in the body when using a team API key. `422 campaign_variables_missing` means the test's sample values, the mapped recipient value and the fallback all leave a variable in the campaign content empty.\n\nRequires `campaigns:manage` and `campaigns:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
@@ -26916,7 +26754,7 @@
"$ref": "#/components/responses/UpstreamFailure"
},
"503": {
- "description": "`idempotency_replay_unavailable`: the recorded response cannot be read. The original request is not run again, and its execution fence remains in place. Keep the first response; do not switch keys to resend. The send path can also be unavailable before a send (`session_not_ready`, `command_dispatch_failed`, `service_unavailable`, or `bansafe_accounting_unavailable`).",
+ "description": "`idempotency_replay_unavailable`: the recorded response cannot be read. The original request is not run again, and its execution fence remains in place. Keep the first response; do not switch keys to resend. The send path can also be unavailable before a send (`connection_not_ready`, `command_dispatch_failed`, `service_unavailable`, or `bansafe_accounting_unavailable`).",
"headers": {
"X-Request-Id": {
"schema": {
@@ -26966,7 +26804,7 @@
"campaigns"
],
"summary": "Create campaign reply flow",
- "description": "Creates an immutable reply flow revision: the steps a campaign runs when a recipient replies. Each step can send a text, reply buttons, a list, or a Flow form (Official numbers only), and branches on the button or list row chosen, an exact keyword, or a Flow form submission. Beta: returns `403` unless campaign reply flows are enabled for the team. `409` means this flow key and revision already exist.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
+ "description": "Creates an immutable reply flow revision: the steps a campaign runs when a recipient replies. Each step can send a text, reply buttons, a list, or a Flow form (Official connections only), and branches on the button or list row chosen, an exact keyword, or a Flow form submission. Beta: returns `403` unless campaign reply flows are enabled for the team. `409` means this flow key and revision already exist.\n\nRequires `campaigns:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
@@ -28270,7 +28108,7 @@
"campaigns"
],
"summary": "Approve a campaign launch",
- "description": "Approves a pending request and runs its `action` in the same step: launches the campaign, resumes it, or moves its start. The action runs every check it would run on its own again and is bound to the request: if the campaign's content, sending numbers, schedule, template or frozen audience changed since the request, or the request is no longer pending, nothing is sent and the answer is `409 campaign_approval_stale`. A requested start time that has already passed starts the campaign when approved. A request can be approved once.\n\nRequires a verified dashboard bearer and current team authorization. The signed-in member must be a team owner or admin. Team keys and project tokens are not accepted.",
+ "description": "Approves a pending request and runs its `action` in the same step: launches the campaign, resumes it, or moves its start. The action runs every check it would run on its own again and is bound to the request: if the campaign's content, sending connections, schedule, template or frozen audience changed since the request, or the request is no longer pending, nothing is sent and the answer is `409 campaign_approval_stale`. A requested start time that has already passed starts the campaign when approved. A request can be approved once.\n\nRequires a verified dashboard bearer and current team authorization. The signed-in member must be a team owner or admin. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
@@ -28891,7 +28729,7 @@
"audiences"
],
"summary": "Create an audience",
- "description": "Creates an audience from inline `members` (at most 1,000) or from an uploaded CSV file (`fileId` + `mapping`). Numbers are normalized to E.164 and repeated numbers are kept once. A file import accepts at most 100,000 data rows; a larger file is refused with `413` and must be split. The response reports how many rows were invalid, with up to 20 samples. `recipientCount` is the number of stored members; any client-supplied count is ignored. If your team deleted an audience profile for one of these numbers in the last 30 days, the request returns `409` naming the row (numbered as in `invalidRows`), and nothing is added.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Creates an audience from inline `members` (at most 1,000) or from an uploaded CSV file (`fileId` + `mapping`). Phone numbers are normalized to E.164 and repeated phone numbers are kept once. A file import accepts at most 100,000 data rows; a larger file is refused with `413` and must be split. The response reports how many rows were invalid, with up to 20 samples. `recipientCount` is the number of stored members; any client-supplied count is ignored. If your team deleted an audience profile for one of these phone numbers in the last 30 days, the request returns `409` naming the row (numbered as in `invalidRows`), and nothing is added.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -29011,7 +28849,7 @@
"audiences"
],
"summary": "Create an audience from a campaign",
- "description": "Creates an audience from the recipients of a previous campaign that had one `outcome`, to send them a follow-up campaign. The members are a snapshot taken when the request runs: later receipts, reads or replies on the source campaign do not change the audience. Numbers on the team's opt-out list are left out and counted in `optedOutCount`; each member keeps the template variables it had on the source campaign. Outcomes: `delivered` (the device confirmed delivery), `not_delivered` (sent, with no delivery confirmation), `read`, `not_read` (sent and not read, including sends never delivered), `replied`, `not_replied` (sent and no reply was attributed), and `failed` (confirmed failed sends; sends whose outcome is uncertain, such as a timeout waiting for WhatsApp, are excluded). Read outcomes depend on the recipient's read receipts. `404` means the campaign is not in your team (or not in `projectId` when given); `409` means no recipient that is not opted out has the outcome, and nothing is created.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Creates an audience from the recipients of a previous campaign that had one `outcome`, to send them a follow-up campaign. The members are a snapshot taken when the request runs: later receipts, reads or replies on the source campaign do not change the audience. Phone numbers on the team's opt-out list are left out and counted in `optedOutCount`; each member keeps the template variables it had on the source campaign. Outcomes: `delivered` (the device confirmed delivery), `not_delivered` (sent, with no delivery confirmation), `read`, `not_read` (sent and not read, including sends never delivered), `replied`, `not_replied` (sent and no reply was attributed), and `failed` (confirmed failed sends; sends whose outcome is uncertain, such as a timeout waiting for WhatsApp, are excluded). Read outcomes depend on the recipient's read receipts. `404` means the campaign is not in your team (or not in `projectId` when given); `409` means no recipient that is not opted out has the outcome, and nothing is created.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -29356,7 +29194,7 @@
"audiences"
],
"summary": "Add audience members",
- "description": "Adds up to 1,000 members to an audience. A number already in the audience is skipped. Invalid entries are reported, not added. If your team deleted an audience profile for one of these numbers in the last 30 days, the request returns `409` naming the row (numbered as in `invalidRows`), and nothing is added.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Adds up to 1,000 members to an audience. A number already in the audience is skipped. Invalid entries are reported, not added. If your team deleted an audience profile for one of these phone numbers in the last 30 days, the request returns `409` naming the row (numbered as in `invalidRows`), and nothing is added.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -32571,11 +32409,11 @@
"flows"
],
"summary": "List Flow drafts",
- "description": "Lists compact WhatsApp Flow draft summaries in one project.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Lists compact WhatsApp Flow draft summaries in one project.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -32659,11 +32497,11 @@
"flows"
],
"summary": "Create a Flow draft",
- "description": "Creates a project-scoped WhatsApp Flow draft. A supplied draftId makes retries idempotent.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Creates a project-scoped WhatsApp Flow draft. A supplied draftId makes retries idempotent.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -32745,11 +32583,11 @@
"flows"
],
"summary": "Get a Flow draft",
- "description": "Gets one project-scoped WhatsApp Flow draft.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Gets one project-scoped WhatsApp Flow draft.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -32843,11 +32681,11 @@
"flows"
],
"summary": "Update a Flow draft",
- "description": "Updates a Flow draft when expectedUpdatedAt matches the stored revision.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Updates a Flow draft when expectedUpdatedAt matches the stored revision.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -32940,11 +32778,11 @@
"flows"
],
"summary": "Delete a Flow draft",
- "description": "Deletes a local Flow draft without deleting linked Meta Flow assets.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Deletes a local Flow draft without deleting linked Meta Flow assets.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -33033,12 +32871,12 @@
"tags": [
"flows"
],
- "summary": "Upload a Flow to a Number",
- "description": "Sends the saved Flow draft to the WhatsApp Business Account of one Number. The first upload to a Number, or the first upload after the Number's Flow was deprecated, creates a WhatsApp Flow and needs `categories`; later uploads replace the JSON of that Flow while it is still a WhatsApp draft. The response lists the validation errors WhatsApp reported, and `uploadState` is `valid` only when there are none. The Number needs an active WhatsApp Business Platform connection and the Cloud onboarding beta; test Numbers use the simulation. A Flow with `data_api_version` needs an enabled data endpoint for the Number (see Configure a Flow's data endpoint); its endpoint URI is attached during the upload. Test Numbers cannot use data endpoints. A supplied `requestId` makes retries return the original operation instead of sending again.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Upload a Flow to a Connection",
+ "description": "Sends the saved Flow draft to the WhatsApp Business Account of one Connection. The first upload to a Connection, or the first upload after the Connection's Flow was deprecated, creates a WhatsApp Flow and needs `categories`; later uploads replace the JSON of that Flow while it is still a WhatsApp draft. The response lists the validation errors WhatsApp reported, and `uploadState` is `valid` only when there are none. The Connection needs an active WhatsApp Business Platform method and the Cloud onboarding beta; test Connections use the simulation. A Flow with `data_api_version` needs an enabled data endpoint for the Connection (see Configure a Flow's data endpoint); its endpoint URI is attached during the upload. Test Connections cannot use data endpoints. A supplied `requestId` makes retries return the original operation instead of sending again.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -33138,12 +32976,12 @@
"tags": [
"flows"
],
- "summary": "Publish a Flow on a Number",
- "description": "Publishes the Number's WhatsApp Flow. The last upload must match the saved draft, and for a Flow with a data endpoint the endpoint's current URI, and have no validation errors. A published Flow cannot be changed or deleted; it can only be deprecated. The Flow counts as published only after WhatsApp confirms it: when the response is lost, the operation state is `uncertain` until a provider read settles it, and publishing is never sent twice.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Publish a Flow on a Connection",
+ "description": "Publishes the Connection's WhatsApp Flow. The last upload must match the saved draft, and for a Flow with a data endpoint the endpoint's current URI, and have no validation errors. A published Flow cannot be changed or deleted; it can only be deprecated. The Flow counts as published only after WhatsApp confirms it: when the response is lost, the operation state is `uncertain` until a provider read settles it, and publishing is never sent twice.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -33243,12 +33081,12 @@
"tags": [
"flows"
],
- "summary": "Deprecate a Flow on a Number",
- "description": "Deprecates the Number's published WhatsApp Flow so it can no longer be sent. Deprecation cannot be undone; upload the draft again to create a new WhatsApp Flow. It remains available while the team's service is restricted.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Deprecate a Flow on a Connection",
+ "description": "Deprecates the Connection's published WhatsApp Flow so it can no longer be sent. Deprecation cannot be undone; upload the draft again to create a new WhatsApp Flow. It remains available while the team's service is restricted.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -33345,12 +33183,12 @@
"tags": [
"flows"
],
- "summary": "Delete a Flow from a Number",
- "description": "Deletes the Number's WhatsApp Flow while it is still a WhatsApp draft and removes the Number's link. The saved Polymorfa draft is kept. A Flow that was published cannot be deleted; deprecate it instead.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Delete a Flow from a Connection",
+ "description": "Deletes the Connection's WhatsApp Flow while it is still a WhatsApp draft and removes the Connection's link. The saved Polymorfa draft is kept. A Flow that was published cannot be deleted; deprecate it instead.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -33447,12 +33285,12 @@
"tags": [
"flows"
],
- "summary": "Sync a Flow's status from a Number",
- "description": "Reads the Number's WhatsApp Flow status, validation errors and preview link, and settles an earlier operation whose outcome was unknown. It never repeats a change.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Sync a Flow's status from a Connection",
+ "description": "Reads the Connection's WhatsApp Flow status, validation errors and preview link, and settles an earlier operation whose outcome was unknown. It never repeats a change.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -33550,11 +33388,11 @@
"flows"
],
"summary": "List a Flow's provider operations",
- "description": "Lists up to 50 recent upload, publish, deprecate and delete operations for a Flow draft across Numbers, newest first.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Lists up to 50 recent upload, publish, deprecate and delete operations for a Flow draft across Connections, newest first.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -33647,12 +33485,12 @@
"tags": [
"flows"
],
- "summary": "Get a Flow's data endpoint on a Number",
- "description": "Returns the data endpoint configured for a Flow on one Number, the endpoint URI WhatsApp calls, and the Number's Flow encryption custody. `endpoint` is null when none is configured.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "Get a Flow's data endpoint on a Connection",
+ "description": "Returns the data endpoint configured for a Flow on one Connection, the endpoint URI WhatsApp calls, and the Connection's Flow encryption custody. `endpoint` is null when none is configured.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -33679,7 +33517,7 @@
}
},
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "query",
"required": true,
"schema": {
@@ -33750,12 +33588,12 @@
"tags": [
"flows"
],
- "summary": "Configure a Flow's data endpoint on a Number",
- "description": "Creates or replaces the data endpoint of a dynamic Flow on one Number. `forward` decrypts each WhatsApp request with the Number's Polymorfa-managed key and forwards the request JSON to your HTTPS `url`, signed with `X-Polymorfa-Flow-Signature`; your JSON response is encrypted and returned to WhatsApp. `function` runs a deployed Function with the request JSON as the body. `direct` attaches your own `url` and requires your own encryption key on the Number; Polymorfa never decrypts that traffic. A new forward endpoint, a switch to forward and `rotateSigningSecret` return `signingSecret` once. Upload the Flow after configuring its endpoint so the endpoint URI is attached. Request and response contents are never stored.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Configure a Flow's data endpoint on a Connection",
+ "description": "Creates or replaces the data endpoint of a dynamic Flow on one Connection. `forward` decrypts each WhatsApp request with the Connection's Polymorfa-managed key and forwards the request JSON to your HTTPS `url`, signed with `X-Polymorfa-Flow-Signature`; your JSON response is encrypted and returned to WhatsApp. `function` runs a deployed Function with the request JSON as the body. `direct` attaches your own `url` and requires your own encryption key on the Connection; Polymorfa never decrypts that traffic. A new forward endpoint, a switch to forward and `rotateSigningSecret` return `signingSecret` once. Upload the Flow after configuring its endpoint so the endpoint URI is attached. Request and response contents are never stored.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -33853,12 +33691,12 @@
"tags": [
"flows"
],
- "summary": "Remove a Flow's data endpoint on a Number",
- "description": "Removes the endpoint configuration. Requests to its URI are refused afterwards. Receipts are kept.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Remove a Flow's data endpoint on a Connection",
+ "description": "Removes the endpoint configuration. Requests to its URI are refused afterwards. Receipts are kept.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -33885,7 +33723,7 @@
}
},
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "query",
"required": true,
"schema": {
@@ -33956,11 +33794,11 @@
"flows"
],
"summary": "List a Flow's data endpoint receipts",
- "description": "Lists up to 100 recent data-exchange receipts for a Flow, newest first. Receipts record the action, outcome, HTTP status returned to WhatsApp, an error code and timing. They never contain form data, Flow tokens or responses.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Lists up to 100 recent data-exchange receipts for a Flow, newest first. Receipts record the action, outcome, HTTP status returned to WhatsApp, an error code and timing. They never contain form data, Flow tokens or responses.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -33987,7 +33825,7 @@
}
},
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "query",
"required": false,
"schema": {
@@ -34072,12 +33910,12 @@
"tags": [
"flow-encryption-keys"
],
- "summary": "Get a Number's Flow encryption custody",
- "description": "Returns whether Polymorfa holds the Number's active Flow encryption key (`managed`) or not (`customer`), and recent managed keys. Private keys are never returned.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "Get a Connection's Flow encryption custody",
+ "description": "Returns whether Polymorfa holds the Connection's active Flow encryption key (`managed`) or not (`customer`), and recent managed keys. Private keys are never returned.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -34096,7 +33934,7 @@
}
},
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "query",
"required": true,
"schema": {
@@ -34169,12 +34007,12 @@
"tags": [
"flow-encryption-keys"
],
- "summary": "Rotate a Number's managed Flow encryption key",
- "description": "Generates a 2048-bit RSA key pair, keeps the private key sealed, and registers the public key with WhatsApp for the Number. Every dynamic Flow on the Number uses this key. The previous managed key keeps decrypting for 24 hours. A lost WhatsApp response is settled by reading the registered key; the key is `uncertain` until then and is never registered twice.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "summary": "Rotate a Connection's managed Flow encryption key",
+ "description": "Generates a 2048-bit RSA key pair, keeps the private key sealed, and registers the public key with WhatsApp for the Connection. Every dynamic Flow on the Connection uses this key. The previous managed key keeps decrypting for 24 hours. A lost WhatsApp response is settled by reading the registered key; the key is `uncertain` until then and is never registered twice.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -34622,7 +34460,7 @@
"optouts"
],
"summary": "Update opt-out keyword settings",
- "description": "Replaces the team's keyword opt-out settings. When enabled, a direct text reply whose whole body matches an opt-out keyword, from a number that received a campaign message from the team in the last 30 days, adds that number to the opt-out list with source `stop-keyword` and emits `contact.opted_out`. Matching ignores letter case and surrounding punctuation and whitespace. An opt-in keyword removes only an opt-out created this way and emits `contact.opted_in`; opt-outs added manually, by file or through the API are never removed by a reply. Each list holds at most 50 keywords of 1 to 32 characters, the opt-out list needs at least one keyword, and the two lists must not share a keyword. Keywords are stored in upper case. Changes apply to replies within 30 seconds.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Replaces the team's keyword opt-out settings. When enabled, a direct text reply whose whole body matches an opt-out keyword, from a phone number that received a campaign message from the team in the last 30 days, adds that phone number to the opt-out list with source `stop-keyword` and emits `contact.opted_out`. Matching ignores letter case and surrounding punctuation and whitespace. An opt-in keyword removes only an opt-out created this way and emits `contact.opted_in`; opt-outs added manually, by file or through the API are never removed by a reply. Each list holds at most 50 keywords of 1 to 32 characters, the opt-out list needs at least one keyword, and the two lists must not share a keyword. Keywords are stored in upper case. Changes apply to replies within 30 seconds.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -34776,7 +34614,7 @@
"optouts"
],
"summary": "Update STOP confirmation settings",
- "description": "Replaces the team's preference using the observed revision. Enabling requires STOP confirmations beta access and a selected locale. A team owner or admin can also change it in the console. A new STOP opt-out queues at most one plain acknowledgement from the receiving connection; manual opt-outs, repeated STOP while suppressed and START produce none. A confirmation cannot undo suppression. Disabling remains available after beta withdrawal and cancels queued acknowledgements. A changed revision returns 409. Unknown send outcomes are never resent with a new operation identity.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
+ "description": "Replaces the team's preference using the observed revision. Enabling requires STOP confirmations beta access and a selected locale. A team owner or admin can also change it in the console. A new STOP opt-out queues at most one plain acknowledgement from the receiving method; manual opt-outs, repeated STOP while suppressed and START produce none. A confirmation cannot undo suppression. Disabling remains available after beta withdrawal and cancels queued acknowledgements. A changed revision returns 409. Unknown send outcomes are never resent with a new operation identity.\n\nTeam keys require `campaigns:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -35191,7 +35029,7 @@
"billing"
],
"summary": "Read a resource's limit and priority",
- "description": "Reads one project, customer or real number without loading the team directory. Requires a team key with the stated billing scope, or a signed-in team owner or admin. Project and client credentials cannot access these controls. Billing must be configured. Writes require Pay-As-You-Go. These controls never enable charging of unpriced usage.\n\nTeam keys require `billing:read`. Project tokens are not accepted.",
+ "description": "Reads one project, customer or real connection without loading the team directory. Requires a team key with the stated billing scope, or a signed-in team owner or admin. Project and client credentials cannot access these controls. Billing must be configured. Writes require Pay-As-You-Go. These controls never enable charging of unpriced usage.\n\nTeam keys require `billing:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -35214,7 +35052,7 @@
"enum": [
"project",
"customer",
- "number"
+ "connection"
]
}
},
@@ -35315,7 +35153,7 @@
"enum": [
"project",
"customer",
- "number"
+ "connection"
]
}
},
@@ -35439,7 +35277,7 @@
"billing"
],
"summary": "Read monthly spending limits",
- "description": "Reads attributed charges and active reservations in Polymorfa credits. Months reset at 00:00 UTC on the first day. Omit projectId for project limits across the team; pass it to include that project's customer and number limits. Pass scope=project to read only project limits. Requires a team key with the stated billing scope, or a signed-in team owner or admin. Project and client credentials cannot access these controls. Billing must be configured. Writes require Pay-As-You-Go. These controls never enable charging of unpriced usage.\n\nTeam keys require `billing:read`. Project tokens are not accepted.",
+ "description": "Reads attributed charges and active reservations in Polymorfa credits. Months reset at 00:00 UTC on the first day. Omit projectId for project limits across the team; pass it to include that project's customer and connection limits. Pass scope=project to read only project limits. Requires a team key with the stated billing scope, or a signed-in team owner or admin. Project and client credentials cannot access these controls. Billing must be configured. Writes require Pay-As-You-Go. These controls never enable charging of unpriced usage.\n\nTeam keys require `billing:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -35563,7 +35401,7 @@
"enum": [
"project",
"customer",
- "number"
+ "connection"
]
}
},
@@ -35684,7 +35522,7 @@
"billing"
],
"summary": "Read funding priorities",
- "description": "Lists active projects, customers and real numbers. Pass scope=project to read only project ranks. Pass projectId to read one project and its customer/number leaderboard. Project priority takes precedence. Within a project, numbers inherit their customer priority; a higher number priority overrides it. Number priority then breaks ties before renewal due time and stable number identity. Numbers are ranked within a project. Requires a team key with the stated billing scope, or a signed-in team owner or admin. Project and client credentials cannot access these controls. Billing must be configured. Writes require Pay-As-You-Go. These controls never enable charging of unpriced usage.\n\nTeam keys require `billing:read`. Project tokens are not accepted.",
+ "description": "Lists active projects, customers and real connections. Pass scope=project to read only project ranks. Pass projectId to read one project and its customer/connection leaderboard. Project priority takes precedence. Within a project, connections inherit their customer priority; a higher connection priority overrides it. Connection priority then breaks ties before renewal due time and stable connection identity. Connections are ranked within a project. Requires a team key with the stated billing scope, or a signed-in team owner or admin. Project and client credentials cannot access these controls. Billing must be configured. Writes require Pay-As-You-Go. These controls never enable charging of unpriced usage.\n\nTeam keys require `billing:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -35783,7 +35621,7 @@
"billing"
],
"summary": "Reorder funding priorities",
- "description": "resourceIds is the complete list in highest-first order. Project order includes every active project; customer and number orders include every active customer or real number in projectId. Use scope=resource with projectId and a complete resources array of {scope: customer or number, resourceId} for one mixed leaderboard. Saves the whole order atomically. Concurrent changes or an incomplete list return 409. Retrying the same successful order is harmless. Requires a team key with the stated billing scope, or a signed-in team owner or admin. Project and client credentials cannot access these controls. Billing must be configured. Writes require Pay-As-You-Go. These controls never enable charging of unpriced usage.\n\nTeam keys require `billing:manage`. Project tokens are not accepted.",
+ "description": "resourceIds is the complete list in highest-first order. Project order includes every active project; customer and connection orders include every active customer or real connection in projectId. Use scope=resource with projectId and a complete resources array of {scope: customer or connection, resourceId} for one mixed leaderboard. Saves the whole order atomically. Concurrent changes or an incomplete list return 409. Retrying the same successful order is harmless. Requires a team key with the stated billing scope, or a signed-in team owner or admin. Project and client credentials cannot access these controls. Billing must be configured. Writes require Pay-As-You-Go. These controls never enable charging of unpriced usage.\n\nTeam keys require `billing:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
@@ -35826,7 +35664,7 @@
"type": "string",
"enum": [
"customer",
- "number"
+ "connection"
]
},
"resourceId": {
@@ -35894,7 +35732,7 @@
"type": "string",
"enum": [
"customer",
- "number"
+ "connection"
]
},
"projectId": {
@@ -36020,7 +35858,7 @@
"enum": [
"project",
"customer",
- "number"
+ "connection"
]
}
},
@@ -36130,11 +35968,11 @@
"usage"
],
"summary": "Get usage",
- "description": "Returns metered usage for one calendar month (UTC), by meter and by number. Omit `period` for the current month. Usage is measured, not charged: `billingEnabled` is false and no credits are deducted for it. A project token reads its own project; `session` narrows to one number.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns metered usage for one calendar month (UTC), by meter and by connection. Omit `period` for the current month. Usage is measured, not charged: `billingEnabled` is false and no credits are deducted for it. A project token reads its own project; `connection` narrows to one connection.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -36154,14 +35992,14 @@
}
},
{
- "name": "session",
+ "name": "connection",
"in": "query",
"required": false,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
- "description": "Number (session name)."
+ "description": "Connection (connection name)."
}
},
{
@@ -36235,11 +36073,11 @@
"usage"
],
"summary": "List usage records",
- "description": "Lists usage records, newest first. Filter by project, number (`session`), call (`callId`), meter or calendar month; without `period`, records from every month are listed. A call has one `call.duration` record, and an outgoing Cloud API call also a `call.cloud_pulses` record. Pass `nextCursor` as `cursor` to read the next page with the same filters.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Lists usage records, newest first. Filter by project, connection (`connection`), call (`callId`), meter or calendar month; without `period`, records from every month are listed. A call has one `call.duration` record, and an outgoing Cloud API call also a `call.cloud_pulses` record. Pass `nextCursor` as `cursor` to read the next page with the same filters.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -36259,14 +36097,14 @@
}
},
{
- "name": "session",
+ "name": "connection",
"in": "query",
"required": false,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
- "description": "Number (session name)."
+ "description": "Connection (connection name)."
}
},
{
@@ -36380,11 +36218,11 @@
"usage"
],
"summary": "List usage gates",
- "description": "Returns every usage gate with its mode, limit, current usage and decisions in the last 30 days. Gate state covers the whole team, so it needs a team API key; project tokens are refused. Pass `session` to include limits that apply per number, and `projectId` to require that the number belongs to that project. The active outbound monthly gate is record-only: an action over its limit is counted but allowed. It cannot be switched to enforce until placement reservations are available. An action whose limit cannot be checked fails with `503`.\n\nTeam keys require `sessions:read`. Project tokens are not accepted.",
+ "description": "Returns every usage gate with its mode, limit, current usage and decisions in the last 30 days. Gate state covers the whole team, so it needs a team API key; project tokens are refused. Pass `connection` to include limits that apply per connection, and `projectId` to require that the connection belongs to that project. The active outbound monthly gate is record-only: an action over its limit is counted but allowed. It cannot be switched to enforce until placement reservations are available. An action whose limit cannot be checked fails with `503`.\n\nTeam keys require `connections:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -36398,20 +36236,20 @@
"name": "projectId",
"in": "query",
"required": false,
- "description": "Use with `session` to require that the number belongs to this project. Gate limits and usage remain team-wide or per number.",
+ "description": "Use with `connection` to require that the connection belongs to this project. Gate limits and usage remain team-wide or per connection.",
"schema": {
"type": "string"
}
},
{
- "name": "session",
+ "name": "connection",
"in": "query",
"required": false,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
- "description": "Number (session name)."
+ "description": "Connection (connection name)."
}
}
],
@@ -36478,11 +36316,11 @@
"team"
],
"summary": "Get team",
- "description": "Public Management API. Team keys require `sessions:read`. Project tokens are not accepted.",
+ "description": "Public Management API. Team keys require `connections:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -36616,11 +36454,11 @@
"projects"
],
"summary": "List projects",
- "description": "Public Management API. Team keys require `sessions:read`. Project tokens are not accepted.",
+ "description": "Public Management API. Team keys require `connections:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -36678,11 +36516,11 @@
"projects"
],
"summary": "Create a project",
- "description": "Creates a project in development. A Free team can have one active project; creating another returns `409` with code `payg_required` until the team upgrades to Pay-As-You-Go. Pay-As-You-Go teams have no project limit.\n\nTeam keys require `sessions:manage`. Project tokens are not accepted.",
+ "description": "Creates a project in development. A Free team can have one active project; creating another returns `409` with code `payg_required` until the team upgrades to Pay-As-You-Go. Pay-As-You-Go teams have no project limit.\n\nTeam keys require `connections:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -36897,7 +36735,7 @@
"connectionPath",
"audience",
"events",
- "sessionSource",
+ "connectionSource",
"goals"
],
"properties": {
@@ -36975,7 +36813,7 @@
"unsure"
]
},
- "sessionSource": {
+ "connectionSource": {
"type": "string",
"enum": [
"new",
@@ -37016,7 +36854,7 @@
"connectionPath",
"audience",
"events",
- "sessionSource",
+ "connectionSource",
"goals"
],
"properties": {
@@ -37124,7 +36962,7 @@
]
}
},
- "sessionSource": {
+ "connectionSource": {
"type": "array",
"minItems": 1,
"maxItems": 4,
@@ -37170,7 +37008,7 @@
"connectionPath",
"audience",
"events",
- "sessionSource",
+ "connectionSource",
"goals",
"journey"
],
@@ -37279,7 +37117,7 @@
]
}
},
- "sessionSource": {
+ "connectionSource": {
"type": "array",
"minItems": 1,
"maxItems": 4,
@@ -37428,7 +37266,7 @@
"connectionPath",
"audience",
"events",
- "sessionSource",
+ "connectionSource",
"goals",
"journey"
],
@@ -37537,7 +37375,7 @@
]
}
},
- "sessionSource": {
+ "connectionSource": {
"type": "array",
"minItems": 1,
"maxItems": 4,
@@ -37581,7 +37419,7 @@
"data",
"hosting",
"existingSolutions",
- "connectedNumbers"
+ "connectedConnections"
],
"properties": {
"mode": {
@@ -37680,7 +37518,7 @@
"additionalProperties": false,
"required": [
"kind",
- "connection",
+ "method",
"packageName",
"name",
"url"
@@ -37694,7 +37532,7 @@
"meta-direct"
]
},
- "connection": {
+ "method": {
"type": "string",
"enum": [
"meta",
@@ -37736,7 +37574,7 @@
"enum": [
"audience",
"existingUsers",
- "connectedNumbers",
+ "connectedConnections",
"source",
"connectionPath",
"assets",
@@ -37747,7 +37585,7 @@
]
}
},
- "connectedNumbers": {
+ "connectedConnections": {
"type": "object",
"additionalProperties": false,
"required": [
@@ -37859,7 +37697,7 @@
]
]
},
- "connectedNumbers": {
+ "connectedConnections": {
"properties": {
"exact": {
"type": "integer",
@@ -37917,9 +37755,9 @@
"type": "object",
"additionalProperties": false,
"required": [
- "numberCreated",
+ "connectionCreated",
"webhookCreated",
- "numberConnected",
+ "connectionConnected",
"credentialCreated",
"apiUsed",
"webhookEnabled",
@@ -37935,13 +37773,13 @@
"safetyViewed"
],
"properties": {
- "numberCreated": {
+ "connectionCreated": {
"type": "boolean"
},
"webhookCreated": {
"type": "boolean"
},
- "numberConnected": {
+ "connectionConnected": {
"type": "boolean"
},
"credentialCreated": {
@@ -38043,7 +37881,7 @@
"projects"
],
"summary": "Save a project integration plan",
- "description": "Saves reviewed setup answers. Version 4 includes bounded source identities and agent-observed count provenance or human ranges. Versions 2, 3 and 4 accept multiple selections per question except connectionPath; version 1 scalar plans remain readable and accepted. Unresolved choices use unsure alone; version 4 can also retain explicitly unanswered business decisions. Request bodies are bounded to 8 KiB and do not accept query parameters. Server SDK choices require TypeScript or JavaScript; browser calling requires client code and the Calls feature. Requires a current owner or admin and the expected revision; stale writes return 409. Does not grant access, enable features, import a session or configure resources.\n\nRequires a verified dashboard bearer and current team authorization. The signed-in member must be a team owner or admin. Team keys and project tokens are not accepted.",
+ "description": "Saves reviewed setup answers. Version 4 includes bounded source identities and agent-observed count provenance or human ranges. Versions 2, 3 and 4 accept multiple selections per question except connectionPath; version 1 scalar plans remain readable and accepted. Unresolved choices use unsure alone; version 4 can also retain explicitly unanswered business decisions. Request bodies are bounded to 8 KiB and do not accept query parameters. Server SDK choices require TypeScript or JavaScript; browser calling requires client code and the Calls feature. Requires a current owner or admin and the expected revision; stale writes return 409. Does not grant access, enable features, import a connection or configure resources.\n\nRequires a verified dashboard bearer and current team authorization. The signed-in member must be a team owner or admin. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
@@ -38096,7 +37934,7 @@
"connectionPath",
"audience",
"events",
- "sessionSource",
+ "connectionSource",
"goals"
],
"properties": {
@@ -38174,7 +38012,7 @@
"unsure"
]
},
- "sessionSource": {
+ "connectionSource": {
"type": "string",
"enum": [
"new",
@@ -38215,7 +38053,7 @@
"connectionPath",
"audience",
"events",
- "sessionSource",
+ "connectionSource",
"goals"
],
"properties": {
@@ -38323,7 +38161,7 @@
]
}
},
- "sessionSource": {
+ "connectionSource": {
"type": "array",
"minItems": 1,
"maxItems": 4,
@@ -38369,7 +38207,7 @@
"connectionPath",
"audience",
"events",
- "sessionSource",
+ "connectionSource",
"goals",
"journey"
],
@@ -38478,7 +38316,7 @@
]
}
},
- "sessionSource": {
+ "connectionSource": {
"type": "array",
"minItems": 1,
"maxItems": 4,
@@ -38627,7 +38465,7 @@
"connectionPath",
"audience",
"events",
- "sessionSource",
+ "connectionSource",
"goals",
"journey"
],
@@ -38736,7 +38574,7 @@
]
}
},
- "sessionSource": {
+ "connectionSource": {
"type": "array",
"minItems": 1,
"maxItems": 4,
@@ -38780,7 +38618,7 @@
"data",
"hosting",
"existingSolutions",
- "connectedNumbers"
+ "connectedConnections"
],
"properties": {
"mode": {
@@ -38879,7 +38717,7 @@
"additionalProperties": false,
"required": [
"kind",
- "connection",
+ "method",
"packageName",
"name",
"url"
@@ -38893,7 +38731,7 @@
"meta-direct"
]
},
- "connection": {
+ "method": {
"type": "string",
"enum": [
"meta",
@@ -38935,7 +38773,7 @@
"enum": [
"audience",
"existingUsers",
- "connectedNumbers",
+ "connectedConnections",
"source",
"connectionPath",
"assets",
@@ -38946,7 +38784,7 @@
]
}
},
- "connectedNumbers": {
+ "connectedConnections": {
"type": "object",
"additionalProperties": false,
"required": [
@@ -39058,7 +38896,7 @@
]
]
},
- "connectedNumbers": {
+ "connectedConnections": {
"properties": {
"exact": {
"type": "integer",
@@ -39260,7 +39098,7 @@
"connectionPath",
"audience",
"events",
- "sessionSource",
+ "connectionSource",
"goals",
"connect",
"webhook",
@@ -39360,11 +39198,11 @@
"projects"
],
"summary": "Update project settings",
- "description": "Updates the display name, icon, or default number plan without changing the project ID, URL, stage, or individual number overrides.\n\n**Hybrid Link.** A default plan without Hybrid Link returns `409` with code `hybrid_choice_required` while a Hybrid Link Number inherits the project plan. Change each such Number's tier first and choose which connection it keeps.\n\nRequires a verified dashboard bearer and current team authorization. The signed-in member must be a team owner or admin. Team keys and project tokens are not accepted.",
+ "description": "Updates the display name, icon, or default connection plan without changing the project ID, URL, stage, or individual connection overrides.\n\n**Hybrid Link.** A default plan without Hybrid Link returns `409` with code `hybrid_choice_required` while a Hybrid Link Connection inherits the project plan. Change each such Connection's tier first and choose which method it keeps.\n\nRequires a verified dashboard bearer and current team authorization. The signed-in member must be a team owner or admin. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
- "x-exclusion-reason": "Dashboard project name, icon, and default number plan settings. Requires a current owner or admin.",
+ "x-exclusion-reason": "Dashboard project name, icon, and default connection plan settings. Requires a current owner or admin.",
"x-required-team-role": "owner_or_admin",
"security": [
{
@@ -39518,11 +39356,11 @@
"projects"
],
"summary": "Request production enrollment",
- "description": "Creates a durable production-enrollment operation. The team must be on Pay-As-You-Go; a Free team receives `409` with code `payg_required` and upgrades from Billing first. The project stays in development until provisioning succeeds. Poll the returned operationId for progress.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Creates a durable production-enrollment operation. The team must be on Pay-As-You-Go; a Free team receives `409` with code `payg_required` and upgrades from Billing first. The project stays in development until provisioning succeeds. Poll the returned operationId for progress.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -39705,7 +39543,7 @@
"customers"
],
"summary": "Enable Customers",
- "description": "Enables Customers once, creates the default Customer, and assigns every existing Number in the project to it atomically.\n\nRequires `customers:manage`. Project tokens only access resources in their own project.",
+ "description": "Enables Customers once, creates the default Customer, and assigns every existing Connection in the project to it atomically.\n\nRequires `customers:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
@@ -39808,11 +39646,11 @@
"projects"
],
"summary": "Approve production enrollment",
- "description": "Resumes a production-enrollment operation that requires approval.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Resumes a production-enrollment operation that requires approval.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -39915,11 +39753,11 @@
"projects"
],
"summary": "Cancel production enrollment",
- "description": "Requests cancellation of an active production-enrollment operation. Provisioned resources are compensated before cancellation completes.\n\nRequires `sessions:manage`. Project tokens only access resources in their own project.",
+ "description": "Requests cancellation of an active production-enrollment operation. Provisioned resources are compensated before cancellation completes.\n\nRequires `connections:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -40021,12 +39859,12 @@
"tags": [
"projects"
],
- "summary": "List Numbers that can merge into Hybrid Link",
- "description": "Lists pairs of Numbers in the project that are the same WhatsApp Business number: one connected through Linked Devices and one through the Official API with the WhatsApp Business app (coexistence). Merge an eligible pair with a Pro tier quote on the Number you want to keep and `hybridMerge.absorbNumberId` set to the other Number. Neither side needs to pair or sign up again. Returns `403` with code `feature_unavailable` when the team has no Hybrid Link access. Each Number reports `canBeAbsorbed`; a Number with hosted message storage must be the one you keep.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "List Connections that can merge into Hybrid Link",
+ "description": "Lists pairs of Connections in the project that are the same WhatsApp Business number: one connected through Linked Devices and one through the Official API with the WhatsApp Business app (coexistence). Merge an eligible pair with a Pro tier quote on the Connection you want to keep and `hybridMerge.absorbConnectionId` set to the other Connection. Neither side needs to pair or sign up again. Returns `403` with code `feature_unavailable` when the team has no Hybrid Link access. Each Connection reports `canBeAbsorbed`; a Connection with hosted message storage must be the one you keep.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -41539,7 +41377,7 @@
"webhooks"
],
"summary": "Send a project webhook test",
- "description": "Creates a synthetic project event and a traceable webhook delivery. An optional complete native envelope is accepted only with an exact HMS-enabled project session.\n\nRequires `webhooks:manage`. Project tokens only access resources in their own project.",
+ "description": "Creates a synthetic project event and a traceable webhook delivery. An optional complete native envelope is accepted only with an exact HMS-enabled project connection.\n\nRequires `webhooks:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
@@ -42484,7 +42322,7 @@
"name": "route",
"in": "query",
"required": false,
- "description": "Exact route pattern, for example `/messaging/:session/messages`.",
+ "description": "Exact route pattern, for example `/messaging/:connection/messages`.",
"schema": {
"type": "string",
"minLength": 1,
@@ -43807,8 +43645,8 @@
"type": "string",
"enum": [
"auth_projection_repair",
- "session_lifecycle",
- "auth_session_purge",
+ "connection_lifecycle",
+ "auth_connection_purge",
"label_projection_purge",
"billing_reconciliation",
"auto_top_up",
@@ -44347,8 +44185,8 @@
"type": "string",
"enum": [
"auth_projection_repair",
- "session_lifecycle",
- "auth_session_purge",
+ "connection_lifecycle",
+ "auth_connection_purge",
"label_projection_purge",
"billing_reconciliation",
"auto_top_up",
@@ -44918,7 +44756,7 @@
}
},
{
- "name": "hasNumbers",
+ "name": "hasConnections",
"in": "query",
"required": false,
"schema": {
@@ -45518,14 +45356,14 @@
}
}
},
- "/platform/customers/{customerId}/numbers": {
+ "/platform/customers/{customerId}/connections": {
"get": {
- "operationId": "listCustomerNumbers",
+ "operationId": "listCustomerConnections",
"tags": [
"customers"
],
- "summary": "List Customer Numbers",
- "description": "Lists Numbers assigned to one Customer in the exact project.\n\nRequires `customers:read`. Project tokens only access resources in their own project.",
+ "summary": "List Customer Connections",
+ "description": "Lists Connections assigned to one Customer in the exact project.\n\nRequires `customers:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
@@ -45590,7 +45428,7 @@
"data": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/CustomerNumber"
+ "$ref": "#/components/schemas/CustomerConnection"
}
}
},
@@ -46040,14 +45878,14 @@
}
}
},
- "/platform/customers/{customerId}/numbers/{sessionId}/transfer": {
+ "/platform/customers/{customerId}/connections/{connectionId}/transfer": {
"post": {
- "operationId": "transferCustomerNumber",
+ "operationId": "transferCustomerConnection",
"tags": [
"customers"
],
- "summary": "Transfer a Customer Number",
- "description": "Atomically transfers one eligible Number from the explicitly confirmed source Customer to the destination Customer.\n\nRequires `customers:manage`. Project tokens only access resources in their own project.",
+ "summary": "Transfer a Customer Connection",
+ "description": "Atomically transfers one eligible Connection from the explicitly confirmed source Customer to the destination Customer.\n\nRequires `customers:manage`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
@@ -46071,12 +45909,12 @@
}
},
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "path",
"required": true,
- "description": "Database session UUID or stable session slug.",
+ "description": "Database connection UUID or stable connection slug.",
"schema": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
},
{
@@ -46095,7 +45933,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TransferCustomerNumberRequest"
+ "$ref": "#/components/schemas/TransferCustomerConnectionRequest"
}
}
}
@@ -46131,7 +45969,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/CustomerNumber"
+ "$ref": "#/components/schemas/CustomerConnection"
}
},
"required": [
@@ -46169,11 +46007,11 @@
"members"
],
"summary": "List members",
- "description": "Public Management API. Team keys require `sessions:read`. Project tokens are not accepted.",
+ "description": "Public Management API. Team keys require `connections:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -46664,11 +46502,11 @@
"audit"
],
"summary": "List audit logs",
- "description": "Public Management API. Team keys require `sessions:read`. Project tokens are not accepted.",
+ "description": "Public Management API. Team keys require `connections:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -46728,11 +46566,11 @@
"incidents"
],
"summary": "List security incidents",
- "description": "Public Management API. Team keys require `sessions:read`. Project tokens are not accepted.",
+ "description": "Public Management API. Team keys require `connections:read`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -46792,11 +46630,11 @@
"incidents"
],
"summary": "Acknowledge security incident",
- "description": "Public Management API. Team keys require `sessions:manage`. Project tokens are not accepted.",
+ "description": "Public Management API. Team keys require `connections:manage`. Project tokens are not accepted.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "team",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:manage",
+ "x-required-scope": "connections:manage",
"security": [
{
"ApiKeyAuth": []
@@ -47613,11 +47451,11 @@
"teams"
],
"summary": "Ensure for current user team",
- "description": "**EXCLUDED from the public API** (`console`). First-sign-in bootstrap for the session user.",
+ "description": "**EXCLUDED from the public API** (`console`). First-sign-in bootstrap for the connection user.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
- "x-exclusion-reason": "First-sign-in bootstrap for the session user.",
+ "x-exclusion-reason": "First-sign-in bootstrap for the connection user.",
"security": [
{
"ConsoleSession": []
@@ -47768,11 +47606,11 @@
"profile"
],
"summary": "Get user profile",
- "description": "Read the signed-in account profile, including the saved language. Session-only; never available to team API keys.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
+ "description": "Read the signed-in account profile, including the saved language. Connection-only; never available to team API keys.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
- "x-exclusion-reason": "'Current user' only exists for a session; keys are team-scoped, not user-scoped.",
+ "x-exclusion-reason": "'Current user' only exists for a connection; keys are team-scoped, not user-scoped.",
"security": [
{
"ConsoleSession": []
@@ -47852,7 +47690,7 @@
"profile"
],
"summary": "Update user profile field",
- "description": "Edit the signed-in account profile. Set locale to en or pt-BR; null restores Automatic. Session-only.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
+ "description": "Edit the signed-in account profile. Set locale to en or pt-BR; null restores Automatic. Connection-only.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
@@ -48116,11 +47954,11 @@
"teams"
],
"summary": "List user profile teams",
- "description": "**EXCLUDED from the public API** (`console`). Session user's team switcher.",
+ "description": "**EXCLUDED from the public API** (`console`). Connection user's team switcher.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
- "x-exclusion-reason": "Session user's team switcher.",
+ "x-exclusion-reason": "Connection user's team switcher.",
"security": [
{
"ConsoleSession": []
@@ -48380,11 +48218,11 @@
"auth"
],
"summary": "Get user profile auth methods",
- "description": "**EXCLUDED from the public API** (`console`). Account-security introspection for the session user.",
+ "description": "**EXCLUDED from the public API** (`console`). Account-security introspection for the connection user.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
- "x-exclusion-reason": "Account-security introspection for the session user.",
+ "x-exclusion-reason": "Account-security introspection for the connection user.",
"security": [
{
"ConsoleSession": []
@@ -48788,11 +48626,11 @@
"teams"
],
"summary": "Leave team user profile",
- "description": "**EXCLUDED from the public API** (`console`). Acts on the session user's own membership.",
+ "description": "**EXCLUDED from the public API** (`console`). Acts on the connection user's own membership.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
- "x-exclusion-reason": "Acts on the session user's own membership.",
+ "x-exclusion-reason": "Acts on the connection user's own membership.",
"security": [
{
"ConsoleSession": []
@@ -50432,11 +50270,11 @@
"calls"
],
"summary": "List call records",
- "description": "Lists call detail records, newest first. Filter by project, number, direction, connection, outcome and start time. The other party appears only as `peerRef`, a team-specific pseudonym; phone numbers are never returned. Pass `page.nextCursor` as `cursor` with the same filters to read the next page.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Lists call detail records, newest first. Filter by project, number, direction, method, outcome and start time. The other party appears only as `peerRef`, a team-specific pseudonym; phone numbers are never returned. Pass `page.nextCursor` as `cursor` with the same filters to read the next page.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -50456,14 +50294,14 @@
}
},
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "query",
"required": false,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
- "description": "Session name of one number."
+ "description": "Connection name of one connection."
}
},
{
@@ -50488,7 +50326,7 @@
"linked_device",
"cloud_api"
],
- "description": "How the number connects to WhatsApp."
+ "description": "How the connection connects to WhatsApp."
}
},
{
@@ -50504,7 +50342,7 @@
"failed",
"in_progress"
],
- "description": "How the call went. `answered`: media connected, including answered calls still in progress. `declined`: declined by a participant or the other party, or the line was busy. `missed`: nobody answered before ringing stopped or the caller hung up. `failed`: ended before it connected for any other reason, such as a connection or capacity failure. `in_progress`: still ringing."
+ "description": "How the call went. `answered`: media connected, including answered calls still in progress. `declined`: declined by a participant or the other party, or the line was busy. `missed`: nobody answered before ringing stopped or the caller hung up. `failed`: ended before it connected for any other reason, such as a method or capacity failure. `in_progress`: still ringing."
}
},
{
@@ -50617,11 +50455,11 @@
"calls"
],
"summary": "Get call statistics",
- "description": "Returns call volume, outcomes, answer rate and connected duration for a time range, grouped by day, hour, number or outcome, with an hour-of-week heatmap. Filters match the call records endpoints. Without `since` and `until` the range is the last 7 days. Day and hour groups use the requested `timezone` and include empty buckets.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns call volume, outcomes, answer rate and connected duration for a time range, grouped by day, hour, number or outcome, with an hour-of-week heatmap. Filters match the call records endpoints. Without `since` and `until` the range is the last 7 days. Day and hour groups use the requested `timezone` and include empty buckets.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -50641,14 +50479,14 @@
}
},
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "query",
"required": false,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
- "description": "Session name of one number."
+ "description": "Connection name of one connection."
}
},
{
@@ -50673,7 +50511,7 @@
"linked_device",
"cloud_api"
],
- "description": "How the number connects to WhatsApp."
+ "description": "How the connection connects to WhatsApp."
}
},
{
@@ -50689,7 +50527,7 @@
"failed",
"in_progress"
],
- "description": "How the call went. `answered`: media connected, including answered calls still in progress. `declined`: declined by a participant or the other party, or the line was busy. `missed`: nobody answered before ringing stopped or the caller hung up. `failed`: ended before it connected for any other reason, such as a connection or capacity failure. `in_progress`: still ringing."
+ "description": "How the call went. `answered`: media connected, including answered calls still in progress. `declined`: declined by a participant or the other party, or the line was busy. `missed`: nobody answered before ringing stopped or the caller hung up. `failed`: ended before it connected for any other reason, such as a method or capacity failure. `in_progress`: still ringing."
}
},
{
@@ -50721,11 +50559,11 @@
"enum": [
"day",
"hour",
- "session",
+ "connection",
"outcome"
],
"default": "day",
- "description": "`day` and `hour` return one group per bucket in `timezone`, covering at most 366 and 31 days. `session` returns one group per number, most calls first, up to 500. `outcome` returns one group per outcome."
+ "description": "`day` and `hour` return one group per bucket in `timezone`, covering at most 366 and 31 days. `connection` returns one group per connection, most calls first, up to 500. `outcome` returns one group per outcome."
}
},
{
@@ -50804,11 +50642,11 @@
"calls"
],
"summary": "Get a call record and history",
- "description": "Returns one stored call with its participant and connection lifetimes, bounded event history, media measurements and app-reported diagnostics. Requires sessions:read. Project credentials can read only the call's original owning project, including after a number is deleted. Unknown measurements are null. Webhook deliveries require the separate webhook-deliveries:read endpoints. This read does not retrieve audio, video or event payloads and does not control a live call.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "description": "Returns one stored call with its participant and method lifetimes, bounded event history, media measurements and app-reported diagnostics. Requires connections:read. Project credentials can read only the call's original owning project, including after a connection is deleted. Unknown measurements are null. Webhook deliveries require the separate webhook-deliveries:read endpoints. This read does not retrieve audio, video or event payloads and does not control a live call.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -50903,7 +50741,7 @@
"calls"
],
"summary": "List calls",
- "description": "Lists the team's calls, newest first. Filter by project, session, state, direction, start time, or live calls only. `live=true` returns offered and answered calls; `live=false` returns declined, missed, and ended calls. Pass `nextCursor` as `cursor` to read the next page with the same filters.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
+ "description": "Lists the team's calls, newest first. Filter by project, connection, state, direction, start time, or live calls only. `live=true` returns offered and answered calls; `live=false` returns declined, missed, and ended calls. Pass `nextCursor` as `cursor` to read the next page with the same filters.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
@@ -50924,14 +50762,14 @@
}
},
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "query",
"required": false,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
- "description": "Session name."
+ "description": "Connection name."
}
},
{
@@ -51070,7 +50908,7 @@
"calls"
],
"summary": "Get call detail",
- "description": "Returns one call with its participants, connections, media measurements, webhook delivery outcomes, and correlation identifiers. Measurements that were not reported are null. Webhook delivery records are kept for 30 days.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
+ "description": "Returns one call with its participants, methods, media measurements, webhook delivery outcomes, and correlation identifiers. Measurements that were not reported are null. Webhook delivery records are kept for 30 days.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
@@ -51264,12 +51102,12 @@
"tags": [
"calls"
],
- "summary": "Remove a call connection",
- "description": "Closes one client connection of a live call. The call continues for everyone else. Returns 409 when the call is not live or the connection now belongs to another participant. Every attempt is recorded in the audit log.\n\nRequires a verified dashboard bearer and current team authorization. The signed-in member must be a team owner or admin. Team keys and project tokens are not accepted.",
+ "summary": "Remove a call method",
+ "description": "Closes one client method of a live call. The call continues for everyone else. Returns 409 when the call is not live or the method now belongs to another participant. Every attempt is recorded in the audit log.\n\nRequires a verified dashboard bearer and current team authorization. The signed-in member must be a team owner or admin. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
- "x-exclusion-reason": "Console call control; requires a live team owner or admin. Server integrations close their own connections with POST /messaging/voip/calls/{callId}/leave.",
+ "x-exclusion-reason": "Console call control; requires a live team owner or admin. Server integrations close their own media connections with POST /messaging/voip/calls/{callId}/leave.",
"x-required-team-role": "owner_or_admin",
"security": [
{
@@ -51293,7 +51131,7 @@
"name": "connectionId",
"in": "path",
"required": true,
- "description": "Client-chosen connection identifier.",
+ "description": "Client-chosen media connection identifier.",
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,64}$"
@@ -51575,7 +51413,7 @@
"enum": [
"api",
"webhooks",
- "sessions"
+ "connections"
]
},
"kind": {
@@ -51587,11 +51425,11 @@
"type": "string",
"enum": [
"requestId",
- "sessionId",
+ "connectionId",
"eventId",
"webhookId",
"customerId",
- "numberId",
+ "connectionId",
"conversationId"
]
},
@@ -51613,7 +51451,7 @@
"id",
"name",
"dataset",
- "sessionId",
+ "connectionId",
"windowHours",
"encoding",
"url",
@@ -51648,7 +51486,7 @@
"ndjson"
]
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid",
"nullable": true
@@ -51796,7 +51634,7 @@
"enum": [
"api",
"webhooks",
- "sessions"
+ "connections"
]
},
"kind": {
@@ -51808,11 +51646,11 @@
"type": "string",
"enum": [
"requestId",
- "sessionId",
+ "connectionId",
"eventId",
"webhookId",
"customerId",
- "numberId",
+ "connectionId",
"conversationId"
]
},
@@ -51975,7 +51813,7 @@
"ndjson"
]
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid",
"nullable": true
@@ -52277,7 +52115,7 @@
"all",
"api",
"webhooks",
- "sessions",
+ "connections",
"errors",
"audit"
],
@@ -52517,12 +52355,12 @@
"tags": [
"Analytics"
],
- "summary": "Get WhatsApp number analytics",
- "description": "Aggregated number activity and operational vitals. Returns disabled with null summary and empty data until a team owner or admin enables Analytics. Conversation rates use completed 24-hour direct-chat cohorts, booked in the period when they mature; missing or dropped cohort coverage returns null rates. Read means an observed read receipt, not a verified app open. No contact identifiers or message content. Linked Devices telemetry only; unsupported or unobserved numbers carry measured=false. Bucket timestamps use UTC. Activity series use hourly buckets for ranges up to 48 hours and daily buckets for longer ranges. Call series use daily buckets. Message metadata compares direct sends and completed conversations by type, coarse text/caption length, source, calling code and observed device count. Device observations are bounded samples. Calling-code shares describe conversations, not distinct people or location. Presence signals require existing subscriptions. Primary phone activity spans end at their last observed signal and close after 15 minutes without evidence. Quiet gaps end at the next observed signal. Duration sums and averages count completed intervals and exclude open or restart-censored intervals; they do not measure phone online/offline or power state. Metadata collection uses the current team opt-in; disable erases these aggregates and stale queued metadata is rejected. Calls aggregate retained records by their immutable original number/project ownership, including supported Official API calls; message measured/coverage fields do not apply to calls. Call series groups starts by UTC day. Answer rate excludes still-ringing calls; timing fields have explicit observation counts. Missed-call follow-up observes an answered outgoing call to the same pseudonymous contact within 24h, including after the requested end; only completed windows with a known contact form the denominator. It does not prove callback intent. Quality uses reported measurements, latest cumulative app reports per connection and per-call averages. Breakdown counts can overlap. Disabling hides this call view without deleting operational call history. Device analytics estimates sending client families from message ID prefixes, not verified hardware. Customer/account distributions count observed live direct messages, not unique people or installed devices; unknown is included. Older retained buckets lack device coverage and return null shares. Each number exposes at most 25 of its own device indexes, coarse reported class and last observed sending activity. A list change makes inventory membership/count unknown until another full list. Inventory is null in the combined summary. No recipient device identity or raw message ID is retained by this analytics block. Joint conversation breakdown rows retain first outgoing message type, length band, send source, inferred calling code and observed customer device-count class together with UTC completion bucket. Combine rows matching all selected categories to drill into countries and message attributes without inferring intersections from independent marginal totals. Calling codes do not establish current location and shared codes do not identify a unique country. Counts describe completed 24-hour conversation cohorts, not distinct customers. Rates and averages are null when coverage is missing, dropped or truncated. At most 4096 number/time/category groups are returned in one scope, prioritizing largest groups and marking truncation; raw reply latency sums support weighted aggregation. Connection/call vitals and live message platform distributions are separate measurements, not recipient-country filtered cohorts. Recipient country and recipient linked-device-count fields refine joint conversation metadata. Recipient activity remains hourly even for long date ranges, supporting incoming-message timing in an explicit time zone. Delivery signals do not prove reading; read signals are distinct. Presence subscriptions are best-effort around permitted direct sends, reuse a live bounded local lease, preserve observation-off policies and never poll every contact. Missing presence is Unknown, not offline.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "Get WhatsApp connection analytics",
+ "description": "Aggregated connection activity and operational vitals. Returns disabled with null summary and empty data until a team owner or admin enables Analytics. Conversation rates use completed 24-hour direct-chat cohorts, booked in the period when they mature; missing or dropped cohort coverage returns null rates. Read means an observed read receipt, not a verified app open. No contact identifiers or message content. Linked Devices telemetry only; unsupported or unobserved connections carry measured=false. Bucket timestamps use UTC. Activity series use hourly buckets for ranges up to 48 hours and daily buckets for longer ranges. Call series use daily buckets. Message metadata compares direct sends and completed conversations by type, coarse text/caption length, source, calling code and observed device count. Device observations are bounded samples. Calling-code shares describe conversations, not distinct people or location. Presence signals require existing subscriptions. Primary phone activity spans end at their last observed signal and close after 15 minutes without evidence. Quiet gaps end at the next observed signal. Duration sums and averages count completed intervals and exclude open or restart-censored intervals; they do not measure phone online/offline or power state. Metadata collection uses the current team opt-in; disable erases these aggregates and stale queued metadata is rejected. Calls aggregate retained records by their immutable original connection/project ownership, including supported Official API calls; message measured/coverage fields do not apply to calls. Call series groups starts by UTC day. Answer rate excludes still-ringing calls; timing fields have explicit observation counts. Missed-call follow-up observes an answered outgoing call to the same pseudonymous contact within 24h, including after the requested end; only completed windows with a known contact form the denominator. It does not prove callback intent. Quality uses reported measurements, latest cumulative app reports per connection and per-call averages. Breakdown counts can overlap. Disabling hides this call view without deleting operational call history. Device analytics estimates sending client families from message ID prefixes, not verified hardware. Customer/account distributions count observed live direct messages, not unique people or installed devices; unknown is included. Older retained buckets lack device coverage and return null shares. Each number exposes at most 25 of its own device indexes, coarse reported class and last observed sending activity. A list change makes inventory membership/count unknown until another full list. Inventory is null in the combined summary. No recipient device identity or raw message ID is retained by this analytics block. Joint conversation breakdown rows retain first outgoing message type, length band, send source, inferred calling code and observed customer device-count class together with UTC completion bucket. Combine rows matching all selected categories to drill into countries and message attributes without inferring intersections from independent marginal totals. Calling codes do not establish current location and shared codes do not identify a unique country. Counts describe completed 24-hour conversation cohorts, not distinct customers. Rates and averages are null when coverage is missing, dropped or truncated. At most 4096 connection/time/category groups are returned in one scope, prioritizing largest groups and marking truncation; raw reply latency sums support weighted aggregation. Connection/call vitals and live message platform distributions are separate measurements, not recipient-country filtered cohorts. Recipient country and recipient linked-device-count fields refine joint conversation metadata. Recipient activity remains hourly even for long date ranges, supporting incoming-message timing in an explicit time zone. Delivery signals do not prove reading; read signals are distinct. Presence subscriptions are best-effort around permitted direct sends, reuse a live bounded local lease, preserve observation-off policies and never poll every contact. Missing presence is Unknown, not offline.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -52542,13 +52380,13 @@
}
},
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
- "description": "Number record UUID."
+ "description": "Connection record UUID."
}
},
{
@@ -52637,12 +52475,12 @@
"tags": [
"Analytics"
],
- "summary": "Get WhatsApp number analytics",
- "description": "Aggregated number activity and operational vitals. Returns disabled with null summary and empty data until a team owner or admin enables Analytics. Conversation rates use completed 24-hour direct-chat cohorts, booked in the period when they mature; missing or dropped cohort coverage returns null rates. Read means an observed read receipt, not a verified app open. No contact identifiers or message content. Linked Devices telemetry only; unsupported or unobserved numbers carry measured=false. Bucket timestamps use UTC. Activity series use hourly buckets for ranges up to 48 hours and daily buckets for longer ranges. Call series use daily buckets. Message metadata compares direct sends and completed conversations by type, coarse text/caption length, source, calling code and observed device count. Device observations are bounded samples. Calling-code shares describe conversations, not distinct people or location. Presence signals require existing subscriptions. Primary phone activity spans end at their last observed signal and close after 15 minutes without evidence. Quiet gaps end at the next observed signal. Duration sums and averages count completed intervals and exclude open or restart-censored intervals; they do not measure phone online/offline or power state. Metadata collection uses the current team opt-in; disable erases these aggregates and stale queued metadata is rejected. Calls aggregate retained records by their immutable original number/project ownership, including supported Official API calls; message measured/coverage fields do not apply to calls. Call series groups starts by UTC day. Answer rate excludes still-ringing calls; timing fields have explicit observation counts. Missed-call follow-up observes an answered outgoing call to the same pseudonymous contact within 24h, including after the requested end; only completed windows with a known contact form the denominator. It does not prove callback intent. Quality uses reported measurements, latest cumulative app reports per connection and per-call averages. Breakdown counts can overlap. Disabling hides this call view without deleting operational call history. Device analytics estimates sending client families from message ID prefixes, not verified hardware. Customer/account distributions count observed live direct messages, not unique people or installed devices; unknown is included. Older retained buckets lack device coverage and return null shares. Each number exposes at most 25 of its own device indexes, coarse reported class and last observed sending activity. A list change makes inventory membership/count unknown until another full list. Inventory is null in the combined summary. No recipient device identity or raw message ID is retained by this analytics block. Joint conversation breakdown rows retain first outgoing message type, length band, send source, inferred calling code and observed customer device-count class together with UTC completion bucket. Combine rows matching all selected categories to drill into countries and message attributes without inferring intersections from independent marginal totals. Calling codes do not establish current location and shared codes do not identify a unique country. Counts describe completed 24-hour conversation cohorts, not distinct customers. Rates and averages are null when coverage is missing, dropped or truncated. At most 4096 number/time/category groups are returned in one scope, prioritizing largest groups and marking truncation; raw reply latency sums support weighted aggregation. Connection/call vitals and live message platform distributions are separate measurements, not recipient-country filtered cohorts. Recipient country and recipient linked-device-count fields refine joint conversation metadata. Recipient activity remains hourly even for long date ranges, supporting incoming-message timing in an explicit time zone. Delivery signals do not prove reading; read signals are distinct. Presence subscriptions are best-effort around permitted direct sends, reuse a live bounded local lease, preserve observation-off policies and never poll every contact. Missing presence is Unknown, not offline.\n\nRequires `sessions:read`. Project tokens only access resources in their own project.",
+ "summary": "Get WhatsApp connection analytics",
+ "description": "Aggregated connection activity and operational vitals. Returns disabled with null summary and empty data until a team owner or admin enables Analytics. Conversation rates use completed 24-hour direct-chat cohorts, booked in the period when they mature; missing or dropped cohort coverage returns null rates. Read means an observed read receipt, not a verified app open. No contact identifiers or message content. Linked Devices telemetry only; unsupported or unobserved connections carry measured=false. Bucket timestamps use UTC. Activity series use hourly buckets for ranges up to 48 hours and daily buckets for longer ranges. Call series use daily buckets. Message metadata compares direct sends and completed conversations by type, coarse text/caption length, source, calling code and observed device count. Device observations are bounded samples. Calling-code shares describe conversations, not distinct people or location. Presence signals require existing subscriptions. Primary phone activity spans end at their last observed signal and close after 15 minutes without evidence. Quiet gaps end at the next observed signal. Duration sums and averages count completed intervals and exclude open or restart-censored intervals; they do not measure phone online/offline or power state. Metadata collection uses the current team opt-in; disable erases these aggregates and stale queued metadata is rejected. Calls aggregate retained records by their immutable original connection/project ownership, including supported Official API calls; message measured/coverage fields do not apply to calls. Call series groups starts by UTC day. Answer rate excludes still-ringing calls; timing fields have explicit observation counts. Missed-call follow-up observes an answered outgoing call to the same pseudonymous contact within 24h, including after the requested end; only completed windows with a known contact form the denominator. It does not prove callback intent. Quality uses reported measurements, latest cumulative app reports per connection and per-call averages. Breakdown counts can overlap. Disabling hides this call view without deleting operational call history. Device analytics estimates sending client families from message ID prefixes, not verified hardware. Customer/account distributions count observed live direct messages, not unique people or installed devices; unknown is included. Older retained buckets lack device coverage and return null shares. Each number exposes at most 25 of its own device indexes, coarse reported class and last observed sending activity. A list change makes inventory membership/count unknown until another full list. Inventory is null in the combined summary. No recipient device identity or raw message ID is retained by this analytics block. Joint conversation breakdown rows retain first outgoing message type, length band, send source, inferred calling code and observed customer device-count class together with UTC completion bucket. Combine rows matching all selected categories to drill into countries and message attributes without inferring intersections from independent marginal totals. Calling codes do not establish current location and shared codes do not identify a unique country. Counts describe completed 24-hour conversation cohorts, not distinct customers. Rates and averages are null when coverage is missing, dropped or truncated. At most 4096 connection/time/category groups are returned in one scope, prioritizing largest groups and marking truncation; raw reply latency sums support weighted aggregation. Connection/call vitals and live message platform distributions are separate measurements, not recipient-country filtered cohorts. Recipient country and recipient linked-device-count fields refine joint conversation metadata. Recipient activity remains hourly even for long date ranges, supporting incoming-message timing in an explicit time zone. Delivery signals do not prove reading; read signals are distinct. Presence subscriptions are best-effort around permitted direct sends, reuse a live bounded local lease, preserve observation-off policies and never poll every contact. Missing presence is Unknown, not offline.\n\nRequires `connections:read`. Project tokens only access resources in their own project.",
"x-audience": "public",
"x-polymorfa-resource-boundary": "project",
"x-excluded-from-public": false,
- "x-required-scope": "sessions:read",
+ "x-required-scope": "connections:read",
"security": [
{
"ApiKeyAuth": []
@@ -52662,13 +52500,13 @@
}
},
{
- "name": "sessionId",
+ "name": "connectionId",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uuid",
- "description": "Number record UUID."
+ "description": "Connection record UUID."
}
},
{
@@ -52751,14 +52589,14 @@
}
}
},
- "/console/insights/number-options": {
+ "/console/insights/connection-options": {
"get": {
- "operationId": "listConsoleNumberOptions",
+ "operationId": "listConsoleConnectionOptions",
"tags": [
"insights"
],
- "summary": "Search Console number options",
- "description": "Private dashboard-only, team-scoped production number labels for selectors. Optional projectId must name an active, nondeleting project. Search is a literal case-insensitive substring of display name, current phone, session name or immutable number UUID, evaluated before pagination. Numbers in testing, deletion or deleted status and inactive/deleting projects are excluded; expired number history remains selectable. Results use immutable UUID ascending keyset order, default 25 and maximum 100; a cursor is bound to team, project and normalized search. It is navigation only and never grants authority. Response includes only number ID, project ID and a display label, with no configuration, owner, customer or provider fields. Public session listing is unchanged.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
+ "summary": "Search Console connection options",
+ "description": "Private dashboard-only, team-scoped production connection labels for selectors. Optional projectId must name an active, nondeleting project. Search is a literal case-insensitive substring of display name, current phone, connection name or immutable connection UUID, evaluated before pagination. Connections in testing, deletion or deleted status and inactive/deleting projects are excluded; expired connection history remains selectable. Results use immutable UUID ascending keyset order, default 25 and maximum 100; a cursor is bound to team, project and normalized search. It is navigation only and never grants authority. Response includes only connection ID, project ID and a display label, with no configuration, owner, customer or provider fields. Public connection listing is unchanged.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
@@ -52841,7 +52679,7 @@
"additionalProperties": false,
"properties": {
"data": {
- "$ref": "#/components/schemas/ConsoleNumberOptionsPage"
+ "$ref": "#/components/schemas/ConsoleConnectionOptionsPage"
}
},
"required": [
@@ -52873,7 +52711,7 @@
"insights"
],
"summary": "Read Console usage",
- "description": "Private Console usage for the authenticated team or one active project. `start` and `end` are inclusive Unix-millisecond boundaries, with a maximum span of 366 days. A missing end defaults to now; a missing start defaults to 29 days before the end. Daily buckets use UTC dates and include only dates with observed audit or credit-ledger activity. API request counts include API and MCP operations; peak request rate is the busiest one-minute bucket, not a sum of daily peaks. Number and connection metrics are live snapshots, and message-rate usage remains null because its peak is not measured. The project breakdown includes active projects and omits unattributed team activity, which remains in team totals.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
+ "description": "Private Console usage for the authenticated team or one active project. `start` and `end` are inclusive Unix-millisecond boundaries, with a maximum span of 366 days. A missing end defaults to now; a missing start defaults to 29 days before the end. Daily buckets use UTC dates and include only dates with observed audit or credit-ledger activity. API request counts include API and MCP operations; peak request rate is the busiest one-minute bucket, not a sum of daily peaks. Connection and method metrics are live snapshots, and message-rate usage remains null because its peak is not measured. The project breakdown includes active projects and omits unattributed team activity, which remains in team totals.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
@@ -52895,10 +52733,10 @@
}
},
{
- "name": "numberId",
+ "name": "connectionId",
"in": "query",
"required": false,
- "description": "Immutable production number UUID. Requires projectId; missing, deleted, testing or mismatched numbers return 404. Filters only immutable attributed records; request logs and serverless receipts have no number attribution.",
+ "description": "Immutable production connection UUID. Requires projectId; missing, deleted, testing or mismatched connections return 404. Filters only immutable attributed records; request logs and serverless receipts have no connection attribution.",
"schema": {
"type": "string",
"format": "uuid"
@@ -52988,7 +52826,7 @@
"insights"
],
"summary": "Analytics insight",
- "description": "Team/project-scoped recorded API, event, webhook and number analytics. Event and webhook counts include unexpired metadata only; current snapshots are independent of dates. No message bodies or identity fields are returned.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
+ "description": "Team/project-scoped recorded API, event, webhook and connection analytics. Event and webhook counts include unexpired metadata only; current snapshots are independent of dates. No message bodies or identity fields are returned.\n\nRequires a verified dashboard bearer and current team authorization. Team keys and project tokens are not accepted.",
"x-audience": "console",
"x-polymorfa-resource-boundary": "human_only",
"x-excluded-from-public": true,
@@ -53775,7 +53613,7 @@
},
"capture": {
"type": "object",
- "description": "Present for features that control data capture: whether capture already follows the change for every affected Number (`applied`) or is still being brought in line (`pending`).",
+ "description": "Present for features that control data capture: whether capture already follows the change for every affected Connection (`applied`) or is still being brought in line (`pending`).",
"additionalProperties": false,
"required": [
"state"
@@ -54688,7 +54526,7 @@
]
}
},
- "numbers": {
+ "connections": {
"type": "array",
"items": {
"type": "object",
@@ -54724,7 +54562,7 @@
"revision",
"projects",
"customers",
- "numbers"
+ "connections"
]
},
"BillingLimit": {
@@ -54736,7 +54574,7 @@
"enum": [
"project",
"customer",
- "number"
+ "connection"
]
},
"resourceId": {
@@ -54911,7 +54749,7 @@
"type": "object",
"additionalProperties": false,
"required": [
- "session",
+ "connection",
"phone",
"appId",
"wabaId",
@@ -54922,21 +54760,6 @@
"diagnostic"
],
"properties": {
- "session": {
- "type": "string"
- },
- "phone": {
- "type": "string",
- "nullable": true
- },
- "appId": {
- "type": "string",
- "nullable": true
- },
- "wabaId": {
- "type": "string",
- "nullable": true
- },
"connection": {
"type": "object",
"additionalProperties": false,
@@ -54955,10 +54778,22 @@
},
"sendingPaused": {
"type": "boolean",
- "description": "Whether Hybrid sending is paused for this Number. Always false for Numbers without a Hybrid Link."
+ "description": "Whether Hybrid sending is paused for this Connection. Always false for Connections without a Hybrid Link."
}
}
},
+ "phone": {
+ "type": "string",
+ "nullable": true
+ },
+ "appId": {
+ "type": "string",
+ "nullable": true
+ },
+ "wabaId": {
+ "type": "string",
+ "nullable": true
+ },
"credentials": {
"type": "object",
"additionalProperties": false,
@@ -55103,7 +54938,7 @@
"nextAction": {
"type": "string",
"enum": [
- "reconnect_number",
+ "reconnect_connection",
"reauthorize",
"complete_registration",
"check_webhook_subscription",
@@ -55228,7 +55063,7 @@
"team",
"project",
"customer",
- "number"
+ "connection"
]
},
"scopeId": {
@@ -55274,7 +55109,7 @@
"properties": {
"effective": {
"type": "object",
- "description": "Present for the `number` scope.",
+ "description": "Present for the `connection` scope.",
"required": [
"region",
"contacts",
@@ -55302,7 +55137,7 @@
"source": {
"type": "string",
"enum": [
- "number",
+ "connection",
"customer",
"project",
"team",
@@ -55329,7 +55164,7 @@
"source": {
"type": "string",
"enum": [
- "number",
+ "connection",
"customer",
"project",
"team",
@@ -55356,7 +55191,7 @@
"source": {
"type": "string",
"enum": [
- "number",
+ "connection",
"customer",
"project",
"team",
@@ -55383,7 +55218,7 @@
"source": {
"type": "string",
"enum": [
- "number",
+ "connection",
"customer",
"project",
"team",
@@ -55406,7 +55241,7 @@
"source": {
"type": "string",
"enum": [
- "number",
+ "connection",
"customer",
"project",
"team",
@@ -55429,7 +55264,7 @@
"source": {
"type": "string",
"enum": [
- "number",
+ "connection",
"customer",
"project",
"team",
@@ -55452,7 +55287,7 @@
"source": {
"type": "string",
"enum": [
- "number",
+ "connection",
"customer",
"project",
"team",
@@ -55477,7 +55312,7 @@
"source": {
"type": "string",
"enum": [
- "number",
+ "connection",
"customer",
"project",
"team",
@@ -55502,7 +55337,7 @@
"source": {
"type": "string",
"enum": [
- "number",
+ "connection",
"customer",
"project",
"team",
@@ -55617,7 +55452,7 @@
"team",
"project",
"customer",
- "number"
+ "connection"
]
},
"scopeId": {
@@ -55673,7 +55508,7 @@
"applied",
"pending"
],
- "description": "`pending` while some affected Numbers are still being brought in line with the saved settings."
+ "description": "`pending` while some affected Connections are still being brought in line with the saved settings."
}
}
}
@@ -55786,7 +55621,7 @@
"type": "integer",
"minimum": 0
},
- "sessionDays": {
+ "connectionDays": {
"type": "integer",
"minimum": 0
},
@@ -55794,7 +55629,7 @@
"type": "number",
"minimum": 0
},
- "newNumbers": {
+ "newConnections": {
"type": "integer",
"minimum": 0
}
@@ -55807,9 +55642,9 @@
"avgLatencyMs",
"durationSumMs",
"p95LatencyMs",
- "sessionDays",
+ "connectionDays",
"credits",
- "newNumbers"
+ "newConnections"
]
}
},
@@ -55826,7 +55661,7 @@
"minimum": 0,
"maximum": 1
},
- "sessionDays": {
+ "connectionDays": {
"type": "integer",
"minimum": 0
},
@@ -55834,7 +55669,7 @@
"type": "number",
"minimum": 0
},
- "newNumbers": {
+ "newConnections": {
"type": "integer",
"minimum": 0
}
@@ -55842,9 +55677,9 @@
"required": [
"apiRequests",
"failureRate",
- "sessionDays",
+ "connectionDays",
"credits",
- "newNumbers"
+ "newConnections"
]
},
"byProject": {
@@ -55866,7 +55701,7 @@
"minimum": 0,
"maximum": 1
},
- "sessionDays": {
+ "connectionDays": {
"type": "integer",
"minimum": 0
},
@@ -55874,7 +55709,7 @@
"type": "number",
"minimum": 0
},
- "newNumbers": {
+ "newConnections": {
"type": "integer",
"minimum": 0
}
@@ -55883,9 +55718,9 @@
"projectId",
"apiRequests",
"failureRate",
- "sessionDays",
+ "connectionDays",
"credits",
- "newNumbers"
+ "newConnections"
]
}
},
@@ -55896,7 +55731,7 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "totalNumbers": {
+ "totalConnections": {
"type": "integer",
"minimum": 0
},
@@ -55919,7 +55754,7 @@
}
},
"required": [
- "totalNumbers",
+ "totalConnections",
"businessAccounts",
"platformCoverage",
"platforms"
@@ -56338,7 +56173,7 @@
"count"
]
},
- "description": "Current number snapshot, independent of the date range."
+ "description": "Current connection snapshot, independent of the date range."
}
},
"required": [
@@ -56568,15 +56403,15 @@
"droppedReceiptJoins"
]
},
- "totalNumbers": {
+ "totalConnections": {
"type": "integer",
"minimum": 0
},
- "measuredNumbers": {
+ "measuredConnections": {
"type": "integer",
"minimum": 0
},
- "connectedNumbers": {
+ "connectedConnections": {
"type": "integer",
"minimum": 0
},
@@ -57524,7 +57359,7 @@
"properties": {
"listObserved": {
"type": "boolean",
- "description": "True after a full device list for this number was observed."
+ "description": "True after a full device list for this connection was observed."
},
"listCurrent": {
"type": "boolean",
@@ -57642,7 +57477,7 @@
"accountPlatforms",
"inventory"
],
- "description": "Observed message client-family distributions and a bounded inventory of this number's own devices. The combined summary has null inventory."
+ "description": "Observed message client-family distributions and a bounded inventory of this connection's own devices. The combined summary has null inventory."
},
"conversationBreakdown": {
"type": "object",
@@ -57666,7 +57501,7 @@
},
"truncated": {
"type": "boolean",
- "description": "True when the requested scope exceeded 4096 number/time/category groups. The largest groups are retained; rates and averages are null."
+ "description": "True when the requested scope exceeded 4096 connection/time/category groups. The largest groups are retained; rates and averages are null."
},
"buckets": {
"type": "array",
@@ -57680,7 +57515,7 @@
},
"complete": {
"type": "boolean",
- "description": "True when this UTC time bucket has joint category coverage and no conversations or records were dropped. A summary bucket also requires every scoped number to have a bucket."
+ "description": "True when this UTC time bucket has joint category coverage and no conversations or records were dropped. A summary bucket also requires every scoped connection to have a bucket."
}
},
"required": [
@@ -57740,7 +57575,7 @@
"recipientCountry": {
"type": "string",
"pattern": "^(unknown|[A-Z]{2})$",
- "description": "Numbering country inferred from a full phone number or valid BSUID prefix; Unknown for missing historical metadata. Not current location."
+ "description": "Calling country inferred from a full phone number or valid BSUID prefix; Unknown for missing historical metadata. Not current location."
},
"recipientDeviceCount": {
"type": "string",
@@ -57957,7 +57792,7 @@
"truncated",
"rows"
],
- "description": "Hourly aggregate recipient observations, grouped jointly by numbering country, observed linked-device count and sender-device class. Incoming messages and matched delivery/read receipts are deduplicated by native message and device in bounded memory. Presence is user-level and uses Unknown device source. Quiet gaps of at least 15 minutes are completed gaps between observed signals on the same device, never verified offline periods. No recipient identity, native message ID or recipient device index is retained. Coverage is explicit; older retained buckets are unmeasured. Message telemetry remains Linked Devices only; Official API message activity is not measured."
+ "description": "Hourly aggregate recipient observations, grouped jointly by connectioning country, observed linked-device count and sender-device class. Incoming messages and matched delivery/read receipts are deduplicated by native message and device in bounded memory. Presence is user-level and uses Unknown device source. Quiet gaps of at least 15 minutes are completed gaps between observed signals on the same device, never verified offline periods. No recipient identity, native message ID or recipient device index is retained. Coverage is explicit; older retained buckets are unmeasured. Message telemetry remains Linked Devices only; Official API message activity is not measured."
}
},
"required": [
@@ -57977,9 +57812,9 @@
"streamErrors",
"keepaliveTimeouts",
"engagement",
- "totalNumbers",
- "measuredNumbers",
- "connectedNumbers",
+ "totalConnections",
+ "measuredConnections",
+ "connectedConnections",
"messageAnalysis",
"customerActivity",
"accountActivity",
@@ -57991,13 +57826,13 @@
}
]
},
- "numbers": {
+ "connections": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -59105,7 +58940,7 @@
"properties": {
"listObserved": {
"type": "boolean",
- "description": "True after a full device list for this number was observed."
+ "description": "True after a full device list for this connection was observed."
},
"listCurrent": {
"type": "boolean",
@@ -59223,7 +59058,7 @@
"accountPlatforms",
"inventory"
],
- "description": "Observed message client-family distributions and a bounded inventory of this number's own devices. The combined summary has null inventory."
+ "description": "Observed message client-family distributions and a bounded inventory of this connection's own devices. The combined summary has null inventory."
},
"conversationBreakdown": {
"type": "object",
@@ -59247,7 +59082,7 @@
},
"truncated": {
"type": "boolean",
- "description": "True when the requested scope exceeded 4096 number/time/category groups. The largest groups are retained; rates and averages are null."
+ "description": "True when the requested scope exceeded 4096 connection/time/category groups. The largest groups are retained; rates and averages are null."
},
"buckets": {
"type": "array",
@@ -59261,7 +59096,7 @@
},
"complete": {
"type": "boolean",
- "description": "True when this UTC time bucket has joint category coverage and no conversations or records were dropped. A summary bucket also requires every scoped number to have a bucket."
+ "description": "True when this UTC time bucket has joint category coverage and no conversations or records were dropped. A summary bucket also requires every scoped connection to have a bucket."
}
},
"required": [
@@ -59321,7 +59156,7 @@
"recipientCountry": {
"type": "string",
"pattern": "^(unknown|[A-Z]{2})$",
- "description": "Numbering country inferred from a full phone number or valid BSUID prefix; Unknown for missing historical metadata. Not current location."
+ "description": "Calling country inferred from a full phone number or valid BSUID prefix; Unknown for missing historical metadata. Not current location."
},
"recipientDeviceCount": {
"type": "string",
@@ -59538,11 +59373,11 @@
"truncated",
"rows"
],
- "description": "Hourly aggregate recipient observations, grouped jointly by numbering country, observed linked-device count and sender-device class. Incoming messages and matched delivery/read receipts are deduplicated by native message and device in bounded memory. Presence is user-level and uses Unknown device source. Quiet gaps of at least 15 minutes are completed gaps between observed signals on the same device, never verified offline periods. No recipient identity, native message ID or recipient device index is retained. Coverage is explicit; older retained buckets are unmeasured. Message telemetry remains Linked Devices only; Official API message activity is not measured."
+ "description": "Hourly aggregate recipient observations, grouped jointly by connectioning country, observed linked-device count and sender-device class. Incoming messages and matched delivery/read receipts are deduplicated by native message and device in bounded memory. Presence is user-level and uses Unknown device source. Quiet gaps of at least 15 minutes are completed gaps between observed signals on the same device, never verified offline periods. No recipient identity, native message ID or recipient device index is retained. Coverage is explicit; older retained buckets are unmeasured. Message telemetry remains Linked Devices only; Official API message activity is not measured."
}
},
"required": [
- "sessionId",
+ "connectionId",
"projectId",
"name",
"backend",
@@ -59613,7 +59448,7 @@
"type": "integer",
"minimum": 0
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -59667,7 +59502,7 @@
"averageBusinessResponseMs",
"onlineMs",
"disconnects",
- "sessionId",
+ "connectionId",
"customerOnlineSignals",
"customerTypingSignals",
"primaryPhoneMessages",
@@ -59762,7 +59597,7 @@
"type": "integer",
"minimum": 0
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -59789,7 +59624,7 @@
"p95PickupMs",
"shortAnswered",
"video",
- "sessionId",
+ "connectionId",
"ts"
]
}
@@ -59800,7 +59635,7 @@
"period",
"requestVitals",
"summary",
- "numbers",
+ "connections",
"series",
"callSeries"
]
@@ -59816,7 +59651,7 @@
"data"
]
},
- "ConsoleNumberOptionsPage": {
+ "ConsoleConnectionOptionsPage": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -59843,7 +59678,7 @@
"type": "array",
"maxItems": 100,
"items": {
- "$ref": "#/components/schemas/ConsoleNumberOption"
+ "$ref": "#/components/schemas/ConsoleConnectionOption"
}
},
"nextCursor": {
@@ -59858,14 +59693,14 @@
"nextCursor"
]
},
- "ConsoleNumberOption": {
+ "ConsoleConnectionOption": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid",
- "description": "Immutable number UUID, never its reusable session name."
+ "description": "Immutable connection UUID, never its reusable connection name."
},
"projectId": {
"type": "string",
@@ -59874,7 +59709,7 @@
"name": {
"type": "string",
"minLength": 1,
- "description": "Trimmed number name, else current phone, else session name (UUID fallback when all labels are blank)."
+ "description": "Trimmed display name, else current phone, else connection name (UUID fallback when all labels are blank)."
}
},
"required": [
@@ -59898,7 +59733,7 @@
"$ref": "#/components/schemas/ConsoleMonthlyOutgoingCalls"
}
],
- "description": "Known-tier selected-number included outgoing allowance and completed-call usage for the current UTC month. Null for team/project reads or an unknown number tier. Independent of the requested chart period and of staff gate overrides; never a hard admission cap or charged-credit quote."
+ "description": "Known-tier selected-connection included outgoing allowance and completed-call usage for the current UTC month. Null for team/project reads or an unknown connection tier. Independent of the requested chart period and of staff gate overrides; never a hard admission cap or charged-credit quote."
},
"period": {
"type": "object",
@@ -59932,15 +59767,15 @@
"type": "integer",
"minimum": 0,
"nullable": true,
- "description": "Null for a number read: audit logs have no immutable number attribution."
+ "description": "Null for a connection read: audit logs have no immutable connection attribution."
},
- "sessionDayCredits": {
+ "connectionDayCredits": {
"type": "number"
}
},
"required": [
"failedRequests",
- "sessionDayCredits"
+ "connectionDayCredits"
]
},
"daily": {
@@ -59954,14 +59789,14 @@
"consumption": {
"type": "array",
"maxItems": 18,
- "description": "Credit-ledger number windows, registered meters and priced overage families. Outbound calls count completed call.duration records, matching the monthly gate. Serverless counts surviving admitted project invocation receipts, including failed or uncertain outcomes; receipts have no per-number allowance attribution. WhatsApp data covers media and enabled HMS but has no approved complete GB-month aggregate source. Pricing and measurement availability never establish a charge; credits come only from the number-window debit ledger.",
+ "description": "Credit-ledger connection windows, registered meters and priced overage families. Outbound calls count completed call.duration records, matching the monthly gate. Serverless counts surviving admitted project invocation receipts, including failed or uncertain outcomes; receipts have no per-connection allowance attribution. WhatsApp data covers media and enabled HMS but has no approved complete GB-month aggregate source. Pricing and measurement availability never establish a charge; credits come only from the connection-window debit ledger.",
"items": {
"$ref": "#/components/schemas/ConsoleConsumption"
}
},
"byProject": {
"type": "array",
- "description": "Included for a team-wide read; omitted for a selected project or number. Active projects only. Team-level activity without a project is included in totals but has no project row.",
+ "description": "Included for a team-wide read; omitted for a selected project or connection. Active projects only. Team-level activity without a project is included in totals but has no project row.",
"items": {
"$ref": "#/components/schemas/ConsoleProjectUsage"
}
@@ -59986,7 +59821,7 @@
"enum": [
"team",
"project",
- "number"
+ "connection"
]
},
"teamId": {
@@ -59998,23 +59833,23 @@
"format": "uuid",
"nullable": true
},
- "numberId": {
+ "connectionId": {
"type": "string",
"format": "uuid",
"nullable": true
},
- "numberName": {
+ "connectionName": {
"type": "string",
"nullable": true,
- "description": "Selected number display name or session name; null without a selected number."
+ "description": "Selected connection display name or connection name; null without a selected connection."
}
},
"required": [
"kind",
"teamId",
"projectId",
- "numberId",
- "numberName"
+ "connectionId",
+ "connectionName"
]
},
"ConsoleMonthlyOutgoingCalls": {
@@ -60034,13 +59869,13 @@
"used": {
"type": "integer",
"minimum": 0,
- "description": "Completed outbound call.duration records for the exact number and project, including zero-duration calls. In-flight placements are not included."
+ "description": "Completed outbound call.duration records for the exact connection and project, including zero-duration calls. In-flight placements are not included."
},
"limit": {
"type": "integer",
"minimum": 0,
"nullable": true,
- "description": "Included number-tier monthly outgoing calls, using the runtime gate tier lookup. Null means a known unlimited tier. Separate staff gate overrides are not the included allowance."
+ "description": "Included connection-tier monthly outgoing calls, using the runtime gate tier lookup. Null means a known unlimited tier. Separate staff gate overrides are not the included allowance."
}
},
"required": [
@@ -60057,10 +59892,10 @@
"key": {
"type": "string",
"enum": [
- "number.free",
- "number.standard",
- "number.pro",
- "number.other",
+ "connection.free",
+ "connection.standard",
+ "connection.pro",
+ "connection.other",
"call.duration",
"call.cloud_pulses",
"campaign.call",
@@ -60080,7 +59915,7 @@
"group": {
"type": "string",
"enum": [
- "numbers",
+ "connections",
"calls",
"voice",
"agents",
@@ -60198,9 +60033,9 @@
"key": {
"type": "string",
"enum": [
- "numbers",
+ "connections",
"connected",
- "session-days",
+ "connection-days",
"api-requests",
"request-rate",
"message-rate",
@@ -60216,8 +60051,8 @@
"unit": {
"type": "string",
"enum": [
- "numbers",
- "sessions",
+ "connections",
+ "connections",
"days",
"requests",
"req/min",
@@ -60233,7 +60068,7 @@
"limit": {
"type": "integer",
"minimum": -1,
- "description": "-1 means no limit. Session-days uses 0 because every observed session-day is metered."
+ "description": "-1 means no limit. Connection-days uses 0 because every observed connection-day is metered."
},
"overage": {
"type": "number",
@@ -60264,18 +60099,18 @@
"format": "date",
"description": "UTC date, YYYY-MM-DD."
},
- "sessionDays": {
+ "connectionDays": {
"type": "integer",
"minimum": 0
},
- "sessionDayCredits": {
+ "connectionDayCredits": {
"type": "number"
},
"apiRequests": {
"type": "integer",
"minimum": 0,
"nullable": true,
- "description": "Null for number scope: request logs have no immutable number attribution."
+ "description": "Null for connection scope: request logs have no immutable connection attribution."
},
"failedRequests": {
"type": "integer",
@@ -60286,20 +60121,20 @@
"type": "integer",
"minimum": 0,
"nullable": true,
- "description": "Null for number scope. Maximum API and MCP request count in one UTC minute on this date within the requested range."
+ "description": "Null for connection scope. Maximum API and MCP request count in one UTC minute on this date within the requested range."
},
"activeDays": {
"type": "integer",
"enum": [
1
],
- "description": "This date has at least one observed audit, credit-ledger, usage-meter or admitted function invocation row, including activity that is not an API request or session charge."
+ "description": "This date has at least one observed audit, credit-ledger, usage-meter or admitted function invocation row, including activity that is not an API request or connection charge."
}
},
"required": [
"date",
- "sessionDays",
- "sessionDayCredits",
+ "connectionDays",
+ "connectionDayCredits",
"apiRequests",
"failedRequests",
"peakRequestRate",
@@ -60318,11 +60153,11 @@
"type": "integer",
"minimum": 0
},
- "sessionDays": {
+ "connectionDays": {
"type": "integer",
"minimum": 0
},
- "sessionDayCredits": {
+ "connectionDayCredits": {
"type": "number"
},
"apiRequests": {
@@ -60337,8 +60172,8 @@
"required": [
"projectId",
"connected",
- "sessionDays",
- "sessionDayCredits",
+ "connectionDays",
+ "connectionDayCredits",
"apiRequests",
"failedRequests"
]
@@ -60525,11 +60360,11 @@
"format": "int64",
"nullable": true
},
- "numberCount": {
+ "connectionCount": {
"type": "integer",
"minimum": 0
},
- "connectedNumberCount": {
+ "connectedConnectionCount": {
"type": "integer",
"minimum": 0
},
@@ -60563,8 +60398,8 @@
"status",
"isDefault",
"archivedAt",
- "numberCount",
- "connectedNumberCount",
+ "connectionCount",
+ "connectedConnectionCount",
"activePairingLinkState",
"lastActivityAt",
"needsAttention",
@@ -60630,7 +60465,7 @@
],
"nullable": true
},
- "migratedNumberCount": {
+ "migratedConnectionCount": {
"type": "integer",
"minimum": 0
}
@@ -60640,7 +60475,7 @@
"enabledAt",
"enabledBy",
"defaultCustomer",
- "migratedNumberCount"
+ "migratedConnectionCount"
]
},
"CustomerProjectRequest": {
@@ -60695,7 +60530,7 @@
}
}
},
- "CustomerNumber": {
+ "CustomerConnection": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -60706,7 +60541,7 @@
"customerId": {
"$ref": "#/components/schemas/CustomerId"
},
- "sessionId": {
+ "connectionId": {
"type": "string"
},
"name": {
@@ -60732,7 +60567,7 @@
"required": [
"id",
"customerId",
- "sessionId",
+ "connectionId",
"name",
"phoneMasked",
"status",
@@ -60761,7 +60596,7 @@
"type": "string",
"nullable": true
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid",
"nullable": true
@@ -60799,7 +60634,7 @@
"action",
"fromStatus",
"toStatus",
- "sessionId",
+ "connectionId",
"pairingLinkId",
"metadata",
"occurredAt"
@@ -60884,7 +60719,7 @@
"minimum": 1,
"maximum": 20
},
- "pendingSessionId": {
+ "pendingConnectionId": {
"type": "string",
"format": "uuid",
"nullable": true
@@ -60964,7 +60799,7 @@
"status",
"attemptCount",
"maxAttempts",
- "pendingSessionId",
+ "pendingConnectionId",
"createdBy",
"reservedAt",
"openedAt",
@@ -61059,7 +60894,7 @@
"minimum": 1,
"maximum": 20
},
- "pendingSessionId": {
+ "pendingConnectionId": {
"type": "string",
"format": "uuid",
"nullable": true
@@ -61145,7 +60980,7 @@
"status",
"attemptCount",
"maxAttempts",
- "pendingSessionId",
+ "pendingConnectionId",
"createdBy",
"reservedAt",
"openedAt",
@@ -61195,7 +61030,7 @@
}
}
},
- "TransferCustomerNumberRequest": {
+ "TransferCustomerConnectionRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -61418,7 +61253,7 @@
"removed"
]
},
- "SessionConfigurationView": {
+ "ConnectionConfigurationView": {
"type": "object",
"properties": {
"requestedHistory": {
@@ -61625,7 +61460,7 @@
"enum": [
"descriptor"
],
- "description": "Polymorfa-Version 2026-10-14 and later. `descriptor` makes history.sync carry the chunk descriptor or inline payload; Polymorfa never downloads the chunk. Reset it to inherit the project or team delivery setting. Without an inherited choice, delivery is archive. Existing Numbers require confirmed cleanup before switching to descriptor delivery."
+ "description": "Polymorfa-Version 2026-10-14 and later. `descriptor` makes history.sync carry the chunk descriptor or inline payload; Polymorfa never downloads the chunk. Reset it to inherit the project or team delivery setting. Without an inherited choice, delivery is archive. Existing Connections require confirmed cleanup before switching to descriptor delivery."
}
},
"additionalProperties": false
@@ -61744,7 +61579,7 @@
"platform",
"team",
"project",
- "session"
+ "connection"
]
},
"observation.typingMode": {
@@ -61753,7 +61588,7 @@
"platform",
"team",
"project",
- "session"
+ "connection"
]
},
"observation.labelMode": {
@@ -61762,7 +61597,7 @@
"platform",
"team",
"project",
- "session"
+ "connection"
]
},
"observation.quickReplyMode": {
@@ -61771,7 +61606,7 @@
"platform",
"team",
"project",
- "session"
+ "connection"
]
},
"historySync.mode": {
@@ -61780,7 +61615,7 @@
"platform",
"team",
"project",
- "session",
+ "connection",
"consent"
]
},
@@ -61790,7 +61625,7 @@
"platform",
"team",
"project",
- "session",
+ "connection",
"consent"
]
},
@@ -61800,7 +61635,7 @@
"platform",
"team",
"project",
- "session"
+ "connection"
]
},
"hms": {
@@ -61809,7 +61644,7 @@
"platform",
"team",
"project",
- "session"
+ "connection"
]
}
},
@@ -61835,7 +61670,7 @@
"type": "integer",
"minimum": 0
},
- "session": {
+ "connection": {
"type": "integer",
"minimum": 0
}
@@ -61843,7 +61678,7 @@
"required": [
"team",
"project",
- "session"
+ "connection"
],
"additionalProperties": false
},
@@ -61883,7 +61718,7 @@
],
"additionalProperties": false
},
- "SessionConfigurationUpdateRequest": {
+ "ConnectionConfigurationUpdateRequest": {
"type": "object",
"properties": {
"projectId": {
@@ -61918,7 +61753,7 @@
"enum": [
"descriptor"
],
- "description": "Polymorfa-Version 2026-10-14 and later. `descriptor` makes history.sync carry the chunk descriptor or inline payload; Polymorfa never downloads the chunk. Reset it to inherit the project or team delivery setting. Without an inherited choice, delivery is archive. Existing Numbers require confirmed cleanup before switching to descriptor delivery."
+ "description": "Polymorfa-Version 2026-10-14 and later. `descriptor` makes history.sync carry the chunk descriptor or inline payload; Polymorfa never downloads the chunk. Reset it to inherit the project or team delivery setting. Without an inherited choice, delivery is archive. Existing Connections require confirmed cleanup before switching to descriptor delivery."
}
},
"additionalProperties": false
@@ -62134,17 +61969,17 @@
"signalModeDefault"
]
},
- "SessionCallSettings": {
+ "ConnectionCallSettings": {
"type": "object",
"additionalProperties": false,
"properties": {
"callsEnabled": {
"type": "boolean",
- "description": "Whether the session can place, answer and receive calls."
+ "description": "Whether the connection can place, answer and receive calls."
},
"conferenceMode": {
"type": "boolean",
- "description": "Conference mode. When true, every participant you connect to a call (including SIP trunk callers) hears the WhatsApp party and every other participant you connected. When false, each of them hears only the WhatsApp party. The WhatsApp party always hears all of your participants, and no participant hears their own audio. Sessions without saved settings report true."
+ "description": "Conference mode. When true, every participant you connect to a call (including SIP trunk callers) hears the WhatsApp party and every other participant you connected. When false, each of them hears only the WhatsApp party. The WhatsApp party always hears all of your participants, and no participant hears their own audio. Connections without saved settings report true."
},
"inboundRoute": {
"type": "string",
@@ -62166,28 +62001,28 @@
},
"hostCloudApiCalls": {
"type": "boolean",
- "description": "Whether Polymorfa Calls answers the session's incoming calls when the session uses the Cloud API. When false (the default), your app answers them through the Graph API `/calls` endpoint and Polymorfa Calls does not host them. Sessions on a linked device ignore it."
+ "description": "Whether Polymorfa Calls answers the connection's incoming calls when the connection uses the Cloud API. When false (the default), your app answers them through the Graph API `/calls` endpoint and Polymorfa Calls does not host them. Connections on a linked device ignore it."
},
"simultaneousCalls": {
"type": "boolean",
- "description": "Whether this Number may hold more than one call at a time, with no limit. Linked-device sessions only; Cloud API sessions ignore it. It voids Ban Credit: a ban whose 30-day window overlaps any period this setting was on is not covered. Defaults to false."
+ "description": "Whether this Connection may hold more than one call at a time, with no limit. Linked-device connections only; Cloud API connections ignore it. It voids Ban Credit: a ban whose 30-day window overlaps any period this setting was on is not covered. Defaults to false."
},
"simultaneousCallsCoverageExcludedUntil": {
"type": "string",
"format": "date-time",
"nullable": true,
- "description": "Read-only. While `simultaneousCalls` is false, when Ban Credit stops excluding this Number because of an earlier period with it on: 30 days after the latest period ended. A ban is excluded when the setting was on at any time in the 30 days before it, so until this time, a new ban is not covered. Null while `simultaneousCalls` is true, and null when no period ended in the last 30 days. Null does not mean the Number is covered: the other Ban Credit conditions still apply."
+ "description": "Read-only. While `simultaneousCalls` is false, when Ban Credit stops excluding this Connection because of an earlier period with it on: 30 days after the latest period ended. A ban is excluded when the setting was on at any time in the 30 days before it, so until this time, a new ban is not covered. Null while `simultaneousCalls` is true, and null when no period ended in the last 30 days. Null does not mean the Connection is covered: the other Ban Credit conditions still apply."
},
"revision": {
"type": "integer",
"minimum": 0,
- "description": "Increases on every change; 0 while the session uses the defaults. Send it as `expectedRevision` to refuse an update that would overwrite someone else's change."
+ "description": "Increases on every change; 0 while the connection uses the defaults. Send it as `expectedRevision` to refuse an update that would overwrite someone else's change."
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true,
- "description": "When the settings were last changed, or null when the session uses the defaults."
+ "description": "When the settings were last changed, or null when the connection uses the defaults."
}
},
"required": [
@@ -62294,11 +62129,11 @@
"type": "string",
"format": "uuid",
"nullable": true,
- "description": "Original owning project, retained after number deletion. Null when the original owner is unknown; those records appear only in team-wide reads."
+ "description": "Original owning project, retained after connection deletion. Null when the original owner is unknown; those records appear only in team-wide reads."
},
- "sessionId": {
+ "connectionId": {
"type": "string",
- "description": "Session name of the number that placed or received the call."
+ "description": "Connection name of the connection that placed or received the call."
},
"direction": {
"type": "string",
@@ -62313,7 +62148,7 @@
"linked_device",
"cloud_api"
],
- "description": "How the number connects to WhatsApp."
+ "description": "How the connection connects to WhatsApp."
},
"outcome": {
"type": "string",
@@ -62324,7 +62159,7 @@
"failed",
"in_progress"
],
- "description": "How the call went. `answered`: media connected, including answered calls still in progress. `declined`: declined by a participant or the other party, or the line was busy. `missed`: nobody answered before ringing stopped or the caller hung up. `failed`: ended before it connected for any other reason, such as a connection or capacity failure. `in_progress`: still ringing."
+ "description": "How the call went. `answered`: media connected, including answered calls still in progress. `declined`: declined by a participant or the other party, or the line was busy. `missed`: nobody answered before ringing stopped or the caller hung up. `failed`: ended before it connected for any other reason, such as a method or capacity failure. `in_progress`: still ringing."
},
"state": {
"type": "string",
@@ -62376,7 +62211,7 @@
"required": [
"callId",
"projectId",
- "sessionId",
+ "connectionId",
"direction",
"upstream",
"outcome",
@@ -62457,13 +62292,13 @@
"properties": {
"key": {
"type": "string",
- "description": "Local date (`2026-09-18`) for `day`, local hour (`2026-09-18T14:00`) for `hour`, session name for `session`, or outcome for `outcome`."
+ "description": "Local date (`2026-09-18`) for `day`, local hour (`2026-09-18T14:00`) for `hour`, connection name for `connection`, or outcome for `outcome`."
},
"start": {
"type": "string",
"format": "date-time",
"nullable": true,
- "description": "Start of the day or hour bucket. Null for `session` and `outcome` groups."
+ "description": "Start of the day or hour bucket. Null for `connection` and `outcome` groups."
},
"calls": {
"type": "integer",
@@ -62575,7 +62410,7 @@
"enum": [
"day",
"hour",
- "session",
+ "connection",
"outcome"
]
},
@@ -62590,7 +62425,7 @@
},
"groupsTruncated": {
"type": "boolean",
- "description": "True when a `session` grouping left out numbers beyond the first 500. Totals still count every call."
+ "description": "True when a `connection` grouping left out connections beyond the first 500. Totals still count every call."
},
"heatmap": {
"type": "array",
@@ -62641,9 +62476,9 @@
"type": "string",
"format": "uuid"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
- "description": "Session name."
+ "description": "Connection name."
},
"callId": {
"type": "string"
@@ -62720,7 +62555,7 @@
},
"required": [
"id",
- "sessionId",
+ "connectionId",
"callId",
"projectId",
"direction",
@@ -62809,7 +62644,7 @@
}
]
},
- "description": "Closed, per-meter attributes. Call meters carry `direction`, `upstream` (`linked_device` or `cloud_api`), `origin`, `participants`, `connections`, `sipLegs` and `video`."
+ "description": "Closed, per-meter attributes. Call meters carry `direction`, `upstream` (`linked_device` or `cloud_api`), `origin`, `participants`, `methods`, `sipLegs` and `video`."
},
"keySource": {
"$ref": "#/components/schemas/UsageKeySource"
@@ -62833,12 +62668,12 @@
"type": "string",
"format": "uuid",
"nullable": true,
- "description": "Original owning project, preserved across usage revisions and number deletion. Null when unknown; project-filtered reads exclude unattributed records."
+ "description": "Original owning project, preserved across usage revisions and connection deletion. Null when unknown; project-filtered reads exclude unattributed records."
},
- "session": {
+ "connection": {
"type": "string",
"nullable": true,
- "description": "The number (session name) the usage belongs to."
+ "description": "The connection (connection name) the usage belongs to."
},
"occurredAt": {
"type": "string",
@@ -62852,7 +62687,7 @@
"revision": {
"type": "integer",
"minimum": 1,
- "description": "Increases when a later observation corrects the record, for example a call end reported after a lost connection."
+ "description": "Increases when a later observation corrects the record, for example a call end reported after a lost method."
},
"pricingState": {
"type": "string",
@@ -62899,7 +62734,7 @@
"sourceKind",
"sourceId",
"projectId",
- "session",
+ "connection",
"occurredAt",
"recordedAt",
"revision",
@@ -62982,7 +62817,7 @@
"format": "uuid",
"nullable": true
},
- "session": {
+ "connection": {
"type": "string",
"nullable": true
},
@@ -62996,15 +62831,15 @@
"$ref": "#/components/schemas/UsageMeterTotal"
}
},
- "numbers": {
+ "connections": {
"type": "array",
"maxItems": 100,
- "description": "Totals per number, most call time first.",
+ "description": "Totals per connection, most call time first.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
"projectId": {
@@ -63020,15 +62855,15 @@
}
},
"required": [
- "session",
+ "connection",
"projectId",
"meters"
]
}
},
- "numbersTruncated": {
+ "connectionsTruncated": {
"type": "boolean",
- "description": "True when more than 100 numbers had usage."
+ "description": "True when more than 100 connections had usage."
}
},
"required": [
@@ -63036,11 +62871,11 @@
"start",
"end",
"projectId",
- "session",
+ "connection",
"billingEnabled",
"meters",
- "numbers",
- "numbersTruncated"
+ "connections",
+ "connectionsTruncated"
]
},
"UsageGate": {
@@ -63082,7 +62917,7 @@
"type": "string",
"enum": [
"team",
- "number",
+ "connection",
"project",
"campaign"
],
@@ -63104,12 +62939,12 @@
"limit": {
"type": "number",
"nullable": true,
- "description": "For capability gates, 1 when included and 0 when not. Otherwise the limit, or -1 for no limit. Null when the limit applies per number and no `session` was given."
+ "description": "For capability gates, 1 when included and 0 when not. Otherwise the limit, or -1 for no limit. Null when the limit applies per connection and no `connection` was given."
},
"used": {
"type": "number",
"nullable": true,
- "description": "Usage this calendar month (UTC) counted against a quota. Per-number quotas count only the current number; retained usage from a deleted number with the same name is excluded."
+ "description": "Usage this calendar month (UTC) counted against a quota. Per-connection quotas count only the current connection; retained usage from a deleted connection with the same name is excluded."
},
"unit": {
"type": "string",
@@ -63178,7 +63013,7 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "session": {
+ "connection": {
"type": "string",
"nullable": true
},
@@ -63190,7 +63025,7 @@
}
},
"required": [
- "session",
+ "connection",
"gates"
]
},
@@ -63227,9 +63062,9 @@
"callId": {
"type": "string"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
- "description": "Session name."
+ "description": "Connection name."
},
"projectId": {
"type": "string",
@@ -63259,7 +63094,7 @@
},
"backend": {
"type": "string",
- "description": "How the number reaches WhatsApp for this call."
+ "description": "How the connection reaches WhatsApp for this call."
},
"hasVideo": {
"type": "boolean"
@@ -63308,7 +63143,7 @@
},
"required": [
"callId",
- "sessionId",
+ "connectionId",
"projectId",
"direction",
"state",
@@ -63494,7 +63329,7 @@
"appReports": {
"type": "object",
"additionalProperties": false,
- "description": "Diagnostics your app sent with `POST /messaging/voip/calls/{id}/reports`, by connection. Figures the app did not report are null.",
+ "description": "Diagnostics your app sent with `POST /messaging/voip/calls/{id}/reports`, by method. Figures the app did not report are null.",
"properties": {
"status": {
"type": "string",
@@ -63523,7 +63358,7 @@
"type": "object",
"nullable": true,
"additionalProperties": false,
- "description": "The SDK named by the connection's most recent report. Null when that report named none.",
+ "description": "The SDK named by the method's most recent report. Null when that report named none.",
"properties": {
"sdk": {
"type": "string",
@@ -63552,7 +63387,7 @@
"type": "object",
"nullable": true,
"additionalProperties": false,
- "description": "The connection's latest quality report. Null when it sent none.",
+ "description": "The method's latest quality report. Null when it sent none.",
"properties": {
"reportedAt": {
"type": "string",
@@ -63661,7 +63496,7 @@
},
"required": [
"status",
- "connections",
+ "methods",
"truncated"
]
},
@@ -63813,20 +63648,20 @@
"callId": {
"type": "string"
},
- "sessionId": {
+ "connectionId": {
"type": "string"
}
},
"required": [
"callId",
- "sessionId"
+ "connectionId"
]
}
},
"required": [
"call",
"participants",
- "connections",
+ "methods",
"telemetry",
"appReports",
"webhookDeliveries",
@@ -63860,7 +63695,7 @@
"projectId": {
"type": "string",
"format": "uuid",
- "description": "Project that owns the call's session."
+ "description": "Project that owns the call's connection."
}
}
},
@@ -63887,13 +63722,13 @@
"removed"
]
},
- "UpdateSessionCallSettingsRequest": {
+ "UpdateConnectionCallSettingsRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"callsEnabled": {
"type": "boolean",
- "description": "False refuses new and incoming calls on the session."
+ "description": "False refuses new and incoming calls on the connection."
},
"conferenceMode": {
"type": "boolean",
@@ -63917,17 +63752,17 @@
},
"hostCloudApiCalls": {
"type": "boolean",
- "description": "True has Polymorfa Calls answer the session's Cloud API calls instead of your Graph API integration."
+ "description": "True has Polymorfa Calls answer the connection's Cloud API calls instead of your Graph API integration."
},
"simultaneousCalls": {
"type": "boolean",
- "description": "True lets this Number hold more than one call at a time. Requires a team owner or admin and current risk acknowledgement through acceptTerms, a recorded acceptance, or the original acknowledgeRisk alias. It voids Ban Credit for this Number. False returns to one call at a time."
+ "description": "True lets this Connection hold more than one call at a time. Requires a team owner or admin and current risk acknowledgement through acceptTerms, a recorded acceptance, or the original acknowledgeRisk alias. It voids Ban Credit for this Connection. False returns to one call at a time."
},
"acceptTerms": {
"type": "string",
"minLength": 1,
"maxLength": 100,
- "description": "Published simultaneous-call terms version accepted inline for this Number. Unpublished terms add no requirement."
+ "description": "Published simultaneous-call terms version accepted inline for this Connection. Unpublished terms add no requirement."
},
"termsLocale": {
"type": "string",
@@ -63949,7 +63784,7 @@
"projectId": {
"type": "string",
"format": "uuid",
- "description": "Project that owns the session."
+ "description": "Project that owns the connection."
}
},
"minProperties": 1
@@ -63975,7 +63810,7 @@
"type": "string",
"format": "uri",
"nullable": true,
- "description": "Project-owned HTTPS destination after connection confirmation."
+ "description": "Project-owned HTTPS destination after method confirmation."
},
"failureCallbackUrl": {
"type": "string",
@@ -64149,7 +63984,7 @@
"pattern": "^[Hh][Tt][Tt][Pp][Ss]://",
"maxLength": 2048,
"nullable": true,
- "description": "Project-only destination after connection confirmation. Snapshotted when issuing a link."
+ "description": "Project-only destination after method confirmation. Snapshotted when issuing a link."
},
"failureCallbackUrl": {
"type": "string",
@@ -64180,7 +64015,7 @@
"type": "string",
"maxLength": 280,
"nullable": true,
- "description": "Message shown after the number connects."
+ "description": "Message shown after the connection connects."
},
"supportUrl": {
"type": "string",
@@ -64331,7 +64166,7 @@
"metaLinks": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/FlowNumberLink"
+ "$ref": "#/components/schemas/FlowConnectionLink"
}
},
"createdAt": {
@@ -64456,11 +64291,11 @@
"projectId": {
"$ref": "#/components/schemas/ProjectId"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
- "description": "Number (session) name or id in the Flow's project."
+ "description": "Connection name or ID in the Flow's project."
},
"categories": {
"type": "array",
@@ -64470,7 +64305,7 @@
"items": {
"$ref": "#/components/schemas/FlowCategory"
},
- "description": "WhatsApp Flow categories. Required for an upload that creates the Number's Flow; ignored otherwise."
+ "description": "WhatsApp Flow categories. Required for an upload that creates the Connection's Flow; ignored otherwise."
},
"requestId": {
"type": "string",
@@ -64480,7 +64315,7 @@
},
"required": [
"projectId",
- "sessionId"
+ "connectionId"
]
},
"FlowValidationIssue": {
@@ -64534,18 +64369,18 @@
}
}
},
- "FlowNumberLink": {
+ "FlowConnectionLink": {
"type": "object",
"additionalProperties": false,
- "description": "The Flow as WhatsApp last reported it for one Number.",
+ "description": "The Flow as WhatsApp last reported it for one Connection.",
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid",
- "description": "Stable Number ID. A Number recreated under the same name does not reuse this link."
+ "description": "Connection record UUID. A Connection recreated under the same name does not reuse this link."
},
"wabaId": {
"type": "string",
@@ -64601,11 +64436,11 @@
},
"simulated": {
"type": "boolean",
- "description": "True for a test Number."
+ "description": "True for a test Connection."
}
},
"required": [
- "session",
+ "connection",
"wabaId",
"metaFlowId",
"status",
@@ -64631,11 +64466,11 @@
"flowId": {
"$ref": "#/components/schemas/FlowId"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
- "session": {
+ "connection": {
"type": "string"
},
"flowName": {
@@ -64720,8 +64555,8 @@
"id",
"requestId",
"flowId",
- "sessionId",
- "session",
+ "connectionId",
+ "connection",
"flowName",
"action",
"state",
@@ -64778,7 +64613,7 @@
"flowId": {
"$ref": "#/components/schemas/FlowId"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -64832,7 +64667,7 @@
"teamId",
"projectId",
"flowId",
- "sessionId",
+ "connectionId",
"mode",
"url",
"functionId",
@@ -64911,7 +64746,7 @@
"managed",
"customer"
],
- "description": "`managed`: Polymorfa holds the Number's active key. `customer`: it does not; register your own key to use direct endpoints."
+ "description": "`managed`: Polymorfa holds the Connection's active key. `customer`: it does not; register your own key to use direct endpoints."
},
"activeKeyId": {
"type": "string",
@@ -64957,16 +64792,16 @@
"projectId": {
"$ref": "#/components/schemas/ProjectId"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
- "description": "Number (session) name or id."
+ "description": "Connection name or ID."
}
},
"required": [
"projectId",
- "sessionId"
+ "connectionId"
]
},
"FlowEndpointState": {
@@ -65018,11 +64853,11 @@
"projectId": {
"$ref": "#/components/schemas/ProjectId"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
- "description": "Number (session) name or id in the Flow's project."
+ "description": "Connection name or ID in the Flow's project."
},
"mode": {
"type": "string",
@@ -65065,7 +64900,7 @@
},
"required": [
"projectId",
- "sessionId",
+ "connectionId",
"mode"
]
},
@@ -65084,7 +64919,7 @@
"type": "string",
"format": "uuid"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -65155,7 +64990,7 @@
"id",
"flowId",
"endpointId",
- "sessionId",
+ "connectionId",
"mode",
"action",
"outcome",
@@ -65330,13 +65165,13 @@
"ok"
]
},
- "SessionIdentifier": {
+ "ConnectionIdentifier": {
"type": "string",
"minLength": 1,
"maxLength": 64,
- "description": "Database session UUID or stable session slug."
+ "description": "Database connection UUID or stable connection slug."
},
- "SessionProjectContext": {
+ "ConnectionProjectContext": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -65345,7 +65180,7 @@
}
}
},
- "SessionTierOverrideRequest": {
+ "ConnectionTierOverrideRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -65361,7 +65196,7 @@
"quoteId"
]
},
- "NumberTierChange": {
+ "ConnectionTierChange": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -65422,7 +65257,7 @@
"nullable": true
},
"hybridTransition": {
- "$ref": "#/components/schemas/NumberHybridTransition"
+ "$ref": "#/components/schemas/ConnectionHybridTransition"
}
},
"required": [
@@ -65444,7 +65279,7 @@
"quote"
]
},
- "NumberTierQuoteRequest": {
+ "ConnectionTierQuoteRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -65480,7 +65315,7 @@
]
},
"HybridResolution": {
- "description": "Required when a Hybrid Link Number moves to a tier without Hybrid Link. `keep` retires the other connection. `split` keeps `existingNumberTransport` on this Number and moves the other connection to a new Standard Number named `newNumberName`, without pairing or signing up again.",
+ "description": "Required when a Hybrid Link Connection moves to a tier without Hybrid Link. `keep` retires the other method. `split` keeps `existingConnectionTransport` on this Connection and moves the other method to a new Standard Connection named `newConnectionName`, without pairing or signing up again.",
"oneOf": [
{
"type": "object",
@@ -65511,18 +65346,18 @@
"split"
]
},
- "existingNumberTransport": {
+ "existingConnectionTransport": {
"$ref": "#/components/schemas/HybridTransport"
},
- "newNumberName": {
+ "newConnectionName": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,63}$"
}
},
"required": [
"action",
- "existingNumberTransport",
- "newNumberName"
+ "existingConnectionTransport",
+ "newConnectionName"
]
}
],
@@ -65533,18 +65368,18 @@
"HybridMerge": {
"type": "object",
"additionalProperties": false,
- "description": "Merges another Number into this one as a Hybrid Link Number. The other Number's connection moves here and the other Number is removed.",
+ "description": "Merges another Connection into this one as a Hybrid Link Connection. The other Connection's method moves here and the other Connection is removed.",
"properties": {
- "absorbNumberId": {
+ "absorbConnectionId": {
"type": "string",
"format": "uuid"
}
},
"required": [
- "absorbNumberId"
+ "absorbConnectionId"
]
},
- "NumberHybridTransition": {
+ "ConnectionHybridTransition": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -65559,24 +65394,24 @@
"keepTransport": {
"$ref": "#/components/schemas/HybridTransport"
},
- "existingNumberTransport": {
+ "existingConnectionTransport": {
"$ref": "#/components/schemas/HybridTransport"
},
- "newNumberName": {
+ "newConnectionName": {
"type": "string"
},
- "absorbNumberId": {
+ "absorbConnectionId": {
"type": "string",
"format": "uuid"
},
- "survivingNumberId": {
+ "survivingConnectionId": {
"type": "string",
"format": "uuid"
},
- "newNumberId": {
+ "newConnectionId": {
"type": "string",
"format": "uuid",
- "description": "The Number created by a completed split."
+ "description": "The Connection created by a completed split."
},
"status": {
"type": "string",
@@ -65594,7 +65429,7 @@
},
"metaDisconnectRequired": {
"type": "boolean",
- "description": "True after an Official API connection that shares the number with the WhatsApp Business app is dropped. Polymorfa has stopped using it; disconnect it in the WhatsApp Business app under Settings > Account > Business Platform."
+ "description": "True after an Official API method that shares the connection with the WhatsApp Business app is dropped. Polymorfa has stopped using it; disconnect it in the WhatsApp Business app under Settings > Account > Business Platform."
},
"effectiveAtMs": {
"type": "integer",
@@ -65603,7 +65438,7 @@
},
"required": [
"action",
- "survivingNumberId"
+ "survivingConnectionId"
]
},
"HybridMergeCandidateList": {
@@ -65612,7 +65447,7 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "numbers": {
+ "connections": {
"type": "array",
"minItems": 2,
"maxItems": 2,
@@ -65627,21 +65462,25 @@
"name": {
"type": "string"
},
- "transport": {
- "$ref": "#/components/schemas/HybridTransport"
+ "method": {
+ "type": "string",
+ "enum": [
+ "linked_device",
+ "cloud_api"
+ ]
},
"status": {
"type": "string"
},
"canBeAbsorbed": {
"type": "boolean",
- "description": "False when this Number has hosted message storage enabled. Keep this Number and absorb the other one."
+ "description": "False when this Connection has hosted message storage enabled. Keep this Connection and absorb the other one."
}
},
"required": [
"id",
"name",
- "transport",
+ "method",
"status",
"canBeAbsorbed"
]
@@ -65665,33 +65504,33 @@
}
},
"required": [
- "numbers",
+ "connections",
"eligible"
]
}
},
- "SessionBatchRequest": {
+ "ConnectionBatchRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"projectId": {
"$ref": "#/components/schemas/ProjectId"
},
- "sessionIds": {
+ "connectionIds": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"items": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "$ref": "#/components/schemas/ConnectionIdentifier"
}
}
},
"required": [
- "sessionIds"
+ "connectionIds"
]
},
- "CreateTestingNumberRequest": {
+ "CreateTestingConnectionRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -65964,7 +65803,7 @@
"projectId"
]
},
- "ManagedSession": {
+ "ManagedConnection": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -65972,9 +65811,9 @@
"type": "string",
"format": "uuid"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
- "description": "Stable session slug."
+ "description": "Stable connection slug."
},
"status": {
"type": "string"
@@ -65992,12 +65831,12 @@
},
"required": [
"id",
- "sessionId",
+ "connectionId",
"status",
"tierOverride"
]
},
- "PlatformSession": {
+ "PlatformConnection": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -66012,8 +65851,8 @@
"projectId": {
"$ref": "#/components/schemas/ProjectId"
},
- "sessionId": {
- "$ref": "#/components/schemas/SessionIdentifier"
+ "connectionId": {
+ "$ref": "#/components/schemas/ConnectionIdentifier"
},
"name": {
"type": "string",
@@ -66046,12 +65885,12 @@
},
"status": {
"type": "string",
- "description": "Latest runtime connection status."
+ "description": "Latest runtime method status."
},
"statusReason": {
"type": "string",
"nullable": true,
- "description": "Machine-readable reason for the latest connection status, when available."
+ "description": "Machine-readable reason for the latest method status, when available."
},
"messageCount": {
"type": "integer",
@@ -66158,7 +65997,7 @@
"_id",
"_creationTime",
"projectId",
- "sessionId",
+ "connectionId",
"name",
"phone",
"platform",
@@ -66192,7 +66031,7 @@
"properties": {
"released": {
"type": "boolean",
- "description": "False when the Number was already unclaimed."
+ "description": "False when the Connection was already unclaimed."
}
},
"required": [
@@ -66202,7 +66041,7 @@
"InspectorClaimState": {
"type": "object",
"additionalProperties": false,
- "description": "Whether a team member has claimed this Number in Inspector. The claimant's identity is not included.",
+ "description": "Whether a team member has claimed this Connection in Inspector. The claimant's identity is not included.",
"properties": {
"claimed": {
"type": "boolean"
@@ -66219,7 +66058,7 @@
"claimedAt"
]
},
- "SessionStopResult": {
+ "ConnectionStopResult": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -66229,17 +66068,17 @@
true
]
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"stopping",
- "sessionId"
+ "connectionId"
]
},
- "SessionStartResult": {
+ "ConnectionStartResult": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -66249,17 +66088,17 @@
true
]
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"starting",
- "sessionId"
+ "connectionId"
]
},
- "SessionRemoveResult": {
+ "ConnectionRemoveResult": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -66269,17 +66108,17 @@
true
]
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"removed",
- "sessionId"
+ "connectionId"
]
},
- "SessionBatchStopResult": {
+ "ConnectionBatchStopResult": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -66293,7 +66132,7 @@
"stopping"
]
},
- "SessionBatchRemoveResult": {
+ "ConnectionBatchRemoveResult": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -66307,10 +66146,10 @@
"removed"
]
},
- "TestingSessionId": {
+ "TestingConnectionId": {
"type": "string",
"pattern": "^[1-9][0-9]{0,18}$",
- "description": "Opaque Number ID. Keep it as a string; use testMode to identify Test Numbers."
+ "description": "Opaque Connection ID. Keep it as a string; use testMode to identify Test Connections."
},
"ProductionEnrollmentRequest": {
"type": "object",
@@ -66513,7 +66352,7 @@
"type": "string",
"minLength": 1,
"maxLength": 64,
- "description": "Number in international format, for example `+14155550100`. Spaces, dots, hyphens and parentheses are ignored; a leading `00` is read as `+`; digits without `+` are read as including the country code."
+ "description": "Connection in international format, for example `+14155550100`. Spaces, dots, hyphens and parentheses are ignored; a leading `00` is read as `+`; digits without `+` are read as including the country code."
},
"variables": {
"type": "object",
@@ -66569,7 +66408,7 @@
"required": [
"message"
],
- "description": "One optional receipt-timed follow-up, sent from the Number that sent the first message. A beta; a team that is not enrolled gets `403 feature_unavailable`. Expiry must exceed delay and is counted from the first send. Configuration freezes at launch. The first read takes precedence over the first delivery; additional reads do not move it. Replies and opt-outs cancel it. Without a delivery or read receipt it never arms, and an expired wait never sends. Requires a single first message, and the text cannot contain tracked links.",
+ "description": "One optional receipt-timed follow-up, sent from the Connection that sent the first message. A beta; a team that is not enrolled gets `403 feature_unavailable`. Expiry must exceed delay and is counted from the first send. Configuration freezes at launch. The first read takes precedence over the first delivery; additional reads do not move it. Replies and opt-outs cancel it. Without a delivery or read receipt it never arms, and an expired wait never sends. Requires a single first message, and the text cannot contain tracked links.",
"properties": {
"delaySeconds": {
"type": "integer",
@@ -66635,7 +66474,7 @@
"additionalProperties": false,
"required": [
"id",
- "numberId",
+ "connectionId",
"status",
"anchorKind",
"firstDeliveredAt",
@@ -66654,7 +66493,7 @@
"type": "string",
"format": "uuid"
},
- "numberId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -66813,16 +66652,16 @@
"format": "uuid",
"description": "Required when using a team API key. Project tokens derive the project from the credential."
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid",
- "description": "The number to send the test from. It must be connected, on a plan that includes Campaigns and, when the campaign selects numbers, one of them."
+ "description": "The connection to send the test from. It must be connected, on a plan that includes Campaigns and, when the campaign selects connections, one of them."
},
"to": {
"type": "string",
"minLength": 1,
"maxLength": 32,
- "description": "The seed recipient in international format. It must be the phone of a number connected to your team.",
+ "description": "The seed recipient in international format. It must be the phone of a connection connected to your team.",
"example": "+5511999990000"
},
"sampleRecipientId": {
@@ -66851,7 +66690,7 @@
}
},
"required": [
- "sessionId",
+ "connectionId",
"to"
]
},
@@ -66878,7 +66717,7 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
@@ -66887,10 +66726,10 @@
}
},
"required": [
- "sessionId",
+ "connectionId",
"phone"
],
- "description": "The number the test was sent from."
+ "description": "The connection the test was sent from."
},
"to": {
"type": "string",
@@ -67473,7 +67312,7 @@
"templateId": {
"type": "string",
"format": "uuid",
- "description": "Template in the campaign's project to send instead of composed messages. On Cloud API numbers it must be approved by WhatsApp before launch."
+ "description": "Template in the campaign's project to send instead of composed messages. On Cloud API connections it must be approved by WhatsApp before launch."
},
"variableMapping": {
"$ref": "#/components/schemas/CampaignVariableMapping"
@@ -67511,7 +67350,7 @@
"items": {
"$ref": "#/components/schemas/CampaignTrackedLink"
},
- "description": "Beta. Links to track, at most 5. Each message reference `{{link:}}` is replaced with a short link per recipient that redirects to `url`. Only campaigns sent from linked-device numbers track links. `null` or `[]` stores none."
+ "description": "Beta. Links to track, at most 5. Each message reference `{{link:}}` is replaced with a short link per recipient that redirects to `url`. Only campaigns sent from linked-device connections track links. `null` or `[]` stores none."
},
"drip": {
"nullable": true,
@@ -67594,7 +67433,7 @@
},
"messageVariations": {
"$ref": "#/components/schemas/CampaignMessageVariations",
- "description": "Two to five message alternatives for linked-device numbers. Each recipient receives one, chosen by weight, and keeps it across retries. Cannot be combined with composed messages, a template or an A/B test. A beta; a team that is not enrolled gets `403 feature_unavailable`."
+ "description": "Two to five message alternatives for linked-device connections. Each recipient receives one, chosen by weight, and keeps it across retries. Cannot be combined with composed messages, a template or an A/B test. A beta; a team that is not enrolled gets `403 feature_unavailable`."
}
},
"required": [
@@ -67609,7 +67448,7 @@
"exitOnReply",
"exitOnLinkClick"
],
- "description": "Beta drip settings. Defaults: audience enrollment, exit on reply true, exit on link open false. Opt-outs always stop remaining steps. Cannot combine with a template, A/B variants, weighted alternatives or receipt-timed followUp. Linked-device and test numbers only.",
+ "description": "Beta drip settings. Defaults: audience enrollment, exit on reply true, exit on link open false. Opt-outs always stop remaining steps. Cannot combine with a template, A/B variants, weighted alternatives or receipt-timed followUp. Linked-device and test connections only.",
"properties": {
"enrollment": {
"type": "string",
@@ -67623,7 +67462,7 @@
"exitOnReply": {
"type": "boolean",
"default": true,
- "description": "When true, a contact who replies to the sending number gets no further steps."
+ "description": "When true, a contact who replies to the sending connection gets no further steps."
},
"exitOnLinkClick": {
"type": "boolean",
@@ -67635,7 +67474,7 @@
"CampaignDripInput": {
"type": "object",
"additionalProperties": false,
- "description": "Beta drip settings. Defaults: audience enrollment, exit on reply true, exit on link open false. Opt-outs always stop remaining steps. Cannot combine with a template, A/B variants, weighted alternatives or receipt-timed followUp. Linked-device and test numbers only.",
+ "description": "Beta drip settings. Defaults: audience enrollment, exit on reply true, exit on link open false. Opt-outs always stop remaining steps. Cannot combine with a template, A/B variants, weighted alternatives or receipt-timed followUp. Linked-device and test connections only.",
"properties": {
"enrollment": {
"type": "string",
@@ -67649,7 +67488,7 @@
"exitOnReply": {
"type": "boolean",
"default": true,
- "description": "When true, a contact who replies to the sending number gets no further steps."
+ "description": "When true, a contact who replies to the sending connection gets no further steps."
},
"exitOnLinkClick": {
"type": "boolean",
@@ -67673,7 +67512,7 @@
},
"exitOnReply": {
"type": "boolean",
- "description": "When true, a contact who replies to the sending number gets no further steps."
+ "description": "When true, a contact who replies to the sending connection gets no further steps."
},
"exitOnLinkClick": {
"type": "boolean",
@@ -67872,7 +67711,7 @@
"url": {
"type": "string",
"format": "uri",
- "description": "Public https URL the sending number downloads the file from. Launch is refused with `400 invalid_parameter` when an attachment has no URL."
+ "description": "Public https URL the sending connection downloads the file from. Launch is refused with `400 invalid_parameter` when an attachment has no URL."
},
"filename": {
"type": "string"
@@ -67885,7 +67724,7 @@
},
"buttons": {
"type": "array",
- "description": "On WhatsApp numbers, link and call buttons are sent as text lines and quick replies are left out.",
+ "description": "On WhatsApp connections, link and call buttons are sent as text lines and quick replies are left out.",
"items": {
"type": "object",
"additionalProperties": true,
@@ -68359,7 +68198,7 @@
"kind"
],
"additionalProperties": true,
- "description": "`text` (`text`), `buttons` (`body`, up to 3 `buttons` with `id` and `text`), `list` (`body`, `buttonText`, up to 10 `rows`), or `flow_form` (`flowId`, `body`, `buttonText`, `screen`; Official numbers only).",
+ "description": "`text` (`text`), `buttons` (`body`, up to 3 `buttons` with `id` and `text`), `list` (`body`, `buttonText`, up to 10 `rows`), or `flow_form` (`flowId`, `body`, `buttonText`, `screen`; Official connections only).",
"properties": {
"kind": {
"type": "string",
@@ -69831,7 +69670,7 @@
"cold_held",
"campaign_cancelled",
"invalid_recipient",
- "session_not_connected",
+ "connection_not_connected",
"ack_timeout",
"blocked_by_safety",
"send_failed",
@@ -69839,7 +69678,7 @@
"frequency_cap",
"other"
],
- "description": "Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the number is on the team's opt-out list. `cold_held`: the number never wrote to the sending number and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the number is not a valid WhatsApp address. `session_not_connected`: the sending number was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `frequency_cap`: the recipient reached the team's or campaign's rolling contact frequency cap. `other`: any other reason. New codes may be added."
+ "description": "Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the phone number is on the team's opt-out list. `cold_held`: the recipient never wrote to the sending connection and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the recipient is not a valid WhatsApp address. `connection_not_connected`: the sending connection was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `frequency_cap`: the recipient reached the team's or campaign's rolling contact frequency cap. `other`: any other reason. New codes may be added."
},
"RecordCampaignConversionRequest": {
"type": "object",
@@ -70308,7 +70147,7 @@
"enum": [
"direct_condition",
"delivery",
- "connection",
+ "method",
"conduct",
"cadence"
]
@@ -70373,7 +70212,7 @@
"minimum": 0,
"maximum": 100
},
- "connection": {
+ "method": {
"type": "number",
"minimum": 0,
"maximum": 100
@@ -70392,7 +70231,7 @@
"required": [
"conduct",
"delivery",
- "connection",
+ "method",
"restriction",
"total"
]
@@ -70413,7 +70252,7 @@
"enum": [
"direct_condition",
"delivery",
- "connection",
+ "method",
"conduct",
"cadence"
]
@@ -70428,7 +70267,7 @@
"enum": [
"direct_condition",
"delivery",
- "connection",
+ "method",
"conduct",
"cadence"
]
@@ -70690,15 +70529,15 @@
"signals"
]
},
- "BanSafeCollectionSession": {
+ "BanSafeCollectionConnection": {
"type": "object",
"additionalProperties": false,
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
- "session": {
+ "connection": {
"type": "string"
},
"projectId": {
@@ -70710,8 +70549,8 @@
}
},
"required": [
- "sessionId",
- "session",
+ "connectionId",
+ "connection",
"projectId",
"collection"
]
@@ -70720,11 +70559,11 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
- "session": {
+ "connection": {
"type": "string"
},
"projectId": {
@@ -70744,8 +70583,8 @@
}
},
"required": [
- "sessionId",
- "session",
+ "connectionId",
+ "connection",
"projectId",
"collection",
"snapshot"
@@ -70759,11 +70598,11 @@
"type": "string",
"format": "uuid"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
- "session": {
+ "connection": {
"type": "string"
},
"projectId": {
@@ -70857,8 +70696,8 @@
},
"required": [
"id",
- "sessionId",
- "session",
+ "connectionId",
+ "connection",
"projectId",
"mode",
"action",
@@ -70875,7 +70714,7 @@
"outcome"
]
},
- "BanSafeNumberEnforcement": {
+ "BanSafeConnectionEnforcement": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -70908,7 +70747,7 @@
"block_cold",
"suspend"
],
- "description": "The lowest restriction every number in this workspace is held to."
+ "description": "The lowest restriction every connection in this workspace is held to."
},
"reason": {
"type": "string"
@@ -70923,15 +70762,15 @@
"throughputPerMinute": {
"type": "number",
"nullable": true,
- "description": "Messages per minute this number is paced to, or null when it is not paced."
+ "description": "Messages per minute this connection is paced to, or null when it is not paced."
},
"blocksUnsolicited": {
"type": "boolean",
- "description": "First messages to people who never wrote to this number are refused outside Campaigns."
+ "description": "First messages to people who never wrote to this connection are refused outside Campaigns."
},
"suspended": {
"type": "boolean",
- "description": "This number cannot originate a message. It still receives, reads, and shows presence."
+ "description": "This connection cannot originate a message. It still receives, reads, and shows presence."
},
"startedAt": {
"type": "string",
@@ -70971,7 +70810,7 @@
"applied",
"applying"
],
- "description": "`applying` while the number has not confirmed the restriction."
+ "description": "`applying` while the connection has not confirmed the restriction."
}
},
"required": [
@@ -70992,15 +70831,15 @@
"state"
]
},
- "BanSafeNumber": {
+ "BanSafeConnection": {
"type": "object",
"additionalProperties": false,
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
- "session": {
+ "connection": {
"type": "string"
},
"phoneNumber": {
@@ -71115,14 +70954,14 @@
"nullable": true,
"allOf": [
{
- "$ref": "#/components/schemas/BanSafeNumberEnforcement"
+ "$ref": "#/components/schemas/BanSafeConnectionEnforcement"
}
]
}
},
"required": [
- "sessionId",
- "session",
+ "connectionId",
+ "connection",
"phoneNumber",
"projectId",
"health",
@@ -71197,13 +71036,13 @@
"evidence": {
"type": "object",
"additionalProperties": true,
- "description": "Numbers only. Never message content, a message identifier, or a recipient identifier."
+ "description": "Connections only. Never message content, a message identifier, or a recipient identifier."
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
- "session": {
+ "connection": {
"type": "string"
},
"phoneNumber": {
@@ -71249,7 +71088,7 @@
"enum": [
"clean",
"key_retired",
- "number_removed",
+ "connection_removed",
"stale",
null
]
@@ -71266,8 +71105,8 @@
"occurrences",
"reopenedCount",
"evidence",
- "sessionId",
- "session",
+ "connectionId",
+ "connection",
"phoneNumber",
"firstSeenAt",
"lastSeenAt",
@@ -71279,7 +71118,7 @@
"resolveReason"
]
},
- "BanSafeNumberDetail": {
+ "BanSafeConnectionDetail": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -71385,7 +71224,7 @@
]
},
"warmup": {
- "$ref": "#/components/schemas/BanSafeNumberWarmup"
+ "$ref": "#/components/schemas/BanSafeConnectionWarmup"
},
"findings": {
"type": "array",
@@ -71409,8 +71248,8 @@
}
},
"required": [
- "sessionId",
- "session",
+ "connectionId",
+ "connection",
"phoneNumber",
"projectId",
"health",
@@ -71433,7 +71272,7 @@
"appealState"
]
},
- "BanSafeNumberWarmup": {
+ "BanSafeConnectionWarmup": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -71454,7 +71293,7 @@
"tenureDay": {
"type": "integer",
"minimum": 0,
- "description": "Whole days since the number's known tenure lower bound; zero when unknown."
+ "description": "Whole days since the connection's known tenure lower bound; zero when unknown."
},
"allowance": {
"type": "integer",
@@ -72061,11 +71900,11 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
- "session": {
+ "connection": {
"type": "string"
},
"points": {
@@ -72076,8 +71915,8 @@
}
},
"required": [
- "sessionId",
- "session",
+ "connectionId",
+ "connection",
"points"
]
},
@@ -72102,11 +71941,11 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
- "session": {
+ "connection": {
"type": "string"
},
"phoneNumber": {
@@ -72271,7 +72110,7 @@
"nullable": true,
"allOf": [
{
- "$ref": "#/components/schemas/BanSafeNumberEnforcement"
+ "$ref": "#/components/schemas/BanSafeConnectionEnforcement"
}
]
},
@@ -72314,8 +72153,8 @@
}
},
"required": [
- "sessionId",
- "session",
+ "connectionId",
+ "connection",
"phoneNumber",
"projectId",
"rung",
@@ -72352,11 +72191,11 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
- "session": {
+ "connection": {
"type": "string"
},
"rung": {
@@ -72391,8 +72230,8 @@
}
},
"required": [
- "sessionId",
- "session",
+ "connectionId",
+ "connection",
"rung",
"appealState",
"requestedAt",
@@ -72408,11 +72247,11 @@
"type": "string",
"format": "uuid"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
- "session": {
+ "connection": {
"type": "string"
},
"phoneNumber": {
@@ -72486,8 +72325,8 @@
},
"required": [
"id",
- "sessionId",
- "session",
+ "connectionId",
+ "connection",
"phoneNumber",
"projectId",
"kind",
@@ -72516,11 +72355,11 @@
"type": "boolean",
"description": "False when the same Idempotency-Key already recorded this report."
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
- "session": {
+ "connection": {
"type": "string"
},
"occurredAt": {
@@ -72531,8 +72370,8 @@
"required": [
"incidentId",
"created",
- "sessionId",
- "session",
+ "connectionId",
+ "connection",
"occurredAt"
]
},
@@ -72561,7 +72400,7 @@
},
"restrictedInWindow": {
"type": "boolean",
- "description": "Whether Polymorfa was restricting this number's sending inside the window."
+ "description": "Whether Polymorfa was restricting this connection's sending inside the window."
},
"criticalFindingDays": {
"type": "integer",
@@ -72570,7 +72409,7 @@
},
"sharedConnection": {
"type": "boolean",
- "description": "Whether this number shared its connection with numbers that were being restricted."
+ "description": "Whether this connection shared its method with connections that were being restricted."
},
"measuredHours": {
"type": "integer",
@@ -72579,11 +72418,11 @@
},
"simultaneousCalls": {
"type": "boolean",
- "description": "Whether simultaneous calls were on for this number inside the window. When true, Ban Credit does not cover the ban and the claim is denied when filed."
+ "description": "Whether simultaneous calls were on for this connection inside the window. When true, Ban Credit does not cover the ban and the claim is denied when filed."
},
"linkedDeviceInteractive": {
"type": "boolean",
- "description": "Whether this number sent an interactive message (buttons, lists, product messages, Flows and similar) from a linked device inside the window. When true, Ban Credit does not cover the ban and the claim is denied when filed. False can also mean not recorded: earlier claims report false, and sends before recording began are not backfilled."
+ "description": "Whether this connection sent an interactive message (buttons, lists, product messages, Flows and similar) from a linked device inside the window. When true, Ban Credit does not cover the ban and the claim is denied when filed. False can also mean not recorded: earlier claims report false, and sends before recording began are not backfilled."
}
},
"required": [
@@ -72611,11 +72450,11 @@
"type": "string",
"format": "uuid"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
},
- "session": {
+ "connection": {
"type": "string"
},
"phoneNumber": {
@@ -72660,7 +72499,7 @@
"type": "number",
"minimum": 0,
"multipleOf": 0.000001,
- "description": "Credit quantity this number consumed inside the window, with up to six decimal places."
+ "description": "Credit quantity this connection consumed inside the window, with up to six decimal places."
},
"capCents": {
"type": "number",
@@ -72701,8 +72540,8 @@
"required": [
"id",
"incidentId",
- "sessionId",
- "session",
+ "connectionId",
+ "connection",
"phoneNumber",
"projectId",
"status",
@@ -72754,7 +72593,7 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "session": {
+ "connection": {
"type": "string",
"minLength": 1,
"maxLength": 256
@@ -72769,7 +72608,7 @@
}
},
"required": [
- "session"
+ "connection"
]
},
"SafeModeSettings": {
@@ -72879,7 +72718,7 @@
"SafeModeApplied": {
"type": "object",
"additionalProperties": false,
- "description": "What the number itself last reported it is running. An observation, not a claim.",
+ "description": "What the connection itself last reported it is running. An observation, not a claim.",
"properties": {
"observedAt": {
"type": "string",
@@ -72938,13 +72777,13 @@
"entitlementReason"
]
},
- "SessionCapabilities": {
+ "ConnectionCapabilities": {
"type": "object",
"additionalProperties": false,
"properties": {
- "session": {
+ "connection": {
"type": "string",
- "description": "The session name."
+ "description": "The connection name."
},
"projectId": {
"type": "string",
@@ -72956,7 +72795,7 @@
"synced",
"unknown"
],
- "description": "`synced` when the values reflect WhatsApp's configuration for the account last linked to the number. `unknown` before the first sync, from the first sync attempt of another linked WhatsApp account until its configuration is synced, and when Polymorfa cannot tell whether the stored configuration belongs to the account linked now; every capability value is then null."
+ "description": "`synced` when the values reflect WhatsApp's configuration for the account last linked to the connection. `unknown` before the first sync, from the first sync attempt of another linked WhatsApp account until its configuration is synced, and when Polymorfa cannot tell whether the stored configuration belongs to the account linked now; every capability value is then null."
},
"syncedAt": {
"type": "string",
@@ -72968,7 +72807,7 @@
"type": "string",
"format": "date-time",
"nullable": true,
- "description": "When Polymorfa last asked WhatsApp for the number's configuration, whether or not anything changed. Null before the first request."
+ "description": "When Polymorfa last asked WhatsApp for the connection's configuration, whether or not anything changed. Null before the first request."
},
"accountType": {
"type": "string",
@@ -72985,12 +72824,12 @@
"maxItems": 100,
"description": "Every capability, always in the same order. Ignore keys your app does not recognize; new keys can be added.",
"items": {
- "$ref": "#/components/schemas/SessionCapability"
+ "$ref": "#/components/schemas/ConnectionCapability"
}
}
},
"required": [
- "session",
+ "connection",
"projectId",
"status",
"syncedAt",
@@ -72999,7 +72838,7 @@
"capabilities"
]
},
- "SessionCapability": {
+ "ConnectionCapability": {
"type": "object",
"additionalProperties": false,
"properties": {
@@ -73062,11 +72901,11 @@
"source"
]
},
- "SessionSafeMode": {
+ "ConnectionSafeMode": {
"type": "object",
"additionalProperties": false,
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
"projectId": {
@@ -73093,11 +72932,11 @@
},
"mismatch": {
"type": "boolean",
- "description": "True when the number reports something other than the policy in force."
+ "description": "True when the connection reports something other than the policy in force."
},
"entitled": {
"type": "boolean",
- "description": "Whether this number's plan includes BanSafe Lite, which Safe Mode is part of. When false, a request that raises a setting is refused."
+ "description": "Whether this connection's plan includes BanSafe Lite, which Safe Mode is part of. When false, a request that raises a setting is refused."
},
"entitlementReason": {
"type": "string",
@@ -73106,7 +72945,7 @@
}
},
"required": [
- "session",
+ "connection",
"projectId",
"project",
"override",
@@ -73166,7 +73005,7 @@
}
}
},
- "UpdateSessionSafeModeInput": {
+ "UpdateConnectionSafeModeInput": {
"type": "object",
"additionalProperties": false,
"description": "A partial update. `inherit` follows the project ceiling.",
@@ -73215,19 +73054,19 @@
"properties": {
"enabled": {
"type": "boolean",
- "description": "Whether every number in this project has a daily allowance."
+ "description": "Whether every connection in this project has a daily allowance."
},
"warmupDays": {
"type": "integer",
"minimum": 1,
"maximum": 90,
- "description": "Days the ramp takes to reach the per-number daily cap."
+ "description": "Days the ramp takes to reach the per-connection daily cap."
},
"dailyStart": {
"type": "integer",
"minimum": 1,
"maximum": 2000,
- "description": "Messages a number may send on its first day."
+ "description": "Messages a connection may send on its first day."
}
},
"required": [
@@ -73243,7 +73082,7 @@
"day": {
"type": "integer",
"minimum": 0,
- "description": "Days since the number's first proven activity."
+ "description": "Days since the connection's first proven activity."
},
"allowance": {
"type": "integer",
@@ -73270,7 +73109,7 @@
"ceiling": {
"type": "integer",
"minimum": 1,
- "description": "The per-number daily cap the ramp climbs to."
+ "description": "The per-connection daily cap the ramp climbs to."
},
"curve": {
"type": "array",
@@ -73278,7 +73117,7 @@
"items": {
"$ref": "#/components/schemas/WarmupCurvePoint"
},
- "description": "The projected allowance day by day for a number whose health is good. A number in a lower health band gets less."
+ "description": "The projected allowance day by day for a connection whose health is good. A connection in a lower health band gets less."
},
"entitled": {
"type": "boolean",
@@ -73359,7 +73198,7 @@
"maximum": 100,
"description": "Actions trigger only when an available health estimate is below this value."
},
- "sessionAction": {
+ "connectionAction": {
"type": "string",
"enum": [
"none",
@@ -73389,7 +73228,7 @@
"version",
"enabled",
"threshold",
- "sessionAction",
+ "connectionAction",
"slowDownMps",
"emailNotification",
"webhookNotification",
@@ -73412,7 +73251,7 @@
"minimum": 0,
"maximum": 100
},
- "sessionAction": {
+ "connectionAction": {
"type": "string",
"enum": [
"none",
@@ -73438,7 +73277,7 @@
"version",
"enabled",
"threshold",
- "sessionAction",
+ "connectionAction",
"slowDownMps",
"emailNotification",
"webhookNotification"
@@ -73696,7 +73535,7 @@
"minimum": 7,
"maximum": 13,
"default": 10,
- "description": "First day without the phone on which this endpoint receives session.phone_offline. WhatsApp signs the linked device out on day 14. On PATCH, omission preserves the stored value. To stop the warning, remove session.phone_offline from eventTypes."
+ "description": "First day without the phone on which this endpoint receives connection.phone_offline. WhatsApp signs the linked device out on day 14. On PATCH, omission preserves the stored value. To stop the warning, remove connection.phone_offline from eventTypes."
},
"headers": {
"type": "array",
@@ -73756,7 +73595,7 @@
"minimum": 7,
"maximum": 13,
"default": 10,
- "description": "First day without the phone on which this endpoint receives session.phone_offline. WhatsApp signs the linked device out on day 14. On PATCH, omission preserves the stored value. To stop the warning, remove session.phone_offline from eventTypes."
+ "description": "First day without the phone on which this endpoint receives connection.phone_offline. WhatsApp signs the linked device out on day 14. On PATCH, omission preserves the stored value. To stop the warning, remove connection.phone_offline from eventTypes."
},
"headers": {
"type": "array",
@@ -73813,7 +73652,7 @@
"type": "integer",
"minimum": 7,
"maximum": 13,
- "description": "First day without the phone on which this endpoint receives session.phone_offline. WhatsApp signs the linked device out on day 14. On PATCH, omission preserves the stored value. To stop the warning, remove session.phone_offline from eventTypes."
+ "description": "First day without the phone on which this endpoint receives connection.phone_offline. WhatsApp signs the linked device out on day 14. On PATCH, omission preserves the stored value. To stop the warning, remove connection.phone_offline from eventTypes."
},
"headers": {
"type": "array",
@@ -73867,7 +73706,7 @@
"type": "integer",
"minimum": 7,
"maximum": 13,
- "description": "First day without the phone on which this endpoint receives session.phone_offline. WhatsApp signs the linked device out on day 14. On PATCH, omission preserves the stored value. To stop the warning, remove session.phone_offline from eventTypes."
+ "description": "First day without the phone on which this endpoint receives connection.phone_offline. WhatsApp signs the linked device out on day 14. On PATCH, omission preserves the stored value. To stop the warning, remove connection.phone_offline from eventTypes."
},
"headers": {
"type": "array",
@@ -73952,7 +73791,7 @@
"type": "integer",
"minimum": 7,
"maximum": 13,
- "description": "First day without the phone on which this endpoint receives session.phone_offline."
+ "description": "First day without the phone on which this endpoint receives connection.phone_offline."
},
"headers": {
"type": "array",
@@ -74049,7 +73888,7 @@
"type": "integer",
"minimum": 7,
"maximum": 13,
- "description": "First day without the phone on which this endpoint receives session.phone_offline."
+ "description": "First day without the phone on which this endpoint receives connection.phone_offline."
},
"headers": {
"type": "array",
@@ -74576,7 +74415,7 @@
},
"route": {
"type": "string",
- "description": "Matched route pattern, for example `/messaging/:session/messages`. Path values are not included."
+ "description": "Matched route pattern, for example `/messaging/:connection/messages`. Path values are not included."
},
"status": {
"type": "integer",
@@ -75327,8 +75166,8 @@
"type": "string",
"enum": [
"auth_projection_repair",
- "session_lifecycle",
- "auth_session_purge",
+ "connection_lifecycle",
+ "auth_connection_purge",
"label_projection_purge",
"billing_reconciliation",
"auto_top_up",
@@ -75458,8 +75297,8 @@
"type": "string",
"enum": [
"auth_projection_repair",
- "session_lifecycle",
- "auth_session_purge",
+ "connection_lifecycle",
+ "auth_connection_purge",
"label_projection_purge",
"billing_reconciliation",
"auto_top_up",
@@ -75716,7 +75555,7 @@
"TestTeamWebhookInput": {
"type": "object",
"additionalProperties": false,
- "description": "A team webhook test accepts an optional event type. Supplied event bodies and session IDs are rejected with HTTP 400.",
+ "description": "A team webhook test accepts an optional event type. Supplied event bodies and connection IDs are rejected with HTTP 400.",
"properties": {
"eventType": {
"type": "string",
@@ -75750,14 +75589,14 @@
"body": {
"$ref": "#/components/schemas/EncodedEventPayload"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"body",
- "sessionId"
+ "connectionId"
]
}
]
@@ -76050,7 +75889,7 @@
"team",
"project",
"customer",
- "number"
+ "connection"
]
},
"id": {
@@ -76072,7 +75911,7 @@
"team",
"project",
"customer",
- "number"
+ "connection"
]
}
},
@@ -76260,7 +76099,7 @@
"code": {
"type": "string",
"enum": [
- "zero_knowledge_session",
+ "zero_knowledge_connection",
"invalid_parameter",
"invalid_credential",
"entitlement_required",
@@ -76311,7 +76150,7 @@
"order_status_transition_invalid",
"order_cancellation_failed",
"call_opt_out_limit",
- "number_restricted",
+ "connection_restricted",
"sip_trunk_in_use",
"sip_trunk_revision_conflict",
"sip_trunk_limit",
@@ -76329,7 +76168,7 @@
"upstream_failure",
"service_unavailable",
"credential_verification_unavailable",
- "session_not_ready",
+ "connection_not_ready",
"command_dispatch_failed",
"result_unknown",
"parent_bsuid_not_supported",
@@ -77325,15 +77164,15 @@
"PlatformAccessMintClientTokenRequest": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string",
"minLength": 1,
- "description": "ID of the session this token can access. Provide exactly one of `session` or `customer`."
+ "description": "ID of the connection this token can access. Provide exactly one of `connection` or `customer`."
},
"customer": {
"type": "string",
"format": "uuid",
- "description": "Polymorfa Customer ID. The token covers the numbers this Customer owns when it is minted, and only while the Customer still owns each one. Provide exactly one of `session` or `customer`. Requires the `customers:read` scope and enrollment in the Customer-scoped client tokens beta."
+ "description": "Polymorfa Customer ID. The token covers the connections this Customer owns when it is minted, and only while the Customer still owns each one. Provide exactly one of `connection` or `customer`. Requires the `customers:read` scope and enrollment in the Customer-scoped client tokens beta."
},
"allow": {
"type": "array",
@@ -77374,7 +77213,7 @@
},
"minItems": 0,
"maxItems": 30,
- "description": "Immutable action ceiling, intersected with live client rules. Session allow requires the action-ceilings beta. With ceiling issuance enabled, session omission snapshots its configured actions. For a Customer, omission uses the original Customer action set. An empty session allow grants no actions; Customer allow must be non-empty. Regional actions are reserved for enrolled beta access."
+ "description": "Immutable action ceiling, intersected with live client rules. Connection allow requires the action-ceilings beta. With ceiling issuance enabled, connection omission snapshots its configured actions. For a Customer, omission uses the original Customer action set. An empty connection allow grants no actions; Customer allow must be non-empty. Regional actions are reserved for enrolled beta access."
},
"ephemeralId": {
"type": "string",
@@ -77429,7 +77268,7 @@
},
"allowedNumber": {
"type": "string",
- "description": "Comma-separated E.164 numbers client tokens may call. Empty allows any number."
+ "description": "Comma-separated E.164 phone numbers client tokens may call. Empty allows any destination number."
},
"maxSetupsPerMinute": {
"type": "integer",
@@ -77446,7 +77285,7 @@
},
"enabled": {
"type": "boolean",
- "description": "Whether client tokens are accepted for this session."
+ "description": "Whether client tokens are accepted for this connection."
}
},
"required": [
@@ -77555,7 +77394,7 @@
"properties": {
"callsEnabled": {
"type": "boolean",
- "description": "Whether the session can place, answer and receive calls. When false, placing, answering, joining and attaching media fail with `403 calls_disabled`, incoming calls are declined, and SIP trunks cannot place calls through the session. Calls in progress continue, and the participant that answered or placed one can reconnect to it. Defaults to true."
+ "description": "Whether the connection can place, answer and receive calls. When false, placing, answering, joining and attaching media fail with `403 calls_disabled`, incoming calls are declined, and SIP trunks cannot place calls through the connection. Calls in progress continue, and the participant that answered or placed one can reconnect to it. Defaults to true."
},
"conferenceMode": {
"type": "boolean",
@@ -77576,28 +77415,28 @@
},
"hostCloudApiCalls": {
"type": "boolean",
- "description": "Whether Polymorfa Calls answers the session's incoming calls when the session uses the Cloud API. When false (the default), your app answers them through the Graph API `/calls` endpoint and Polymorfa Calls does not host them. Sessions on a linked device ignore it."
+ "description": "Whether Polymorfa Calls answers the connection's incoming calls when the connection uses the Cloud API. When false (the default), your app answers them through the Graph API `/calls` endpoint and Polymorfa Calls does not host them. Connections on a linked device ignore it."
},
"simultaneousCalls": {
"type": "boolean",
- "description": "Whether this Number may hold more than one call at a time, with no limit. Linked-device sessions only; Cloud API sessions ignore it. WhatsApp's own apps never hold two calls at once, so this behavior is unusual for WhatsApp, and it voids Ban Credit: a ban whose 30-day window overlaps any period this setting was on is not covered. Defaults to false."
+ "description": "Whether this Connection may hold more than one call at a time, with no limit. Linked-device connections only; Cloud API connections ignore it. WhatsApp's own apps never hold two calls at once, so this behavior is unusual for WhatsApp, and it voids Ban Credit: a ban whose 30-day window overlaps any period this setting was on is not covered. Defaults to false."
},
"simultaneousCallsCoverageExcludedUntil": {
"type": "string",
"nullable": true,
"format": "date-time",
- "description": "Read-only. While `simultaneousCalls` is false, when Ban Credit stops excluding this Number because of an earlier period with it on: 30 days after the latest period ended. A ban is excluded when the setting was on at any time in the 30 days before it, so until this time, a new ban is not covered; from this time on, that period no longer excludes a ban. Null while `simultaneousCalls` is true, because the exclusion has no end yet, and null when no period ended in the last 30 days. Null does not mean the Number is covered: the other Ban Credit conditions still apply."
+ "description": "Read-only. While `simultaneousCalls` is false, when Ban Credit stops excluding this Connection because of an earlier period with it on: 30 days after the latest period ended. A ban is excluded when the setting was on at any time in the 30 days before it, so until this time, a new ban is not covered; from this time on, that period no longer excludes a ban. Null while `simultaneousCalls` is true, because the exclusion has no end yet, and null when no period ended in the last 30 days. Null does not mean the Connection is covered: the other Ban Credit conditions still apply."
},
"revision": {
"type": "integer",
"minimum": 0,
- "description": "Increases on every change; 0 while the session uses the defaults. Send it as `expectedRevision` to refuse an update that would overwrite someone else's change."
+ "description": "Increases on every change; 0 while the connection uses the defaults. Send it as `expectedRevision` to refuse an update that would overwrite someone else's change."
},
"updatedAt": {
"type": "string",
"nullable": true,
"format": "date-time",
- "description": "When the settings were last changed, or null when the session uses the defaults."
+ "description": "When the settings were last changed, or null when the connection uses the defaults."
}
},
"required": [
@@ -77655,7 +77494,7 @@
"properties": {
"callsEnabled": {
"type": "boolean",
- "description": "Set to false to refuse new and incoming calls on the session; true allows them again."
+ "description": "Set to false to refuse new and incoming calls on the connection; true allows them again."
},
"conferenceMode": {
"type": "boolean",
@@ -77675,7 +77514,7 @@
"type": "string",
"nullable": true,
"format": "uuid",
- "description": "The SIP trunk for `sip_trunk`: a trunk in the session's project whose direction is `outbound` or `both`. Required when switching the route to `sip_trunk`; omit it to keep the stored trunk. With `clients` send `null` or omit it: a trunk ID is refused, and `clients` clears the stored trunk."
+ "description": "The SIP trunk for `sip_trunk`: a trunk in the connection's project whose direction is `outbound` or `both`. Required when switching the route to `sip_trunk`; omit it to keep the stored trunk. With `clients` send `null` or omit it: a trunk ID is refused, and `clients` clears the stored trunk."
},
"sipClaim": {
"type": "boolean",
@@ -77683,11 +77522,11 @@
},
"hostCloudApiCalls": {
"type": "boolean",
- "description": "Set to true to have Polymorfa Calls answer the session's Cloud API calls instead of your Graph API integration. Applies to calls that arrive after the change."
+ "description": "Set to true to have Polymorfa Calls answer the connection's Cloud API calls instead of your Graph API integration. Applies to calls that arrive after the change."
},
"simultaneousCalls": {
"type": "boolean",
- "description": "Set to true to let this Number hold more than one call at a time, with no limit. Turning it on requires a team API key and risk acknowledgement, using `acceptTerms`, a recorded current acceptance, or the original `acknowledgeRisk: true` alias; it voids Ban Credit for any ban whose 30-day window overlaps a period it was on. Set to false to return to one call at a time. Applies to calls that start after the change."
+ "description": "Set to true to let this Connection hold more than one call at a time, with no limit. Turning it on requires a team API key and risk acknowledgement, using `acceptTerms`, a recorded current acceptance, or the original `acknowledgeRisk: true` alias; it voids Ban Credit for any ban whose 30-day window overlaps a period it was on. Set to false to return to one call at a time. Applies to calls that start after the change."
},
"termsLocale": {
"type": "string",
@@ -77701,16 +77540,16 @@
"type": "string",
"minLength": 1,
"maxLength": 100,
- "description": "The published simultaneous-call terms version to accept for this Number. The original acknowledgeRisk: true remains an alias for simultaneous-calls-v1. Unpublished terms add no requirement."
+ "description": "The published simultaneous-call terms version to accept for this Connection. The original acknowledgeRisk: true remains an alias for simultaneous-calls-v1. Unpublished terms add no requirement."
},
"acknowledgeRisk": {
"type": "boolean",
- "description": "Confirms the original simultaneous-calls-v1 risk acknowledgement. A later published version requires acceptTerms or a recorded current acceptance. Confirms the unusual-behavior risk and loss of Ban Credit for this Number."
+ "description": "Confirms the original simultaneous-calls-v1 risk acknowledgement. A later published version requires acceptTerms or a recorded current acceptance. Confirms the unusual-behavior risk and loss of Ban Credit for this Connection."
},
"expectedRevision": {
"type": "integer",
"minimum": 0,
- "description": "Apply the update only if the settings still have this `revision` (0 for a session using the defaults). Otherwise the update fails with `409 state_conflict`."
+ "description": "Apply the update only if the settings still have this `revision` (0 for a connection using the defaults). Otherwise the update fails with `409 state_conflict`."
}
},
"additionalProperties": false
@@ -78066,10 +77905,10 @@
"type": "string",
"description": "Digest realm for `username`."
},
- "session": {
+ "connection": {
"type": "string",
"nullable": true,
- "description": "Session that places the WhatsApp calls your PBX sends, or null when none is set. Calls from the PBX are refused until a session is set."
+ "description": "Connection that places the WhatsApp calls your PBX sends, or null when none is set. Calls from the PBX are refused until a connection is set."
},
"allowedAddresses": {
"type": "array",
@@ -78089,7 +77928,7 @@
"required": [
"username",
"realm",
- "session",
+ "connection",
"allowedAddresses",
"allowedDestinations"
],
@@ -78293,12 +78132,12 @@
"PlatformAccessSipTrunkInboundInput": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 64,
- "description": "Session in the same project that places calls from your PBX."
+ "description": "Connection in the same project that places calls from your PBX."
},
"allowedAddresses": {
"type": "array",
@@ -78457,12 +78296,12 @@
"PlatformAccessSipTrunkInboundPatch": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 64,
- "description": "Session in the same project that places calls from your PBX."
+ "description": "Connection in the same project that places calls from your PBX."
},
"allowedAddresses": {
"type": "array",
@@ -79815,7 +79654,7 @@
"data"
]
},
- "PlatformAccessSessionConfigurationView": {
+ "PlatformAccessConnectionConfigurationView": {
"type": "object",
"properties": {
"requestedHistory": {
@@ -80022,7 +79861,7 @@
"enum": [
"descriptor"
],
- "description": "Polymorfa-Version 2026-10-14 and later. `descriptor` makes history.sync carry the chunk descriptor or inline payload; Polymorfa never downloads the chunk. Reset it to inherit the project or team delivery setting. Without an inherited choice, delivery is archive. Existing Numbers require confirmed cleanup before switching to descriptor delivery."
+ "description": "Polymorfa-Version 2026-10-14 and later. `descriptor` makes history.sync carry the chunk descriptor or inline payload; Polymorfa never downloads the chunk. Reset it to inherit the project or team delivery setting. Without an inherited choice, delivery is archive. Existing Connections require confirmed cleanup before switching to descriptor delivery."
}
},
"additionalProperties": false
@@ -80141,7 +79980,7 @@
"platform",
"team",
"project",
- "session"
+ "connection"
]
},
"observation.typingMode": {
@@ -80150,7 +79989,7 @@
"platform",
"team",
"project",
- "session"
+ "connection"
]
},
"observation.labelMode": {
@@ -80159,7 +79998,7 @@
"platform",
"team",
"project",
- "session"
+ "connection"
]
},
"observation.quickReplyMode": {
@@ -80168,7 +80007,7 @@
"platform",
"team",
"project",
- "session"
+ "connection"
]
},
"historySync.mode": {
@@ -80177,7 +80016,7 @@
"platform",
"team",
"project",
- "session",
+ "connection",
"consent"
]
},
@@ -80187,7 +80026,7 @@
"platform",
"team",
"project",
- "session",
+ "connection",
"consent"
]
},
@@ -80197,7 +80036,7 @@
"platform",
"team",
"project",
- "session"
+ "connection"
]
},
"hms": {
@@ -80206,7 +80045,7 @@
"platform",
"team",
"project",
- "session"
+ "connection"
]
}
},
@@ -80232,7 +80071,7 @@
"type": "integer",
"minimum": 0
},
- "session": {
+ "connection": {
"type": "integer",
"minimum": 0
}
@@ -80240,7 +80079,7 @@
"required": [
"team",
"project",
- "session"
+ "connection"
],
"additionalProperties": false
},
@@ -80287,11 +80126,11 @@
"enabled": {
"type": "boolean",
"nullable": true,
- "description": "Whether WhatsApp enabled its new-chat cap for this number. WhatsApp decides this per number; `false` means no cap applies. `null` means WhatsApp's configuration for this number could not be read to a decision, and Polymorfa does not pace to a cap."
+ "description": "Whether WhatsApp enabled its new-chat cap for this connection. WhatsApp decides this per connection; `false` means no cap applies. `null` means WhatsApp's configuration for this connection could not be read to a decision, and Polymorfa does not pace to a cap."
},
"pacing": {
"type": "boolean",
- "description": "Whether Polymorfa is holding back sends that would start a new chat while the number is capped. True only when `enabled` is true."
+ "description": "Whether Polymorfa is holding back sends that would start a new chat while the connection is capped. True only when `enabled` is true."
},
"status": {
"type": "string",
@@ -80303,18 +80142,18 @@
"capped",
null
],
- "description": "The number's cap status as WhatsApp last reported it: `none`, `first_warning`, `second_warning` or `capped`. `null` until WhatsApp reported one. Reads `none` once the reported cycle has ended.",
+ "description": "The connection's cap status as WhatsApp last reported it: `none`, `first_warning`, `second_warning` or `capped`. `null` until WhatsApp reported one. Reads `none` once the reported cycle has ended.",
"example": "first_warning"
},
"capped": {
"type": "boolean",
- "description": "True while WhatsApp reports the number capped and Polymorfa paces it (`pacing` is true), until `resetsAt`. New-chat sends are then held back; messages to existing chats still send."
+ "description": "True while WhatsApp reports the connection capped and Polymorfa paces it (`pacing` is true), until `resetsAt`. New-chat sends are then held back; messages to existing chats still send."
},
"limit": {
"type": "integer",
"nullable": true,
"minimum": 0,
- "description": "New chats the number may start in the current cycle, as WhatsApp reported it.",
+ "description": "New chats the connection may start in the current cycle, as WhatsApp reported it.",
"example": 50
},
"used": {
@@ -80339,7 +80178,7 @@
"resetsAt": {
"type": "string",
"nullable": true,
- "description": "ISO 8601 end of the current cycle as WhatsApp reported it. While Polymorfa holds a number that WhatsApp rejected for a new chat without reporting a cycle, the end of that one-hour hold."
+ "description": "ISO 8601 end of the current cycle as WhatsApp reported it. While Polymorfa holds a connection that WhatsApp rejected for a new chat without reporting a cycle, the end of that one-hour hold."
},
"observedAt": {
"type": "string",
@@ -80358,14 +80197,14 @@
"resetsAt",
"observedAt"
],
- "description": "WhatsApp's new-chat cap for this linked-device number. Returned by Get session only. `null` when Polymorfa has not observed the number's configuration yet."
+ "description": "WhatsApp's new-chat cap for this linked-device connection. Returned by Get connection only. `null` when Polymorfa has not observed the connection's configuration yet."
},
"PlatformAccessInspectorClaimState": {
"type": "object",
"properties": {
"claimed": {
"type": "boolean",
- "description": "Whether a team member has claimed this Number in Inspector."
+ "description": "Whether a team member has claimed this Connection in Inspector."
},
"claimedAt": {
"type": "string",
@@ -80378,9 +80217,9 @@
"claimed",
"claimedAt"
],
- "description": "Whether a team member has claimed this Number in Inspector. The claimant's identity is not included."
+ "description": "Whether a team member has claimed this Connection in Inspector. The claimant's identity is not included."
},
- "PlatformAccessSession": {
+ "PlatformAccessConnection": {
"type": "object",
"properties": {
"signalMode": {
@@ -80391,32 +80230,42 @@
],
"description": "Immutable Signal key custody selected before pairing. Customer-owned custody is a gated beta for real Linked Devices."
},
- "sessionId": {
+ "connectionId": {
"type": "string",
- "description": "Session ID. Use it to address this session in Platform and Messaging requests."
+ "description": "Connection ID. Use it to address this connection in Platform and Messaging requests."
},
"name": {
"type": "string",
- "description": "Display label, or the session identifier when no label is set."
+ "description": "Display label, or the connection identifier when no label is set."
},
"externalId": {
"type": "string",
- "description": "Integrator correlation supplied when creating the QuickLink for this session."
+ "description": "Integrator correlation supplied when creating the QuickLink for this connection."
},
"tenantId": {
"type": "string"
},
"type": {
+ "type": "string",
+ "enum": [
+ "whatsapp"
+ ]
+ },
+ "phoneNumberId": {
+ "type": "string"
+ },
+ "method": {
"type": "string",
"enum": [
"linked_device",
- "cloud_api"
+ "cloud_api",
+ "hybrid"
],
- "description": "How the session connects to WhatsApp. 'linked_device' pairs as a WhatsApp linked device; 'cloud_api' uses the Meta Cloud API. Immutable after create."
+ "description": "The connection's method: 'linked_device' pairs as a WhatsApp linked device; 'cloud_api' uses the Meta Cloud API; 'hybrid' combines both methods in one Connection."
},
"testMode": {
"type": "boolean",
- "description": "Whether this session was created as a simulated testing number."
+ "description": "Whether this connection was created as a simulated testing connection."
},
"status": {
"type": "string",
@@ -80426,7 +80275,7 @@
"type": "string"
},
"configuration": {
- "$ref": "#/components/schemas/PlatformAccessSessionConfigurationView"
+ "$ref": "#/components/schemas/PlatformAccessConnectionConfigurationView"
},
"newChatCapping": {
"$ref": "#/components/schemas/PlatformAccessNewChatCapping"
@@ -80441,7 +80290,7 @@
"required": [
"claim"
],
- "description": "Inspector state for this Number. Returned by Get session only."
+ "description": "Inspector state for this Connection. Returned by Get connection only."
},
"createdAt": {
"type": "string"
@@ -80451,17 +80300,18 @@
}
},
"required": [
- "sessionId",
+ "connectionId",
"name",
"tenantId",
"type",
+ "method",
"testMode",
"status",
"createdAt",
"updatedAt"
]
},
- "PlatformAccessGetSessionResponse": {
+ "PlatformAccessGetConnectionResponse": {
"type": "object",
"properties": {
"success": {
@@ -80471,7 +80321,7 @@
]
},
"data": {
- "$ref": "#/components/schemas/PlatformAccessSession"
+ "$ref": "#/components/schemas/PlatformAccessConnection"
}
},
"required": [
@@ -80479,7 +80329,7 @@
"data"
]
},
- "PlatformAccessUpdateSessionResponse": {
+ "PlatformAccessUpdateConnectionResponse": {
"type": "object",
"properties": {
"success": {
@@ -80489,7 +80339,7 @@
]
},
"data": {
- "$ref": "#/components/schemas/PlatformAccessSession"
+ "$ref": "#/components/schemas/PlatformAccessConnection"
}
},
"required": [
@@ -80497,7 +80347,7 @@
"data"
]
},
- "PlatformAccessUpdateSessionRequest": {
+ "PlatformAccessUpdateConnectionRequest": {
"type": "object",
"properties": {
"configuration": {
@@ -80524,7 +80374,7 @@
"enum": [
"descriptor"
],
- "description": "Polymorfa-Version 2026-10-14 and later. `descriptor` makes history.sync carry the chunk descriptor or inline payload; Polymorfa never downloads the chunk. Reset it to inherit the project or team delivery setting. Without an inherited choice, delivery is archive. Existing Numbers require confirmed cleanup before switching to descriptor delivery."
+ "description": "Polymorfa-Version 2026-10-14 and later. `descriptor` makes history.sync carry the chunk descriptor or inline payload; Polymorfa never downloads the chunk. Reset it to inherit the project or team delivery setting. Without an inherited choice, delivery is archive. Existing Connections require confirmed cleanup before switching to descriptor delivery."
}
},
"additionalProperties": false
@@ -80724,7 +80574,7 @@
"x-enumDescriptions": {
"android": "WhatsApp or WhatsApp Business on an Android phone.",
"ios": "WhatsApp or WhatsApp Business on an iPhone.",
- "meta_cloud": "Meta hosts the number through Cloud API.",
+ "meta_cloud": "Meta hosts the connection through Cloud API.",
"unknown": "The phone has not reported a recognized platform."
}
},
@@ -80752,7 +80602,7 @@
"pushName"
]
},
- "PlatformAccessGetSessionAccountResponse": {
+ "PlatformAccessGetConnectionAccountResponse": {
"type": "object",
"properties": {
"success": {
@@ -80900,7 +80750,7 @@
"enum": [
"passthrough_plus"
],
- "description": "When set, atomically flips sessions.config.bartenderMode → passthrough_plus after the keys persist. Eliminates the window where mode is set but no keys are staged."
+ "description": "When set, atomically flips connections.config.bartenderMode → passthrough_plus after the keys persist. Eliminates the window where mode is set but no keys are staged."
}
},
"required": [
@@ -80972,9 +80822,9 @@
"callId": {
"type": "string"
},
- "sessionId": {
+ "connectionId": {
"type": "string",
- "description": "Session name."
+ "description": "Connection name."
},
"projectId": {
"type": "string",
@@ -81004,7 +80854,7 @@
},
"backend": {
"type": "string",
- "description": "How the number reaches WhatsApp for this call."
+ "description": "How the connection reaches WhatsApp for this call."
},
"hasVideo": {
"type": "boolean"
@@ -81053,7 +80903,7 @@
},
"required": [
"callId",
- "sessionId",
+ "connectionId",
"projectId",
"direction",
"state",
@@ -81239,7 +81089,7 @@
"appReports": {
"type": "object",
"additionalProperties": false,
- "description": "Diagnostics your app sent with `POST /messaging/voip/calls/{id}/reports`, by connection. Figures the app did not report are null.",
+ "description": "Diagnostics your app sent with `POST /messaging/voip/calls/{id}/reports`, by method. Figures the app did not report are null.",
"properties": {
"status": {
"type": "string",
@@ -81268,7 +81118,7 @@
"type": "object",
"nullable": true,
"additionalProperties": false,
- "description": "The SDK named by the connection's most recent report. Null when that report named none.",
+ "description": "The SDK named by the method's most recent report. Null when that report named none.",
"properties": {
"sdk": {
"type": "string",
@@ -81297,7 +81147,7 @@
"type": "object",
"nullable": true,
"additionalProperties": false,
- "description": "The connection's latest quality report. Null when it sent none.",
+ "description": "The method's latest quality report. Null when it sent none.",
"properties": {
"reportedAt": {
"type": "string",
@@ -81406,7 +81256,7 @@
},
"required": [
"status",
- "connections",
+ "methods",
"truncated"
]
},
@@ -81456,20 +81306,20 @@
"callId": {
"type": "string"
},
- "sessionId": {
+ "connectionId": {
"type": "string"
}
},
"required": [
"callId",
- "sessionId"
+ "connectionId"
]
}
},
"required": [
"call",
"participants",
- "connections",
+ "methods",
"telemetry",
"appReports",
"history",
@@ -81749,7 +81599,7 @@
"error": {
"type": "billing_error",
"code": "billing_credit_required",
- "message": "Credit is unavailable for this number. Add credit or review team billing.",
+ "message": "Credit is unavailable for this connection. Add credit or review team billing.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -81760,7 +81610,7 @@
}
},
"CampaignsNotEntitled": {
- "description": "`campaigns_not_entitled`: a sending number is missing or its plan does not include Campaigns.",
+ "description": "`campaigns_not_entitled`: a sending connection is missing or its plan does not include Campaigns.",
"headers": {
"X-Request-Id": {
"schema": {
@@ -81791,7 +81641,7 @@
"error": {
"type": "billing_error",
"code": "campaigns_not_entitled",
- "message": "This number’s plan does not include Campaigns.",
+ "message": "This connection’s plan does not include Campaigns.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -81802,7 +81652,7 @@
}
},
"SafeModeNotEntitled": {
- "description": "`safe_mode_not_entitled`: Safe Mode is part of BanSafe Lite, which is not included on this number's plan. Lowering a setting always works.",
+ "description": "`safe_mode_not_entitled`: Safe Mode is part of BanSafe Lite, which is not included on this connection's plan. Lowering a setting always works.",
"headers": {
"X-Request-Id": {
"schema": {
@@ -81833,7 +81683,7 @@
"error": {
"type": "billing_error",
"code": "safe_mode_not_entitled",
- "message": "Safe Mode is not included on this number’s plan.",
+ "message": "Safe Mode is not included on this connection’s plan.",
"param": null,
"request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
},
@@ -82054,7 +81904,7 @@
}
},
"SendPathUnavailable": {
- "description": "The send path is unavailable or the sending number is not ready (`session_not_ready`, `command_dispatch_failed`, `service_unavailable`, or `bansafe_accounting_unavailable`). No message was sent.",
+ "description": "The send path is unavailable or the sending connection is not ready (`connection_not_ready`, `command_dispatch_failed`, `service_unavailable`, or `bansafe_accounting_unavailable`). No message was sent.",
"headers": {
"X-Request-Id": {
"schema": {
@@ -82085,7 +81935,7 @@
}
},
"CampaignEligibilityUnavailable": {
- "description": "`service_unavailable`: the selected numbers' plans could not be checked. Nothing was launched or saved; retry the request.",
+ "description": "`service_unavailable`: the selected connections' plans could not be checked. Nothing was launched or saved; retry the request.",
"headers": {
"X-Request-Id": {
"schema": {
@@ -82116,7 +81966,7 @@
}
},
"InspectorClaimReleaseUnavailable": {
- "description": "`service_unavailable`: the claimant's Inspector device could not be removed, so the Number is still claimed. Nothing changed. Retry after `Retry-After` seconds; repeating the request is safe.",
+ "description": "`service_unavailable`: the claimant's Inspector device could not be removed, so the Connection is still claimed. Nothing changed. Retry after `Retry-After` seconds; repeating the request is safe.",
"headers": {
"X-Request-Id": {
"schema": {
@@ -82185,7 +82035,7 @@
}
},
"PropagationPending": {
- "description": "The change was stored, but a connected number has not confirmed it. Retry the request; the stored setting is already correct and is retried automatically.",
+ "description": "The change was stored, but a connected connection has not confirmed it. Retry the request; the stored setting is already correct and is retried automatically.",
"headers": {
"X-Request-Id": {
"schema": {
@@ -82309,7 +82159,7 @@
}
},
"CampaignLaunchConflict": {
- "description": "`campaign_approval_required`: the launch is held for a team owner or admin and nothing was sent; the message names the approval request. `state_conflict`: the campaign is not a draft, is already launched and waiting for its start, its sending numbers or audience changed during launch, or segment evaluation exceeded its time limit (simplify the rules and retry). A launched campaign whose segment was deleted cannot be launched again.",
+ "description": "`campaign_approval_required`: the launch is held for a team owner or admin and nothing was sent; the message names the approval request. `state_conflict`: the campaign is not a draft, is already launched and waiting for its start, its sending connections or audience changed during launch, or segment evaluation exceeded its time limit (simplify the rules and retry). A launched campaign whose segment was deleted cannot be launched again.",
"headers": {
"X-Request-Id": {
"schema": {
@@ -82433,7 +82283,7 @@
}
},
"BanSafeIncidentKeyReused": {
- "description": "`bansafe_incident_idempotency_scope_conflict`: this key was already used to report a different number. Use a different key only for a different report.",
+ "description": "`bansafe_incident_idempotency_scope_conflict`: this key was already used to report a different connection. Use a different key only for a different report.",
"headers": {
"X-Request-Id": {
"schema": {
@@ -82501,7 +82351,7 @@
}
},
"InternalError": {
- "description": "The session-control publisher or testing-number persistence path is temporarily unavailable.",
+ "description": "The connection-control publisher or testing-connection persistence path is temporarily unavailable.",
"headers": {
"X-Request-Id": {
"schema": {
diff --git a/contracts/source.json b/contracts/source.json
index c5a16b8e3..b1a559ed3 100644
--- a/contracts/source.json
+++ b/contracts/source.json
@@ -1,19 +1,19 @@
{
"repository": "polymorfa/polymorfa",
- "commit": "f180dc1ee2bd45dbecf01702f73bdd75c664634b",
- "branch": "recovery/org-team-backend-20261028",
- "published": true,
- "note": "Full Messaging and Platform snapshots are byte-identical copies of the API specifications at polymorfa/polymorfa#887 pushed head f180dc1ee2 (contract revision f180dc1ee2). That head includes the team rename and later dev changes. SDK publication and API deployment remain separate gates.",
+ "commit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
+ "branch": "rajeh/connection-rename-backend",
+ "published": false,
+ "note": "Breaking Connection source candidate at held API date 2026-09-22. Exact committed producer snapshots; no source merge, deployed API acceptance or package publication is inferred. Nightly/stable release gates remain closed until matching staging/production acceptance.",
"contracts": {
"messaging": {
"sourcePath": "apps/api/docs/openapi.json",
"snapshotPath": "contracts/openapi.messaging.json",
- "sha256": "0c66f1ee93923cf57425ac29c01a84c5c140b703ace2160e1b899ee6dad0b071"
+ "sha256": "e84c7ff814c6b59ca7f32c3fda1aedbed3f672e728910adb883f0aa8c6cf3ab7"
},
"platform": {
"sourcePath": "apps/api/docs/openapi.management.json",
"snapshotPath": "contracts/openapi.platform.json",
- "sha256": "bee9be6cc08d2ec78f5eb5e05135bea3751f93af917b8dd6983b26029feac485"
+ "sha256": "e09ed3e8aa24e4f56fc64223ea3e54a9d603cdc533173ac0920a9d14f61be559"
}
}
}
diff --git a/contracts/testing-events.json b/contracts/testing-events.json
index a6ea5793b..230680f66 100644
--- a/contracts/testing-events.json
+++ b/contracts/testing-events.json
@@ -1,12 +1,218 @@
{
"repository": "polymorfa/polymorfa",
- "commit": "f180dc1ee2bd45dbecf01702f73bdd75c664634b",
+ "commit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
"sourcePath": "apps/api/docs/openapi.json",
- "sourceSha256": "0c66f1ee93923cf57425ac29c01a84c5c140b703ace2160e1b899ee6dad0b071",
+ "sourceSha256": "e84c7ff814c6b59ca7f32c3fda1aedbed3f672e728910adb883f0aa8c6cf3ab7",
+ "schemas": {
+ "TestEventFixtureList": {
+ "type": "object",
+ "properties": {
+ "fixtures": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "enum": [
+ "message.received",
+ "message.ack",
+ "message.failed",
+ "call.received",
+ "call.missed",
+ "call.ended",
+ "connection.status",
+ "connection.restriction_updated",
+ "template.status"
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "overrides": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": ["name", "description", "overrides"]
+ }
+ }
+ },
+ "required": ["fixtures"]
+ },
+ "TriggerTestEventRequest": {
+ "type": "object",
+ "properties": {
+ "event": {
+ "type": "string",
+ "enum": [
+ "message.received",
+ "message.ack",
+ "message.failed",
+ "call.received",
+ "call.missed",
+ "call.ended",
+ "connection.status",
+ "connection.restriction_updated",
+ "template.status"
+ ],
+ "description": "Fixture name. Each name is the event type it produces."
+ },
+ "overrides": {
+ "$ref": "#/schemas/TestEventOverrides"
+ },
+ "fromConnection": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "description": "message.received only. Send a simulated text message from this other connected Test connection in the same project instead of generating an event."
+ }
+ },
+ "required": ["event"],
+ "additionalProperties": false
+ },
+ "TriggerTestEventResponse": {
+ "type": "object",
+ "properties": {
+ "event": {
+ "type": "string",
+ "enum": [
+ "message.received",
+ "message.ack",
+ "message.failed",
+ "call.received",
+ "call.missed",
+ "call.ended",
+ "connection.status",
+ "connection.restriction_updated",
+ "template.status"
+ ]
+ },
+ "connection": {
+ "type": "string"
+ },
+ "delivery": {
+ "type": "string",
+ "enum": ["generated", "simulated"]
+ },
+ "eventId": {
+ "type": "string",
+ "nullable": true,
+ "format": "uuid"
+ },
+ "source": {
+ "type": "string",
+ "enum": ["test", "runtime"]
+ }
+ },
+ "required": ["event", "connection", "delivery", "eventId", "source"]
+ },
+ "TestEventOverrides": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4096
+ },
+ "from": {
+ "type": "string",
+ "pattern": "^\\+[1-9]\\d{7,14}$"
+ },
+ "pushName": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 64
+ },
+ "mediaType": {
+ "type": "string",
+ "enum": ["image", "video", "audio", "document", "sticker"]
+ },
+ "caption": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "ackStatus": {
+ "type": "string",
+ "enum": ["delivered", "read", "played", "error"]
+ },
+ "messageId": {
+ "type": "string",
+ "pattern": "^[1-9][0-9]{0,18}$"
+ },
+ "failureReason": {
+ "type": "string",
+ "enum": [
+ "invalid_recipient",
+ "connection_not_connected",
+ "ack_timeout",
+ "send_failed",
+ "blocked_by_safety"
+ ]
+ },
+ "video": {
+ "type": "boolean"
+ },
+ "durationSeconds": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 86400
+ },
+ "callEndReason": {
+ "type": "string",
+ "enum": [
+ "user_hangup",
+ "timeout",
+ "lost_connection",
+ "rejected",
+ "call_restricted"
+ ]
+ },
+ "restrictionActive": {
+ "type": "boolean"
+ },
+ "status": {
+ "type": "string",
+ "enum": ["CONNECTING", "CONNECTED", "DISCONNECTED"]
+ },
+ "statusReason": {
+ "type": "string",
+ "enum": [
+ "SCAN_QR",
+ "AUTO_RECONNECT",
+ "FAILED",
+ "MANUAL_STOP",
+ "QR_TIMEOUT",
+ "LOGGED_OUT",
+ "TEMPORARY_BAN",
+ "STREAM_ERROR"
+ ]
+ },
+ "templateName": {
+ "type": "string",
+ "pattern": "^[a-z0-9_]{1,512}$"
+ },
+ "templateStatus": {
+ "type": "string",
+ "enum": ["APPROVED", "REJECTED"]
+ },
+ "reason": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256
+ }
+ },
+ "additionalProperties": false
+ }
+ },
+ "published": false,
"operations": {
"triggerTestEvent": {
"method": "POST",
- "path": "/messaging/{session}/test-events",
+ "path": "/messaging/{connection}/test-events",
"operation": {
"operationId": "triggerTestEvent",
"tags": ["Testing"],
@@ -15,7 +221,7 @@
"BearerAuth": []
}
],
- "summary": "Trigger a test event for a Test number",
+ "summary": "Trigger a test event for a Test connection",
"x-required-scope": "sandbox:write",
"parameters": [
{
@@ -23,10 +229,10 @@
"type": "string",
"minLength": 1,
"maxLength": 128,
- "description": "Test Number ID."
+ "description": "Test Connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -45,7 +251,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/TriggerTestEventRequest"
+ "$ref": "#/components/schemas/TriggerTestEventRequest"
}
}
}
@@ -56,7 +262,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/TriggerTestEventResponse"
+ "$ref": "#/components/schemas/TriggerTestEventResponse"
}
}
},
@@ -88,7 +294,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -105,7 +311,7 @@
}
},
"403": {
- "description": "Test numbers access required, or a client token was used",
+ "description": "Test connections access required, or a client token was used",
"headers": {
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
@@ -120,7 +326,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -152,7 +358,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -184,7 +390,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -216,7 +422,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -233,9 +439,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sandbox:write "
- },
"x-protocols": ["Linked Device API"],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `sandbox:write`"
}
@@ -259,7 +462,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/TestEventFixtureList"
+ "$ref": "#/components/schemas/TestEventFixtureList"
}
}
},
@@ -291,7 +494,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -308,384 +511,388 @@
}
}
},
- "x-mint": {
- "content": "sandbox:read "
- },
"description": "**Required scope:** `sandbox:read`"
}
}
},
- "schemas": {
- "TriggerTestEventRequest": {
- "type": "object",
- "properties": {
- "event": {
- "type": "string",
- "enum": [
- "message.received",
- "message.ack",
- "message.failed",
- "call.received",
- "call.missed",
- "call.ended",
- "session.status",
- "session.restriction_updated",
- "template.status"
- ],
- "description": "Fixture name. Each name is the event type it produces."
- },
- "overrides": {
- "$ref": "#/schemas/TestEventOverrides"
- },
- "fromNumber": {
- "type": "string",
- "minLength": 1,
- "maxLength": 128,
- "description": "message.received only. Send a simulated text message from this other connected Test number in the same project instead of generating an event."
- }
- },
- "required": ["event"],
- "additionalProperties": false
- },
- "TestEventOverrides": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string",
- "minLength": 1,
- "maxLength": 4096
- },
- "from": {
- "type": "string",
- "pattern": "^\\+[1-9]\\d{7,14}$"
- },
- "pushName": {
- "type": "string",
- "minLength": 1,
- "maxLength": 64
- },
- "mediaType": {
- "type": "string",
- "enum": ["image", "video", "audio", "document", "sticker"]
- },
- "caption": {
- "type": "string",
- "minLength": 1,
- "maxLength": 1024
- },
- "ackStatus": {
- "type": "string",
- "enum": ["delivered", "read", "played", "error"]
- },
- "messageId": {
- "type": "string",
- "pattern": "^[1-9][0-9]{0,18}$"
- },
- "failureReason": {
- "type": "string",
- "enum": [
- "invalid_recipient",
- "session_not_connected",
- "ack_timeout",
- "send_failed",
- "blocked_by_safety"
- ]
- },
- "video": {
- "type": "boolean"
- },
- "durationSeconds": {
- "type": "integer",
- "minimum": 0,
- "maximum": 86400
- },
- "callEndReason": {
- "type": "string",
- "enum": [
- "user_hangup",
- "timeout",
- "lost_connection",
- "rejected",
- "call_restricted"
- ]
- },
- "restrictionActive": {
- "type": "boolean"
- },
- "status": {
- "type": "string",
- "enum": ["CONNECTING", "CONNECTED", "DISCONNECTED"]
- },
- "statusReason": {
- "type": "string",
- "enum": [
- "SCAN_QR",
- "AUTO_RECONNECT",
- "FAILED",
- "MANUAL_STOP",
- "QR_TIMEOUT",
- "LOGGED_OUT",
- "TEMPORARY_BAN",
- "STREAM_ERROR"
- ]
- },
- "templateName": {
- "type": "string",
- "pattern": "^[a-z0-9_]{1,512}$"
- },
- "templateStatus": {
- "type": "string",
- "enum": ["APPROVED", "REJECTED"]
- },
- "reason": {
- "type": "string",
- "minLength": 1,
- "maxLength": 256
- }
- },
- "additionalProperties": false
- },
- "TriggerTestEventResponse": {
- "type": "object",
- "properties": {
- "event": {
- "type": "string",
- "enum": [
- "message.received",
- "message.ack",
- "message.failed",
- "call.received",
- "call.missed",
- "call.ended",
- "session.status",
- "session.restriction_updated",
- "template.status"
- ]
- },
- "session": {
- "type": "string"
- },
- "delivery": {
- "type": "string",
- "enum": ["generated", "simulated"]
- },
- "eventId": {
- "type": "string",
- "nullable": true,
- "format": "uuid"
- },
- "source": {
- "type": "string",
- "enum": ["test", "runtime"]
- }
- },
- "required": ["event", "session", "delivery", "eventId", "source"]
- },
- "PublicError": {
- "type": "object",
- "properties": {
- "error": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "invalid_request_error",
- "authentication_error",
- "permission_error",
- "billing_error",
- "conflict_error",
- "rate_limit_error",
- "api_error",
- "upstream_error"
- ]
- },
- "code": {
- "type": "string",
- "enum": [
- "zero_knowledge_session",
- "invalid_parameter",
- "invalid_credential",
- "entitlement_required",
- "cloud_template_authority_restricted",
- "gate_limit_reached",
- "billing_credit_required",
- "addon_required",
- "safe_mode_not_entitled",
- "warmup_plan_not_entitled",
- "method_not_allowed",
- "permission_denied",
- "missing_scope",
- "resource_not_found",
- "hms_not_enabled",
- "media_fetch_failed",
- "resource_gone",
- "feature_unavailable",
- "stream_cursor_invalid",
- "stream_cursor_expired",
- "stream_connection_limit_reached",
- "state_conflict",
- "team_deletion_scheduled",
- "hybrid_routing_paused",
- "hybrid_choice_required",
- "hybrid_transition_ineligible",
- "hybrid_automation_unavailable",
- "hybrid_group_linked_devices_unavailable",
- "hybrid_transport_unavailable",
- "hybrid_target_reference_unavailable",
- "send_outcome_unknown",
- "terms_acceptance_required",
- "terms_activation_blocked",
- "idempotency_conflict",
- "idempotency_in_progress",
- "idempotency_outcome_unknown",
- "idempotency_replay_unavailable",
- "call_claimed",
- "call_not_ringing",
- "connection_limit",
- "unsupported_for_connection",
- "call_permission_required",
- "invalid_sip_trunk",
- "calls_disabled",
- "call_recipient_opted_out",
- "call_destination_blocked",
- "call_permission_request_limited",
- "call_permission_granted",
- "order_status_transition_invalid",
- "order_cancellation_failed",
- "call_opt_out_limit",
- "number_restricted",
- "sip_trunk_in_use",
- "sip_trunk_revision_conflict",
- "sip_trunk_limit",
- "sip_unavailable",
- "voice_not_enabled",
- "provider_credential_invalid",
- "provider_unavailable",
- "asset_not_ready",
- "voice_asset_in_use",
- "voice_asset_revision_conflict",
- "voice_unavailable",
- "rate_limit_exceeded",
- "internal_error",
- "operation_not_supported",
- "upstream_failure",
- "service_unavailable",
- "credential_verification_unavailable",
- "session_not_ready",
- "command_dispatch_failed",
- "result_unknown",
- "parent_bsuid_not_supported",
- "recipient_not_on_whatsapp",
- "conversation_window_closed",
- "template_not_approved",
- "media_too_large",
- "whatsapp_rate_limited",
- "new_chat_limit_reached",
- "marketing_disabled_on_cloud_api",
- "whatsapp_account_restricted",
- "whatsapp_authorization_required",
- "whatsapp_payment_method_required",
- "whatsapp_number_not_registered",
- "whatsapp_groups_ineligible",
- "whatsapp_group_creation_paused",
- "whatsapp_group_limit_reached",
- "whatsapp_group_full",
- "whatsapp_group_suspended",
- "whatsapp_group_has_no_participants",
- "bansafe_suspended",
- "bansafe_team_suspended",
- "bansafe_cold_blocked",
- "bansafe_cold_held",
- "bansafe_throttled",
- "bansafe_daily_allowance_reached",
- "bansafe_accounting_unavailable",
- "bansafe_send_outcome_unknown",
- "campaigns_not_entitled",
- "campaign_throughput_capped",
- "campaign_approval_required",
- "campaign_approval_stale",
- "campaign_variables_missing"
- ]
- },
- "message": {
- "type": "string"
- },
- "param": {
- "type": "string",
- "nullable": true
- },
- "request_id": {
- "type": "string",
- "description": "Matches the X-Request-Id response header. Include it when you contact support."
- },
- "request_log_url": {
- "type": "string",
- "format": "uri",
- "description": "Console page that shows this request. Returned only to team and project credentials whose request was logged."
- }
- },
- "required": ["type", "code", "message", "param", "request_id"]
- },
- "data": {
- "type": "string",
- "nullable": true,
- "enum": [null],
- "description": "Always null for a failed request."
- },
- "docs": {
- "type": "string",
- "format": "uri"
- }
- },
- "required": ["error", "data", "docs"]
+ "components": {
+ "securitySchemes": {
+ "BearerAuth": {
+ "type": "http",
+ "scheme": "bearer",
+ "description": "Polymorfa team key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Team keys and project tokens may be personal or service-account owned and enforce selected action scopes. Team keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and connection and enforce their client rules and immutable mint-time action ceiling. Treat all credentials as opaque strings. Never parse them or assume a fixed length; store at least 512 characters. Server keys use issuance-record lookup; short-lived client tokens carry a signed permission ceiling."
+ }
},
- "TestEventFixtureList": {
- "type": "object",
- "properties": {
- "fixtures": {
- "type": "array",
- "items": {
+ "schemas": {
+ "PublicError": {
+ "type": "object",
+ "properties": {
+ "error": {
"type": "object",
"properties": {
- "name": {
+ "type": {
"type": "string",
"enum": [
- "message.received",
- "message.ack",
- "message.failed",
- "call.received",
- "call.missed",
- "call.ended",
- "session.status",
- "session.restriction_updated",
- "template.status"
+ "invalid_request_error",
+ "authentication_error",
+ "permission_error",
+ "billing_error",
+ "conflict_error",
+ "rate_limit_error",
+ "api_error",
+ "upstream_error"
]
},
- "description": {
+ "code": {
+ "type": "string",
+ "enum": [
+ "zero_knowledge_connection",
+ "invalid_parameter",
+ "invalid_credential",
+ "entitlement_required",
+ "cloud_template_authority_restricted",
+ "gate_limit_reached",
+ "billing_credit_required",
+ "addon_required",
+ "safe_mode_not_entitled",
+ "warmup_plan_not_entitled",
+ "method_not_allowed",
+ "permission_denied",
+ "missing_scope",
+ "resource_not_found",
+ "hms_not_enabled",
+ "media_fetch_failed",
+ "resource_gone",
+ "feature_unavailable",
+ "stream_cursor_invalid",
+ "stream_cursor_expired",
+ "stream_connection_limit_reached",
+ "state_conflict",
+ "team_deletion_scheduled",
+ "hybrid_routing_paused",
+ "hybrid_choice_required",
+ "hybrid_transition_ineligible",
+ "hybrid_automation_unavailable",
+ "hybrid_group_linked_devices_unavailable",
+ "hybrid_transport_unavailable",
+ "hybrid_target_reference_unavailable",
+ "send_outcome_unknown",
+ "terms_acceptance_required",
+ "terms_activation_blocked",
+ "idempotency_conflict",
+ "idempotency_in_progress",
+ "idempotency_outcome_unknown",
+ "idempotency_replay_unavailable",
+ "call_claimed",
+ "call_not_ringing",
+ "connection_limit",
+ "unsupported_for_connection",
+ "call_permission_required",
+ "invalid_sip_trunk",
+ "calls_disabled",
+ "call_recipient_opted_out",
+ "call_destination_blocked",
+ "call_permission_request_limited",
+ "call_permission_granted",
+ "order_status_transition_invalid",
+ "order_cancellation_failed",
+ "call_opt_out_limit",
+ "connection_restricted",
+ "sip_trunk_in_use",
+ "sip_trunk_revision_conflict",
+ "sip_trunk_limit",
+ "sip_unavailable",
+ "voice_not_enabled",
+ "provider_credential_invalid",
+ "provider_unavailable",
+ "asset_not_ready",
+ "voice_asset_in_use",
+ "voice_asset_revision_conflict",
+ "voice_unavailable",
+ "rate_limit_exceeded",
+ "internal_error",
+ "operation_not_supported",
+ "upstream_failure",
+ "service_unavailable",
+ "credential_verification_unavailable",
+ "connection_not_ready",
+ "command_dispatch_failed",
+ "result_unknown",
+ "parent_bsuid_not_supported",
+ "recipient_not_on_whatsapp",
+ "conversation_window_closed",
+ "template_not_approved",
+ "media_too_large",
+ "whatsapp_rate_limited",
+ "new_chat_limit_reached",
+ "marketing_disabled_on_cloud_api",
+ "whatsapp_account_restricted",
+ "whatsapp_authorization_required",
+ "whatsapp_payment_method_required",
+ "whatsapp_number_not_registered",
+ "whatsapp_groups_ineligible",
+ "whatsapp_group_creation_paused",
+ "whatsapp_group_limit_reached",
+ "whatsapp_group_full",
+ "whatsapp_group_suspended",
+ "whatsapp_group_has_no_participants",
+ "bansafe_suspended",
+ "bansafe_team_suspended",
+ "bansafe_cold_blocked",
+ "bansafe_cold_held",
+ "bansafe_throttled",
+ "bansafe_daily_allowance_reached",
+ "bansafe_accounting_unavailable",
+ "bansafe_send_outcome_unknown",
+ "campaigns_not_entitled",
+ "campaign_throughput_capped",
+ "campaign_approval_required",
+ "campaign_approval_stale",
+ "campaign_variables_missing"
+ ]
+ },
+ "message": {
"type": "string"
},
- "overrides": {
- "type": "array",
- "items": {
- "type": "string"
- }
+ "param": {
+ "type": "string",
+ "nullable": true
+ },
+ "request_id": {
+ "type": "string",
+ "description": "Matches the X-Request-Id response header. Include it when you contact support."
+ },
+ "request_log_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "Console page that shows this request. Returned only to team and project credentials whose request was logged."
}
},
- "required": ["name", "description", "overrides"]
+ "required": ["type", "code", "message", "param", "request_id"]
+ },
+ "data": {
+ "type": "string",
+ "nullable": true,
+ "enum": [null],
+ "description": "Always null for a failed request."
+ },
+ "docs": {
+ "type": "string",
+ "format": "uri"
}
- }
+ },
+ "required": ["error", "data", "docs"]
},
- "required": ["fixtures"]
- }
- },
- "components": {
+ "TestEventFixtureList": {
+ "type": "object",
+ "properties": {
+ "fixtures": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "enum": [
+ "message.received",
+ "message.ack",
+ "message.failed",
+ "call.received",
+ "call.missed",
+ "call.ended",
+ "connection.status",
+ "connection.restriction_updated",
+ "template.status"
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "overrides": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": ["name", "description", "overrides"]
+ }
+ }
+ },
+ "required": ["fixtures"]
+ },
+ "TriggerTestEventResponse": {
+ "type": "object",
+ "properties": {
+ "event": {
+ "type": "string",
+ "enum": [
+ "message.received",
+ "message.ack",
+ "message.failed",
+ "call.received",
+ "call.missed",
+ "call.ended",
+ "connection.status",
+ "connection.restriction_updated",
+ "template.status"
+ ]
+ },
+ "connection": {
+ "type": "string"
+ },
+ "delivery": {
+ "type": "string",
+ "enum": ["generated", "simulated"]
+ },
+ "eventId": {
+ "type": "string",
+ "nullable": true,
+ "format": "uuid"
+ },
+ "source": {
+ "type": "string",
+ "enum": ["test", "runtime"]
+ }
+ },
+ "required": ["event", "connection", "delivery", "eventId", "source"]
+ },
+ "TriggerTestEventRequest": {
+ "type": "object",
+ "properties": {
+ "event": {
+ "type": "string",
+ "enum": [
+ "message.received",
+ "message.ack",
+ "message.failed",
+ "call.received",
+ "call.missed",
+ "call.ended",
+ "connection.status",
+ "connection.restriction_updated",
+ "template.status"
+ ],
+ "description": "Fixture name. Each name is the event type it produces."
+ },
+ "overrides": {
+ "$ref": "#/components/schemas/TestEventOverrides"
+ },
+ "fromConnection": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 128,
+ "description": "message.received only. Send a simulated text message from this other connected Test connection in the same project instead of generating an event."
+ }
+ },
+ "required": ["event"],
+ "additionalProperties": false
+ },
+ "TestEventOverrides": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4096
+ },
+ "from": {
+ "type": "string",
+ "pattern": "^\\+[1-9]\\d{7,14}$"
+ },
+ "pushName": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 64
+ },
+ "mediaType": {
+ "type": "string",
+ "enum": ["image", "video", "audio", "document", "sticker"]
+ },
+ "caption": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "ackStatus": {
+ "type": "string",
+ "enum": ["delivered", "read", "played", "error"]
+ },
+ "messageId": {
+ "type": "string",
+ "pattern": "^[1-9][0-9]{0,18}$"
+ },
+ "failureReason": {
+ "type": "string",
+ "enum": [
+ "invalid_recipient",
+ "connection_not_connected",
+ "ack_timeout",
+ "send_failed",
+ "blocked_by_safety"
+ ]
+ },
+ "video": {
+ "type": "boolean"
+ },
+ "durationSeconds": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 86400
+ },
+ "callEndReason": {
+ "type": "string",
+ "enum": [
+ "user_hangup",
+ "timeout",
+ "lost_connection",
+ "rejected",
+ "call_restricted"
+ ]
+ },
+ "restrictionActive": {
+ "type": "boolean"
+ },
+ "status": {
+ "type": "string",
+ "enum": ["CONNECTING", "CONNECTED", "DISCONNECTED"]
+ },
+ "statusReason": {
+ "type": "string",
+ "enum": [
+ "SCAN_QR",
+ "AUTO_RECONNECT",
+ "FAILED",
+ "MANUAL_STOP",
+ "QR_TIMEOUT",
+ "LOGGED_OUT",
+ "TEMPORARY_BAN",
+ "STREAM_ERROR"
+ ]
+ },
+ "templateName": {
+ "type": "string",
+ "pattern": "^[a-z0-9_]{1,512}$"
+ },
+ "templateStatus": {
+ "type": "string",
+ "enum": ["APPROVED", "REJECTED"]
+ },
+ "reason": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 256
+ }
+ },
+ "additionalProperties": false
+ }
+ },
"headers": {
- "X-RateLimit-Limit": {
- "description": "Team request quota per rolling minute, when the per-team request limiter applies.",
+ "X-RateLimit-Reset": {
+ "description": "Unix timestamp in seconds when the oldest counted request leaves the rolling window, when the per-team request limiter applies. Follow Retry-After on a rejected request.",
"schema": {
"type": "integer",
- "minimum": 1
+ "minimum": 0
}
},
"X-RateLimit-Remaining": {
@@ -695,11 +902,11 @@
"minimum": 0
}
},
- "X-RateLimit-Reset": {
- "description": "Unix timestamp in seconds when the oldest counted request leaves the rolling window, when the per-team request limiter applies. Follow Retry-After on a rejected request.",
+ "X-RateLimit-Limit": {
+ "description": "Team request quota per rolling minute, when the per-team request limiter applies.",
"schema": {
"type": "integer",
- "minimum": 0
+ "minimum": 1
}
}
}
diff --git a/contracts/testing-phone.json b/contracts/testing-phone.json
index 61e7001a5..bef05e91a 100644
--- a/contracts/testing-phone.json
+++ b/contracts/testing-phone.json
@@ -1,12 +1,12 @@
{
"repository": "polymorfa/polymorfa",
- "commit": "f180dc1ee2bd45dbecf01702f73bdd75c664634b",
+ "commit": "15db8b1c9d88e2ceccb58c851e731feabb659a39",
"sourcePath": "apps/api/docs/openapi.json",
- "sourceSha256": "0c66f1ee93923cf57425ac29c01a84c5c140b703ace2160e1b899ee6dad0b071",
+ "sourceSha256": "e84c7ff814c6b59ca7f32c3fda1aedbed3f672e728910adb883f0aa8c6cf3ab7",
"operations": {
"getTestingPhone": {
"method": "GET",
- "path": "/messaging/{session}/phone",
+ "path": "/messaging/{connection}/phone",
"operation": {
"operationId": "getTestingPhone",
"tags": ["Testing"],
@@ -15,7 +15,7 @@
"BearerAuth": []
}
],
- "summary": "Get a Test number's phone",
+ "summary": "Get a Test connection's phone",
"x-required-scope": "sandbox:read",
"parameters": [
{
@@ -23,10 +23,10 @@
"type": "string",
"minLength": 1,
"maxLength": 256,
- "description": "The Test number's session ID."
+ "description": "The Test connection's connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -36,7 +36,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/TestingPhoneState"
+ "$ref": "#/components/schemas/TestingPhoneState"
}
}
},
@@ -53,7 +53,7 @@
}
},
"403": {
- "description": "Test numbers access required, or a client token was used",
+ "description": "Test connections access required, or a client token was used",
"headers": {
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
@@ -68,7 +68,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -100,7 +100,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -132,7 +132,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -149,16 +149,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sandbox:read "
- },
"x-protocols": ["Linked Device API"],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `sandbox:read`"
}
},
"sendTestingPhoneMessage": {
"method": "POST",
- "path": "/messaging/{session}/phone/messages",
+ "path": "/messaging/{connection}/phone/messages",
"operation": {
"operationId": "sendTestingPhoneMessage",
"tags": ["Testing"],
@@ -167,7 +164,7 @@
"BearerAuth": []
}
],
- "summary": "Send a message from a Test number's phone",
+ "summary": "Send a message from a Test connection's phone",
"x-required-scope": "sandbox:write",
"parameters": [
{
@@ -175,10 +172,10 @@
"type": "string",
"minLength": 1,
"maxLength": 256,
- "description": "The Test number's session ID."
+ "description": "The Test connection's connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
}
],
@@ -187,7 +184,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/TestingPhoneMessageRequest"
+ "$ref": "#/components/schemas/TestingPhoneMessageRequest"
}
}
}
@@ -198,7 +195,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/TestingPhoneMessage"
+ "$ref": "#/components/schemas/TestingPhoneMessage"
}
}
},
@@ -230,7 +227,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -247,7 +244,7 @@
}
},
"403": {
- "description": "Test numbers access required, or a client token was used",
+ "description": "Test connections access required, or a client token was used",
"headers": {
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
@@ -262,7 +259,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -294,7 +291,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -326,7 +323,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -358,7 +355,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -375,16 +372,13 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sandbox:write "
- },
"x-protocols": ["Linked Device API"],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `sandbox:write`"
}
},
"unlinkTestingPhoneDevice": {
"method": "POST",
- "path": "/messaging/{session}/phone/devices/{deviceId}/unlink",
+ "path": "/messaging/{connection}/phone/devices/{deviceId}/unlink",
"operation": {
"operationId": "unlinkTestingPhoneDevice",
"tags": ["Testing"],
@@ -393,7 +387,7 @@
"BearerAuth": []
}
],
- "summary": "Unlink a companion from a Test number's phone",
+ "summary": "Unlink a companion from a Test connection's phone",
"x-required-scope": "sandbox:write",
"parameters": [
{
@@ -401,10 +395,10 @@
"type": "string",
"minLength": 1,
"maxLength": 256,
- "description": "The Test number's session ID."
+ "description": "The Test connection's connection ID."
},
"required": true,
- "name": "session",
+ "name": "connection",
"in": "path"
},
{
@@ -425,7 +419,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/TestingPhoneUnlink"
+ "$ref": "#/components/schemas/TestingPhoneUnlink"
}
}
},
@@ -457,7 +451,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -474,7 +468,7 @@
}
},
"403": {
- "description": "Test numbers access required, or a client token was used",
+ "description": "Test connections access required, or a client token was used",
"headers": {
"X-RateLimit-Limit": {
"$ref": "#/components/headers/X-RateLimit-Limit"
@@ -489,7 +483,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -521,7 +515,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -553,7 +547,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/schemas/PublicError"
+ "$ref": "#/components/schemas/PublicError"
},
"example": {
"error": {
@@ -570,9 +564,6 @@
}
}
},
- "x-mint": {
- "content": "Linked Device API sandbox:write "
- },
"x-protocols": ["Linked Device API"],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `sandbox:write`"
}
@@ -582,7 +573,7 @@
"TestingPhoneState": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
"phone": {
@@ -604,10 +595,10 @@
},
"required": ["deviceId"]
},
- "description": "Companions linked to the phone, such as Polymorfa's own session and Inspector."
+ "description": "Companions linked to the phone, such as Polymorfa's own connection and Inspector."
}
},
- "required": ["session", "phone", "online", "devices"]
+ "required": ["connection", "phone", "online", "devices"]
},
"PublicError": {
"type": "object",
@@ -631,7 +622,7 @@
"code": {
"type": "string",
"enum": [
- "zero_knowledge_session",
+ "zero_knowledge_connection",
"invalid_parameter",
"invalid_credential",
"entitlement_required",
@@ -682,7 +673,7 @@
"order_status_transition_invalid",
"order_cancellation_failed",
"call_opt_out_limit",
- "number_restricted",
+ "connection_restricted",
"sip_trunk_in_use",
"sip_trunk_revision_conflict",
"sip_trunk_limit",
@@ -700,7 +691,7 @@
"upstream_failure",
"service_unavailable",
"credential_verification_unavailable",
- "session_not_ready",
+ "connection_not_ready",
"command_dispatch_failed",
"result_unknown",
"parent_bsuid_not_supported",
@@ -774,7 +765,7 @@
"to": {
"type": "string",
"pattern": "^\\+[1-9]\\d{7,14}$",
- "description": "Another Test number in the same project, in E.164 format."
+ "description": "The phone number of another Test connection in the same project, in E.164 format."
},
"text": {
"type": "string",
@@ -788,7 +779,7 @@
"TestingPhoneMessage": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
"to": {
@@ -799,12 +790,12 @@
"nullable": true
}
},
- "required": ["session", "to", "messageId"]
+ "required": ["connection", "to", "messageId"]
},
"TestingPhoneUnlink": {
"type": "object",
"properties": {
- "session": {
+ "connection": {
"type": "string"
},
"deviceId": {
@@ -815,16 +806,268 @@
"enum": [true]
}
},
- "required": ["session", "deviceId", "unlinked"]
+ "required": ["connection", "deviceId", "unlinked"]
}
},
+ "published": false,
+ "previousExport": {
+ "path": "contracts/history/pre-connections/testing-phone.json",
+ "sha256": "5eef77d9370e3837d674fb807d389e77473363f9baa378457590bf4b27ff99e6"
+ },
"components": {
+ "securitySchemes": {
+ "BearerAuth": {
+ "type": "http",
+ "scheme": "bearer",
+ "description": "Polymorfa team key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Team keys and project tokens may be personal or service-account owned and enforce selected action scopes. Team keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and connection and enforce their client rules and immutable mint-time action ceiling. Treat all credentials as opaque strings. Never parse them or assume a fixed length; store at least 512 characters. Server keys use issuance-record lookup; short-lived client tokens carry a signed permission ceiling."
+ }
+ },
+ "schemas": {
+ "PublicError": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "invalid_request_error",
+ "authentication_error",
+ "permission_error",
+ "billing_error",
+ "conflict_error",
+ "rate_limit_error",
+ "api_error",
+ "upstream_error"
+ ]
+ },
+ "code": {
+ "type": "string",
+ "enum": [
+ "zero_knowledge_connection",
+ "invalid_parameter",
+ "invalid_credential",
+ "entitlement_required",
+ "cloud_template_authority_restricted",
+ "gate_limit_reached",
+ "billing_credit_required",
+ "addon_required",
+ "safe_mode_not_entitled",
+ "warmup_plan_not_entitled",
+ "method_not_allowed",
+ "permission_denied",
+ "missing_scope",
+ "resource_not_found",
+ "hms_not_enabled",
+ "media_fetch_failed",
+ "resource_gone",
+ "feature_unavailable",
+ "stream_cursor_invalid",
+ "stream_cursor_expired",
+ "stream_connection_limit_reached",
+ "state_conflict",
+ "team_deletion_scheduled",
+ "hybrid_routing_paused",
+ "hybrid_choice_required",
+ "hybrid_transition_ineligible",
+ "hybrid_automation_unavailable",
+ "hybrid_group_linked_devices_unavailable",
+ "hybrid_transport_unavailable",
+ "hybrid_target_reference_unavailable",
+ "send_outcome_unknown",
+ "terms_acceptance_required",
+ "terms_activation_blocked",
+ "idempotency_conflict",
+ "idempotency_in_progress",
+ "idempotency_outcome_unknown",
+ "idempotency_replay_unavailable",
+ "call_claimed",
+ "call_not_ringing",
+ "connection_limit",
+ "unsupported_for_connection",
+ "call_permission_required",
+ "invalid_sip_trunk",
+ "calls_disabled",
+ "call_recipient_opted_out",
+ "call_destination_blocked",
+ "call_permission_request_limited",
+ "call_permission_granted",
+ "order_status_transition_invalid",
+ "order_cancellation_failed",
+ "call_opt_out_limit",
+ "connection_restricted",
+ "sip_trunk_in_use",
+ "sip_trunk_revision_conflict",
+ "sip_trunk_limit",
+ "sip_unavailable",
+ "voice_not_enabled",
+ "provider_credential_invalid",
+ "provider_unavailable",
+ "asset_not_ready",
+ "voice_asset_in_use",
+ "voice_asset_revision_conflict",
+ "voice_unavailable",
+ "rate_limit_exceeded",
+ "internal_error",
+ "operation_not_supported",
+ "upstream_failure",
+ "service_unavailable",
+ "credential_verification_unavailable",
+ "connection_not_ready",
+ "command_dispatch_failed",
+ "result_unknown",
+ "parent_bsuid_not_supported",
+ "recipient_not_on_whatsapp",
+ "conversation_window_closed",
+ "template_not_approved",
+ "media_too_large",
+ "whatsapp_rate_limited",
+ "new_chat_limit_reached",
+ "marketing_disabled_on_cloud_api",
+ "whatsapp_account_restricted",
+ "whatsapp_authorization_required",
+ "whatsapp_payment_method_required",
+ "whatsapp_number_not_registered",
+ "whatsapp_groups_ineligible",
+ "whatsapp_group_creation_paused",
+ "whatsapp_group_limit_reached",
+ "whatsapp_group_full",
+ "whatsapp_group_suspended",
+ "whatsapp_group_has_no_participants",
+ "bansafe_suspended",
+ "bansafe_team_suspended",
+ "bansafe_cold_blocked",
+ "bansafe_cold_held",
+ "bansafe_throttled",
+ "bansafe_daily_allowance_reached",
+ "bansafe_accounting_unavailable",
+ "bansafe_send_outcome_unknown",
+ "campaigns_not_entitled",
+ "campaign_throughput_capped",
+ "campaign_approval_required",
+ "campaign_approval_stale",
+ "campaign_variables_missing"
+ ]
+ },
+ "message": {
+ "type": "string"
+ },
+ "param": {
+ "type": "string",
+ "nullable": true
+ },
+ "request_id": {
+ "type": "string",
+ "description": "Matches the X-Request-Id response header. Include it when you contact support."
+ },
+ "request_log_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "Console page that shows this request. Returned only to team and project credentials whose request was logged."
+ }
+ },
+ "required": ["type", "code", "message", "param", "request_id"]
+ },
+ "data": {
+ "type": "string",
+ "nullable": true,
+ "enum": [null],
+ "description": "Always null for a failed request."
+ },
+ "docs": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": ["error", "data", "docs"]
+ },
+ "TestingPhoneUnlink": {
+ "type": "object",
+ "properties": {
+ "connection": {
+ "type": "string"
+ },
+ "deviceId": {
+ "type": "integer"
+ },
+ "unlinked": {
+ "type": "boolean",
+ "enum": [true]
+ }
+ },
+ "required": ["connection", "deviceId", "unlinked"]
+ },
+ "TestingPhoneMessage": {
+ "type": "object",
+ "properties": {
+ "connection": {
+ "type": "string"
+ },
+ "to": {
+ "type": "string"
+ },
+ "messageId": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": ["connection", "to", "messageId"]
+ },
+ "TestingPhoneMessageRequest": {
+ "type": "object",
+ "properties": {
+ "to": {
+ "type": "string",
+ "pattern": "^\\+[1-9]\\d{7,14}$",
+ "description": "The phone number of another Test connection in the same project, in E.164 format."
+ },
+ "text": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4096
+ }
+ },
+ "required": ["to", "text"],
+ "additionalProperties": false
+ },
+ "TestingPhoneState": {
+ "type": "object",
+ "properties": {
+ "connection": {
+ "type": "string"
+ },
+ "phone": {
+ "type": "string",
+ "description": "The Test number, in E.164 format."
+ },
+ "online": {
+ "type": "boolean",
+ "description": "True while the simulated phone is running."
+ },
+ "devices": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "deviceId": {
+ "type": "integer"
+ }
+ },
+ "required": ["deviceId"]
+ },
+ "description": "Companions linked to the phone, such as Polymorfa's own connection and Inspector."
+ }
+ },
+ "required": ["connection", "phone", "online", "devices"]
+ }
+ },
"headers": {
- "X-RateLimit-Limit": {
- "description": "Team request quota per rolling minute, when the per-team request limiter applies.",
+ "X-RateLimit-Reset": {
+ "description": "Unix timestamp in seconds when the oldest counted request leaves the rolling window, when the per-team request limiter applies. Follow Retry-After on a rejected request.",
"schema": {
"type": "integer",
- "minimum": 1
+ "minimum": 0
}
},
"X-RateLimit-Remaining": {
@@ -834,11 +1077,11 @@
"minimum": 0
}
},
- "X-RateLimit-Reset": {
- "description": "Unix timestamp in seconds when the oldest counted request leaves the rolling window, when the per-team request limiter applies. Follow Retry-After on a rejected request.",
+ "X-RateLimit-Limit": {
+ "description": "Team request quota per rolling minute, when the per-team request limiter applies.",
"schema": {
"type": "integer",
- "minimum": 0
+ "minimum": 1
}
}
}
diff --git a/examples/calls-example/README.md b/examples/calls-example/README.md
index 7d580fc0b..6944cc407 100644
--- a/examples/calls-example/README.md
+++ b/examples/calls-example/README.md
@@ -21,7 +21,7 @@ server key or project token
stays in that terminal's environment and never enters the browser:
```bash
-export POLYMORFA_SESSION=support
+export POLYMORFA_CONNECTION=support
export POLYMORFA_EPHEMERAL_ID=calls-example-1
read -rs 'POLYMORFA_SERVER_KEY?Staging server key: '; echo
export POLYMORFA_SERVER_KEY
@@ -30,7 +30,7 @@ unset POLYMORFA_SERVER_KEY
```
Paste the printed token into the page. The issuing credential needs the six client
-delegation scopes (`sessions:manage`, `messages:write`, `contacts:read`,
+delegation scopes (`connections:manage`, `messages:write`, `contacts:read`,
`presence:read`, `presence:observe`, `mcp`) and authority over every action
allowed by this session's rules. The rules need `voip_place`, `voip_answer`,
and `voip_signal` for the flows here. If the rules restrict origins, allow
@@ -38,7 +38,7 @@ and `voip_signal` for the flows here. If the rules restrict origins, allow
its project must have calling access. Use a fresh ephemeral ID for each browser.
The mint helper reads client rules and reports missing Calls actions or a
blocked local origin before minting. On a rules 404 it also checks the Number
-ID when the key has `sessions:read`. A project token must belong to the
+ID when the key has `connections:read`. A project token must belong to the
Number's project. If the key cannot read the Number, a rules 404 can mean an
inaccessible Number or missing rules. The browser authenticates the Calls
socket with its client token in the first WebSocket frame. The SDK can reuse a
@@ -51,7 +51,7 @@ If the Number has no client rules, the example can install narrow rules for a
local test. Set `POLYMORFA_TEST_CALLEE` to the E.164 number you intend to call:
```bash
-export POLYMORFA_SESSION=support
+export POLYMORFA_CONNECTION=support
export POLYMORFA_TEST_CALLEE=+12025550123
read -rs 'POLYMORFA_SERVER_KEY?Staging server key: '; echo
export POLYMORFA_SERVER_KEY
@@ -99,7 +99,7 @@ Connect each Number separately with its own session, display label and browser
client token. The page keeps an independent Calls client and token provider per
entry, only in memory. Choose **Outgoing Number** before dialing; **Call from**
shows the selected source. Each Number has its own labeled incoming-call
-surface, so changing the outgoing choice never hides another Number's call.
+surface, so changing the outgoing choice never hides another Connection's call.
The selector and disconnect buttons lock while any Number is placing, answering
or carrying a call. Finish that call before changing the outgoing Number.
diff --git a/examples/calls-example/client-rules.test.mjs b/examples/calls-example/client-rules.test.mjs
index 119444e8f..4cc6d63de 100644
--- a/examples/calls-example/client-rules.test.mjs
+++ b/examples/calls-example/client-rules.test.mjs
@@ -12,7 +12,7 @@ const rules = {
};
function fakeMessaging({
- sessionError,
+ connectionError,
rulesError,
updateError,
configuredRules = rules,
@@ -20,10 +20,10 @@ function fakeMessaging({
const calls = [];
return {
calls,
- sessions: {
+ connections: {
retrieve: async () => {
- calls.push("retrieve-session");
- if (sessionError) throw sessionError;
+ calls.push("retrieve-connection");
+ if (connectionError) throw connectionError;
},
},
clientTokens: {
@@ -36,7 +36,7 @@ function fakeMessaging({
calls.push(["mint", input]);
return { data: { data: { token: "pmfa_ct_ZXhhbXBsZQ" } } };
},
- updateRules: async (_session, input) => {
+ updateRules: async (_connection, input) => {
calls.push(["update-rules", input]);
if (updateError) throw updateError;
},
@@ -50,19 +50,19 @@ test("mint helper identifies missing rules after a visible Number and never mint
mintCallsExampleToken(messaging, "support", "local-1"),
/No client rules are configured/,
);
- assert.deepEqual(messaging.calls, ["retrieve-rules", "retrieve-session"]);
+ assert.deepEqual(messaging.calls, ["retrieve-rules", "retrieve-connection"]);
});
-test("mint helper reports a generic rules 404 when sessions:read is unavailable", async () => {
+test("mint helper reports a generic rules 404 when connections:read is unavailable", async () => {
const messaging = fakeMessaging({
- sessionError: forbidden,
+ connectionError: forbidden,
rulesError: missing,
});
await assert.rejects(
mintCallsExampleToken(messaging, "support", "local-1"),
/Check the Number ID, project-token project, and whether client rules are configured/,
);
- assert.deepEqual(messaging.calls, ["retrieve-rules", "retrieve-session"]);
+ assert.deepEqual(messaging.calls, ["retrieve-rules", "retrieve-connection"]);
});
test("mint helper rejects missing Calls actions before minting", async () => {
@@ -76,13 +76,16 @@ test("mint helper rejects missing Calls actions before minting", async () => {
assert.deepEqual(messaging.calls, ["retrieve-rules"]);
});
-test("mint helper uses existing rules without requiring sessions:read", async () => {
- const messaging = fakeMessaging({ sessionError: forbidden });
+test("mint helper uses existing rules without requiring connections:read", async () => {
+ const messaging = fakeMessaging({ connectionError: forbidden });
const token = await mintCallsExampleToken(messaging, "support", "local-1");
assert.equal(token, "pmfa_ct_ZXhhbXBsZQ");
assert.deepEqual(messaging.calls, [
"retrieve-rules",
- ["mint", { session: "support", ephemeralId: "local-1", ttlSeconds: 900 }],
+ [
+ "mint",
+ { connection: "support", ephemeralId: "local-1", ttlSeconds: 900 },
+ ],
]);
});
@@ -98,12 +101,12 @@ test("configure helper refuses to replace existing rules", async () => {
test("configure helper uses bounded Calls-only rules when GET returns 404", async () => {
const messaging = fakeMessaging({
rulesError: missing,
- sessionError: forbidden,
+ connectionError: forbidden,
});
await configureCallsExampleRules(messaging, "support", "+12025550123");
assert.deepEqual(messaging.calls.slice(0, 2), [
"retrieve-rules",
- "retrieve-session",
+ "retrieve-connection",
]);
const write = messaging.calls[2];
assert.equal(write[0], "update-rules");
@@ -129,12 +132,15 @@ test("configure helper validates the callee and project before writing", async (
);
assert.deepEqual(invalid.calls, []);
- const hidden = fakeMessaging({ rulesError: missing, sessionError: missing });
+ const hidden = fakeMessaging({
+ rulesError: missing,
+ connectionError: missing,
+ });
await assert.rejects(
configureCallsExampleRules(hidden, "support", "+12025550123"),
/Number unavailable/,
);
- assert.deepEqual(hidden.calls, ["retrieve-rules", "retrieve-session"]);
+ assert.deepEqual(hidden.calls, ["retrieve-rules", "retrieve-connection"]);
});
test("configure helper accepts a seven-digit E.164 test callee", async () => {
diff --git a/examples/calls-example/configure-client-rules-core.mjs b/examples/calls-example/configure-client-rules-core.mjs
index d88da1cda..5044f3a09 100644
--- a/examples/calls-example/configure-client-rules-core.mjs
+++ b/examples/calls-example/configure-client-rules-core.mjs
@@ -6,7 +6,7 @@ const E164 = /^\+[1-9]\d{6,14}$/;
/** Install narrow Calls rules only when this Number has no rules yet. */
export async function configureCallsExampleRules(
messaging,
- session,
+ connection,
testCallee,
) {
if (!E164.test(testCallee))
@@ -16,7 +16,7 @@ export async function configureCallsExampleRules(
let existing = false;
try {
- await messaging.clientTokens.retrieveRules(session);
+ await messaging.clientTokens.retrieveRules(connection);
existing = true;
} catch (cause) {
if (cause?.status !== 404) throw cause;
@@ -31,9 +31,9 @@ export async function configureCallsExampleRules(
// The public 404 does not say whether rules are absent or the Number is
// outside this credential's project. A readable Number resolves it; when
- // sessions:read is missing, the PUT still checks the project on the server.
+ // connections:read is missing, the PUT still checks the project on the server.
try {
- await messaging.sessions.retrieve(session);
+ await messaging.connections.retrieve(connection);
} catch (cause) {
if (cause?.status === 404)
throw new CallsExampleSetupError(
@@ -43,7 +43,7 @@ export async function configureCallsExampleRules(
}
try {
- await messaging.clientTokens.updateRules(session, {
+ await messaging.clientTokens.updateRules(connection, {
recipientMode: "none",
allowedActions: "voip_place,voip_answer,voip_signal",
// Per token per minute: signaling, candidates and diagnostics share it.
diff --git a/examples/calls-example/configure-client-rules.mjs b/examples/calls-example/configure-client-rules.mjs
index dc48fc44b..f52793c98 100644
--- a/examples/calls-example/configure-client-rules.mjs
+++ b/examples/calls-example/configure-client-rules.mjs
@@ -4,13 +4,13 @@ import { CallsExampleSetupError } from "./mint-client-token-core.mjs";
import { configureCallsExampleRules } from "./configure-client-rules-core.mjs";
const key = process.env.POLYMORFA_SERVER_KEY;
-const session = process.env.POLYMORFA_SESSION;
+const connection = process.env.POLYMORFA_CONNECTION;
const testCallee = process.env.POLYMORFA_TEST_CALLEE;
const credentialType = serverCredentialType(key);
-if (!key || !session || !testCallee) {
+if (!key || !connection || !testCallee) {
process.stderr.write(
- "Set POLYMORFA_SERVER_KEY, POLYMORFA_SESSION and POLYMORFA_TEST_CALLEE.\n",
+ "Set POLYMORFA_SERVER_KEY, POLYMORFA_CONNECTION and POLYMORFA_TEST_CALLEE.\n",
);
process.exitCode = 1;
} else if (!credentialType) {
@@ -22,7 +22,7 @@ if (!key || !session || !testCallee) {
credential: { type: credentialType, value: key },
baseUrl: "https://api.polymorfastaging.com",
});
- await configureCallsExampleRules(messaging, session, testCallee);
+ await configureCallsExampleRules(messaging, connection, testCallee);
process.stdout.write(
"Configured bounded Calls client rules for this Number.\n",
);
diff --git a/examples/calls-example/mint-client-token-core.mjs b/examples/calls-example/mint-client-token-core.mjs
index bb23c8a22..aad3b9145 100644
--- a/examples/calls-example/mint-client-token-core.mjs
+++ b/examples/calls-example/mint-client-token-core.mjs
@@ -2,31 +2,36 @@
export class CallsExampleSetupError extends Error {}
/** Check the Number and its client rules before minting the browser token. */
-export async function mintCallsExampleToken(messaging, session, ephemeralId) {
+export async function mintCallsExampleToken(
+ messaging,
+ connection,
+ ephemeralId,
+) {
let rules;
try {
- rules = (await messaging.clientTokens.retrieveRules(session)).data.data;
+ rules = (await messaging.clientTokens.retrieveRules(connection)).data.data;
} catch (cause) {
if (cause?.status !== 404) throw cause;
// Public 404s conceal whether rules are absent or the Number is outside
// this credential's project. Check Number visibility only on that path.
try {
- await messaging.sessions.retrieve(session);
+ await messaging.connections.retrieve(connection);
throw new CallsExampleSetupError(
"No client rules are configured for this Number. Configure the Calls actions before minting.",
);
- } catch (sessionCause) {
- if (sessionCause instanceof CallsExampleSetupError) throw sessionCause;
- if (sessionCause?.status === 404)
+ } catch (connectionCause) {
+ if (connectionCause instanceof CallsExampleSetupError)
+ throw connectionCause;
+ if (connectionCause?.status === 404)
throw new CallsExampleSetupError(
"Number unavailable to this credential. Check the Number ID and project-token project.",
);
- // Reading a Number needs sessions:read; minting only needs sessions:manage.
- if (sessionCause?.status === 403)
+ // Reading a Number needs connections:read; minting only needs connections:manage.
+ if (connectionCause?.status === 403)
throw new CallsExampleSetupError(
"Client rules are unavailable. Check the Number ID, project-token project, and whether client rules are configured.",
);
- throw sessionCause;
+ throw connectionCause;
}
}
@@ -50,7 +55,7 @@ export async function mintCallsExampleToken(messaging, session, ephemeralId) {
);
const result = await messaging.clientTokens.mint({
- session,
+ connection,
ephemeralId,
ttlSeconds: 900,
});
diff --git a/examples/calls-example/mint-client-token.mjs b/examples/calls-example/mint-client-token.mjs
index 6c8b6aa60..0edd029b2 100644
--- a/examples/calls-example/mint-client-token.mjs
+++ b/examples/calls-example/mint-client-token.mjs
@@ -6,12 +6,12 @@ import {
} from "./mint-client-token-core.mjs";
const key = process.env.POLYMORFA_SERVER_KEY;
-const session = process.env.POLYMORFA_SESSION;
+const connection = process.env.POLYMORFA_CONNECTION;
const ephemeralId = process.env.POLYMORFA_EPHEMERAL_ID;
const credentialType = serverCredentialType(key);
-if (!key || !session || !ephemeralId) {
+if (!key || !connection || !ephemeralId) {
process.stderr.write(
- "Set POLYMORFA_SERVER_KEY, POLYMORFA_SESSION and POLYMORFA_EPHEMERAL_ID.\n",
+ "Set POLYMORFA_SERVER_KEY, POLYMORFA_CONNECTION and POLYMORFA_EPHEMERAL_ID.\n",
);
process.exitCode = 1;
} else if (!credentialType) {
@@ -23,7 +23,11 @@ if (!key || !session || !ephemeralId) {
credential: { type: credentialType, value: key },
baseUrl: "https://api.polymorfastaging.com",
});
- const token = await mintCallsExampleToken(messaging, session, ephemeralId);
+ const token = await mintCallsExampleToken(
+ messaging,
+ connection,
+ ephemeralId,
+ );
process.stdout.write(`${token}\n`);
} catch (cause) {
const detail =
@@ -31,7 +35,7 @@ if (!key || !session || !ephemeralId) {
? cause.message
: "Token mint failed.";
process.stderr.write(
- `${detail}\nCheck the staging API, key scopes, session and client rules.\n`,
+ `${detail}\nCheck the staging API, key scopes, connection and client rules.\n`,
);
process.exitCode = 1;
}
diff --git a/examples/calls-example/src/numbers.ts b/examples/calls-example/src/connections.ts
similarity index 62%
rename from examples/calls-example/src/numbers.ts
rename to examples/calls-example/src/connections.ts
index 2f4dff00c..6420e4839 100644
--- a/examples/calls-example/src/numbers.ts
+++ b/examples/calls-example/src/connections.ts
@@ -4,44 +4,44 @@ import {
type BrowserCallsOptions,
} from "@polymorfa/ui-kit";
-export interface NumberConnection {
+export interface CallingConnection {
readonly id: string;
readonly label: string;
readonly calls: BrowserCalls;
dispose(): Promise;
}
-/** The example accepts only a token already authorized for this exact Number. */
-export function createNumberConnection(
+/** The example accepts only a token already authorized for this exact Connection. */
+export function createCallingConnection(
input: {
- readonly session: string;
+ readonly connection: string;
readonly label: string;
readonly token: string;
readonly baseUrl: string;
},
callbacks: Pick = {},
create = createBrowserCalls,
-): NumberConnection {
- const session = input.session.trim();
- if (!session || !input.token.trim().startsWith("pmfa_ct_"))
+): CallingConnection {
+ const connection = input.connection.trim();
+ if (!connection || !input.token.trim().startsWith("pmfa_ct_"))
throw new Error(
- "Enter a Number's session and its pmfa_ct_ browser client token.",
+ "Enter a Connection ID and its pmfa_ct_ browser client token.",
);
let token = input.token.trim();
let disposed = false;
const calls = create({
...callbacks,
- session,
+ connection,
baseUrl: input.baseUrl,
- // Each closure belongs to one Number. Selection never changes its token.
+ // Each closure belongs to one Connection. Selection never changes its token.
getClientToken: () =>
disposed
- ? Promise.reject(new Error("Number disconnected."))
+ ? Promise.reject(new Error("Connection disconnected."))
: Promise.resolve(token),
});
return {
- id: session,
- label: input.label.trim() || session,
+ id: connection,
+ label: input.label.trim() || connection,
calls,
dispose: () => {
disposed = true;
@@ -51,8 +51,10 @@ export function createNumberConnection(
};
}
-export function hasActiveCall(numbers: readonly NumberConnection[]): boolean {
- return numbers.some(({ calls }) => {
+export function hasActiveCall(
+ connections: readonly CallingConnection[],
+): boolean {
+ return connections.some(({ calls }) => {
const snapshot = calls.controller.getSnapshot();
return (
snapshot.placing === true ||
diff --git a/examples/calls-example/src/main.tsx b/examples/calls-example/src/main.tsx
index afeb954e8..6c2f16860 100644
--- a/examples/calls-example/src/main.tsx
+++ b/examples/calls-example/src/main.tsx
@@ -1,16 +1,16 @@
import { useEffect, useRef, useState } from "react";
import { createRoot } from "react-dom/client";
import {
- CallNumberPicker,
+ CallConnectionPicker,
CallSurface,
DialPad,
PolymorfaProvider,
} from "@polymorfa/ui-kit/react";
import {
- createNumberConnection,
+ createCallingConnection,
hasActiveCall,
- type NumberConnection,
-} from "./numbers.js";
+ type CallingConnection,
+} from "./connections.js";
import "./style.css";
const apiBaseUrl = "https://api.polymorfastaging.com";
@@ -20,15 +20,17 @@ interface Feedback {
}
function App() {
- const [session, setSession] = useState("");
+ const [connection, setConnection] = useState("");
const [label, setLabel] = useState("");
const [token, setToken] = useState("");
- const [numbers, setNumbers] = useState([]);
+ const [connections, setConnections] = useState(
+ [],
+ );
const [selectedId, setSelectedId] = useState("");
const [error, setError] = useState("");
const [feedback, setFeedback] = useState>({});
const [, redraw] = useState(0);
- const numbersRef = useRef([]);
+ const connectionsRef = useRef([]);
const subscriptions = useRef(new Map void>());
useEffect(() => {
@@ -37,30 +39,31 @@ function App() {
window.clearInterval(timer);
for (const stop of subscriptions.current.values()) stop();
subscriptions.current.clear();
- for (const number of numbersRef.current) void number.dispose();
- numbersRef.current = [];
+ for (const connection of connectionsRef.current)
+ void connection.dispose();
+ connectionsRef.current = [];
};
}, []);
- async function addNumber() {
- const id = session.trim();
- if (numbersRef.current.some((number) => number.id === id)) {
+ async function addConnection() {
+ const id = connection.trim();
+ if (connectionsRef.current.some((connection) => connection.id === id)) {
setError(
- "This Number is already connected. Disconnect it before replacing its token.",
+ "This Connection is already connected. Disconnect it before replacing its token.",
);
return;
}
- let number: NumberConnection;
+ let configured: CallingConnection;
const update = (next: Feedback) => {
- if (!numbersRef.current.includes(number)) return;
+ if (!connectionsRef.current.includes(configured)) return;
setFeedback((previous) => ({
...previous,
[id]: { ...previous[id], ...next },
}));
};
try {
- number = createNumberConnection(
- { session: id, label, token, baseUrl: apiBaseUrl },
+ configured = createCallingConnection(
+ { connection: id, label, token, baseUrl: apiBaseUrl },
{
onError: ({ code, message }) =>
update({ error: `${code}: ${message}` }),
@@ -78,24 +81,24 @@ function App() {
);
} catch (cause) {
setError(
- cause instanceof Error ? cause.message : "Could not add Number.",
+ cause instanceof Error ? cause.message : "Could not add Connection.",
);
return;
}
setError("");
setToken("");
- setSession("");
+ setConnection("");
setLabel("");
- const next = [...numbersRef.current, number];
- numbersRef.current = next;
- setNumbers(next);
- setSelectedId((current) => current || number.id);
+ const next = [...connectionsRef.current, configured];
+ connectionsRef.current = next;
+ setConnections(next);
+ setSelectedId((current) => current || configured.id);
subscriptions.current.set(
- number.id,
- number.calls.controller.subscribe(() => redraw((value) => value + 1)),
+ configured.id,
+ configured.calls.controller.subscribe(() => redraw((value) => value + 1)),
);
try {
- await number.calls.connect();
+ await configured.calls.connect();
} catch (cause) {
update({
error:
@@ -106,53 +109,55 @@ function App() {
}
}
- async function disconnect(number: NumberConnection) {
- if (hasActiveCall(numbersRef.current)) return;
- subscriptions.current.get(number.id)?.();
- subscriptions.current.delete(number.id);
- const next = numbersRef.current.filter((entry) => entry !== number);
- numbersRef.current = next;
- setNumbers(next);
+ async function disconnect(connection: CallingConnection) {
+ if (hasActiveCall(connectionsRef.current)) return;
+ subscriptions.current.get(connection.id)?.();
+ subscriptions.current.delete(connection.id);
+ const next = connectionsRef.current.filter((entry) => entry !== connection);
+ connectionsRef.current = next;
+ setConnections(next);
setSelectedId((current) =>
- current === number.id ? (next[0]?.id ?? "") : current,
+ current === connection.id ? (next[0]?.id ?? "") : current,
);
setFeedback((current) => {
const next = { ...current };
- delete next[number.id];
+ delete next[connection.id];
return next;
});
- await number.dispose();
+ await connection.dispose();
}
- const selected = numbers.find((number) => number.id === selectedId);
- const busy = hasActiveCall(numbers);
+ const selected = connections.find(
+ (connection) => connection.id === selectedId,
+ );
+ const busy = hasActiveCall(connections);
return (
Polymorfa SDK
Calls example
- Choose an authorized staging Number for outgoing calls.
+ Choose an authorized staging Connection for outgoing calls.
API: {apiBaseUrl}
-
+
{error && (
@@ -180,17 +187,17 @@ function App() {
)}
- {numbers.length > 0 && (
+ {connections.length > 0 && (
- ({
- id: number.id,
- label: number.label,
- controller: number.calls.controller,
+ ({
+ id: connection.id,
+ label: connection.label,
+ controller: connection.calls.controller,
}))}
value={selectedId}
onChange={(id) => {
- if (!hasActiveCall(numbersRef.current)) setSelectedId(id);
+ if (!hasActiveCall(connectionsRef.current)) setSelectedId(id);
}}
/>
{selected !== undefined && (
@@ -198,7 +205,7 @@ function App() {
Call from {selected.label}
{busy ? (
- Finish the active call before choosing another Number or
+ Finish the active call before choosing another Connection or
dialing.
) : selected.calls.connected ? (
@@ -208,39 +215,39 @@ function App() {
allowVideo={false}
/>
) : (
- Waiting for this Number's call connection.
+ Waiting for this Connection's call connection.
)}
>
)}
)}
- {numbers.map((number) => {
- const failure = number.calls.controller.getSnapshot().error;
+ {connections.map((connection) => {
+ const failure = connection.calls.controller.getSnapshot().error;
return (
- Calls on {number.label}
- Session: {number.id}
+ Calls on {connection.label}
+ Connection: {connection.id}
void disconnect(number)}
+ onClick={() => void disconnect(connection)}
>
- Disconnect Number
+ Disconnect Connection
- {number.calls.connected
+ {connection.calls.connected
? "Ready for calls"
: "Reconnecting to call events"}
- {feedback[number.id]?.error && (
+ {feedback[connection.id]?.error && (
- {feedback[number.id]!.error}
+ {feedback[connection.id]!.error}
)}
{failure && (
@@ -248,12 +255,12 @@ function App() {
{failure.code}: {failure.message}
)}
- {feedback[number.id]?.requestFailure && (
+ {feedback[connection.id]?.requestFailure && (
- Last failed request: {feedback[number.id]!.requestFailure}
+ Last failed request: {feedback[connection.id]!.requestFailure}
)}
-
+
);
})}
diff --git a/examples/five-minute-inbox/app/api/polymorfa/[...route]/route.ts b/examples/five-minute-inbox/app/api/polymorfa/[...route]/route.ts
index b68c9a31c..07cec0f78 100644
--- a/examples/five-minute-inbox/app/api/polymorfa/[...route]/route.ts
+++ b/examples/five-minute-inbox/app/api/polymorfa/[...route]/route.ts
@@ -15,7 +15,7 @@ export const { GET, POST } = createPolymorfaHandler({
authenticate: currentUser,
// The only place permissions are chosen: the smallest set this user needs.
mint: () => ({
- session: process.env.POLYMORFA_SESSION!,
+ connection: process.env.POLYMORFA_CONNECTION!,
conversations: "all",
allow: ["read_messages", "subscribe_events", "send_message"],
ttlSeconds: 600,
diff --git a/examples/full-platform/README.md b/examples/full-platform/README.md
index e60a3124f..fd68f1c35 100644
--- a/examples/full-platform/README.md
+++ b/examples/full-platform/README.md
@@ -15,7 +15,7 @@ customer answer, pushed to the browser as live events.
## What is inside
- **Tickets.** Three panes: a ticket list with Open, Pending and Resolved tabs,
- search and filters by queue, tag, number and assignee; a WhatsApp-style chat;
+ search and filters by queue, tag, connection and assignee; a WhatsApp-style chat;
and a contact panel with tags, custom fields, notes, ticket history, block
and mute. Accept, transfer to an agent or queue, resolve and reopen. A
server-computed countdown shows how long the 24-hour reply window stays
@@ -90,7 +90,7 @@ Copy `.env.example` to `.env.local` and fill it in:
| `POLYMORFA_TEAM_API_KEY` | The team `Client` in the admin area and BanSafe Health (`pmfa_...`) |
| `POLYMORFA_PROJECT_ID` | The project the project token is bound to |
| `POLYMORFA_PROJECT_SLUG` | Template and Messaging campaign routes |
-| `POLYMORFA_SESSION` | The session (number) the support team uses |
+| `POLYMORFA_CONNECTION` | The Connection the support team uses |
| `POLYMORFA_TEMPLATE_SESSION` | The Cloud API session that submits templates to Meta |
| `POLYMORFA_AGENT_SESSIONS` | Optional comma-separated extra sessions agents may use |
| `POLYMORFA_WEBHOOK_SECRET` | Signing secret of the management webhook at `/api/polymorfa/webhooks` |
@@ -196,7 +196,7 @@ flowchart LR
| Templates library, picker and builder | `templates.list`, `TemplateBuilder`, `TemplateBuilderController`, `createTemplateBuilderRoute` | `ui/pages/templates.tsx`, `app/api/polymorfa/templates/route.ts` |
| Campaigns and the create wizard | `MessagingClient.campaigns` (`list`, `create`, `launch`, `pause`, `resume`, `stop`) | `lib/desk/live.ts`, `app/api/messaging/campaigns/route.ts` |
| Connections, QR and pairing code, restart, logout, delete | `sessions.list`, `qr`, `requestPairingCode`, `restart`, `logout`, `delete`, `start`, `stop` | `lib/desk/live.ts`, `app/api/messaging/sessions/route.ts` |
-| Connect a number (hosted QuickLink URL only) | `quickLinks.create` | `lib/desk/live.ts`, `app/api/messaging/quicklinks/route.ts` |
+| Connect a connection (hosted QuickLink URL only) | `quickLinks.create` | `lib/desk/live.ts`, `app/api/messaging/quicklinks/route.ts` |
| BanSafe health on connection cards and in Admin | `Client.banSafe` | `lib/desk/live.ts`, `app/api/admin/bansafe/route.ts` |
| Calls, dial pad, incoming calls | `createBrowserCalls`, `CallSurface`, `DialPad`, `clientTokens.mint`, `voip.reject`, `voip.end` | `ui/calls.ts`, `ui/pages/calls.tsx`, `app/api/messaging/calls/*` |
| Webhooks and live events | `readVerifiedWebhook`, `constructWebhookEvent`, `isEvent`, `WebhookEventOf` | `lib/webhooks.ts`, `lib/realtime.ts`, `lib/browser/live-events.ts` |
diff --git a/examples/full-platform/app/api/admin/bansafe/route.ts b/examples/full-platform/app/api/admin/bansafe/route.ts
index cef065a9d..ed0e7e8b1 100644
--- a/examples/full-platform/app/api/admin/bansafe/route.ts
+++ b/examples/full-platform/app/api/admin/bansafe/route.ts
@@ -1,4 +1,4 @@
-import type { BanSafeNumber } from "@polymorfa/sdk";
+import type { BanSafeConnection } from "@polymorfa/sdk";
import { team } from "../../../../lib/polymorfa.js";
import { env } from "../../../../lib/env.js";
@@ -15,7 +15,7 @@ import {
export const GET = route("admin", async () => {
const banSafe = team().banSafe;
const projectId = env.projectId();
- const numbers: BanSafeNumber[] = [];
+ const numbers: BanSafeConnection[] = [];
let cursor: string | undefined;
// At most 20 pages (2,000 numbers); stop if the cursor does not advance.
for (let pages = 0; pages < 20; pages += 1) {
@@ -63,12 +63,12 @@ export const POST = route("admin", async ({ body, request }) => {
const banSafe = team().banSafe;
switch (action(body)) {
case "number": {
- const session = text(body, "session");
+ const connection = text(body, "connection");
const [health, history, telemetry, telemetryHistory] = await Promise.all([
- banSafe.getHealth(session),
- banSafe.listHealthHistory(session, { limit: 30 }),
- banSafe.getTelemetry(session),
- banSafe.listTelemetryHistory(session, { limit: 24 }),
+ banSafe.getHealth(connection),
+ banSafe.listHealthHistory(connection, { limit: 30 }),
+ banSafe.getTelemetry(connection),
+ banSafe.listTelemetryHistory(connection, { limit: 24 }),
]);
return {
health: health.data.data,
@@ -81,7 +81,7 @@ export const POST = route("admin", async ({ body, request }) => {
const note = optionalText(body, "note");
return banSafe.createIncident(
{
- session: text(body, "session"),
+ connection: text(body, "connection"),
...(note === undefined ? {} : { note }),
},
{ idempotencyKey: idempotencyKey(request) },
diff --git a/examples/full-platform/app/api/admin/sessions/route.ts b/examples/full-platform/app/api/admin/connections/route.ts
similarity index 51%
rename from examples/full-platform/app/api/admin/sessions/route.ts
rename to examples/full-platform/app/api/admin/connections/route.ts
index 381f2f1b5..343c5c793 100644
--- a/examples/full-platform/app/api/admin/sessions/route.ts
+++ b/examples/full-platform/app/api/admin/connections/route.ts
@@ -11,59 +11,69 @@ import {
} from "../../../../lib/route.js";
export const GET = route("admin", () =>
- team().sessions.list({ projectId: env.projectId() }),
+ team().connections.list({ projectId: env.projectId() }),
);
export const POST = route("admin", async ({ body, request }) => {
- const sessions = team().sessions;
+ const connections = team().connections;
const projectId = env.projectId();
const name = action(body);
switch (name) {
case "stopMany":
- return sessions.stopMany({ projectId, sessionIds: texts(body, "ids") });
+ return connections.stopMany({
+ projectId,
+ connectionIds: texts(body, "ids"),
+ });
case "deleteMany":
- return sessions.deleteMany({ projectId, sessionIds: texts(body, "ids") });
+ return connections.deleteMany({
+ projectId,
+ connectionIds: texts(body, "ids"),
+ });
}
- const sessionId = text(body, "sessionId");
+ const connectionId = text(body, "connectionId");
switch (name) {
case "retrieve":
- return sessions.retrieve(sessionId);
+ return connections.retrieve(connectionId);
case "start":
- return sessions.start(sessionId, { projectId });
+ return connections.start(connectionId, { projectId });
case "stop":
- return sessions.stop(sessionId, { projectId });
+ return connections.stop(connectionId, { projectId });
case "delete":
- return sessions.delete(sessionId);
+ return connections.delete(connectionId);
case "resetConfiguration": {
- const current = await sessions.retrieve(sessionId);
- const revision = current.data.data.configuration?.revisions.session ?? 0;
- return sessions.update(sessionId, {
+ const current = await connections.retrieve(connectionId);
+ const revision =
+ current.data.data.configuration?.revisions.connection ?? 0;
+ return connections.update(connectionId, {
configuration: { reset: ["observation", "historySync"] },
revision,
});
}
case "quoteTier":
// Review the quote with the customer, then confirm it with applyTier.
- return sessions.quoteTierChange(sessionId, {
+ return connections.quoteTierChange(connectionId, {
projectId,
tierOverride: oneOf(body, "tier", ["free", "standard", "pro"]),
});
case "tierQuote":
- return sessions.retrieveTierChange(sessionId, text(body, "quoteId"));
+ return connections.retrieveTierChange(
+ connectionId,
+ text(body, "quoteId"),
+ );
case "applyTier":
- return sessions.setTierOverride(
- sessionId,
+ return connections.setTierOverride(
+ connectionId,
{ projectId, quoteId: text(body, "quoteId") },
{ idempotencyKey: idempotencyKey(request) },
);
case "capabilities":
// Beta: returns 403 until the team enrolls in number capabilities.
- return sessions.getCapabilities(sessionId);
+ return connections.getCapabilities(connectionId);
case "safeMode":
- return sessions.getSafeMode(sessionId);
+ return connections.getSafeMode(connectionId);
case "updateSafeMode":
- return sessions.updateSafeMode(sessionId, { pacing: "jittered" });
+ return connections.updateSafeMode(connectionId, { pacing: "jittered" });
default:
return unknownAction(name);
}
diff --git a/examples/full-platform/app/api/admin/customers/route.ts b/examples/full-platform/app/api/admin/customers/route.ts
index 723758fa7..1a73271ed 100644
--- a/examples/full-platform/app/api/admin/customers/route.ts
+++ b/examples/full-platform/app/api/admin/customers/route.ts
@@ -82,7 +82,7 @@ export const POST = route("admin", async ({ body, request }) => {
{ idempotencyKey: idempotencyKey(request) },
);
case "numbers":
- return customers.listNumbers(customerId, projectId);
+ return customers.listConnections(customerId, projectId);
case "events":
return customers.listEvents(customerId, { projectId, limit: 50 });
case "createPairingLink": {
@@ -108,10 +108,10 @@ export const POST = route("admin", async ({ body, request }) => {
text(body, "pairingLinkId"),
projectId,
);
- case "transferNumber":
- return customers.transferNumber(
+ case "transferConnection":
+ return customers.transferConnection(
customerId,
- text(body, "sessionId"),
+ text(body, "connectionId"),
{
projectId,
sourceCustomerId: text(body, "sourceCustomerId"),
diff --git a/examples/full-platform/app/api/admin/projects/route.ts b/examples/full-platform/app/api/admin/projects/route.ts
index f9453e3e3..a1706868a 100644
--- a/examples/full-platform/app/api/admin/projects/route.ts
+++ b/examples/full-platform/app/api/admin/projects/route.ts
@@ -54,7 +54,7 @@ export const POST = route("admin", async ({ body, request }) => {
version: current.version,
enabled: false,
threshold: current.threshold,
- sessionAction: current.sessionAction,
+ connectionAction: current.connectionAction,
slowDownMps: current.slowDownMps,
emailNotification: current.emailNotification,
webhookNotification: current.webhookNotification,
diff --git a/examples/full-platform/app/api/admin/security/route.ts b/examples/full-platform/app/api/admin/security/route.ts
index a3cc0a577..998d0e232 100644
--- a/examples/full-platform/app/api/admin/security/route.ts
+++ b/examples/full-platform/app/api/admin/security/route.ts
@@ -1,7 +1,7 @@
import { team } from "../../../../lib/polymorfa.js";
import { action, route, text, unknownAction } from "../../../../lib/route.js";
-// Audit trail, leaked-credential incidents and session bans.
+// Audit trail, leaked-credential incidents and connection bans.
export const GET = route("admin", async ({ url }) => {
const client = team();
const auditAction = url.searchParams.get("action") ?? undefined;
@@ -11,14 +11,14 @@ export const GET = route("admin", async ({ url }) => {
...(auditAction === undefined ? {} : { action: auditAction }),
}),
client.securityIncidents.list(),
- client.sessionBans.list(),
- client.sessionBans.listActive(),
+ client.connectionBans.list(),
+ client.connectionBans.listActive(),
]);
return {
auditLogs: auditLogs.data.data,
securityIncidents: incidents.data.data,
- sessionBans: bans.data.data,
- activeSessionBans: activeBans.data.data,
+ connectionBans: bans.data.data,
+ activeConnectionBans: activeBans.data.data,
};
});
diff --git a/examples/full-platform/app/api/admin/settings/route.ts b/examples/full-platform/app/api/admin/settings/route.ts
index 5ebb0441a..27cf20a69 100644
--- a/examples/full-platform/app/api/admin/settings/route.ts
+++ b/examples/full-platform/app/api/admin/settings/route.ts
@@ -7,18 +7,18 @@ import {
unknownAction,
} from "../../../../lib/route.js";
-// Session configuration defaults and saved QuickLink branding, for the team
+// Connection configuration defaults and saved QuickLink branding, for the team
// (team view) and for this project (project view).
export const GET = route("admin", async () => {
const [teamConfig, projectConfig, teamLinks, projectLinks] =
await Promise.all([
- team().sessionConfiguration.retrieve(),
- project().sessionConfiguration.retrieve(),
+ team().connectionConfiguration.retrieve(),
+ project().connectionConfiguration.retrieve(),
team().quickLinkSettings.retrieve(),
project().quickLinkSettings.retrieve(),
]);
return {
- sessionConfiguration: {
+ connectionConfiguration: {
team: teamConfig.data,
project: projectConfig.data,
},
@@ -30,7 +30,7 @@ export const POST = route("admin", async ({ body }) => {
switch (action(body)) {
case "projectObservation":
// `revision` must match the value last read, or the API rejects the write.
- return project().sessionConfiguration.update({
+ return project().connectionConfiguration.update({
configuration: {
set: {
observation: { presenceMode: "cache", typingMode: "events" },
diff --git a/examples/full-platform/app/api/desk/connections/route.ts b/examples/full-platform/app/api/desk/connections/route.ts
index e19be6372..ce44b7db5 100644
--- a/examples/full-platform/app/api/desk/connections/route.ts
+++ b/examples/full-platform/app/api/desk/connections/route.ts
@@ -26,7 +26,7 @@ export const GET = route(
{ demo: "handler" },
);
-// Session controls are admin-only.
+// Connection controls are admin-only.
export const POST = route(
"admin",
async ({ body, request }) => {
@@ -35,7 +35,7 @@ export const POST = route(
case "quickLink":
// QuickLink is hosted by Polymorfa: return the URL, embed nothing.
return data.createQuickLink(idempotencyKey(request));
- case "session":
+ case "connection":
return data.connectionAction(
text(body, "connectionId"),
oneOf(body, "operation", ACTIONS),
diff --git a/examples/full-platform/app/api/desk/media/route.ts b/examples/full-platform/app/api/desk/media/route.ts
index 976c4dce7..d3176731b 100644
--- a/examples/full-platform/app/api/desk/media/route.ts
+++ b/examples/full-platform/app/api/desk/media/route.ts
@@ -67,7 +67,7 @@ const authenticatedGet = route(
{ demo: "handler" },
);
-// Signed links let Polymorfa fetch an upload without a session cookie.
+// Signed links let Polymorfa fetch an upload without a connection cookie.
export async function GET(request: Request): Promise {
const url = new URL(request.url);
if (url.searchParams.has("sig")) {
diff --git a/examples/full-platform/app/api/desk/tickets/route.ts b/examples/full-platform/app/api/desk/tickets/route.ts
index 221f9612f..3db55f4d5 100644
--- a/examples/full-platform/app/api/desk/tickets/route.ts
+++ b/examples/full-platform/app/api/desk/tickets/route.ts
@@ -43,17 +43,17 @@ export const GET = route(
export const POST = route(
"agent",
- async ({ body, operator, sessionOf }) => {
+ async ({ body, operator, connectionOf }) => {
const data = await desk();
const name = action(body);
if (name === "create") {
const requested = optionalText(body, "connectionId");
- // Live sessions go through the same allow-list as every other route;
+ // Live connections go through the same allow-list as every other route;
// demo connections are fixtures.
const connectionId =
requested === undefined || isDemoMode()
? requested
- : sessionOf({ session: requested });
+ : connectionOf({ connection: requested });
return data.createTicket(
{
phone: text(body, "phone").replace(/[\s()-]/g, ""),
diff --git a/examples/full-platform/app/api/messaging/bansafe/route.ts b/examples/full-platform/app/api/messaging/bansafe/route.ts
index 24c9484be..b9a8f177e 100644
--- a/examples/full-platform/app/api/messaging/bansafe/route.ts
+++ b/examples/full-platform/app/api/messaging/bansafe/route.ts
@@ -3,26 +3,26 @@ import { env } from "../../../../lib/env.js";
import { action, flag, route, unknownAction } from "../../../../lib/route.js";
// BanSafe settings through the Messaging API.
-export const GET = route("admin", async ({ body, sessionOf }) => {
+export const GET = route("admin", async ({ body, connectionOf }) => {
const banSafe = messaging().banSafe;
const projectId = env.projectId();
- const [safeMode, warmup, insurance, health, session] = await Promise.all([
+ const [safeMode, warmup, insurance, health, connection] = await Promise.all([
banSafe.getProjectSafeMode(projectId),
banSafe.getProjectWarmupPlan(projectId),
banSafe.getProjectInsuranceEvidence(projectId),
banSafe.getProjectHealthPolicy(projectId),
- banSafe.getSessionSafeMode(sessionOf(body)),
+ banSafe.getConnectionSafeMode(connectionOf(body)),
]);
return {
safeMode: safeMode.data.data,
warmup: warmup.data.data,
insurance: insurance.data.data,
health: health.data.data,
- session: session.data.data,
+ connection: connection.data.data,
};
});
-export const POST = route("admin", async ({ body, sessionOf }) => {
+export const POST = route("admin", async ({ body, connectionOf }) => {
const banSafe = messaging().banSafe;
const projectId = env.projectId();
switch (action(body)) {
@@ -51,14 +51,14 @@ export const POST = route("admin", async ({ body, sessionOf }) => {
version: policy.version,
enabled: true,
threshold: 40,
- sessionAction: "slow_down",
+ connectionAction: "slow_down",
slowDownMps: 1,
emailNotification: policy.integrations.emailConfigured,
webhookNotification: policy.integrations.webhookConfigured,
});
}
- case "sessionSafeMode":
- return banSafe.updateSessionSafeMode(sessionOf(body), {
+ case "connectionSafeMode":
+ return banSafe.updateConnectionSafeMode(connectionOf(body), {
presence: "inherit",
typing: "inherit",
reads: "all_inbound",
diff --git a/examples/full-platform/app/api/messaging/business/route.ts b/examples/full-platform/app/api/messaging/business/route.ts
index b18823aa6..3e855732d 100644
--- a/examples/full-platform/app/api/messaging/business/route.ts
+++ b/examples/full-platform/app/api/messaging/business/route.ts
@@ -12,15 +12,15 @@ import {
} from "../../../../lib/route.js";
// Business App profile and commerce. Most reads take the business user id.
-export const POST = route("admin", async ({ body, sessionOf }) => {
+export const POST = route("admin", async ({ body, connectionOf }) => {
const business = messaging().business;
- const session = sessionOf(body);
+ const connection = connectionOf(body);
const name = action(body);
switch (name) {
case "profile":
- return business.getProfile(session);
+ return business.getProfile(connection);
case "updateProfile":
- return business.updateProfile(session, {
+ return business.updateProfile(connection, {
description: text(body, "description"),
websites: ["https://acme.test"],
hours: {
@@ -37,67 +37,71 @@ export const POST = route("admin", async ({ body, sessionOf }) => {
},
});
case "setCoverPhoto":
- return business.setCoverPhoto(session, { url: text(body, "url") });
+ return business.setCoverPhoto(connection, { url: text(body, "url") });
case "deleteCoverPhoto":
- return business.deleteCoverPhoto(session, text(body, "coverPhotoId"));
+ return business.deleteCoverPhoto(connection, text(body, "coverPhotoId"));
case "catalog": {
const after = optionalText(body, "after");
- return business.getCatalog(session, {
+ return business.getCatalog(connection, {
id: text(body, "businessId"),
limit: optionalInteger(body, "limit") ?? 20,
...(after === undefined ? {} : { after }),
});
}
case "createCatalog":
- return business.createCatalog(session);
+ return business.createCatalog(connection);
case "setCartEnabled":
- return business.setCartEnabled(session, {
+ return business.setCartEnabled(connection, {
enabled: flag(body, "enabled"),
});
case "product":
- return business.getProduct(session, text(body, "productId"), {
+ return business.getProduct(connection, text(body, "productId"), {
id: text(body, "businessId"),
});
case "createProduct":
- return business.createProduct(session, product(body));
+ return business.createProduct(connection, product(body));
case "updateProduct":
return business.updateProduct(
- session,
+ connection,
text(body, "productId"),
product(body),
);
case "deleteProduct":
- return business.deleteProduct(session, text(body, "productId"));
+ return business.deleteProduct(connection, text(body, "productId"));
case "setProductVisibility":
- return business.setProductVisibility(session, text(body, "productId"), {
- hidden: flag(body, "hidden"),
- });
+ return business.setProductVisibility(
+ connection,
+ text(body, "productId"),
+ {
+ hidden: flag(body, "hidden"),
+ },
+ );
case "appealProduct":
- return business.appealProduct(session, text(body, "productId"), {
+ return business.appealProduct(connection, text(body, "productId"), {
reason: text(body, "reason"),
});
case "collections":
- return business.listCollections(session, {
+ return business.listCollections(connection, {
id: text(body, "businessId"),
collectionLimit: 10,
});
case "collection":
- return business.getCollection(session, text(body, "collectionId"), {
+ return business.getCollection(connection, text(body, "collectionId"), {
id: text(body, "businessId"),
});
case "createCollection":
- return business.createCollection(session, {
+ return business.createCollection(connection, {
name: text(body, "name"),
productIds: texts(body, "productIds"),
});
case "updateCollection":
- return business.updateCollection(session, text(body, "collectionId"), {
+ return business.updateCollection(connection, text(body, "collectionId"), {
name: text(body, "name"),
});
case "deleteCollection":
- return business.deleteCollection(session, text(body, "collectionId"));
+ return business.deleteCollection(connection, text(body, "collectionId"));
case "reorderCollections":
- return business.reorderCollections(session, {
+ return business.reorderCollections(connection, {
moves: [
{
collectionId: text(body, "collectionId"),
@@ -107,22 +111,22 @@ export const POST = route("admin", async ({ body, sessionOf }) => {
],
});
case "appealCollection":
- return business.appealCollection(session, text(body, "collectionId"), {
+ return business.appealCollection(connection, text(body, "collectionId"), {
reason: text(body, "reason"),
});
case "order":
- return business.getOrder(session, text(body, "orderId"), {
+ return business.getOrder(connection, text(body, "orderId"), {
token: text(body, "token"),
});
case "merchantCompliance":
- return business.getMerchantCompliance(session);
+ return business.getMerchantCompliance(connection);
case "setMerchantCompliance": {
const contact = {
email: "care@acme.test",
landlineNumber: "+15550100",
mobileNumber: "+15550101",
};
- return business.setMerchantCompliance(session, {
+ return business.setMerchantCompliance(connection, {
entityName: "Acme Inc.",
entityType: "PRIVATE_COMPANY",
isRegistered: true,
@@ -132,9 +136,9 @@ export const POST = route("admin", async ({ body, sessionOf }) => {
});
}
case "linkedAccounts":
- return business.getLinkedAccounts(session);
+ return business.getLinkedAccounts(connection);
case "eligibility":
- return business.getEligibility(session);
+ return business.getEligibility(connection);
default:
return unknownAction(name);
}
diff --git a/examples/full-platform/app/api/messaging/calls/token/route.ts b/examples/full-platform/app/api/messaging/calls/token/route.ts
index 9380e8bca..225e46530 100644
--- a/examples/full-platform/app/api/messaging/calls/token/route.ts
+++ b/examples/full-platform/app/api/messaging/calls/token/route.ts
@@ -8,7 +8,7 @@ import { env, isDemoMode } from "../../../../../lib/env.js";
import { messaging } from "../../../../../lib/polymorfa.js";
// Calls token minted with `clientTokens.mint` (POST /platform/client-tokens).
-// The session's client rules must grant voip_place, voip_answer and
+// The connection's client rules must grant voip_place, voip_answer and
// voip_signal.
export const POST = createClientTokenRoute({
authorize: async (request) => {
@@ -21,7 +21,7 @@ export const POST = createClientTokenRoute({
createMessagingClientTokenMint({
clientTokens: messaging().clientTokens,
resolve: () => ({
- session: env.session(),
+ connection: env.connection(),
ephemeralId: subject.userId,
ttlSeconds: 600,
}),
diff --git a/examples/full-platform/app/api/messaging/channels/route.ts b/examples/full-platform/app/api/messaging/channels/route.ts
index c75dfe6e2..df862897f 100644
--- a/examples/full-platform/app/api/messaging/channels/route.ts
+++ b/examples/full-platform/app/api/messaging/channels/route.ts
@@ -8,17 +8,17 @@ import {
unknownAction,
} from "../../../../lib/route.js";
-export const GET = route("agent", ({ body, sessionOf }) =>
- messaging().channels.list(sessionOf(body)),
+export const GET = route("agent", ({ body, connectionOf }) =>
+ messaging().channels.list(connectionOf(body)),
);
-export const POST = route("admin", async ({ body, sessionOf }) => {
+export const POST = route("admin", async ({ body, connectionOf }) => {
const channels = messaging().channels;
- const session = sessionOf(body);
+ const connection = connectionOf(body);
const name = action(body);
if (name === "create") {
const description = optionalText(body, "description");
- return channels.create(session, {
+ return channels.create(connection, {
name: text(body, "name"),
...(description === undefined ? {} : { description }),
});
@@ -26,47 +26,47 @@ export const POST = route("admin", async ({ body, sessionOf }) => {
const channelId = text(body, "channelId");
switch (name) {
case "retrieve":
- return channels.retrieve(session, channelId);
+ return channels.retrieve(connection, channelId);
case "delete":
- return channels.delete(session, channelId);
+ return channels.delete(connection, channelId);
case "messages": {
// Page older history with the smallest `position` you have seen.
const before = optionalInteger(body, "before");
- return channels.listMessages(session, channelId, {
+ return channels.listMessages(connection, channelId, {
count: 50,
...(before === undefined ? {} : { before }),
});
}
case "updates": {
const since = optionalInteger(body, "since");
- return channels.listMessageUpdates(session, channelId, {
+ return channels.listMessageUpdates(connection, channelId, {
count: 50,
...(since === undefined ? {} : { since }),
});
}
case "markViewed":
return channels.markMessageViewed(
- session,
+ connection,
channelId,
text(body, "messageId"),
);
case "react":
return channels.reactToMessage(
- session,
+ connection,
channelId,
text(body, "messageId"),
{ reaction: typeof body.reaction === "string" ? body.reaction : "" },
);
case "liveUpdates":
- return channels.subscribeToLiveUpdates(session, channelId);
+ return channels.subscribeToLiveUpdates(connection, channelId);
case "follow":
- return channels.follow(session, channelId);
+ return channels.follow(connection, channelId);
case "unfollow":
- return channels.unfollow(session, channelId);
+ return channels.unfollow(connection, channelId);
case "mute":
- return channels.mute(session, channelId);
+ return channels.mute(connection, channelId);
case "unmute":
- return channels.unmute(session, channelId);
+ return channels.unmute(connection, channelId);
default:
return unknownAction(name);
}
diff --git a/examples/full-platform/app/api/messaging/chats/route.ts b/examples/full-platform/app/api/messaging/chats/route.ts
index c5bb36bc8..3b42e4149 100644
--- a/examples/full-platform/app/api/messaging/chats/route.ts
+++ b/examples/full-platform/app/api/messaging/chats/route.ts
@@ -9,24 +9,24 @@ import {
const TIMERS = { off: 0, "24h": 86400, "7d": 604800, "90d": 7776000 } as const;
-export const POST = route("agent", async ({ body, sessionOf }) => {
+export const POST = route("agent", async ({ body, connectionOf }) => {
const chats = messaging().chats;
- const session = sessionOf(body);
+ const connection = connectionOf(body);
const chatId = text(body, "chatId");
switch (action(body)) {
case "editMessage":
- return chats.editMessage(session, chatId, text(body, "messageId"), {
+ return chats.editMessage(connection, chatId, text(body, "messageId"), {
text: text(body, "text"),
});
case "deleteMessage":
- return chats.deleteMessage(session, chatId, text(body, "messageId"));
+ return chats.deleteMessage(connection, chatId, text(body, "messageId"));
case "archive":
- return chats.archive(session, chatId);
+ return chats.archive(connection, chatId);
case "unarchive":
- return chats.unarchive(session, chatId);
+ return chats.unarchive(connection, chatId);
case "disappearing": {
const timer = oneOf(body, "timer", ["off", "24h", "7d", "90d"]);
- return chats.setDisappearingTimer(session, chatId, {
+ return chats.setDisappearingTimer(connection, chatId, {
durationSeconds: TIMERS[timer],
});
}
diff --git a/examples/full-platform/app/api/messaging/client-rules/route.ts b/examples/full-platform/app/api/messaging/client-rules/route.ts
index d88ec5426..4d4c05263 100644
--- a/examples/full-platform/app/api/messaging/client-rules/route.ts
+++ b/examples/full-platform/app/api/messaging/client-rules/route.ts
@@ -2,18 +2,18 @@ import { messaging } from "../../../../lib/polymorfa.js";
import { env } from "../../../../lib/env.js";
import { action, route, unknownAction } from "../../../../lib/route.js";
-export const GET = route("admin", ({ body, sessionOf }) =>
- messaging().clientTokens.retrieveRules(sessionOf(body)),
+export const GET = route("admin", ({ body, connectionOf }) =>
+ messaging().clientTokens.retrieveRules(connectionOf(body)),
);
-export const POST = route("admin", async ({ body, sessionOf }) => {
+export const POST = route("admin", async ({ body, connectionOf }) => {
const clientTokens = messaging().clientTokens;
- const session = sessionOf(body);
+ const connection = connectionOf(body);
switch (action(body)) {
case "apply":
- // What browser tokens for this session may do: chat in existing
+ // What browser tokens for this connection may do: chat in existing
// conversations and handle calls from this origin only.
- return clientTokens.updateRules(session, {
+ return clientTokens.updateRules(connection, {
enabled: true,
recipientMode: "conversation",
allowedActions: [
@@ -32,7 +32,7 @@ export const POST = route("admin", async ({ body, sessionOf }) => {
maxConcurrency: 1,
});
case "delete":
- return clientTokens.deleteRules(session);
+ return clientTokens.deleteRules(connection);
default:
return unknownAction(action(body));
}
diff --git a/examples/full-platform/app/api/messaging/sessions/route.ts b/examples/full-platform/app/api/messaging/connections/route.ts
similarity index 53%
rename from examples/full-platform/app/api/messaging/sessions/route.ts
rename to examples/full-platform/app/api/messaging/connections/route.ts
index 1e32935b6..1cad89fc2 100644
--- a/examples/full-platform/app/api/messaging/sessions/route.ts
+++ b/examples/full-platform/app/api/messaging/connections/route.ts
@@ -9,33 +9,33 @@ import {
unknownAction,
} from "../../../../lib/route.js";
-// Sessions are created by QuickLink (see ../quicklinks). These routes list,
-// inspect and operate existing sessions.
-export const GET = route("agent", () => messaging().sessions.list());
+// Connections are created by QuickLink (see ../quicklinks). These routes list,
+// inspect and operate existing connections.
+export const GET = route("agent", () => messaging().connections.list());
-export const POST = route("admin", async ({ body, sessionOf }) => {
- const sessions = messaging().sessions;
- const session = sessionOf(body);
+export const POST = route("admin", async ({ body, connectionOf }) => {
+ const connections = messaging().connections;
+ const connection = connectionOf(body);
switch (action(body)) {
case "retrieve":
- return sessions.retrieve(session);
+ return connections.retrieve(connection);
case "status": {
- const response = await sessions.retrieve(session);
+ const response = await connections.retrieve(connection);
const { status, statusReason } = response.data.data;
- return { session, status, statusReason };
+ return { connection, status, statusReason };
}
case "account":
- return sessions.account(session);
+ return connections.account(connection);
case "start":
- return sessions.start(session);
+ return connections.start(connection);
case "stop":
- return sessions.stop(session);
+ return connections.stop(connection);
case "restart":
- return sessions.restart(session);
+ return connections.restart(connection);
case "logout":
- return sessions.logout(session);
+ return connections.logout(connection);
case "delete":
- return sessions.delete(session);
+ return connections.delete(connection);
case "configure": {
// Optimistic concurrency: pass the revision you last read.
const history = object(body, "historySync");
@@ -43,16 +43,16 @@ export const POST = route("admin", async ({ body, sessionOf }) => {
if (mode !== "metadata_only" && mode !== "deliver") {
throw new InputError("historySync.mode is invalid.");
}
- return sessions.update(session, {
+ return connections.update(connection, {
configuration: { set: { historySync: { mode } } },
revision: integer(body, "revision"),
});
}
// Direct pairing is entitlement-gated; QuickLink is the standard flow.
case "qr":
- return sessions.qr(session);
+ return connections.qr(connection);
case "pairingCode":
- return sessions.requestPairingCode(session, {
+ return connections.requestPairingCode(connection, {
phone: text(body, "phone"),
});
default:
diff --git a/examples/full-platform/app/api/messaging/contacts/route.ts b/examples/full-platform/app/api/messaging/contacts/route.ts
index 8ec7432ff..fceb2b348 100644
--- a/examples/full-platform/app/api/messaging/contacts/route.ts
+++ b/examples/full-platform/app/api/messaging/contacts/route.ts
@@ -7,34 +7,34 @@ import {
unknownAction,
} from "../../../../lib/route.js";
-export const GET = route("agent", ({ body, sessionOf }) =>
- messaging().contacts.list(sessionOf(body)),
+export const GET = route("agent", ({ body, connectionOf }) =>
+ messaging().contacts.list(connectionOf(body)),
);
-export const POST = route("agent", async ({ body, sessionOf }) => {
+export const POST = route("agent", async ({ body, connectionOf }) => {
const contacts = messaging().contacts;
- const session = sessionOf(body);
+ const connection = connectionOf(body);
const name = action(body);
if (name === "check") {
- return contacts.check(session, texts(body, "phones"));
+ return contacts.check(connection, texts(body, "phones"));
}
- if (name === "blocklist") return contacts.blocklist(session);
+ if (name === "blocklist") return contacts.blocklist(connection);
const contactId = text(body, "contactId");
switch (name) {
case "retrieve":
- return contacts.retrieve(session, contactId);
+ return contacts.retrieve(connection, contactId);
case "picture":
- return contacts.picture(session, contactId);
+ return contacts.picture(connection, contactId);
case "info":
- return contacts.info(session, contactId);
+ return contacts.info(connection, contactId);
case "devices":
- return contacts.devices(session, contactId);
+ return contacts.devices(connection, contactId);
case "businessProfile":
- return contacts.businessProfile(session, contactId);
+ return contacts.businessProfile(connection, contactId);
case "block":
- return contacts.block(session, contactId);
+ return contacts.block(connection, contactId);
case "unblock":
- return contacts.unblock(session, contactId);
+ return contacts.unblock(connection, contactId);
default:
return unknownAction(name);
}
diff --git a/examples/full-platform/app/api/messaging/groups/route.ts b/examples/full-platform/app/api/messaging/groups/route.ts
index 22bdb842a..1d76e75b9 100644
--- a/examples/full-platform/app/api/messaging/groups/route.ts
+++ b/examples/full-platform/app/api/messaging/groups/route.ts
@@ -9,73 +9,73 @@ import {
unknownAction,
} from "../../../../lib/route.js";
-export const GET = route("agent", ({ body, sessionOf }) =>
- messaging().groups.list(sessionOf(body)),
+export const GET = route("agent", ({ body, connectionOf }) =>
+ messaging().groups.list(connectionOf(body)),
);
-export const POST = route("agent", async ({ body, sessionOf }) => {
+export const POST = route("agent", async ({ body, connectionOf }) => {
const groups = messaging().groups;
- const session = sessionOf(body);
+ const connection = connectionOf(body);
const name = action(body);
switch (name) {
case "create":
- return groups.create(session, {
+ return groups.create(connection, {
name: text(body, "name"),
participants: texts(body, "participants"),
});
case "joinInfo":
- return groups.getJoinInfo(session, text(body, "code"));
+ return groups.getJoinInfo(connection, text(body, "code"));
case "join":
- return groups.join(session, { code: text(body, "code") });
+ return groups.join(connection, { code: text(body, "code") });
}
const groupId = text(body, "groupId");
const participants = () => ({ participants: texts(body, "participants") });
switch (name) {
case "retrieve":
- return groups.retrieve(session, groupId);
+ return groups.retrieve(connection, groupId);
case "delete":
- return groups.delete(session, groupId);
+ return groups.delete(connection, groupId);
case "leave":
- return groups.leave(session, groupId);
+ return groups.leave(connection, groupId);
case "setSubject":
- return groups.setSubject(session, groupId, {
+ return groups.setSubject(connection, groupId, {
value: text(body, "value"),
});
case "setDescription":
- return groups.setDescription(session, groupId, {
+ return groups.setDescription(connection, groupId, {
value: text(body, "value"),
});
case "inviteCode":
- return groups.getInviteCode(session, groupId);
+ return groups.getInviteCode(connection, groupId);
case "revokeInviteCode":
- return groups.revokeInviteCode(session, groupId);
+ return groups.revokeInviteCode(connection, groupId);
case "participants":
- return groups.listParticipants(session, groupId);
+ return groups.listParticipants(connection, groupId);
case "addParticipants":
- return groups.addParticipants(session, groupId, participants());
+ return groups.addParticipants(connection, groupId, participants());
case "removeParticipants":
- return groups.removeParticipants(session, groupId, participants());
+ return groups.removeParticipants(connection, groupId, participants());
case "promoteParticipants":
- return groups.promoteParticipants(session, groupId, participants());
+ return groups.promoteParticipants(connection, groupId, participants());
case "demoteParticipants":
- return groups.demoteParticipants(session, groupId, participants());
+ return groups.demoteParticipants(connection, groupId, participants());
case "setPicture":
- return groups.setPicture(session, groupId, { url: text(body, "url") });
+ return groups.setPicture(connection, groupId, { url: text(body, "url") });
case "setInfoEditing":
- return groups.setInfoEditing(session, groupId, {
+ return groups.setInfoEditing(connection, groupId, {
adminsOnly: flag(body, "adminsOnly"),
});
case "setMessaging":
- return groups.setMessaging(session, groupId, {
+ return groups.setMessaging(connection, groupId, {
adminsOnly: flag(body, "adminsOnly"),
});
case "setMemberAddMode":
- return groups.setMemberAddMode(session, groupId, {
+ return groups.setMemberAddMode(connection, groupId, {
mode: oneOf(body, "mode", ["admin_add", "all_member_add"]),
});
case "setJoinApproval":
- return groups.setJoinApproval(session, groupId, {
+ return groups.setJoinApproval(connection, groupId, {
required: flag(body, "required"),
});
default:
diff --git a/examples/full-platform/app/api/messaging/identities/route.ts b/examples/full-platform/app/api/messaging/identities/route.ts
index 083e51ed3..a9757d760 100644
--- a/examples/full-platform/app/api/messaging/identities/route.ts
+++ b/examples/full-platform/app/api/messaging/identities/route.ts
@@ -11,14 +11,17 @@ import {
type Body,
} from "../../../../lib/route.js";
-export const POST = route("agent", async ({ body, sessionOf }) => {
- const session = sessionOf(body);
+export const POST = route("agent", async ({ body, connectionOf }) => {
+ const connection = connectionOf(body);
switch (action(body)) {
case "resolve":
- return messaging().identities.resolve(session, identity(body));
+ return messaging().identities.resolve(connection, identity(body));
case "securityCode":
// Display-only verification code for a stable user id.
- return messaging().users.getSecurityCode(session, text(body, "userId"));
+ return messaging().users.getSecurityCode(
+ connection,
+ text(body, "userId"),
+ );
default:
return unknownAction(action(body));
}
diff --git a/examples/full-platform/app/api/messaging/inbox/route.ts b/examples/full-platform/app/api/messaging/inbox/route.ts
index 923bfe49f..ce4512db6 100644
--- a/examples/full-platform/app/api/messaging/inbox/route.ts
+++ b/examples/full-platform/app/api/messaging/inbox/route.ts
@@ -24,7 +24,7 @@ export const POST = route("agent", async ({ body, request }) => {
const clientId = text(body, "clientId");
const replyTo = optionalText(body, "replyTo");
const response = await messaging().messages.send(
- env.session(),
+ env.connection(),
{
conversation: { phoneNumber: chat },
content: { text: content },
@@ -41,6 +41,6 @@ export const POST = route("agent", async ({ body, request }) => {
direction: "outbound" as const,
status: "sent" as const,
};
- emit("inbox.message", env.session(), { chat, message });
+ emit("inbox.message", env.connection(), { chat, message });
return message;
});
diff --git a/examples/full-platform/app/api/messaging/labels/route.ts b/examples/full-platform/app/api/messaging/labels/route.ts
index 0a39f4596..e14059662 100644
--- a/examples/full-platform/app/api/messaging/labels/route.ts
+++ b/examples/full-platform/app/api/messaging/labels/route.ts
@@ -10,19 +10,19 @@ import {
unknownAction,
} from "../../../../lib/route.js";
-export const GET = route("agent", ({ body, sessionOf, url }) =>
- messaging().labels.list(sessionOf(body), {
+export const GET = route("agent", ({ body, connectionOf, url }) =>
+ messaging().labels.list(connectionOf(body), {
includeObservation: url.searchParams.get("observation") === "true",
}),
);
-export const POST = route("agent", async ({ body, sessionOf }) => {
+export const POST = route("agent", async ({ body, connectionOf }) => {
const labels = messaging().labels;
- const session = sessionOf(body);
+ const connection = connectionOf(body);
switch (action(body)) {
case "create": {
const color = optionalInteger(body, "color");
- return labels.create(session, {
+ return labels.create(connection, {
name: text(body, "name"),
...(color === undefined ? {} : { color }),
});
@@ -32,23 +32,23 @@ export const POST = route("agent", async ({ body, sessionOf }) => {
const color = optionalInteger(body, "color");
const labelId = text(body, "labelId");
if (name !== undefined) {
- return labels.update(session, labelId, {
+ return labels.update(connection, labelId, {
name,
...(color === undefined ? {} : { color }),
});
}
if (color !== undefined) {
- return labels.update(session, labelId, { color });
+ return labels.update(connection, labelId, { color });
}
throw new InputError("Provide a name or color.");
}
case "delete":
- return labels.delete(session, text(body, "labelId"));
+ return labels.delete(connection, text(body, "labelId"));
case "forChat":
- return labels.listForChat(session, text(body, "chatId"));
+ return labels.listForChat(connection, text(body, "chatId"));
case "replaceForChat":
// Replaces the chat's complete label set.
- return labels.replaceForChat(session, text(body, "chatId"), {
+ return labels.replaceForChat(connection, text(body, "chatId"), {
labels: texts(body, "labels"),
});
default:
diff --git a/examples/full-platform/app/api/messaging/messages/route.ts b/examples/full-platform/app/api/messaging/messages/route.ts
index 63b27c7ea..d616fdccb 100644
--- a/examples/full-platform/app/api/messaging/messages/route.ts
+++ b/examples/full-platform/app/api/messaging/messages/route.ts
@@ -18,25 +18,28 @@ import {
type Body,
} from "../../../../lib/route.js";
-export const POST = route("agent", async ({ body, sessionOf, request }) => {
+export const POST = route("agent", async ({ body, connectionOf, request }) => {
const messages = messaging().messages;
- const session = sessionOf(body);
+ const connection = connectionOf(body);
const conversation = conversationOf(body);
switch (action(body)) {
case "send":
- return messages.send(session, buildMessage(body, { conversation }), {
+ return messages.send(connection, buildMessage(body, { conversation }), {
idempotencyKey: idempotencyKey(request),
});
case "seen":
- return messages.markSeen(session, { conversation, id: text(body, "id") });
+ return messages.markSeen(connection, {
+ conversation,
+ id: text(body, "id"),
+ });
case "typing":
- return messages.setTyping(session, {
+ return messages.setTyping(connection, {
conversation,
state: oneOf(body, "state", ["typing", "recording", "paused"]),
});
case "react":
return messages.react(
- session,
+ connection,
{
conversation,
id: text(body, "id"),
@@ -46,7 +49,7 @@ export const POST = route("agent", async ({ body, sessionOf, request }) => {
{ idempotencyKey: idempotencyKey(request) },
);
case "star":
- return messages.star(session, {
+ return messages.star(connection, {
conversation,
id: text(body, "id"),
star: flag(body, "star"),
diff --git a/examples/full-platform/app/api/messaging/observation-policies/route.ts b/examples/full-platform/app/api/messaging/observation-policies/route.ts
index 864e044de..b653e3553 100644
--- a/examples/full-platform/app/api/messaging/observation-policies/route.ts
+++ b/examples/full-platform/app/api/messaging/observation-policies/route.ts
@@ -2,14 +2,17 @@ import { messaging } from "../../../../lib/polymorfa.js";
import { env } from "../../../../lib/env.js";
import { route } from "../../../../lib/route.js";
-// Effective presence, typing and label observation for the project and session.
+// Effective presence, typing and label observation for the project and connection.
export const GET = route("admin", async ({ url }) => {
const policies = messaging().observationPolicies;
- const [projectPolicy, sessionPolicy] = await Promise.all([
+ const [projectPolicy, connectionPolicy] = await Promise.all([
policies.retrieveForProject(env.projectId()),
- policies.retrieveForSession(
- url.searchParams.get("session") ?? env.session(),
+ policies.retrieveForConnection(
+ url.searchParams.get("connection") ?? env.connection(),
),
]);
- return { project: projectPolicy.data.data, session: sessionPolicy.data.data };
+ return {
+ project: projectPolicy.data.data,
+ connection: connectionPolicy.data.data,
+ };
});
diff --git a/examples/full-platform/app/api/messaging/onboarding/route.ts b/examples/full-platform/app/api/messaging/onboarding/route.ts
index c0a5f18c2..6a8f66d8a 100644
--- a/examples/full-platform/app/api/messaging/onboarding/route.ts
+++ b/examples/full-platform/app/api/messaging/onboarding/route.ts
@@ -26,7 +26,7 @@ export const POST = route("admin", async ({ body }) => {
});
}
case "historyFixture":
- // Simulated history for testing sessions. Never use real content.
+ // Simulated history for testing connections. Never use real content.
return messaging().testing.createHistoryFixture(env.projectId(), {
messages: [
{
@@ -46,14 +46,14 @@ export const POST = route("admin", async ({ body }) => {
],
});
case "testingQuickLink": {
- // A QuickLink that opens a simulated testing session.
+ // A QuickLink that opens a simulated testing connection.
const response = await messaging().quickLinks.create({
configuration: {
testing: {
country: "US",
configuration: {
profile: { name: "Acme Test" },
- accountType: "business",
+ accountType: "business_app",
replyBehavior: "echo",
},
editable: ["profile.name", "replyBehavior"],
diff --git a/examples/full-platform/app/api/messaging/presence/route.ts b/examples/full-platform/app/api/messaging/presence/route.ts
index b9cd58b60..b6c7063b4 100644
--- a/examples/full-platform/app/api/messaging/presence/route.ts
+++ b/examples/full-platform/app/api/messaging/presence/route.ts
@@ -7,23 +7,23 @@ import {
unknownAction,
} from "../../../../lib/route.js";
-export const GET = route("agent", ({ body, sessionOf }) =>
- messaging().presence.get(sessionOf(body)),
+export const GET = route("agent", ({ body, connectionOf }) =>
+ messaging().presence.get(connectionOf(body)),
);
-export const POST = route("agent", async ({ body, sessionOf }) => {
+export const POST = route("agent", async ({ body, connectionOf }) => {
const presence = messaging().presence;
- const session = sessionOf(body);
+ const connection = connectionOf(body);
switch (action(body)) {
case "set":
- return presence.set(session, {
+ return presence.set(connection, {
presence: oneOf(body, "presence", ["available", "unavailable"]),
});
case "forChat":
// Retained observations governed by the observation policy.
- return presence.getForChat(session, text(body, "chatId"));
+ return presence.getForChat(connection, text(body, "chatId"));
case "subscribe":
- return presence.subscribe(session, text(body, "chatId"));
+ return presence.subscribe(connection, text(body, "chatId"));
default:
return unknownAction(action(body));
}
diff --git a/examples/full-platform/app/api/messaging/privacy/route.ts b/examples/full-platform/app/api/messaging/privacy/route.ts
index 9c81a30fe..1b5684e63 100644
--- a/examples/full-platform/app/api/messaging/privacy/route.ts
+++ b/examples/full-platform/app/api/messaging/privacy/route.ts
@@ -16,18 +16,21 @@ import {
const TIMERS = { off: 0, "24h": 86400, "7d": 604800, "90d": 7776000 } as const;
-export const GET = route("admin", ({ body, sessionOf }) =>
- messaging().privacy.get(sessionOf(body)),
+export const GET = route("admin", ({ body, connectionOf }) =>
+ messaging().privacy.get(connectionOf(body)),
);
-export const POST = route("admin", async ({ body, sessionOf }) => {
+export const POST = route("admin", async ({ body, connectionOf }) => {
const privacy = messaging().privacy;
- const session = sessionOf(body);
+ const connection = connectionOf(body);
switch (action(body)) {
case "set":
- return privacy.set(session, mutation(body.setting, text(body, "value")));
+ return privacy.set(
+ connection,
+ mutation(body.setting, text(body, "value")),
+ );
case "defaultTimer":
- return privacy.setDefaultDisappearingTimer(session, {
+ return privacy.setDefaultDisappearingTimer(connection, {
durationSeconds:
TIMERS[oneOf(body, "timer", ["off", "24h", "7d", "90d"])],
});
diff --git a/examples/full-platform/app/api/messaging/profile/route.ts b/examples/full-platform/app/api/messaging/profile/route.ts
index a85b64927..9ff369dfa 100644
--- a/examples/full-platform/app/api/messaging/profile/route.ts
+++ b/examples/full-platform/app/api/messaging/profile/route.ts
@@ -1,22 +1,22 @@
import { messaging } from "../../../../lib/polymorfa.js";
import { action, route, text, unknownAction } from "../../../../lib/route.js";
-export const GET = route("agent", ({ body, sessionOf }) =>
- messaging().profile.get(sessionOf(body)),
+export const GET = route("agent", ({ body, connectionOf }) =>
+ messaging().profile.get(connectionOf(body)),
);
-export const POST = route("admin", async ({ body, sessionOf }) => {
+export const POST = route("admin", async ({ body, connectionOf }) => {
const profile = messaging().profile;
- const session = sessionOf(body);
+ const connection = connectionOf(body);
switch (action(body)) {
case "setName":
- return profile.setName(session, { name: text(body, "name") });
+ return profile.setName(connection, { name: text(body, "name") });
case "setStatus":
- return profile.setStatus(session, { status: text(body, "status") });
+ return profile.setStatus(connection, { status: text(body, "status") });
case "setPicture":
- return profile.setPicture(session, { url: text(body, "url") });
+ return profile.setPicture(connection, { url: text(body, "url") });
case "deletePicture":
- return profile.deletePicture(session);
+ return profile.deletePicture(connection);
default:
return unknownAction(action(body));
}
diff --git a/examples/full-platform/app/api/messaging/quick-replies/route.ts b/examples/full-platform/app/api/messaging/quick-replies/route.ts
index a0f9f3428..5848e6523 100644
--- a/examples/full-platform/app/api/messaging/quick-replies/route.ts
+++ b/examples/full-platform/app/api/messaging/quick-replies/route.ts
@@ -7,24 +7,24 @@ import {
type Body,
} from "../../../../lib/route.js";
-export const GET = route("agent", ({ body, sessionOf }) =>
- messaging().quickReplies.list(sessionOf(body)),
+export const GET = route("agent", ({ body, connectionOf }) =>
+ messaging().quickReplies.list(connectionOf(body)),
);
-export const POST = route("agent", async ({ body, sessionOf }) => {
+export const POST = route("agent", async ({ body, connectionOf }) => {
const quickReplies = messaging().quickReplies;
- const session = sessionOf(body);
+ const connection = connectionOf(body);
switch (action(body)) {
case "create":
- return quickReplies.create(session, reply(body));
+ return quickReplies.create(connection, reply(body));
case "replace":
return quickReplies.replace(
- session,
+ connection,
text(body, "quickReplyId"),
reply(body),
);
case "delete":
- return quickReplies.delete(session, text(body, "quickReplyId"));
+ return quickReplies.delete(connection, text(body, "quickReplyId"));
default:
return unknownAction(action(body));
}
diff --git a/examples/full-platform/app/api/messaging/quicklinks/route.ts b/examples/full-platform/app/api/messaging/quicklinks/route.ts
index 8e423a688..428a00f93 100644
--- a/examples/full-platform/app/api/messaging/quicklinks/route.ts
+++ b/examples/full-platform/app/api/messaging/quicklinks/route.ts
@@ -28,8 +28,8 @@ export const POST = route("admin", async ({ body, request }) => {
},
{ idempotencyKey: idempotencyKey(request) },
);
- const { id, url, session, expiresAt } = response.data.data;
- return { id, url, session, expiresAt };
+ const { id, url, connection, expiresAt } = response.data.data;
+ return { id, url, connection, expiresAt };
}
case "retrieve":
return quickLinks.retrieve(text(body, "id"));
diff --git a/examples/full-platform/app/api/messaging/templates/route.ts b/examples/full-platform/app/api/messaging/templates/route.ts
index 8431e34e4..092b3f4a0 100644
--- a/examples/full-platform/app/api/messaging/templates/route.ts
+++ b/examples/full-platform/app/api/messaging/templates/route.ts
@@ -24,7 +24,7 @@ export const POST = route("admin", async ({ body }) => {
});
case "submit":
return templates.submit(slug, templateId, {
- session: env.templateSession(),
+ connection: env.templateConnection(),
});
case "delete":
return templates.delete(slug, templateId);
diff --git a/examples/full-platform/app/api/polymorfa/templates/route.ts b/examples/full-platform/app/api/polymorfa/templates/route.ts
index 780bf98cc..c50f1479d 100644
--- a/examples/full-platform/app/api/polymorfa/templates/route.ts
+++ b/examples/full-platform/app/api/polymorfa/templates/route.ts
@@ -21,7 +21,8 @@ export function POST(request: Request): Promise {
return operator?.role === "admin" ? { userId: operator.userId } : null;
},
resolveProjectSlug: () => (demo ? "demo" : env.projectSlug()),
- resolveSubmissionSession: () => (demo ? "demo" : env.templateSession()),
+ resolveSubmissionConnection: () =>
+ demo ? "demo" : env.templateConnection(),
});
} catch (error) {
return Promise.resolve(errorResponse(error));
diff --git a/examples/full-platform/app/api/polymorfa/token/route.ts b/examples/full-platform/app/api/polymorfa/token/route.ts
index a359a66a5..b3db9df6e 100644
--- a/examples/full-platform/app/api/polymorfa/token/route.ts
+++ b/examples/full-platform/app/api/polymorfa/token/route.ts
@@ -7,7 +7,7 @@ import { authenticate } from "../../../../lib/auth.js";
import { env, isDemoMode } from "../../../../lib/env.js";
import { messaging } from "../../../../lib/polymorfa.js";
-// Browser messaging token. The session's client rules decide what it can do
+// Browser messaging token. The connection's client rules decide what it can do
// (see /api/messaging/client-rules).
export const POST = createClientTokenRoute({
authorize: async (request) => {
@@ -20,7 +20,7 @@ export const POST = createClientTokenRoute({
createMessagingClientTokenMint({
clientTokens: messaging().clientTokens,
resolve: () => ({
- session: env.session(),
+ connection: env.connection(),
// One ephemeral id per operator keeps rate limits per person.
ephemeralId: subject.userId,
ttlSeconds: 300,
diff --git a/examples/full-platform/lib/desk/data.ts b/examples/full-platform/lib/desk/data.ts
index 158572cf8..7777fe22c 100644
--- a/examples/full-platform/lib/desk/data.ts
+++ b/examples/full-platform/lib/desk/data.ts
@@ -31,7 +31,7 @@ import type { MessagePage } from "./history.js";
export interface InboundMessage {
readonly id: string;
- readonly session: string;
+ readonly connection: string;
readonly phone: string;
readonly name?: string;
readonly text: string;
diff --git a/examples/full-platform/lib/desk/demo-fixtures.ts b/examples/full-platform/lib/desk/demo-fixtures.ts
index 9f71d4db6..04c0dec8e 100644
--- a/examples/full-platform/lib/desk/demo-fixtures.ts
+++ b/examples/full-platform/lib/desk/demo-fixtures.ts
@@ -90,7 +90,7 @@ const FIXTURES: Readonly> = {
slug: "acme-support",
defaultTier: "standard",
environment: "production",
- sessionCount: 3,
+ connectionCount: 3,
createdAt: iso(300 * DAY),
},
{
@@ -99,7 +99,7 @@ const FIXTURES: Readonly> = {
slug: "sandbox",
defaultTier: "free",
environment: "sandbox",
- sessionCount: 1,
+ connectionCount: 1,
createdAt: iso(20 * DAY),
},
],
@@ -113,7 +113,7 @@ const FIXTURES: Readonly> = {
usage: {
periodStart: iso(16 * DAY),
messages: 25_564,
- sessions: 3,
+ connections: 3,
amount: "96.20",
},
transactions: [
@@ -150,19 +150,19 @@ const FIXTURES: Readonly> = {
{
tier: "free",
region: "global",
- perSessionDay: "0.00",
+ perConnectionDay: "0.00",
perMessage: "0.000",
},
{
tier: "standard",
region: "north_america",
- perSessionDay: "0.40",
+ perConnectionDay: "0.40",
perMessage: "0.002",
},
{
tier: "pro",
region: "north_america",
- perSessionDay: "0.90",
+ perConnectionDay: "0.90",
perMessage: "0.001",
},
],
@@ -192,7 +192,7 @@ const FIXTURES: Readonly> = {
},
{
id: "aud_4",
- action: "session.restarted",
+ action: "connection.restarted",
actor: "priya@acme.test",
target: "sales-us",
createdAt: iso(0.2 * DAY),
@@ -207,33 +207,33 @@ const FIXTURES: Readonly> = {
detectedAt: iso(30 * DAY),
},
],
- sessionBans: [
+ connectionBans: [
{
id: "ban_1",
- session: "old-promo",
+ connection: "old-promo",
reason: "spam_reports",
status: "lifted",
createdAt: iso(70 * DAY),
},
],
- activeSessionBans: [],
+ activeConnectionBans: [],
},
- "/api/admin/sessions": [
+ "/api/admin/connections": [
{
id: "ses_1",
- sessionId: "support-main",
+ connectionId: "support-main",
status: "connected",
tierOverride: null,
},
{
id: "ses_2",
- sessionId: "sales-us",
+ connectionId: "sales-us",
status: "connected",
tierOverride: "pro",
},
{
id: "ses_3",
- sessionId: "billing-eu",
+ connectionId: "billing-eu",
status: "disconnected",
tierOverride: null,
},
@@ -241,21 +241,21 @@ const FIXTURES: Readonly> = {
"/api/admin/bansafe": {
numbers: [
{
- session: "support-main",
+ connection: "support-main",
phoneNumber: "+14155550100",
health: 94,
band: "good",
mostLikelyHealthState: "healthy",
},
{
- session: "sales-us",
+ connection: "sales-us",
phoneNumber: "+14155550142",
health: 71,
band: "fair",
mostLikelyHealthState: "healthy",
},
{
- session: "billing-eu",
+ connection: "billing-eu",
phoneNumber: "+442071838750",
health: 48,
band: "poor",
@@ -265,7 +265,7 @@ const FIXTURES: Readonly> = {
findings: [
{
id: "fnd_1",
- session: "billing-eu",
+ connection: "billing-eu",
severity: "critical",
code: "block_rate_high",
status: "open",
@@ -285,7 +285,7 @@ const FIXTURES: Readonly> = {
name: "Northwind Traders",
externalCustomerId: "nw-001",
status: "active",
- numberCount: 2,
+ connectionCount: 2,
createdAt: iso(100 * DAY),
},
{
@@ -293,7 +293,7 @@ const FIXTURES: Readonly> = {
name: "Globex",
externalCustomerId: "gx-17",
status: "active",
- numberCount: 1,
+ connectionCount: 1,
createdAt: iso(45 * DAY),
},
],
@@ -302,31 +302,31 @@ const FIXTURES: Readonly> = {
{
id: "evt_1",
type: "message.received",
- session: "support-main",
+ connection: "support-main",
createdAt: iso(60 * 1000),
},
{
id: "evt_2",
type: "message.ack",
- session: "support-main",
+ connection: "support-main",
createdAt: iso(90 * 1000),
},
{
id: "evt_3",
- type: "session.status",
- session: "billing-eu",
+ type: "connection.status",
+ connection: "billing-eu",
createdAt: iso(26 * 60 * 60 * 1000),
},
{
id: "evt_4",
type: "template.status",
- session: null,
+ connection: null,
createdAt: iso(5 * 60 * 60 * 1000),
},
{
id: "evt_5",
type: "call.missed",
- session: "support-main",
+ connection: "support-main",
createdAt: iso(190 * 60 * 1000),
},
],
@@ -342,7 +342,7 @@ const FIXTURES: Readonly> = {
"message.received",
"message.ack",
"call.received",
- "session.status",
+ "connection.status",
],
createdAt: iso(40 * DAY),
},
@@ -368,7 +368,7 @@ const FIXTURES: Readonly> = {
],
},
"/api/admin/settings": {
- sessionConfiguration: {
+ connectionConfiguration: {
team: {
observation: { presenceMode: "cache", typingMode: "events" },
historySync: { mode: "metadata_only" },
@@ -411,7 +411,7 @@ const FIXTURES: Readonly> = {
{ phone: "+14155550999", reason: "STOP keyword", createdAt: iso(5 * DAY) },
],
"/api/admin/campaigns": [],
- "/api/messaging/sessions": [],
+ "/api/messaging/connections": [],
"/api/messaging/inbox": {
messages: [
{
diff --git a/examples/full-platform/lib/desk/live.ts b/examples/full-platform/lib/desk/live.ts
index ff71457bd..1bd3a71d0 100644
--- a/examples/full-platform/lib/desk/live.ts
+++ b/examples/full-platform/lib/desk/live.ts
@@ -1,6 +1,6 @@
import type { MessageAttachment } from "@polymorfa/ui-kit";
import type {
- PlatformSession,
+ PlatformConnection,
ProjectTemplate,
SendMessageRequest,
} from "@polymorfa/sdk";
@@ -44,7 +44,7 @@ import {
const COLORS = ["#10b981", "#6366f1", "#f59e0b", "#ec4899", "#0ea5e9"];
/**
- * Data layer backed by the Polymorfa SDK. WhatsApp resources (sessions,
+ * Data layer backed by the Polymorfa SDK. WhatsApp resources (connections,
* labels, quick replies, contacts, templates, campaigns, presence, sends) go
* to the Messaging API. Tickets are this app's own records: they live in a
* process-local store fed by webhooks and sends, standing in for your database.
@@ -64,8 +64,8 @@ export class PolymorfaDesk implements DeskData {
}
}
- get #session(): string {
- return env.session();
+ get #connection(): string {
+ return env.connection();
}
async bootstrap(operator: Operator): Promise {
@@ -89,7 +89,7 @@ export class PolymorfaDesk implements DeskData {
/** Records an inbound WhatsApp message (called from the webhook handler). */
ingestInbound(input: InboundMessage): void {
const contact = this.#store.ensureContact(input.phone, input.name);
- const ticket = this.#store.openTicket(contact, input.session);
+ const ticket = this.#store.openTicket(contact, input.connection);
this.#store.upsert({
id: input.id,
ticketId: ticket.id,
@@ -121,15 +121,17 @@ export class PolymorfaDesk implements DeskData {
"Enter the number in E.164 format, like +14155550123.",
);
}
- const session = input.connectionId ?? this.#session;
+ const connection = input.connectionId ?? this.#connection;
// Confirm the number is on WhatsApp before opening a ticket.
- const checked = await messaging().contacts.check(session, input.phone);
+ const checked = await messaging().contacts.check(connection, input.phone);
if (!checked.data.data.some((result) => result.exists)) {
throw new InputError("This number is not on WhatsApp.");
}
const contact = this.#store.ensureContact(input.phone);
const agent = this.#store.agentFor(operator);
- return this.#store.openTicket(contact, session, { assigneeId: agent.id });
+ return this.#store.openTicket(contact, connection, {
+ assigneeId: agent.id,
+ });
}
async updateTicket(
@@ -263,7 +265,7 @@ export class PolymorfaDesk implements DeskData {
}
async listContacts(search?: string): Promise {
- const response = await messaging().contacts.list(this.#session);
+ const response = await messaging().contacts.list(this.#connection);
for (const contact of response.data.data) {
if (contact.phoneNumber === undefined) continue;
const known = this.#store.ensureContact(
@@ -288,13 +290,13 @@ export class PolymorfaDesk implements DeskData {
if (patch.blocked !== undefined && patch.blocked !== contact.blocked) {
await (patch.blocked ? contacts.block : contacts.unblock).call(
contacts,
- this.#session,
+ this.#connection,
contact.phone,
);
}
if (patch.tags !== undefined) {
// Labels are WhatsApp Business chat labels; replace the chat's full set.
- await messaging().labels.replaceForChat(this.#session, contact.phone, {
+ await messaging().labels.replaceForChat(this.#connection, contact.phone, {
labels: patch.tags,
});
}
@@ -305,7 +307,7 @@ export class PolymorfaDesk implements DeskData {
const valid = rows.filter((row) => isE164(row.phone));
if (valid.length === 0) return { imported: 0, skipped: rows.length };
const checked = await messaging().contacts.check(
- this.#session,
+ this.#connection,
valid.map((row) => row.phone),
);
const onWhatsApp = new Set(
@@ -330,7 +332,7 @@ export class PolymorfaDesk implements DeskData {
}
async listQuickReplies(): Promise {
- const response = await messaging().quickReplies.list(this.#session);
+ const response = await messaging().quickReplies.list(this.#connection);
return response.data.data.quickReplies.map(({ id, shortcut, message }) => ({
id,
shortcut,
@@ -347,18 +349,18 @@ export class PolymorfaDesk implements DeskData {
const quickReplies = messaging().quickReplies;
const response =
input.id === undefined
- ? await quickReplies.create(this.#session, body)
- : await quickReplies.replace(this.#session, input.id, body);
+ ? await quickReplies.create(this.#connection, body)
+ : await quickReplies.replace(this.#connection, input.id, body);
const { id, shortcut, message } = response.data.data;
return { id, shortcut, message };
}
async deleteQuickReply(id: string) {
- await messaging().quickReplies.delete(this.#session, id);
+ await messaging().quickReplies.delete(this.#connection, id);
}
async listTags(): Promise {
- const response = await messaging().labels.list(this.#session);
+ const response = await messaging().labels.list(this.#connection);
const data = response.data.data;
const labels = "labels" in data ? data.labels : data;
return labels.map((label) => ({
@@ -372,13 +374,13 @@ export class PolymorfaDesk implements DeskData {
async saveTag(input: { id?: string; name: string; color: number }) {
const labels = messaging().labels;
if (input.id === undefined) {
- const created = await labels.create(this.#session, {
+ const created = await labels.create(this.#connection, {
name: input.name,
color: input.color,
});
return { ...created.data.data, chatCount: 0 };
}
- await labels.update(this.#session, input.id, {
+ await labels.update(this.#connection, input.id, {
name: input.name,
color: input.color,
});
@@ -386,15 +388,15 @@ export class PolymorfaDesk implements DeskData {
}
async deleteTag(id: string) {
- await messaging().labels.delete(this.#session, id);
+ await messaging().labels.delete(this.#connection, id);
}
async listConnections(): Promise {
- const response = await messaging().sessions.list();
- const sessions = response.data.data;
+ const response = await messaging().connections.list();
+ const connections = response.data.data;
const health = await this.#health();
- return sessions.map((session, index) =>
- toConnection(session, index, health.get(session.name)),
+ return connections.map((connection, index) =>
+ toConnection(connection, index, health.get(connection.name)),
);
}
@@ -408,7 +410,7 @@ export class PolymorfaDesk implements DeskData {
limit: 100,
});
for (const number of page.data.data)
- scores.set(number.session, number.health);
+ scores.set(number.connection, number.health);
} catch (error) {
console.warn("BanSafe health unavailable", error);
}
@@ -420,27 +422,27 @@ export class PolymorfaDesk implements DeskData {
action: ConnectionAction,
phone?: string,
): Promise>> {
- const sessions = messaging().sessions;
+ const connections = messaging().connections;
switch (action) {
case "restart":
- return { ...(await sessions.restart(connectionId)).data };
+ return { ...(await connections.restart(connectionId)).data };
case "logout":
- return { ...(await sessions.logout(connectionId)).data };
+ return { ...(await connections.logout(connectionId)).data };
case "delete":
- return { ...(await sessions.delete(connectionId)).data };
+ return { ...(await connections.delete(connectionId)).data };
case "start":
- return { ...(await sessions.start(connectionId)).data };
+ return { ...(await connections.start(connectionId)).data };
case "stop":
- return { ...(await sessions.stop(connectionId)).data };
+ return { ...(await connections.stop(connectionId)).data };
case "qr":
- return { ...(await sessions.qr(connectionId)).data.data };
+ return { ...(await connections.qr(connectionId)).data.data };
case "pairingCode":
if (phone === undefined || !isE164(phone)) {
throw new InputError("Enter the phone number in E.164 format.");
}
return {
- ...(await sessions.requestPairingCode(connectionId, { phone })).data
- .data,
+ ...(await connections.requestPairingCode(connectionId, { phone }))
+ .data.data,
};
}
}
@@ -691,23 +693,23 @@ function toSendRequest(
}
function toConnection(
- session: PlatformSession,
+ connection: PlatformConnection,
index: number,
health: number | null | undefined,
): Connection {
- const score = health ?? (session.status === "connected" ? 90 : 50);
+ const score = health ?? (connection.status === "connected" ? 90 : 50);
const level: HealthLevel =
score >= 80 ? "healthy" : score >= 60 ? "watch" : "at_risk";
return {
- id: session.name,
- name: session.name,
- phone: session.phone,
- platform: session.platform,
- isBusiness: session.isBusiness,
- status: session.status,
+ id: connection.name,
+ name: connection.name,
+ phone: connection.phone,
+ platform: connection.platform,
+ isBusiness: connection.isBusiness,
+ status: connection.status,
color: COLORS[index % COLORS.length] ?? "#10b981",
- messageCount: session.messageCount,
- lastActiveAt: session.lastActiveAt,
+ messageCount: connection.messageCount,
+ lastActiveAt: connection.lastActiveAt,
health: { score, level },
};
}
diff --git a/examples/full-platform/lib/desk/mock.ts b/examples/full-platform/lib/desk/mock.ts
index f17aecf36..dae6088e4 100644
--- a/examples/full-platform/lib/desk/mock.ts
+++ b/examples/full-platform/lib/desk/mock.ts
@@ -301,7 +301,9 @@ export class MockDesk implements DeskData {
...current,
status: "connected",
});
- emitWebhook("session.status", connectionId, { status: "connected" });
+ emitWebhook("connection.status", connectionId, {
+ status: "connected",
+ });
}, 2000);
return { status: "connecting" };
}
diff --git a/examples/full-platform/lib/desk/types.ts b/examples/full-platform/lib/desk/types.ts
index 7b395f871..f6eddb109 100644
--- a/examples/full-platform/lib/desk/types.ts
+++ b/examples/full-platform/lib/desk/types.ts
@@ -35,7 +35,7 @@ export interface Tag {
export type HealthLevel = "healthy" | "watch" | "at_risk";
export interface Connection {
- /** Session name used in Messaging API paths. */
+ /** Connection name used in Messaging API paths. */
readonly id: string;
readonly name: string;
readonly phone: string | null;
diff --git a/examples/full-platform/lib/env.ts b/examples/full-platform/lib/env.ts
index 75608434b..c203b3718 100644
--- a/examples/full-platform/lib/env.ts
+++ b/examples/full-platform/lib/env.ts
@@ -18,14 +18,14 @@ export const env = {
teamApiKey: () => requiredEnv("POLYMORFA_TEAM_API_KEY"),
projectId: () => requiredEnv("POLYMORFA_PROJECT_ID"),
projectSlug: () => requiredEnv("POLYMORFA_PROJECT_SLUG"),
- session: () => requiredEnv("POLYMORFA_SESSION"),
- templateSession: () => requiredEnv("POLYMORFA_TEMPLATE_SESSION"),
+ connection: () => requiredEnv("POLYMORFA_CONNECTION"),
+ templateConnection: () => requiredEnv("POLYMORFA_TEMPLATE_CONNECTION"),
webhookSecret: () => requiredEnv("POLYMORFA_WEBHOOK_SECRET"),
messagingWebhookSecret: () =>
requiredEnv("POLYMORFA_MESSAGING_WEBHOOK_SECRET"),
- /** Extra sessions agents may address; the default session is always allowed. */
- agentSessions: () =>
- (optionalEnv("POLYMORFA_AGENT_SESSIONS") ?? "")
+ /** Extra connections agents may address; the default connection is always allowed. */
+ agentConnections: () =>
+ (optionalEnv("POLYMORFA_AGENT_CONNECTIONS") ?? "")
.split(",")
.map((name) => name.trim())
.filter((name) => name.length > 0),
diff --git a/examples/full-platform/lib/polymorfa.ts b/examples/full-platform/lib/polymorfa.ts
index 7a3801c49..3093e2b96 100644
--- a/examples/full-platform/lib/polymorfa.ts
+++ b/examples/full-platform/lib/polymorfa.ts
@@ -24,7 +24,7 @@ function shared(): SharedClientOptions {
};
}
-/** Project-scoped Messaging API client (sessions, messages, templates, calls, ...). */
+/** Project-scoped Messaging API client (connections, messages, templates, calls, ...). */
export function messaging(): MessagingClient {
assertServerRuntime();
messagingClient ??= new MessagingClient({
diff --git a/examples/full-platform/lib/realtime.ts b/examples/full-platform/lib/realtime.ts
index 92aba6ed8..e08876153 100644
--- a/examples/full-platform/lib/realtime.ts
+++ b/examples/full-platform/lib/realtime.ts
@@ -64,12 +64,12 @@ export function publish(event: RealtimeEvent): void {
/** Builds and publishes an app event in the webhook envelope. */
export function emit(
event: K,
- session: string,
+ connection: string,
payload: AppEventPayloads[K],
): void {
publish({
id: `evt_${crypto.randomUUID()}`,
- session,
+ connection,
timestamp: new Date().toISOString(),
event,
payload,
@@ -79,12 +79,12 @@ export function emit(
/** Publishes a webhook-shaped event that the app synthesizes, e.g. in demo mode. */
export function emitWebhook(
event: K,
- session: string,
+ connection: string,
payload: WebhookPayloadMap[K],
): void {
publish({
id: `evt_${crypto.randomUUID()}`,
- session,
+ connection,
timestamp: new Date().toISOString(),
event,
payload,
diff --git a/examples/full-platform/lib/route.ts b/examples/full-platform/lib/route.ts
index 39e91634d..fbca6bfee 100644
--- a/examples/full-platform/lib/route.ts
+++ b/examples/full-platform/lib/route.ts
@@ -30,10 +30,10 @@ export interface RouteContext {
readonly body: Body;
readonly url: URL;
/**
- * The session this operator may address: the body's `session` field (the
- * `?session=` query for GET), or the default session.
+ * The connection this operator may address: the body's `connection` field (the
+ * `?connection=` query for GET), or the default connection.
*/
- readonly sessionOf: (body: Body) => string;
+ readonly connectionOf: (body: Body) => string;
}
const privateHeaders = { "Cache-Control": "no-store, private" };
@@ -54,8 +54,8 @@ export function route(
if (role === "admin" && operator.role !== "admin") {
return problem(403, "forbidden");
}
- // GET reads take the session from `?session=`, checked by `sessionOf`
- // exactly like a mutation's `session` field.
+ // GET reads take the connection from `?connection=`, checked by `connectionOf`
+ // exactly like a mutation's `connection` field.
const body =
request.method === "GET" ? queryBody(request) : await readBody(request);
// Without credentials, SDK routes answer with sample data so the UI
@@ -77,7 +77,7 @@ export function route(
operator,
body,
url: new URL(request.url),
- sessionOf: (input) => sessionOf(input, operator.role),
+ connectionOf: (input) => connectionOf(input, operator.role),
});
if (result instanceof Response) return result;
return Response.json(unwrap(result), { headers: privateHeaders });
@@ -121,8 +121,8 @@ function isApiResponse(value: unknown): value is ApiResponse {
}
function queryBody(request: Request): Body {
- const session = new URL(request.url).searchParams.get("session");
- return session === null ? {} : { session };
+ const connection = new URL(request.url).searchParams.get("connection");
+ return connection === null ? {} : { connection };
}
async function readBody(request: Request): Promise {
@@ -281,17 +281,17 @@ export function idempotencyKey(request: Request): string {
}
/**
- * Agents may only address the default session or one listed in
- * POLYMORFA_AGENT_SESSIONS; admins may address any session.
+ * Agents may only address the default connection or one listed in
+ * POLYMORFA_AGENT_CONNECTIONS; admins may address any connection.
*/
-function sessionOf(body: Body, role: Role): string {
- const requested = optionalText(body, "session");
- const fallback = env.session();
+function connectionOf(body: Body, role: Role): string {
+ const requested = optionalText(body, "connection");
+ const fallback = env.connection();
if (requested === undefined || requested === fallback) return fallback;
- if (role === "admin" || env.agentSessions().includes(requested)) {
+ if (role === "admin" || env.agentConnections().includes(requested)) {
return requested;
}
- throw new InputError("session is not available to this operator.");
+ throw new InputError("connection is not available to this operator.");
}
/** Accepts `{ chat: { phoneNumber } }`, `{ chat: { id } }` or `{ chat: { bsuid } }`. */
diff --git a/examples/full-platform/lib/webhooks.ts b/examples/full-platform/lib/webhooks.ts
index 0b4e67c7c..1ffcb25b9 100644
--- a/examples/full-platform/lib/webhooks.ts
+++ b/examples/full-platform/lib/webhooks.ts
@@ -20,9 +20,9 @@ export const WEBHOOK_EVENTS = [
"call.received",
"call.ended",
"call.missed",
- "session.status",
- "session.connected",
- "session.logged_out",
+ "connection.status",
+ "connection.connected",
+ "connection.logged_out",
"template.status",
"campaign.completed",
"bansafe.incident",
@@ -78,24 +78,24 @@ function handle(event: WebhookEvent): void {
// Browsers get the verified event unchanged, in the same envelope.
publish(event);
if (isEvent(event, "message.received")) {
- receiveMessage(event.payload, event.session);
+ receiveMessage(event.payload, event.connection);
} else if (isEvent(event, "message.ack")) {
for (const message of event.payload.messages) {
console.info("ack", message.id);
}
- } else if (isEvent(event, "session.connected")) {
- console.info("connected", event.session, event.payload.accountType);
- } else if (isEvent(event, "session.logged_out")) {
- console.warn("logged out", event.session, event.payload.reason);
+ } else if (isEvent(event, "connection.connected")) {
+ console.info("connected", event.connection, event.payload.accountType);
+ } else if (isEvent(event, "connection.logged_out")) {
+ console.warn("logged out", event.connection, event.payload.reason);
} else if (isEvent(event, "campaign.completed")) {
console.info("campaign completed", event.payload.campaignId);
} else if (isEvent(event, "bansafe.incident")) {
- console.warn("BanSafe incident", event.session, event.payload.kind);
+ console.warn("BanSafe incident", event.connection, event.payload.kind);
} else if (
!isEvent(event, "call.received") &&
!isEvent(event, "call.ended") &&
!isEvent(event, "call.missed") &&
- !isEvent(event, "session.status") &&
+ !isEvent(event, "connection.status") &&
!isEvent(event, "template.status") &&
!isEvent(event, "customer.created")
) {
@@ -106,7 +106,7 @@ function handle(event: WebhookEvent): void {
function receiveMessage(
payload: MessageReceivedPayload,
- session: string | undefined,
+ connection: string | undefined,
): void {
const chat = payload.conversation.phoneNumber ?? payload.conversation.id;
const linked = isLinkedDevice(payload) ? payload : undefined;
@@ -115,12 +115,16 @@ function receiveMessage(
const createdAt = toMilliseconds(payload.timestamp);
const phone = payload.conversation.phoneNumber;
// Customer messages open or update a help-desk ticket.
- if (linked?.fromMe !== true && phone !== undefined && session !== undefined) {
+ if (
+ linked?.fromMe !== true &&
+ phone !== undefined &&
+ connection !== undefined
+ ) {
void desk()
.then((data) => {
data.ingestInbound?.({
id: payload.id,
- session,
+ connection,
phone,
text: body ?? "",
kind: kindOf(payload.type),
@@ -129,12 +133,15 @@ function receiveMessage(
})
.catch((error: unknown) => console.error("ticket ingest failed", error));
}
- // The inbox reads and replies through POLYMORFA_SESSION, so only that
- // session's messages go there; tickets above keep their own session.
- if (session === undefined || session !== optionalEnv("POLYMORFA_SESSION")) {
+ // The inbox reads and replies through POLYMORFA_CONNECTION, so only that
+ // connection's messages go there; tickets above keep their own connection.
+ if (
+ connection === undefined ||
+ connection !== optionalEnv("POLYMORFA_CONNECTION")
+ ) {
return;
}
- emit("inbox.message", session, {
+ emit("inbox.message", connection, {
chat,
message: {
id: payload.id,
diff --git a/examples/full-platform/ui/app.tsx b/examples/full-platform/ui/app.tsx
index fb88a9522..2cfdd8328 100644
--- a/examples/full-platform/ui/app.tsx
+++ b/examples/full-platform/ui/app.tsx
@@ -32,20 +32,20 @@ import { TicketsPage } from "./tickets/tickets-page.js";
function CallsProvider({ children }: { readonly children: ReactNode }) {
const { bootstrap } = useDesk();
const [calls, setCalls] = useState(null);
- const session = bootstrap.connections[0]?.id ?? "";
+ const connection = bootstrap.connections[0]?.id ?? "";
useEffect(() => {
// Calls need browser media APIs, so create them after mount.
- if (!bootstrap.me.demo && session === "") {
+ if (!bootstrap.me.demo && connection === "") {
setCalls(null);
return;
}
- const created = createDeskCalls({ demo: bootstrap.me.demo, session });
+ const created = createDeskCalls({ demo: bootstrap.me.demo, connection });
setCalls(created);
return () => {
setCalls((current) => (current === created ? null : current));
created.dispose();
};
- }, [bootstrap.me.demo, session]);
+ }, [bootstrap.me.demo, connection]);
const names = useMemo(
() =>
diff --git a/examples/full-platform/ui/calls.ts b/examples/full-platform/ui/calls.ts
index 11d67040f..f9076cad7 100644
--- a/examples/full-platform/ui/calls.ts
+++ b/examples/full-platform/ui/calls.ts
@@ -25,9 +25,9 @@ export interface DeskCalls {
* Real calling. The client token from /api/messaging/calls/token is the only
* credential; the lifecycle stream delivers incoming calls and their answers.
*/
-function createLiveCalls(session: string): DeskCalls {
+function createLiveCalls(connection: string): DeskCalls {
const calls = createBrowserCalls({
- session,
+ connection,
getClientToken: createClientTokenProvider({
path: "/api/messaging/calls/token",
}),
@@ -50,7 +50,7 @@ function createLiveCalls(session: string): DeskCalls {
/**
* Demo calling: a backend that rings, connects and hangs up on timers, and
- * media sessions with empty streams, so the call UI runs without a network.
+ * media connections with empty streams, so the call UI runs without a network.
*/
function createDemoCalls(): DeskCalls {
const listeners = new Set<(event: CallLifecycleEvent) => void>();
@@ -140,7 +140,7 @@ function createDemoCalls(): DeskCalls {
export function createDeskCalls(options: {
readonly demo: boolean;
- readonly session: string;
+ readonly connection: string;
}): DeskCalls {
- return options.demo ? createDemoCalls() : createLiveCalls(options.session);
+ return options.demo ? createDemoCalls() : createLiveCalls(options.connection);
}
diff --git a/examples/full-platform/ui/pages/admin.tsx b/examples/full-platform/ui/pages/admin.tsx
index d1bd9380b..3d490d2f3 100644
--- a/examples/full-platform/ui/pages/admin.tsx
+++ b/examples/full-platform/ui/pages/admin.tsx
@@ -150,7 +150,7 @@ function Table({
caption={caption}
rows={rows}
rowKey={(row) =>
- String(row.id ?? row.session ?? row.phone ?? JSON.stringify(row))
+ String(row.id ?? row.connection ?? row.phone ?? JSON.stringify(row))
}
empty="Nothing to show."
columns={[
@@ -278,7 +278,7 @@ const TABS: readonly { id: string; label: string; icon: IconName }[] = [
{ id: "bansafe", label: "BanSafe", icon: "alert" },
{ id: "customers", label: "Customers", icon: "contacts" },
{ id: "audiences", label: "Audiences", icon: "campaigns" },
- { id: "settings", label: "Session settings", icon: "settings" },
+ { id: "settings", label: "Connection settings", icon: "settings" },
{ id: "platform", label: "Platform", icon: "globe" },
{ id: "messaging", label: "Messaging API", icon: "code" },
];
@@ -419,7 +419,7 @@ function Panel({ tab }: { readonly tab: string }) {
>
@@ -465,11 +465,11 @@ function Panel({ tab }: { readonly tab: string }) {
}
/>
-
+
>
@@ -605,7 +605,7 @@ function Panel({ tab }: { readonly tab: string }) {
)}
@@ -621,7 +621,7 @@ function Panel({ tab }: { readonly tab: string }) {
caption="Number health"
rows={rowsOf(field(data, "numbers"))}
keys={[
- "session",
+ "connection",
"phoneNumber",
"health",
"band",
@@ -633,7 +633,13 @@ function Panel({ tab }: { readonly tab: string }) {
>
@@ -652,7 +658,7 @@ function Panel({ tab }: { readonly tab: string }) {
"name",
"externalCustomerId",
"status",
- "numberCount",
+ "connectionCount",
"createdAt",
]}
/>
@@ -691,12 +697,12 @@ function Panel({ tab }: { readonly tab: string }) {
return (
{(data, reload) => {
- const config = field(data, "sessionConfiguration") as
+ const config = field(data, "connectionConfiguration") as
Row | undefined;
const quick = field(data, "quickLinkSettings") as Row | undefined;
return (
-
+
Team
@@ -803,7 +809,7 @@ function Panel({ tab }: { readonly tab: string }) {
}
>
- Browser tokens can only do what the session's client rules
+ Browser tokens can only do what the connection's client rules
allow: sending messages and placing, answering and signaling calls
from this app's origin.
diff --git a/examples/full-platform/ui/pages/connections.tsx b/examples/full-platform/ui/pages/connections.tsx
index 4cd575f44..c8a7f13ea 100644
--- a/examples/full-platform/ui/pages/connections.tsx
+++ b/examples/full-platform/ui/pages/connections.tsx
@@ -80,7 +80,7 @@ function PairModal({
const result = await callApi
>>(
"/api/desk/connections",
{
- action: "session",
+ action: "connection",
connectionId: connection.id,
operation,
...(operation === "pairingCode"
@@ -106,7 +106,7 @@ function PairModal({
return (
@@ -199,10 +199,10 @@ export function ConnectionsPage() {
const { reload, setData } = connections;
useLiveEvents({
- "session.status": (event) =>
+ "connection.status": (event) =>
setData((current) =>
current?.map((connection) =>
- connection.id === event.session && "status" in event.payload
+ connection.id === event.connection && "status" in event.payload
? { ...connection, status: event.payload.status }
: connection,
),
@@ -226,7 +226,7 @@ export function ConnectionsPage() {
setBusy(`${connection.id}:${operation}`);
try {
await callApi("/api/desk/connections", {
- action: "session",
+ action: "connection",
connectionId: connection.id,
operation,
});
diff --git a/examples/full-platform/ui/pages/login.tsx b/examples/full-platform/ui/pages/login.tsx
index 2fb59d5a8..140adb3a6 100644
--- a/examples/full-platform/ui/pages/login.tsx
+++ b/examples/full-platform/ui/pages/login.tsx
@@ -42,7 +42,7 @@ export function LoginPage({ error }: { readonly error?: string }) {
Admin
- Everything, including sessions and billing
+ Everything, including connections and billing
diff --git a/examples/full-platform/ui/pages/settings.tsx b/examples/full-platform/ui/pages/settings.tsx
index 51b6fa9ba..44b99af97 100644
--- a/examples/full-platform/ui/pages/settings.tsx
+++ b/examples/full-platform/ui/pages/settings.tsx
@@ -38,7 +38,7 @@ const LOCALES = [
{ value: "he", label: "עברית (right to left)" },
];
-function SessionSettings() {
+function ConnectionSettings() {
const { bootstrap } = useDesk();
const settings = useResource>("/api/admin/settings");
const [mode, setMode] = useState<"metadata_only" | "deliver">(
@@ -46,25 +46,26 @@ function SessionSettings() {
);
const [busy, setBusy] = useState(false);
const project = ((
- settings.data?.sessionConfiguration as Record | undefined
+ settings.data?.connectionConfiguration as
+ Record | undefined
)?.project ?? {}) as { revision?: number; data?: { revision?: number } };
const revision = project.revision ?? project.data?.revision ?? 0;
const save = async () => {
- const session = bootstrap.connections[0]?.id;
- if (session === undefined) {
- toast("Connect a WhatsApp session first", "danger");
+ const connection = bootstrap.connections[0]?.id;
+ if (connection === undefined) {
+ toast("Connect a WhatsApp connection first", "danger");
return;
}
setBusy(true);
try {
- await callApi("/api/messaging/sessions", {
+ await callApi("/api/messaging/connections", {
action: "configure",
- session,
+ connection,
historySync: { mode },
revision,
});
- toast("Session configuration saved", "success");
+ toast("Connection configuration saved", "success");
} catch (error) {
toast(errorMessage(error), "danger");
} finally {
@@ -73,11 +74,11 @@ function SessionSettings() {
};
return (
-
+
- Controls what WhatsApp history the session shares with this app when a
- phone links.
+ Controls what WhatsApp history the connection shares with this app
+ when a phone links.
- Applies to {bootstrap.connections[0]?.name ?? "the default session"}{" "}
- · revision {revision}
+ Applies to{" "}
+ {bootstrap.connections[0]?.name ?? "the default connection"} ·
+ revision {revision}
void save()}>
Save
@@ -245,7 +247,7 @@ export function SettingsPage() {
}}
/>
- {isAdmin && }
+ {isAdmin && }
diff --git a/examples/full-platform/ui/qr.ts b/examples/full-platform/ui/qr.ts
index 350913a77..b80c7c4fd 100644
--- a/examples/full-platform/ui/qr.ts
+++ b/examples/full-platform/ui/qr.ts
@@ -1,6 +1,6 @@
/**
* Minimal QR code encoder (byte mode, error correction level L, mask 0),
- * enough to show a session pairing payload as a scannable code without a
+ * enough to show a connection pairing payload as a scannable code without a
* dependency. Based on the structure of the QR Code Model 2 specification.
*/
diff --git a/examples/full-platform/ui/shell.tsx b/examples/full-platform/ui/shell.tsx
index 55991a3fc..ac5e379d4 100644
--- a/examples/full-platform/ui/shell.tsx
+++ b/examples/full-platform/ui/shell.tsx
@@ -104,11 +104,11 @@ function Rail() {
function ConnectionHealth() {
const { bootstrap, setBootstrap, navigate } = useDesk();
useLiveEvents({
- "session.status": (event) =>
+ "connection.status": (event) =>
setBootstrap((current) => ({
...current,
connections: current.connections.map((connection) =>
- connection.id === event.session && "status" in event.payload
+ connection.id === event.connection && "status" in event.payload
? { ...connection, status: event.payload.status }
: connection,
),
@@ -217,7 +217,7 @@ function AgentMenu() {
icon: "logout",
danger: true,
onSelect: () => {
- // Cached conversations never outlive the session on this device.
+ // Cached conversations never outlive the connection on this device.
void clearDeviceConversationCache().finally(() => {
const form = document.getElementById("sign-out-form");
if (form instanceof HTMLFormElement) form.requestSubmit();
diff --git a/examples/go/calls-agent/main.go b/examples/go/calls-agent/main.go
index b5a62a054..43336c51d 100644
--- a/examples/go/calls-agent/main.go
+++ b/examples/go/calls-agent/main.go
@@ -12,9 +12,9 @@ import (
)
func main() {
- client, err := polymorfa.NewCallsClient(polymorfa.CallsClientConfig{Config: polymorfa.Config{Credential: polymorfa.Credential{Kind: polymorfa.TeamAPIKey, Value: os.Getenv("POLYMORFA_API_KEY")}}, Session: os.Getenv("POLYMORFA_SESSION"), Participant: "go-example"})
+ client, err := polymorfa.NewCallsClient(polymorfa.CallsClientConfig{Config: polymorfa.Config{Credential: polymorfa.Credential{Kind: polymorfa.TeamAPIKey, Value: os.Getenv("POLYMORFA_API_KEY")}}, Connection: os.Getenv("POLYMORFA_CONNECTION"), Participant: "go-example"})
if err != nil {
- log.Fatal("Set a valid API key and session: ", err)
+ log.Fatal("Set a valid API key and Connection: ", err)
}
ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer cancel()
diff --git a/examples/go/send-message/main.go b/examples/go/send-message/main.go
index 58d488b90..8f1d59d9a 100644
--- a/examples/go/send-message/main.go
+++ b/examples/go/send-message/main.go
@@ -17,13 +17,13 @@ func main() {
}
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
- session, phone := os.Getenv("POLYMORFA_SESSION"), os.Getenv("POLYMORFA_PHONE")
- if session == "" || phone == "" {
- fmt.Fprintln(os.Stderr, "Set POLYMORFA_SESSION and POLYMORFA_PHONE before sending.")
+ connection, phone := os.Getenv("POLYMORFA_CONNECTION"), os.Getenv("POLYMORFA_PHONE")
+ if connection == "" || phone == "" {
+ fmt.Fprintln(os.Stderr, "Set POLYMORFA_CONNECTION and POLYMORFA_PHONE before sending.")
os.Exit(1)
}
text := "Hello from Go"
- result, err := client.Messages().Send(ctx, session, polymorfa.SendMessageRequest{Conversation: polymorfa.ConversationReference{PhoneNumber: phone}, Content: polymorfa.MessageContent{Text: &text}})
+ result, err := client.Messages().Send(ctx, connection, polymorfa.SendMessageRequest{Conversation: polymorfa.ConversationReference{PhoneNumber: phone}, Content: polymorfa.MessageContent{Text: &text}})
if err != nil {
fail(err)
}
diff --git a/examples/go/web-host/README.md b/examples/go/web-host/README.md
index 04900e56e..ea4ba23be 100644
--- a/examples/go/web-host/README.md
+++ b/examples/go/web-host/README.md
@@ -13,7 +13,7 @@ go test -race ./...
go run . -framework gin -port 8080
```
-Before the last command, set `EXAMPLE_APP_USERNAME`, `EXAMPLE_APP_PASSWORD`, `POLYMORFA_PROJECT_TOKEN`, `POLYMORFA_SESSION`, `POLYMORFA_RECIPIENT` and `POLYMORFA_WEBHOOK_SECRET` in the server environment. The recipient is the authorized peer's phone number. Open `http://127.0.0.1:8080`. Use `-framework nethttp` for the standard library host. `POLYMORFA_API_BASE_URL` optionally selects an API origin; authenticated plaintext is restricted to loopback. Asset building bundles the workspace Web Components and downloads HTMX 2.0.4 after checking its SHA-256 digest.
+Before the last command, set `EXAMPLE_APP_USERNAME`, `EXAMPLE_APP_PASSWORD`, `POLYMORFA_PROJECT_TOKEN`, `POLYMORFA_CONNECTION`, `POLYMORFA_RECIPIENT` and `POLYMORFA_WEBHOOK_SECRET` in the server environment. The recipient is the authorized peer's phone number. Open `http://127.0.0.1:8080`. Use `-framework nethttp` for the standard library host. `POLYMORFA_API_BASE_URL` optionally selects an API origin; authenticated plaintext is restricted to loopback. Asset building bundles the workspace Web Components and downloads HTMX 2.0.4 after checking its SHA-256 digest.
This loopback example has one configured application account. Sign-in creates a random, server-held session with a 30-minute lifetime and an HttpOnly, SameSite=Strict cookie. Application POST routes enforce the application origin. Browser input cannot select an identity, number or recipient. Sign-out removes the server session and stops browser polling.
@@ -25,7 +25,7 @@ Register `/webhooks/polymorfa` with the API for the assigned Number, native form
Set `POLYMORFA_EXAMPLE_TRANSPORT=local-test-number` when using isolated local test numbers. The page then labels simulated WhatsApp transport. This is a local transport label, not evidence of real WhatsApp-network delivery.
-Before hosting it publicly, integrate the application's real authentication, live membership and Number/recipient authorization, HTTPS origin, durable sessions and transactional message/idempotency storage. Keep project and team credentials exclusively in the server process.
+Before hosting it publicly, integrate the application's real authentication, live membership and Connection/recipient authorization, HTTPS origin, durable sessions and transactional message/idempotency storage. Keep project and team credentials exclusively in the server process.
`main_test.go` and `conversation_test.go` use real HTTP servers with a fixture upstream to verify both hosts, native credential/version headers, authentication, assigned targets, origin rejection, caller-key replay and conflict handling, webhook signatures, event deduplication, target confinement and conversation reads after reload. Those tests do not prove a deployed or real WhatsApp-network exchange.
diff --git a/examples/go/web-host/bridge.js b/examples/go/web-host/bridge.js
index 64d66455b..14efd09d3 100644
--- a/examples/go/web-host/bridge.js
+++ b/examples/go/web-host/bridge.js
@@ -36,7 +36,7 @@ function nativeInbox(inbox) {
const last = snapshot.messages.at(-1);
return {
id: snapshot.peer,
- session: snapshot.session,
+ connection: snapshot.connection,
name: "Assigned recipient",
phoneNumber: snapshot.peer,
lastActivity: last?.createdAt ?? 0,
diff --git a/examples/go/web-host/conversation.go b/examples/go/web-host/conversation.go
index 028823aa8..7b7ae5566 100644
--- a/examples/go/web-host/conversation.go
+++ b/examples/go/web-host/conversation.go
@@ -86,7 +86,7 @@ func (a *app) sendMessage(w http.ResponseWriter, r *http.Request) {
attempt = &sendAttempt{text: input.Text}
s.attempts[key] = attempt
}
- result, err := a.client.Messages().Send(r.Context(), a.session, polymorfa.SendMessageRequest{
+ result, err := a.client.Messages().Send(r.Context(), a.connection, polymorfa.SendMessageRequest{
Conversation: polymorfa.ConversationReference{PhoneNumber: a.peer}, Content: polymorfa.MessageContent{Text: &input.Text},
}, polymorfa.RequestOptions{IdempotencyKey: key, Timeout: 60 * time.Second})
if err != nil || !result.Data.Success || result.Data.Data.ID == "" {
@@ -125,7 +125,7 @@ func (s *conversationState) upsert(message conversationMessage) {
}
func (a *app) receiveEvent(_ *http.Request, event polymorfa.WebhookEvent) error {
- if event.Session != a.session {
+ if event.Connection != a.connection {
return nil
}
payload, known, err := event.TypedPayload()
@@ -202,5 +202,5 @@ func (a *app) conversationSnapshot(w http.ResponseWriter, r *http.Request) {
s.mu.Lock()
defer s.mu.Unlock()
messages := append([]conversationMessage{}, s.messages...)
- writeJSON(w, map[string]any{"messages": messages, "peer": a.peer, "session": a.session, "receivedEvents": s.received, "lastEvent": s.lastEvent})
+ writeJSON(w, map[string]any{"messages": messages, "peer": a.peer, "connection": a.connection, "receivedEvents": s.received, "lastEvent": s.lastEvent})
}
diff --git a/examples/go/web-host/conversation_test.go b/examples/go/web-host/conversation_test.go
index 6121d52f2..16c73aa1b 100644
--- a/examples/go/web-host/conversation_test.go
+++ b/examples/go/web-host/conversation_test.go
@@ -18,7 +18,7 @@ import (
)
func TestSignedIncomingReplySurvivesReloadAndRejectsOtherTargets(t *testing.T) {
- a := &app{peer: "+15550001111", session: "assigned", webhookSecret: "private-local-test-secret", sessions: map[string]appSession{"signed-in": {expires: time.Now().Add(time.Minute), userID: "user"}}}
+ a := &app{peer: "+15550001111", connection: "assigned", webhookSecret: "private-local-test-secret", sessions: map[string]appSession{"signed-in": {expires: time.Now().Add(time.Minute), userID: "user"}}}
a.conversation.peerID = "assigned-conversation"
server := httptest.NewServer(a.routes())
defer server.Close()
@@ -37,11 +37,11 @@ func TestSignedIncomingReplySurvivesReloadAndRejectsOtherTargets(t *testing.T) {
m.Write([]byte(body))
return "sha256=" + hex.EncodeToString(m.Sum(nil))
}
- body := `{"id":"event-1","session":"assigned","timestamp":"2026-10-18T06:00:00Z","event":"message.received","payload":{"id":"incoming-1","conversation":{"id":"assigned-conversation"},"fromMe":false,"timestamp":1792303200,"type":"text","text":"Independent peer reply"}}`
+ body := `{"id":"event-1","connection":"assigned","timestamp":"2026-10-18T06:00:00Z","event":"message.received","payload":{"id":"incoming-1","conversation":{"id":"assigned-conversation"},"fromMe":false,"timestamp":1792303200,"type":"text","text":"Independent peer reply"}}`
if post(body, "sha256=wrong") != 400 {
t.Fatal("unsigned message accepted")
}
- for _, foreign := range []string{strings.Replace(body, `"session":"assigned"`, `"session":"foreign"`, 1), strings.Replace(body, "assigned-conversation", "foreign-conversation", 1)} {
+ for _, foreign := range []string{strings.Replace(body, `"connection":"assigned"`, `"connection":"foreign"`, 1), strings.Replace(body, "assigned-conversation", "foreign-conversation", 1)} {
if post(foreign, sign(foreign)) != 204 {
t.Fatal("foreign envelope handling")
}
@@ -103,7 +103,7 @@ func TestNativeSendKeepsCallerKeyAndServerAssignment(t *testing.T) {
if err != nil {
t.Fatal(err)
}
- a := &app{client: sdk, username: sha256.Sum256([]byte("user")), password: sha256.Sum256([]byte("password")), session: "assigned", userID: "user", sessions: map[string]appSession{}}
+ a := &app{client: sdk, username: sha256.Sum256([]byte("user")), password: sha256.Sum256([]byte("password")), connection: "assigned", userID: "user", sessions: map[string]appSession{}}
server := httptest.NewServer(a.routes())
defer server.Close()
a.origin = server.URL
@@ -137,7 +137,7 @@ func TestNativeSendKeepsCallerKeyAndServerAssignment(t *testing.T) {
if r.StatusCode != 403 {
t.Fatal("foreign origin send accepted")
}
- r = call("/api/polymorfa/send", server.URL, `{"text":"Hello from Go","session":"foreign"}`)
+ r = call("/api/polymorfa/send", server.URL, `{"text":"Hello from Go","connection":"foreign"}`)
r.Body.Close()
if r.StatusCode != 400 {
t.Fatal("browser target override accepted")
diff --git a/examples/go/web-host/main.go b/examples/go/web-host/main.go
index b8651a085..d31343f86 100644
--- a/examples/go/web-host/main.go
+++ b/examples/go/web-host/main.go
@@ -25,15 +25,15 @@ type appSession struct {
userID string
}
type app struct {
- client *polymorfa.MessagingClient
- username, password [32]byte
- userID, session, origin string
- peer string
- webhookSecret string
- transportLabel string
- conversation conversationState
- mu sync.Mutex
- sessions map[string]appSession
+ client *polymorfa.MessagingClient
+ username, password [32]byte
+ userID, connection, origin string
+ peer string
+ webhookSecret string
+ transportLabel string
+ conversation conversationState
+ mu sync.Mutex
+ sessions map[string]appSession
}
func (a *app) authenticated(r *http.Request) (string, bool) {
@@ -76,9 +76,9 @@ func (a *app) routes() http.Handler {
http.Error(w, "Sign in required.", 401)
return
}
- result, err := a.client.QuickLinks().Create(r.Context(), polymorfa.CreateQuickLinkRequest{Purpose: "add_connection", Session: a.session, AddConnection: "linked_devices", ConnectionGoal: "hybrid"})
+ result, err := a.client.QuickLinks().Create(r.Context(), polymorfa.CreateQuickLinkRequest{Purpose: "add_method", Connection: a.connection, AddMethod: "linked_devices", ConnectionGoal: "hybrid"})
if err != nil {
- http.Error(w, "Number connection is unavailable.", 502)
+ http.Error(w, "Connection setup is unavailable.", 502)
return
}
writeJSON(w, result.Data)
@@ -160,7 +160,7 @@ func (a *app) token(w http.ResponseWriter, r *http.Request) {
return
}
ttl := 600
- result, err := a.client.ClientTokens().Mint(r.Context(), polymorfa.MintClientTokenRequest{EphemeralID: "example:" + user, Session: a.session, TTLSeconds: &ttl})
+ result, err := a.client.ClientTokens().Mint(r.Context(), polymorfa.MintClientTokenRequest{EphemeralID: "example:" + user, Connection: a.connection, TTLSeconds: &ttl})
if err != nil {
http.Error(w, "Browser access is unavailable.", 502)
return
@@ -171,7 +171,7 @@ func (a *app) token(w http.ResponseWriter, r *http.Request) {
http.Error(w, "Invalid browser grant response.", 502)
return
}
- writeJSON(w, map[string]any{"value": token.Token, "audience": "browser", "expiresAt": expiry.UnixMilli(), "scopes": []string{"read_messages", "connect_whatsapp"}, "grant": map[string]any{"session": a.session, "conversations": []string{a.peer}, "allow": []string{"read_messages", "connect_whatsapp"}}})
+ writeJSON(w, map[string]any{"value": token.Token, "audience": "browser", "expiresAt": expiry.UnixMilli(), "scopes": []string{"read_messages", "connect_whatsapp"}, "grant": map[string]any{"connection": a.connection, "conversations": []string{a.peer}, "allow": []string{"read_messages", "connect_whatsapp"}}})
}
func writeJSON(w http.ResponseWriter, value any) {
w.Header().Set("Content-Type", "application/json")
@@ -192,9 +192,9 @@ func main() {
mode := flag.String("framework", "nethttp", "nethttp or gin")
port := flag.String("port", "8080", "Loopback port")
flag.Parse()
- username, password, session := os.Getenv("EXAMPLE_APP_USERNAME"), os.Getenv("EXAMPLE_APP_PASSWORD"), os.Getenv("POLYMORFA_SESSION")
+ username, password, connection := os.Getenv("EXAMPLE_APP_USERNAME"), os.Getenv("EXAMPLE_APP_PASSWORD"), os.Getenv("POLYMORFA_CONNECTION")
peer, secret := os.Getenv("POLYMORFA_RECIPIENT"), os.Getenv("POLYMORFA_WEBHOOK_SECRET")
- if username == "" || password == "" || session == "" || peer == "" || secret == "" {
+ if username == "" || password == "" || connection == "" || peer == "" || secret == "" {
log.Fatal("Configure the example account, authorized number, recipient and webhook secret.")
}
credential := polymorfa.Credential{Kind: polymorfa.ProjectToken, Value: os.Getenv("POLYMORFA_PROJECT_TOKEN")}
@@ -206,7 +206,7 @@ func main() {
if err != nil {
log.Fatal("Invalid API configuration.")
}
- a := &app{client: client, username: sha256.Sum256([]byte(username)), password: sha256.Sum256([]byte(password)), session: session, peer: peer, webhookSecret: secret, userID: "local-app-user", origin: "http://127.0.0.1:" + *port, sessions: map[string]appSession{}}
+ a := &app{client: client, username: sha256.Sum256([]byte(username)), password: sha256.Sum256([]byte(password)), connection: connection, peer: peer, webhookSecret: secret, userID: "local-app-user", origin: "http://127.0.0.1:" + *port, sessions: map[string]appSession{}}
if os.Getenv("POLYMORFA_EXAMPLE_TRANSPORT") == "local-test-number" {
a.transportLabel = "Local test numbers. Simulated WhatsApp transport."
}
diff --git a/examples/go/web-host/main_test.go b/examples/go/web-host/main_test.go
index a8657f0c5..afc283004 100644
--- a/examples/go/web-host/main_test.go
+++ b/examples/go/web-host/main_test.go
@@ -27,12 +27,12 @@ func TestNativeFrameworkAuthenticatedTokenBoundary(t *testing.T) {
}
var body map[string]any
_ = json.NewDecoder(r.Body).Decode(&body)
- if len(body) != 4 || body["purpose"] != "add_connection" || body["session"] != "authorized-support" || body["addConnection"] != "linked_devices" || body["connectionGoal"] != "hybrid" {
+ if len(body) != 4 || body["purpose"] != "add_method" || body["connection"] != "authorized-support" || body["addMethod"] != "linked_devices" || body["connectionGoal"] != "hybrid" {
t.Error("QuickLink server assignment", body)
}
connected.Add(1)
w.Header().Set("Content-Type", "application/json")
- w.Write([]byte(`{"success":true,"data":{"purpose":"add_connection","connectionGoal":"hybrid","addConnection":"linked_devices","id":"link","url":"https://quick.example.test/link","session":"authorized-support","expiresAt":null}}`))
+ w.Write([]byte(`{"success":true,"data":{"purpose":"add_method","connectionGoal":"hybrid","addMethod":"linked_devices","id":"link","url":"https://quick.example.test/link","connection":"authorized-support","expiresAt":null}}`))
return
}
@@ -44,7 +44,7 @@ func TestNativeFrameworkAuthenticatedTokenBoundary(t *testing.T) {
}
var body map[string]any
_ = json.NewDecoder(r.Body).Decode(&body)
- if len(body) != 3 || body["ephemeralId"] != "example:app-user" || body["session"] != "authorized-support" || body["ttlSeconds"] != float64(600) {
+ if len(body) != 3 || body["ephemeralId"] != "example:app-user" || body["connection"] != "authorized-support" || body["ttlSeconds"] != float64(600) {
t.Error("server assignment", body)
}
minted.Add(1)
@@ -56,7 +56,7 @@ func TestNativeFrameworkAuthenticatedTokenBoundary(t *testing.T) {
if err != nil {
t.Fatal(err)
}
- a := &app{client: sdk, username: sha256.Sum256([]byte("user")), password: sha256.Sum256([]byte("test-password")), userID: "app-user", session: "authorized-support", sessions: map[string]appSession{}}
+ a := &app{client: sdk, username: sha256.Sum256([]byte("user")), password: sha256.Sum256([]byte("test-password")), userID: "app-user", connection: "authorized-support", sessions: map[string]appSession{}}
handler := a.routes()
if framework == "gin" {
handler = ginHandler(handler)
@@ -107,14 +107,14 @@ func TestNativeFrameworkAuthenticatedTokenBoundary(t *testing.T) {
if len(cookies) != 1 || !cookies[0].HttpOnly || cookies[0].SameSite != http.SameSiteStrictMode || strings.Contains(cookies[0].Value, "app-user") {
t.Fatal("opaque application session")
}
- response = send("POST", "/api/polymorfa/token", server.URL, "session=attacker&ephemeralId=attacker")
+ response = send("POST", "/api/polymorfa/token", server.URL, "connection=attacker&ephemeralId=attacker")
var token map[string]any
_ = json.NewDecoder(response.Body).Decode(&token)
response.Body.Close()
if response.StatusCode != 200 || token["audience"] != "browser" || token["value"] != "pmfa_ct_YnJvd3Nlcl9maXh0dXJl" || response.Header.Get("Cache-Control") != "no-store" || minted.Load() != 1 {
t.Fatal("token result", token, response.Status)
}
- response = send("POST", "/api/polymorfa/connect", server.URL, "session=attacker&purpose=initial")
+ response = send("POST", "/api/polymorfa/connect", server.URL, "connection=attacker&purpose=initial")
var link map[string]any
_ = json.NewDecoder(response.Body).Decode(&link)
response.Body.Close()
diff --git a/examples/nextjs/app/api/polymorfa/token/route.ts b/examples/nextjs/app/api/polymorfa/token/route.ts
index bf6ec2775..984a45849 100644
--- a/examples/nextjs/app/api/polymorfa/token/route.ts
+++ b/examples/nextjs/app/api/polymorfa/token/route.ts
@@ -6,7 +6,7 @@ import {
// Served at /api/polymorfa/token, the default path of
// createClientTokenProvider. Browser messaging and Calls components use the
-// same token; Calls also need the session's client rules to grant
+// same token; Calls also need the connection's client rules to grant
// voip_place, voip_answer, and voip_signal.
const messaging = new MessagingClient({
credential: {
@@ -17,14 +17,14 @@ const messaging = new MessagingClient({
export const POST = createClientTokenRoute({
authorize: async (request) => {
- // Replace with your application's session check.
+ // Replace with your application's connection check.
const userId = request.headers.get("x-example-authenticated-user");
return userId ? { userId } : null;
},
mint: createMessagingClientTokenMint({
clientTokens: messaging.clientTokens,
resolve: (subject) => ({
- session: "support",
+ connection: "support",
ephemeralId: subject.userId,
ttlSeconds: 600,
}),
diff --git a/examples/php/README.md b/examples/php/README.md
index 636bb6e07..beae01f47 100644
--- a/examples/php/README.md
+++ b/examples/php/README.md
@@ -1,6 +1,6 @@
# PHP server examples
-Run `composer install` inside `packages/php`, then run `php examples/php/send.php` from the repository root. Set `POLYMORFA_API_KEY`, `POLYMORFA_SESSION`, `POLYMORFA_RECIPIENT`, and `POLYMORFA_IDEMPOTENCY_KEY` in your server environment. This source SDK has not been published to Packagist. The send example makes a real authorized API request.
+Run `composer install` inside `packages/php`, then run `php examples/php/send.php` from the repository root. Set `POLYMORFA_API_KEY`, `POLYMORFA_CONNECTION`, `POLYMORFA_RECIPIENT`, and `POLYMORFA_IDEMPOTENCY_KEY` in your server environment. This source SDK has not been published to Packagist. The send example makes a real authorized API request.
The Laravel and Symfony snippets verify original request content with `WebhookRequest` before decoding JSON. Configure the signing secret in your application's secret store. Add durable deduplication by the verified event ID before processing. Unknown event payloads remain available.
diff --git a/examples/php/send.php b/examples/php/send.php
index 9c853aefe..5e312862a 100644
--- a/examples/php/send.php
+++ b/examples/php/send.php
@@ -7,7 +7,7 @@
use Polymorfa\{Credential,MessagingClient,RequestOptions};
$client=new MessagingClient(Credential::teamApiKey((string)getenv('POLYMORFA_API_KEY')));
-$response=$client->messages->send((string)getenv('POLYMORFA_SESSION'),[
+$response=$client->messages->send((string)getenv('POLYMORFA_CONNECTION'),[
'conversation'=>['phoneNumber'=>(string)getenv('POLYMORFA_RECIPIENT')],
'content'=>['text'=>'Hello from PHP'],
],new RequestOptions(idempotencyKey:(string)getenv('POLYMORFA_IDEMPOTENCY_KEY')));
diff --git a/examples/php/web-host/README.md b/examples/php/web-host/README.md
index 5eeac9804..395d227f8 100644
--- a/examples/php/web-host/README.md
+++ b/examples/php/web-host/README.md
@@ -12,11 +12,11 @@ composer install
php -S 127.0.0.1:8080 -t public public/router.php
```
-Before starting PHP, configure `EXAMPLE_APP_USERNAME`, `EXAMPLE_APP_PASSWORD`, `POLYMORFA_PROJECT_TOKEN`, `POLYMORFA_SESSION`, `EXAMPLE_APP_ORIGIN=http://127.0.0.1:8080` and an absolute `EXAMPLE_STATE_DIR` under a persistent private application directory. The host creates private session and template-cache directories there. Open the configured origin. `EXAMPLE_FRAMEWORK=laravel` is the default; select `symfony` for HttpKernel and Twig. `POLYMORFA_API_BASE_URL` optionally selects the API origin. Authenticated plaintext API URLs are confined to loopback.
+Before starting PHP, configure `EXAMPLE_APP_USERNAME`, `EXAMPLE_APP_PASSWORD`, `POLYMORFA_PROJECT_TOKEN`, `POLYMORFA_CONNECTION`, `EXAMPLE_APP_ORIGIN=http://127.0.0.1:8080` and an absolute `EXAMPLE_STATE_DIR` under a persistent private application directory. The host creates private session and template-cache directories there. Open the configured origin. `EXAMPLE_FRAMEWORK=laravel` is the default; select `symfony` for HttpKernel and Twig. `POLYMORFA_API_BASE_URL` optionally selects the API origin. Authenticated plaintext API URLs are confined to loopback.
-These are loopback demonstration hosts with one configured application account. Sign-in creates an opaque random session, retained in a private file for 30 minutes, and an HttpOnly, SameSite=Strict cookie. POST routes enforce the configured application origin. The authenticated token endpoint derives the user and authorized number on the server, mints a ten-minute client token through `clientTokens->mint`, and returns browser claims with `Cache-Control: no-store, private`. Browser request fields cannot select the user or number. Sign-out removes the stored session and disposes the browser client. The inbox uses the native server SDK; the separate token endpoint remains an optional browser-grant example.
+These are loopback demonstration hosts with one configured application account. Sign-in creates an opaque random session, retained in a private file for 30 minutes, and an HttpOnly, SameSite=Strict cookie. POST routes enforce the configured application origin. The authenticated token endpoint derives the user and authorized Connection on the server, mints a ten-minute client token through `clientTokens->mint`, and returns browser claims with `Cache-Control: no-store, private`. Browser request fields cannot select the user or Connection. Sign-out removes the stored session and disposes the browser client. The inbox uses the native server SDK; the separate token endpoint remains an optional browser-grant example.
-Before public hosting, use the application's real authentication, live membership and number authorization, HTTPS origin, managed sessions and CSRF protection appropriate to the application. Keep project and team credentials exclusively on the server.
+Before public hosting, use the application's real authentication, live membership and Connection authorization, HTTPS origin, managed sessions and CSRF protection appropriate to the application. Keep project and team credentials exclusively on the server.
Laravel uses its real HTTP application and Blade view service; Symfony uses HttpKernel, HttpFoundation and Twig. Their dependencies and Composer lock file are separate from the SDK package. Blade caches and sessions remain outside the source checkout. Asset building bundles the workspace Web Components and downloads pinned HTMX 2.0.4 after verifying its SHA-256 digest.
@@ -26,16 +26,16 @@ Run the native HTTP tests with PHP 8.2 or newer:
EXAMPLE_STATE_DIR="$HOME/.polymorfa-agent-work/php-web-host-tests" php tests/run.php
```
-The test starts loopback servers on ports 31305 and 31306 with synthetic credentials. It verifies both frameworks, initial template rendering, POST-only sign-in, invalid credentials, foreign origins, opaque cookies, exact server-derived SDK mint requests, browser response claims and revocation after sign-out. PHP 8.2 and 8.4 passed these tests. Earlier browser smoke checks covered sign-in and an empty inbox. Functional video acceptance is recorded separately below. No customer credentials or live WhatsApp number were used.
+The test starts loopback servers on ports 31305 and 31306 with synthetic credentials. It verifies both frameworks, initial template rendering, POST-only sign-in, invalid credentials, foreign origins, opaque cookies, exact server-derived SDK mint requests, browser response claims and revocation after sign-out. PHP 8.2 and 8.4 passed these tests. Earlier browser smoke checks covered sign-in and an empty inbox. Functional video acceptance is recorded separately below. No customer credentials or live WhatsApp Connection were used.
-The Connect number endpoint creates a hosted supplementary linked-device invitation for the server-assigned `POLYMORFA_SESSION`. Assign an eligible Official Number that can add linked devices. The API still checks assignment, eligibility, consent and funding. Browser fields cannot choose another Number or change custody. This does not create an initial Number or establish live WhatsApp pairing.
+The Connect Connection endpoint creates a hosted supplementary linked-device invitation for the server-assigned `POLYMORFA_CONNECTION`. Assign an eligible Official Connection that can add linked devices. The API still checks assignment, eligibility, consent and funding. Browser fields cannot choose another Connection or change custody. This does not create an initial Connection or establish live WhatsApp pairing.
The inbox now calls the native PHP SDK for text sends and consumes signed native
webhooks at `/webhooks/polymorfa`. Configure `POLYMORFA_RECIPIENT` and
`POLYMORFA_WEBHOOK_SECRET` on the server; register `message.received` and
-`message.ack` for the assigned Number with the same secret. The browser cannot
+`message.ack` for the assigned Connection with the same secret. The browser cannot
choose a different target. Native signatures are checked before parsing and
-updates are confined to the assigned Number and canonical conversation ID.
+updates are confined to the assigned Connection and canonical conversation ID.
The private `EXAMPLE_STATE_DIR` keeps at most 100 messages, 128 send attempts and
1024 recent event IDs. Clear this directory explicitly to reset the example. It
@@ -44,7 +44,7 @@ on unknown outcomes; retry the same text and key. Display timestamps use whole
seconds, matching native message events. Laravel and Symfony share these handlers.
The inbox does not use the separate token/connect examples.
-Set `POLYMORFA_EXAMPLE_TRANSPORT=local-test-number` to label simulated transport.
+Set `POLYMORFA_EXAMPLE_TRANSPORT=local-test-connection` to label simulated transport.
The local Inspector video acceptance checks native sends, an independent paired peer's
reply, signed HTTPS delivery, reload and logout. It does not prove registry,
staging or production availability.
diff --git a/examples/php/web-host/bridge.js b/examples/php/web-host/bridge.js
index 05d0d6afa..bf7321350 100644
--- a/examples/php/web-host/bridge.js
+++ b/examples/php/web-host/bridge.js
@@ -36,7 +36,7 @@ function nativeInbox(inbox) {
const last = snapshot.messages.at(-1);
return {
id: snapshot.peer,
- session: snapshot.session,
+ connection: snapshot.connection,
name: "Assigned recipient",
phoneNumber: snapshot.peer,
lastActivity: last?.createdAt ?? 0,
diff --git a/examples/php/web-host/src/Conversation.php b/examples/php/web-host/src/Conversation.php
index 977bd7735..d9053d237 100644
--- a/examples/php/web-host/src/Conversation.php
+++ b/examples/php/web-host/src/Conversation.php
@@ -9,7 +9,7 @@
/** Private application-owned example state. Never HMS; bounded and manually reset. */
final class Conversation
{
- public function __construct(private string $directory, private string $session, private string $peer, private MessagingClient $client) {}
+ public function __construct(private string $directory, private string $connection, private string $peer, private MessagingClient $client) {}
private function update(callable $operation): mixed
{
@@ -18,8 +18,8 @@ private function update(callable $operation): mixed
try {
if ($lock === false || !flock($lock, LOCK_EX)) { throw new \RuntimeException('State unavailable.'); }
$path = $this->directory.'/conversation.json';
- $state = is_file($path) ? json_decode((string)file_get_contents($path), true, flags:JSON_THROW_ON_ERROR) : ['scope'=>hash('sha256',$this->session.':'.$this->peer),'messages'=>[],'attempts'=>[],'eventIds'=>[],'peerId'=>'','receivedEvents'=>0,'lastEvent'=>''];
- if (($state['scope']??null)!==hash('sha256',$this->session.':'.$this->peer)) { throw new \RuntimeException('Use a distinct state directory for this Number and recipient.'); }
+ $state = is_file($path) ? json_decode((string)file_get_contents($path), true, flags:JSON_THROW_ON_ERROR) : ['scope'=>hash('sha256',$this->connection.':'.$this->peer),'messages'=>[],'attempts'=>[],'eventIds'=>[],'peerId'=>'','receivedEvents'=>0,'lastEvent'=>''];
+ if (($state['scope']??null)!==hash('sha256',$this->connection.':'.$this->peer)) { throw new \RuntimeException('Use a distinct state directory for this Connection and recipient.'); }
$result = $operation($state);
if (file_put_contents($path,json_encode($state,JSON_THROW_ON_ERROR),LOCK_EX) === false) { throw new \RuntimeException('State unavailable.'); }
return $result;
@@ -30,7 +30,7 @@ private function update(callable $operation): mixed
}
public function snapshot(): array
{
- return $this->update(fn(array &$state): array => ['messages'=>$state['messages'],'peer'=>$this->peer,'session'=>$this->session,'receivedEvents'=>$state['receivedEvents'],'lastEvent'=>$state['lastEvent']]);
+ return $this->update(fn(array &$state): array => ['messages'=>$state['messages'],'peer'=>$this->peer,'connection'=>$this->connection,'receivedEvents'=>$state['receivedEvents'],'lastEvent'=>$state['lastEvent']]);
}
public function send(string $raw, string $key): array
{
@@ -53,7 +53,7 @@ public function send(string $raw, string $key): array
});
if ($prior!==null) { return $prior; }
try {
- $response=$this->client->messages->send($this->session,['conversation'=>['phoneNumber'=>$this->peer],'content'=>['text'=>$body['text']]],new RequestOptions(timeout:60,idempotencyKey:$key));
+ $response=$this->client->messages->send($this->connection,['conversation'=>['phoneNumber'=>$this->peer],'content'=>['text'=>$body['text']]],new RequestOptions(timeout:60,idempotencyKey:$key));
$receipt=$response->data['data'];$timestamp=strtotime($receipt['timestamp']);
if (!$response->data['success'] || !$receipt['id'] || $timestamp===false) { throw new \RuntimeException('Invalid receipt.'); }
$message=['id'=>$receipt['id'],'clientId'=>$key,'text'=>$body['text'],'createdAt'=>$timestamp*1000,'direction'=>'outbound','status'=>'sent','receipt'=>$receipt['status']];
@@ -72,7 +72,7 @@ private static function upsert(array &$state, array $message): void
}
public function receive(WebhookEvent $event): void
{
- if ($event->session!==$this->session || !is_array($event->payload)) { return; }
+ if ($event->connection!==$this->connection || !is_array($event->payload)) { return; }
$this->update(function(array &$state) use($event): void {
if (in_array($event->id,$state['eventIds'],true)) { return; }
$p=$event->payload;$c=$p['conversation']??[];
diff --git a/examples/php/web-host/src/Host.php b/examples/php/web-host/src/Host.php
index 61bb809f6..0785798a8 100644
--- a/examples/php/web-host/src/Host.php
+++ b/examples/php/web-host/src/Host.php
@@ -15,7 +15,7 @@ final class Host
private Conversation $conversation;
private string $webhookSecret;
private string $origin;
- private string $session;
+ private string $connection;
private string $username;
private string $password;
@@ -23,7 +23,7 @@ public function __construct(private readonly \Closure $render)
{
$this->username = self::setting('EXAMPLE_APP_USERNAME');
$this->password = self::setting('EXAMPLE_APP_PASSWORD');
- $this->session = self::setting('POLYMORFA_SESSION');
+ $this->connection = self::setting('POLYMORFA_CONNECTION');
$this->origin = self::setting('EXAMPLE_APP_ORIGIN');
if (!preg_match('~^http://127\.0\.0\.1:\d+$~D', $this->origin)) {
throw new \RuntimeException('Configure a loopback application origin.');
@@ -35,7 +35,7 @@ public function __construct(private readonly \Closure $render)
self::directory($this->state.'/sessions');
$this->webhookSecret = self::setting('POLYMORFA_WEBHOOK_SECRET');
$this->client = new MessagingClient(Credential::projectToken(self::setting('POLYMORFA_PROJECT_TOKEN')), getenv('POLYMORFA_API_BASE_URL') ?: 'https://api.polymorfa.com');
- $this->conversation = new Conversation($this->state,$this->session,self::setting('POLYMORFA_RECIPIENT'),$this->client);
+ $this->conversation = new Conversation($this->state,$this->connection,self::setting('POLYMORFA_RECIPIENT'),$this->client);
}
public static function directory(string $path): void
@@ -48,7 +48,7 @@ private static function setting(string $name): string
{
$value = getenv($name);
if ($value === false || $value === '') {
- throw new \RuntimeException('Configure the application account, number and state.');
+ throw new \RuntimeException('Configure the application account, Connection and state.');
}
return $value;
}
@@ -71,7 +71,7 @@ private function html(Request $request, bool $authenticated): Response
if ($request->headers->get('HX-Request') !== 'true' && $request->getPathInfo() !== '/') {
return new RedirectResponse('/');
}
- return new Response(($this->render)($authenticated, $request->headers->get('HX-Request') === 'true', getenv('POLYMORFA_EXAMPLE_TRANSPORT') === 'local-test-number'), 200, ['Cache-Control' => 'no-store, private']);
+ return new Response(($this->render)($authenticated, $request->headers->get('HX-Request') === 'true', getenv('POLYMORFA_EXAMPLE_TRANSPORT') === 'local-test-connection'), 200, ['Cache-Control' => 'no-store, private']);
}
public function handle(Request $request): Response
{
@@ -153,15 +153,15 @@ public function handle(Request $request): Response
}
try {
if ($path === '/api/polymorfa/connect') {
- return $this->json($this->client->quickLinks->create(['purpose' => 'add_connection','session' => $this->session,'addConnection' => 'linked_devices','connectionGoal' => 'hybrid'])->data);
+ return $this->json($this->client->quickLinks->create(['purpose' => 'add_method','connection' => $this->connection,'addMethod' => 'linked_devices','connectionGoal' => 'hybrid'])->data);
}
- $result = $this->client->clientTokens->mint(['ephemeralId' => 'example:local-app-user','session' => $this->session,'ttlSeconds' => 600]);
+ $result = $this->client->clientTokens->mint(['ephemeralId' => 'example:local-app-user','connection' => $this->connection,'ttlSeconds' => 600]);
$token = $result->data['data'];
$expires = strtotime($token['expiresAt']);
if ($expires === false || $expires <= time() || !str_starts_with($token['token'], 'pmfa_ct_')) {
return $this->json(['error' => 'invalid_browser_grant'], 502);
}
- return $this->json(['value' => $token['token'],'audience' => 'browser','expiresAt' => $expires * 1000,'scopes' => ['read_messages','connect_whatsapp'],'grant' => ['session' => $this->session,'conversations' => [],'allow' => ['read_messages','connect_whatsapp']]]);
+ return $this->json(['value' => $token['token'],'audience' => 'browser','expiresAt' => $expires * 1000,'scopes' => ['read_messages','connect_whatsapp'],'grant' => ['connection' => $this->connection,'conversations' => [],'allow' => ['read_messages','connect_whatsapp']]]);
} catch (\Throwable) {
return $this->json(['error' => 'browser_access_unavailable'],502);
}
diff --git a/examples/php/web-host/tests/run.php b/examples/php/web-host/tests/run.php
index ed134598f..c269b54c3 100644
--- a/examples/php/web-host/tests/run.php
+++ b/examples/php/web-host/tests/run.php
@@ -15,7 +15,7 @@ function check(bool $condition, string $message): void
check(is_string($state) && str_starts_with($state, '/') && !str_starts_with($state, '/tmp/'), 'persistent test state directory');
foreach (['laravel','symfony'] as $framework) {
$env = getenv();
- $env = array_replace($env, ['EXAMPLE_APP_USERNAME' => 'example-user','EXAMPLE_APP_PASSWORD' => 'test-only-password','POLYMORFA_PROJECT_TOKEN' => 'pmfa_pt_AAECAwQFBgcICQoLDA0ODxAREhM73f-k','POLYMORFA_SESSION' => 'authorized-support','POLYMORFA_RECIPIENT' => '+15550001234','POLYMORFA_WEBHOOK_SECRET' => 'local-test-signing-key']);
+ $env = array_replace($env, ['EXAMPLE_APP_USERNAME' => 'example-user','EXAMPLE_APP_PASSWORD' => 'test-only-password','POLYMORFA_PROJECT_TOKEN' => 'pmfa_pt_AAECAwQFBgcICQoLDA0ODxAREhM73f-k','POLYMORFA_CONNECTION' => 'authorized-support','POLYMORFA_RECIPIENT' => '+15550001234','POLYMORFA_WEBHOOK_SECRET' => 'local-test-signing-key']);
$env['EXAMPLE_STATE_DIR'] = $state.'/'.$framework;
$env['EXAMPLE_FRAMEWORK'] = $framework;
$env['EXAMPLE_APP_ORIGIN'] = 'http://127.0.0.1:31306';
@@ -60,11 +60,11 @@ function check(bool $condition, string $message): void
$response = $send('POST', '/api/login', $origin, ['username' => 'example-user','password' => 'test-only-password']);
check($response->getStatusCode() === 200 && str_contains((string)$response->getBody(), 'pmfa-inbox'), 'authenticated template');
check(str_contains($response->getHeaderLine('Set-Cookie'), 'httponly') && str_contains($response->getHeaderLine('Set-Cookie'), 'samesite=strict'), 'opaque private cookie');
- $response = $send('POST', '/api/polymorfa/token', $origin, ['session' => 'attacker','ephemeralId' => 'attacker']);
+ $response = $send('POST', '/api/polymorfa/token', $origin, ['connection' => 'attacker','ephemeralId' => 'attacker']);
$token = json_decode((string)$response->getBody(), true);
check($response->getStatusCode() === 200 && ($token['value'] ?? null) === 'pmfa_ct_YnJvd3Nlcl9maXh0dXJl' && ($token['audience'] ?? null) === 'browser' && ($token['expiresAt'] ?? 0) > time() * 1000 && str_contains($response->getHeaderLine('Cache-Control'), 'no-store'), 'native SDK token mint');
check((int)file_get_contents($counter) === 1, 'one real upstream request');
- $response = $send('POST', '/api/polymorfa/connect', $origin, ['session' => 'attacker','purpose' => 'initial']);
+ $response = $send('POST', '/api/polymorfa/connect', $origin, ['connection' => 'attacker','purpose' => 'initial']);
$raw = (string)$response->getBody(); $link = json_decode($raw, true);
check($response->getStatusCode() === 200 && ($link['data']['url'] ?? null) === 'https://quick.example.test/link' && !str_contains($raw, 'pmfa_pt_'), 'assigned supplementary QuickLink');
check((int)file_get_contents($linkCounter) === 1, 'one QuickLink upstream request');
@@ -78,7 +78,7 @@ function check(bool $condition, string $message): void
check($message(['text'=>'Native send'])->getStatusCode() === 200, 'same key replay');
check($message(['text'=>'Changed'])->getStatusCode() === 409, 'changed text rejected');
check((int)file_get_contents($env['EXAMPLE_STATE_DIR'].'/native-sends') === 1, 'no duplicate upstream send');
- $envelope = ['id'=>'event-1','timestamp'=>'2026-10-18T10:00:01Z','session'=>'authorized-support','event'=>'message.received','payload'=>[
+ $envelope = ['id'=>'event-1','timestamp'=>'2026-10-18T10:00:01Z','connection'=>'authorized-support','event'=>'message.received','payload'=>[
'id'=>'message-in','conversation'=>['id'=>'canonical-peer'],'fromMe'=>false,'isGroup'=>false,'timestamp'=>1792317601,'text'=>'Independent reply','type'=>'text','pushName'=>'Test peer','whatsapp_ids'=>['linked_devices'=>'wire-in']
]];
$body = json_encode($envelope,JSON_THROW_ON_ERROR);
diff --git a/examples/php/web-host/tests/upstream.php b/examples/php/web-host/tests/upstream.php
index 8c1d85ee5..4de8530dc 100644
--- a/examples/php/web-host/tests/upstream.php
+++ b/examples/php/web-host/tests/upstream.php
@@ -15,13 +15,13 @@
}
if ($_SERVER['REQUEST_URI'] === '/messaging/quicklinks') {
- if ($_SERVER['REQUEST_METHOD'] !== 'POST' || ($_SERVER['HTTP_AUTHORIZATION'] ?? '') !== 'Bearer pmfa_pt_AAECAwQFBgcICQoLDA0ODxAREhM73f-k' || ($_SERVER['HTTP_POLYMORFA_VERSION'] ?? '') !== '2026-09-22' || $body !== ['purpose' => 'add_connection','session' => 'authorized-support','addConnection' => 'linked_devices','connectionGoal' => 'hybrid']) { http_response_code(422); echo '{"error":"fixture_mismatch"}'; return; }
+ if ($_SERVER['REQUEST_METHOD'] !== 'POST' || ($_SERVER['HTTP_AUTHORIZATION'] ?? '') !== 'Bearer pmfa_pt_AAECAwQFBgcICQoLDA0ODxAREhM73f-k' || ($_SERVER['HTTP_POLYMORFA_VERSION'] ?? '') !== '2026-09-22' || $body !== ['purpose' => 'add_method','connection' => 'authorized-support','addMethod' => 'linked_devices','connectionGoal' => 'hybrid']) { http_response_code(422); echo '{"error":"fixture_mismatch"}'; return; }
$links = getenv('EXAMPLE_STATE_DIR').'/native-links';
file_put_contents($links, (string)((is_file($links) ? (int)file_get_contents($links) : 0) + 1), LOCK_EX);
- echo json_encode(['success' => true,'data' => ['purpose' => 'add_connection','session' => 'authorized-support','addConnection' => 'linked_devices','connectionGoal' => 'hybrid','id' => 'link','url' => 'https://quick.example.test/link','expiresAt' => null]]); return;
+ echo json_encode(['success' => true,'data' => ['purpose' => 'add_method','connection' => 'authorized-support','addMethod' => 'linked_devices','connectionGoal' => 'hybrid','id' => 'link','url' => 'https://quick.example.test/link','expiresAt' => null]]); return;
}
-if ($_SERVER['REQUEST_METHOD'] !== 'POST' || $_SERVER['REQUEST_URI'] !== '/platform/client-tokens' || ($_SERVER['HTTP_AUTHORIZATION'] ?? '') !== 'Bearer pmfa_pt_AAECAwQFBgcICQoLDA0ODxAREhM73f-k' || ($_SERVER['HTTP_POLYMORFA_VERSION'] ?? '') !== '2026-09-22' || $body !== ['ephemeralId' => 'example:local-app-user','session' => 'authorized-support','ttlSeconds' => 600]) {
+if ($_SERVER['REQUEST_METHOD'] !== 'POST' || $_SERVER['REQUEST_URI'] !== '/platform/client-tokens' || ($_SERVER['HTTP_AUTHORIZATION'] ?? '') !== 'Bearer pmfa_pt_AAECAwQFBgcICQoLDA0ODxAREhM73f-k' || ($_SERVER['HTTP_POLYMORFA_VERSION'] ?? '') !== '2026-09-22' || $body !== ['ephemeralId' => 'example:local-app-user','connection' => 'authorized-support','ttlSeconds' => 600]) {
http_response_code(422);
echo '{"error":"fixture_mismatch"}';
return;
diff --git a/examples/php/web-host/views/workspace.blade.php b/examples/php/web-host/views/workspace.blade.php
index 50c68bef0..902461731 100644
--- a/examples/php/web-host/views/workspace.blade.php
+++ b/examples/php/web-host/views/workspace.blade.php
@@ -3,7 +3,7 @@
@endif
Messaging workspace
@if ($authenticated)
-@if($localTest)Local test numbers. Simulated WhatsApp transport.
@endifText messages use the server-assigned number and recipient. Conversation state is kept in this example's private state directory.
Waiting for the native SDK conversation.
+@if($localTest)Local test Connections. Simulated WhatsApp transport.
@endifText messages use the server-assigned Connection and recipient. Conversation state is kept in this example's private state directory.
Waiting for the native SDK conversation.
@else
Sign in with the local example application's configured account.
@endif
diff --git a/examples/php/web-host/views/workspace.html.twig b/examples/php/web-host/views/workspace.html.twig
index f3e254348..f2e29cef5 100644
--- a/examples/php/web-host/views/workspace.html.twig
+++ b/examples/php/web-host/views/workspace.html.twig
@@ -3,7 +3,7 @@
{% endif %}
Messaging workspace
{% if authenticated %}
-{% if localTest %}Local test numbers. Simulated WhatsApp transport.
{% endif %}Text messages use the server-assigned number and recipient. Conversation state is kept in this example's private state directory.
Waiting for the native SDK conversation.
+{% if localTest %}Local test Connections. Simulated WhatsApp transport.
{% endif %}Text messages use the server-assigned Connection and recipient. Conversation state is kept in this example's private state directory.
Waiting for the native SDK conversation.
{% else %}
Sign in with the local example application's configured account.
{% endif %}
diff --git a/examples/python/README.md b/examples/python/README.md
index 0cd7797f2..e455e75a6 100644
--- a/examples/python/README.md
+++ b/examples/python/README.md
@@ -1,6 +1,6 @@
# Python server examples
-These examples use the unpublished source SDK. From the repository root, run `uv run --project packages/python examples/python/send.py`. Set `POLYMORFA_API_KEY`, `POLYMORFA_SESSION`, `POLYMORFA_RECIPIENT`, and `POLYMORFA_IDEMPOTENCY_KEY` in your server environment. The send example makes a real authorized API request.
+These examples use the unpublished source SDK. From the repository root, run `uv run --project packages/python examples/python/send.py`. Set `POLYMORFA_API_KEY`, `POLYMORFA_CONNECTION`, `POLYMORFA_RECIPIENT`, and `POLYMORFA_IDEMPOTENCY_KEY` in your server environment. The send example makes a real authorized API request.
For FastAPI, install the `fastapi` extra and run the webhook app with an ASGI server; include the Django view in your existing application's URL configuration with the `django` extra. Set `POLYMORFA_WEBHOOK_SECRET`. Both adapters verify original request bytes, retain unknown events, and reject altered payloads. Add durable deduplication and processing in your application.
diff --git a/examples/python/programmatic_calls.py b/examples/python/programmatic_calls.py
index dc53a93f3..6215acbc6 100644
--- a/examples/python/programmatic_calls.py
+++ b/examples/python/programmatic_calls.py
@@ -9,7 +9,7 @@
async def main() -> None:
async with CallsClient(
os.environ["POLYMORFA_API_KEY"],
- os.environ["POLYMORFA_SESSION"],
+ os.environ["POLYMORFA_CONNECTION"],
participant="voice-worker",
) as client:
async for call in client.incoming_calls():
diff --git a/examples/python/send.py b/examples/python/send.py
index 9534010b0..0830e255e 100644
--- a/examples/python/send.py
+++ b/examples/python/send.py
@@ -1,4 +1,4 @@
-"""Run with POLYMORFA_API_KEY and POLYMORFA_SESSION from your server environment."""
+"""Run with POLYMORFA_API_KEY and POLYMORFA_CONNECTION from your server environment."""
import asyncio
import os
@@ -11,7 +11,7 @@ async def main() -> None:
Credential("team_api_key", os.environ["POLYMORFA_API_KEY"])
) as client:
response = await client.messages.send(
- os.environ["POLYMORFA_SESSION"],
+ os.environ["POLYMORFA_CONNECTION"],
{
"conversation": {"phoneNumber": os.environ["POLYMORFA_RECIPIENT"]},
"content": {"text": "Hello from Python"},
diff --git a/examples/python/web_host/README.md b/examples/python/web_host/README.md
index 519732efe..b37c04a23 100644
--- a/examples/python/web_host/README.md
+++ b/examples/python/web_host/README.md
@@ -14,7 +14,7 @@ uv run --project packages/python --extra fastapi uvicorn \
```
Set `EXAMPLE_APP_USERNAME`, `EXAMPLE_APP_PASSWORD`, `POLYMORFA_PROJECT_TOKEN` and
-`POLYMORFA_SESSION`, `POLYMORFA_RECIPIENT` and `POLYMORFA_WEBHOOK_SECRET` in the server environment before starting the host. Open
+`POLYMORFA_CONNECTION`, `POLYMORFA_RECIPIENT` and `POLYMORFA_WEBHOOK_SECRET` in the server environment before starting the host. Open
`http://127.0.0.1:8080`. Use the `django` extra and `django_app:application` to
run Django. `EXAMPLE_APP_ORIGIN` changes the exact allowed loopback origin;
`POLYMORFA_API_BASE_URL` optionally changes the API origin. Asset building
@@ -23,28 +23,28 @@ bundles the workspace Web Components and checks the SHA-256 digest of HTMX 2.0.4
The example has one configured application account. Sign-in creates a random
server-held session with a 30-minute lifetime and an HttpOnly, SameSite=Strict
cookie. POST routes check the application origin. The token endpoint derives
-the application identity and authorized number on the server and requests a
-ten-minute client token. Browser input cannot select a number or identity.
+the application identity and authorized Connection on the server and requests a
+ten-minute client token. Browser input cannot select a Connection or identity.
The endpoint returns only browser claims with `Cache-Control: no-store`.
Sign-out revokes the application session and disposes the browser client.
The connection indicator describes the browser grant; it does not establish
-a connected WhatsApp number.
+a connected WhatsApp Connection.
The inbox reads an authenticated, application-owned in-memory conversation. Text
sends call the native Python SDK with a caller UUID idempotency key and the
-server-assigned Number and recipient. Unknown outcomes retain that key for a
+server-assigned Connection and recipient. Unknown outcomes retain that key for a
retry; a changed body with the same key is rejected. The example keeps at most
128 send attempts and 100 messages until the process stops. It does not enable HMS.
-Register `/webhooks/polymorfa` as a native webhook for the assigned Number with
+Register `/webhooks/polymorfa` as a native webhook for the assigned Connection with
`message.received` and `message.ack`, using the same signing secret. Both frameworks
verify the original bounded request bytes through the Python SDK before updating
the inbox. Display timestamps use whole seconds, matching native message events, so a
same-second reply retains arrival order rather than sorting before its send.
-Incoming events must match the Number and canonical conversation ID
+Incoming events must match the Connection and canonical conversation ID
from the send receipt. Phone matching is only a fallback before that ID is known.
Duplicate event IDs are ignored within a bounded 1024-event window.
-`POLYMORFA_EXAMPLE_TRANSPORT=local-test-number` labels simulated transport in the UI.
+`POLYMORFA_EXAMPLE_TRANSPORT=local-test-connection` labels simulated transport in the UI.
Before public hosting, integrate live application membership, authorization,
HTTPS, durable sessions and durable conversation/deduplication storage. Keep
@@ -57,9 +57,9 @@ mint fields, POST-only sign-in, invalid credentials, foreign origins and
revocation after sign-out. Both hosts were also exercised in a browser with a
synthetic upstream: sign-in mounted the real components, one mint served the
browser session, the inbox rendered, and sign-out removed the components.
-No real number, customer credentials or live provider was used.
+No real Connection, customer credentials or live provider was used.
-The Connect number endpoint creates a hosted supplementary linked-device invitation for the server-assigned `POLYMORFA_SESSION`. Assign an eligible Official Number that can add linked devices. The API still checks assignment, eligibility, consent and funding. Browser fields cannot choose another Number or change custody. This does not create an initial Number or establish live WhatsApp pairing.
+The Connect Connection endpoint creates a hosted supplementary linked-device invitation for the server-assigned `POLYMORFA_CONNECTION`. Assign an eligible Official Connection that can add linked devices. The API still checks assignment, eligibility, consent and funding. Browser fields cannot choose another Connection or change custody. This does not create an initial Connection or establish live WhatsApp pairing.
The host HTTP tests also verify native sends, fixed targets, idempotent replay,
signed replies, event deduplication, reload and logout for both frameworks.
diff --git a/examples/python/web_host/bridge.js b/examples/python/web_host/bridge.js
index c9bba39f6..d654fb137 100644
--- a/examples/python/web_host/bridge.js
+++ b/examples/python/web_host/bridge.js
@@ -36,7 +36,7 @@ function nativeInbox(inbox) {
const last = snapshot.messages.at(-1);
return {
id: snapshot.peer,
- session: snapshot.session,
+ connection: snapshot.connection,
name: "Assigned recipient",
phoneNumber: snapshot.peer,
lastActivity: last?.createdAt ?? 0,
diff --git a/examples/python/web_host/django_app.py b/examples/python/web_host/django_app.py
index 2700bc6e9..299c826b5 100644
--- a/examples/python/web_host/django_app.py
+++ b/examples/python/web_host/django_app.py
@@ -93,7 +93,7 @@ async def view(request, operation="index"):
result = (
await host.mint()
if operation == "token"
- else await host.connect_number()
+ else await host.connect_connection()
if operation == "connect"
else None
)
diff --git a/examples/python/web_host/fastapi_app.py b/examples/python/web_host/fastapi_app.py
index 854c612ed..c441f650a 100644
--- a/examples/python/web_host/fastapi_app.py
+++ b/examples/python/web_host/fastapi_app.py
@@ -78,7 +78,7 @@ async def browser_action(operation: str, request: Request):
result = (
await host.mint()
if operation == "token"
- else await host.connect_number()
+ else await host.connect_connection()
if operation == "connect"
else None
)
diff --git a/examples/python/web_host/host.py b/examples/python/web_host/host.py
index 0e2e824e2..9e0c6280f 100644
--- a/examples/python/web_host/host.py
+++ b/examples/python/web_host/host.py
@@ -36,7 +36,7 @@ class Host:
def __init__(self) -> None:
self.username = os.environ["EXAMPLE_APP_USERNAME"]
self.password = hashlib.sha256(os.environ["EXAMPLE_APP_PASSWORD"].encode()).digest()
- self.session = os.environ["POLYMORFA_SESSION"]
+ self.connection = os.environ["POLYMORFA_CONNECTION"]
self.peer = os.environ["POLYMORFA_RECIPIENT"]
self.webhook_secret = os.environ["POLYMORFA_WEBHOOK_SECRET"]
if not self.peer or not self.webhook_secret:
@@ -53,8 +53,8 @@ def __init__(self) -> None:
self.origin = os.environ.get("EXAMPLE_APP_ORIGIN", "http://127.0.0.1:8080")
self.api = os.environ.get("POLYMORFA_API_BASE_URL", "https://api.polymorfa.com")
self.credential = Credential("project_token", os.environ["POLYMORFA_PROJECT_TOKEN"])
- if not self.username or not self.session or not os.environ["EXAMPLE_APP_PASSWORD"]:
- raise ValueError("Configure the example account and authorized number.")
+ if not self.username or not self.connection or not os.environ["EXAMPLE_APP_PASSWORD"]:
+ raise ValueError("Configure the example account and authorized Connection.")
if urlsplit(self.origin).hostname not in ("127.0.0.1", "localhost", "::1"):
raise ValueError("The example host is restricted to loopback.")
self.sessions: dict[str, float] = {}
@@ -99,7 +99,7 @@ async def mint(self) -> dict[str, object]:
response = await client.client_tokens.mint(
{
"ephemeralId": "example:local-app-user",
- "session": self.session,
+ "connection": self.connection,
"ttlSeconds": 600,
}
)
@@ -113,19 +113,19 @@ async def mint(self) -> dict[str, object]:
"expiresAt": int(expiry.timestamp() * 1000),
"scopes": ["read_messages", "connect_whatsapp"],
"grant": {
- "session": self.session,
+ "connection": self.connection,
"conversations": [],
"allow": ["read_messages", "connect_whatsapp"],
},
}
- async def connect_number(self) -> object:
+ async def connect_connection(self) -> object:
async with AsyncMessagingClient(self.credential, base_url=self.api) as client:
result = await client.quick_links.create(
{
- "purpose": "add_connection",
- "session": self.session,
- "addConnection": "linked_devices",
+ "purpose": "add_method",
+ "connection": self.connection,
+ "addMethod": "linked_devices",
"connectionGoal": "hybrid",
}
)
@@ -137,7 +137,7 @@ def snapshot(self):
{
"messages": self.messages,
"peer": self.peer,
- "session": self.session,
+ "connection": self.connection,
"receivedEvents": self.received,
"lastEvent": self.last_event,
}
@@ -174,7 +174,7 @@ async def send_message(self, body: bytes, key: str) -> Reply:
try:
async with AsyncMessagingClient(self.credential, base_url=self.api) as client:
response = await client.messages.send(
- self.session,
+ self.connection,
{"conversation": {"phoneNumber": self.peer}, "content": {"text": text}},
options=RequestOptions(idempotency_key=key, timeout=60),
)
@@ -207,7 +207,7 @@ def upsert(self, message):
self.messages = self.messages[-100:]
def receive(self, event):
- if event.session != self.session or not isinstance(event.payload, dict):
+ if event.connection != self.connection or not isinstance(event.payload, dict):
return
payload = event.payload
with self.state_lock:
diff --git a/examples/python/web_host/templates/workspace.html b/examples/python/web_host/templates/workspace.html
index 106d7d06d..a7ccb5ee9 100644
--- a/examples/python/web_host/templates/workspace.html
+++ b/examples/python/web_host/templates/workspace.html
@@ -1,10 +1,10 @@
Messaging workspace
- {% if authenticated %} {% if transport == "local-test-number" %}
- Local test numbers. Simulated WhatsApp transport.
+ {% if authenticated %} {% if transport == "local-test-connection" %}
+ Local test Connections. Simulated WhatsApp transport.
{% endif %}
- Python SDK. Text messages use the server-assigned number and recipient.
+ Python SDK. Text messages use the server-assigned Connection and recipient.
Conversation state lasts until this example server stops.
diff --git a/examples/react/App.tsx b/examples/react/App.tsx
index 091bdea35..718118ec6 100644
--- a/examples/react/App.tsx
+++ b/examples/react/App.tsx
@@ -16,7 +16,7 @@ import {
} from "@polymorfa/ui-kit/react";
const calls = createBrowserCalls({
- session: "support",
+ connection: "support",
getClientToken: createClientTokenProvider(),
onError: (error) => {
// "unauthorized": the token was revoked or expired; the next reconnect
diff --git a/examples/rust/README.md b/examples/rust/README.md
index 77756fe9d..a81dec82b 100644
--- a/examples/rust/README.md
+++ b/examples/rust/README.md
@@ -22,9 +22,9 @@ defineUiKit({ tokenEndpoint: "/api/polymorfa/token" });
Render `` through the framework's custom-element support. There is no second Rust UI
implementation. The token endpoint must authenticate your application user,
-derive their authorized session or customer from server state, and use
+derive their authorized Connection or customer from server state, and use
`MessagingClient.client_tokens().mint()` to issue a short-lived token. Never
-accept the session/customer target or ephemeral identity as trusted browser
+accept the Connection/customer target or ephemeral identity as trusted browser
input, and never send a project token or team key to WASM.
The runnable [Yew + Axum example](yew/README.md) builds a browser WASM application
diff --git a/examples/rust/axum/src/main.rs b/examples/rust/axum/src/main.rs
index 7fb63721b..1fdcae31d 100644
--- a/examples/rust/axum/src/main.rs
+++ b/examples/rust/axum/src/main.rs
@@ -43,7 +43,7 @@ mod tests {
use super::*;
#[tokio::test]
async fn raw_body_signature_is_required_and_verified_before_acknowledgement() {
- let body=Bytes::from_static(br#"{"id":"evt_fixture","session":"support","timestamp":"2026-08-19T10:00:00Z","event":"future.ready","payload":{"capability":42}}"#);
+ let body=Bytes::from_static(br#"{"id":"evt_fixture","connection":"support","timestamp":"2026-08-19T10:00:00Z","event":"future.ready","payload":{"capability":42}}"#);
let mut headers = HeaderMap::new();
assert_eq!(
webhook(
diff --git a/examples/rust/yew/README.md b/examples/rust/yew/README.md
index e69deca21..603222d1e 100644
--- a/examples/rust/yew/README.md
+++ b/examples/rust/yew/README.md
@@ -3,13 +3,13 @@
The Yew application renders the existing Polymorfa Web Components. Its WASM
binary has no dependency on the Rust server SDK. Axum owns the project token,
authenticates a local example user, and mints short-lived browser tokens for
-that user's server-assigned WhatsApp session. The inbox uses native server sends.
+that user's server-assigned WhatsApp Connection. The inbox uses native server sends.
The inbox calls the native Rust SDK on Axum for text sends. Verified native
webhooks at `/webhooks/polymorfa` update its application-owned in-memory
conversation. Register `message.received` and `message.ack` for the assigned
-Number with the configured signing secret. Incoming events must match the
-Number and canonical conversation ID from the send receipt. This does not
+Connection with the configured signing secret. Incoming events must match the
+Connection and canonical conversation ID from the send receipt. This does not
enable HMS.
The example retains at most 100 messages, 128 send attempts and 1024 recent
@@ -34,21 +34,21 @@ cargo run --locked --manifest-path examples/rust/yew/server/Cargo.toml
Configure these environment variables in the server process before running it:
-| Variable | Purpose |
-| ----------------------------- | -------------------------------------------------------- |
-| `POLYMORFA_PROJECT_TOKEN` | Server project credential; never passed to WASM |
-| `POLYMORFA_SESSION` | Session assigned by your application to the example user |
-| `POLYMORFA_RECIPIENT` | Server-assigned recipient phone |
-| `POLYMORFA_WEBHOOK_SECRET` | Native webhook signing secret |
-| `POLYMORFA_EXAMPLE_TRANSPORT` | Set `local-test-number` to label simulated transport |
-| `EXAMPLE_APP_USERNAME` | Local example login name |
-| `EXAMPLE_APP_PASSWORD` | Local example login password |
-| `POLYMORFA_EXAMPLE_PORT` | Loopback port, defaults to `3000` |
-| `POLYMORFA_API_BASE_URL` | Optional API origin for local contract fixtures |
+| Variable | Purpose |
+| ----------------------------- | ----------------------------------------------------------- |
+| `POLYMORFA_PROJECT_TOKEN` | Server project credential; never passed to WASM |
+| `POLYMORFA_CONNECTION` | Connection assigned by your application to the example user |
+| `POLYMORFA_RECIPIENT` | Server-assigned recipient phone |
+| `POLYMORFA_WEBHOOK_SECRET` | Native webhook signing secret |
+| `POLYMORFA_EXAMPLE_TRANSPORT` | Set `local-test-connection` to label simulated transport |
+| `EXAMPLE_APP_USERNAME` | Local example login name |
+| `EXAMPLE_APP_PASSWORD` | Local example login password |
+| `POLYMORFA_EXAMPLE_PORT` | Loopback port, defaults to `3000` |
+| `POLYMORFA_API_BASE_URL` | Optional API origin for local contract fixtures |
Open `http://127.0.0.1:3000` (or the selected port). Sign in with the local
example credentials. The browser receives an opaque, HttpOnly, SameSite cookie;
-it cannot choose the session, customer, or ephemeral ID sent to Polymorfa.
+it cannot choose the Connection, customer, or ephemeral ID sent to Polymorfa.
POST requests check the exact application origin. Logout revokes the server-side
application session immediately. Token responses are marked `no-store` and
include the grant consumed by `defineUiKit`.
@@ -56,7 +56,7 @@ include the grant consumed by `defineUiKit`.
The login and bounded in-memory session store are for this loopback example.
Replace them with your application's durable authentication and live
membership/assignment checks before deployment. Production cookies require
-HTTPS and `Secure`. Preserve the server-derived session and user identity.
+HTTPS and `Secure`. Preserve the server-derived Connection and user identity.
Do not replace authentication with a browser identity header or unsigned cookie.
Verification:
@@ -69,10 +69,10 @@ cargo check --locked --manifest-path examples/rust/yew/frontend/Cargo.toml --tar
The native integration test exercises real Axum HTTP login, cookie validation,
logout, and the Rust SDK's authenticated token request. It verifies that foreign
-origins, forged cookies, and browser-supplied session/identity fields cannot select
+origins, forged cookies, and browser-supplied Connection/identity fields cannot select
a different grant. Browser rendering and native API fixtures are separate from
live WhatsApp pairing or retained-history acceptance.
Local Inspector video acceptance is separate from HTTP contract tests. It uses
-paired simulated WhatsApp numbers, native Rust sends and signed HTTPS webhook
+paired simulated WhatsApp Connections, native Rust sends and signed HTTPS webhook
replies. Registry, staging and production availability remain separate gates.
diff --git a/examples/rust/yew/frontend/bridge.js b/examples/rust/yew/frontend/bridge.js
index 4b77b6305..1cf839cf5 100644
--- a/examples/rust/yew/frontend/bridge.js
+++ b/examples/rust/yew/frontend/bridge.js
@@ -36,7 +36,7 @@ function nativeInbox(inbox) {
const last = snapshot.messages.at(-1);
return {
id: snapshot.peer,
- session: snapshot.session,
+ connection: snapshot.connection,
name: "Assigned recipient",
phoneNumber: snapshot.peer,
lastActivity: last?.createdAt ?? 0,
@@ -68,7 +68,7 @@ function nativeInbox(inbox) {
const label = document.querySelector("#transport-label");
if (label)
label.textContent = snapshot.localTest
- ? "Local test numbers. Simulated WhatsApp transport."
+ ? "Local test Connections. Simulated WhatsApp transport."
: "";
const status = document.querySelector("#native-status");
if (status) {
diff --git a/examples/rust/yew/frontend/src/main.rs b/examples/rust/yew/frontend/src/main.rs
index 5ab06ad8d..b049fbb5f 100644
--- a/examples/rust/yew/frontend/src/main.rs
+++ b/examples/rust/yew/frontend/src/main.rs
@@ -115,7 +115,7 @@ fn app() -> Html {
});
})
};
- html! {{"Polymorfa in Yew"} {if *logged_in {html!{{"Sign out"} {(*error).clone()}
{"Rust SDK. Text messages use the server-assigned number and recipient. Conversation state lasts until this example server stops."}
}}else{html!{}}} }
+ html! {{"Polymorfa in Yew"} {if *logged_in {html!{{"Sign out"} {(*error).clone()}
{"Rust SDK. Text messages use the server-assigned Connection and recipient. Conversation state lasts until this example server stops."}
}}else{html!{}}} }
}
fn main() {
yew::Renderer::::new().render();
diff --git a/examples/rust/yew/server/src/conversation.rs b/examples/rust/yew/server/src/conversation.rs
index 4aeadcb80..9c54486e7 100644
--- a/examples/rust/yew/server/src/conversation.rs
+++ b/examples/rust/yew/server/src/conversation.rs
@@ -46,7 +46,7 @@ pub async fn snapshot(State(app): State>, headers: HeaderMap) -> Respon
return StatusCode::UNAUTHORIZED.into_response();
}
let s = app.conversation.lock().unwrap();
- ([(header::CACHE_CONTROL,"no-store")],Json(json!({"messages":s.messages,"peer":app.peer,"session":app.session,"receivedEvents":s.received,"lastEvent":s.last_event,"localTest":app.local_test}))).into_response()
+ ([(header::CACHE_CONTROL,"no-store")],Json(json!({"messages":s.messages,"peer":app.peer,"connection":app.connection,"receivedEvents":s.received,"lastEvent":s.last_event,"localTest":app.local_test}))).into_response()
}
#[derive(Deserialize)]
#[serde(deny_unknown_fields)]
@@ -98,7 +98,7 @@ pub async fn send(State(app): State>, headers: HeaderMap, body: Bytes)
.client
.messages()
.send(
- &app.session,
+ &app.connection,
&SendMessageRequest::text(ConversationReference::phone(&app.peer), &input.text),
RequestOptions {
idempotency_key: Some(key.into()),
@@ -147,7 +147,7 @@ pub async fn webhook(State(app): State>, headers: HeaderMap, body: Byte
return StatusCode::BAD_REQUEST.into_response();
};
let envelope = event.envelope();
- if envelope.session != app.session {
+ if envelope.connection != app.connection {
return Json(json!({"received":true})).into_response();
}
let mut s = app.conversation.lock().unwrap();
diff --git a/examples/rust/yew/server/src/main.rs b/examples/rust/yew/server/src/main.rs
index d5892389b..5da64b56c 100644
--- a/examples/rust/yew/server/src/main.rs
+++ b/examples/rust/yew/server/src/main.rs
@@ -32,7 +32,7 @@ struct App {
username_hash: [u8; 32],
password_hash: [u8; 32],
user_id: String,
- session: String,
+ connection: String,
origin: String,
users: Mutex>,
}
@@ -56,7 +56,7 @@ struct BrowserToken {
}
#[derive(Serialize)]
struct BrowserGrant {
- session: String,
+ connection: String,
conversations: Vec,
allow: Vec<&'static str>,
}
@@ -156,9 +156,9 @@ async fn connect(State(app): State>, headers: HeaderMap) -> Response {
return StatusCode::UNAUTHORIZED.into_response();
}
let request = polymorfa_sdk::models::CreateQuickLinkRequest {
- purpose: Some(polymorfa_sdk::models::CreateQuickLinkPurpose::AddConnection),
- session: Some(app.session.clone()),
- add_connection: Some(polymorfa_sdk::models::ConnectionKind::LinkedDevices),
+ purpose: Some(polymorfa_sdk::models::CreateQuickLinkPurpose::AddMethod),
+ connection: Some(app.connection.clone()),
+ add_method: Some(polymorfa_sdk::models::ConnectionKind::LinkedDevices),
connection_goal: Some(polymorfa_sdk::models::ConnectionGoal::Hybrid),
..Default::default()
};
@@ -183,8 +183,8 @@ async fn token(
let Some(user) = user else {
return StatusCode::UNAUTHORIZED.into_response();
};
- // Both identity and number assignment are server-owned. No browser body or
- // identity header chooses a session, customer, or ephemeral ID.
+ // Both identity and Connection assignment are server-owned. No browser body or
+ // identity header chooses a Connection, customer, or ephemeral ID.
let result = app
.client
.client_tokens()
@@ -192,8 +192,8 @@ async fn token(
&MintClientTokenRequest {
ephemeral_id: format!("example:{user}"),
ttl_seconds: Some(600),
- target: ClientTokenTarget::Session {
- session: app.session.clone(),
+ target: ClientTokenTarget::Connection {
+ connection: app.connection.clone(),
allow: None,
},
},
@@ -217,7 +217,7 @@ async fn token(
expires_at: expiry.timestamp_millis(),
scopes: vec!["read_messages", "connect_whatsapp"],
grant: BrowserGrant {
- session: app.session.clone(),
+ connection: app.connection.clone(),
conversations: Vec::new(),
allow: vec!["read_messages", "connect_whatsapp"],
},
@@ -239,16 +239,16 @@ async fn token(
async fn main() -> Result<(), Box> {
let username = std::env::var("EXAMPLE_APP_USERNAME")?;
let password = std::env::var("EXAMPLE_APP_PASSWORD")?;
- let session = std::env::var("POLYMORFA_SESSION")?;
+ let connection = std::env::var("POLYMORFA_CONNECTION")?;
let peer = std::env::var("POLYMORFA_RECIPIENT")?;
let webhook_secret = std::env::var("POLYMORFA_WEBHOOK_SECRET")?;
if username.is_empty()
|| password.is_empty()
- || session.is_empty()
+ || connection.is_empty()
|| peer.is_empty()
|| webhook_secret.is_empty()
{
- return Err("Set a nonempty example username, password, and authorized session".into());
+ return Err("Set a nonempty example username, password, and authorized Connection".into());
}
let credential = Credential::project_token(std::env::var("POLYMORFA_PROJECT_TOKEN")?)?;
let port: u16 = std::env::var("POLYMORFA_EXAMPLE_PORT")
@@ -264,13 +264,13 @@ async fn main() -> Result<(), Box> {
username_hash: digest(&username),
password_hash: digest(&password),
user_id: uuid::Uuid::new_v4().to_string(),
- session,
+ connection,
origin: format!("http://127.0.0.1:{port}"),
users: Mutex::new(HashMap::new()),
peer,
webhook_secret,
local_test: std::env::var("POLYMORFA_EXAMPLE_TRANSPORT").as_deref()
- == Ok("local-test-number"),
+ == Ok("local-test-connection"),
conversation: Mutex::new(Default::default()),
send_gate: tokio::sync::Mutex::new(()),
});
diff --git a/examples/rust/yew/server/src/tests.rs b/examples/rust/yew/server/src/tests.rs
index 43000c7fb..ce2e3041d 100644
--- a/examples/rust/yew/server/src/tests.rs
+++ b/examples/rust/yew/server/src/tests.rs
@@ -36,7 +36,7 @@ async fn real_app_login_uses_opaque_cookie_and_server_assignment_for_native_toke
assert!(head.to_lowercase().contains("authorization: bearer pmfa_"));
assert_eq!(
serde_json::from_slice::(&bytes[end..]).unwrap(),
- json!({"ephemeralId":"example:app-user-id","session":"authorized-support","ttlSeconds":600})
+ json!({"ephemeralId":"example:app-user-id","connection":"authorized-support","ttlSeconds":600})
);
let body=json!({"success":true,"data":{"token":"pmfa_ct_YnJvd3Nlcl9maXh0dXJl","expiresAt":"2030-01-01T00:00:00Z"}}).to_string();
stream.write_all(format!("HTTP/1.1 200 OK\r\ncontent-type: application/json\r\ncontent-length: {}\r\nconnection: close\r\n\r\n{body}",body.len()).as_bytes()).await.unwrap();
@@ -56,7 +56,7 @@ async fn real_app_login_uses_opaque_cookie_and_server_assignment_for_native_toke
username_hash: digest("example-user"),
password_hash: digest("test-only-password"),
user_id: "app-user-id".into(),
- session: "authorized-support".into(),
+ connection: "authorized-support".into(),
origin: origin.clone(),
users: Mutex::new(HashMap::new()),
peer: "+15550001234".into(),
@@ -129,7 +129,7 @@ async fn real_app_login_uses_opaque_cookie_and_server_assignment_for_native_toke
.header("origin", &origin)
.header("cookie", cookie)
.header("x-example-authenticated-user", "evil")
- .json(&json!({"session":"foreign","customer":"foreign","ephemeralId":"evil"}))
+ .json(&json!({"connection":"foreign","customer":"foreign","ephemeralId":"evil"}))
.send()
.await
.unwrap();
@@ -137,7 +137,7 @@ async fn real_app_login_uses_opaque_cookie_and_server_assignment_for_native_toke
assert_eq!(minted.headers()["cache-control"], "no-store");
assert_eq!(
minted.json::().await.unwrap(),
- json!({"value":"pmfa_ct_YnJvd3Nlcl9maXh0dXJl","audience":"browser","expiresAt":1893456000000i64,"scopes":["read_messages","connect_whatsapp"],"grant":{"session":"authorized-support","conversations":[],"allow":["read_messages","connect_whatsapp"]}})
+ json!({"value":"pmfa_ct_YnJvd3Nlcl9maXh0dXJl","audience":"browser","expiresAt":1893456000000i64,"scopes":["read_messages","connect_whatsapp"],"grant":{"connection":"authorized-support","conversations":[],"allow":["read_messages","connect_whatsapp"]}})
);
upstream.await.unwrap();
assert_eq!(
@@ -191,13 +191,13 @@ async fn connect_and_conversation_require_app_session_and_keep_assignment_on_ser
assert!(head.starts_with("POST /messaging/quicklinks HTTP/1.1"));
assert_eq!(
serde_json::from_slice::(&bytes[end + 4..]).unwrap(),
- json!({"purpose":"add_connection","session":"authorized-support","addConnection":"linked_devices","connectionGoal":"hybrid"})
+ json!({"purpose":"add_method","connection":"authorized-support","addMethod":"linked_devices","connectionGoal":"hybrid"})
);
break;
}
}
}
- let body=json!({"success":true,"data":{"purpose":"add_connection","connectionGoal":"hybrid","addConnection":"linked_devices","id":"link","url":"https://quick.example.com/link","session":"authorized-support","expiresAt":null}}).to_string();
+ let body=json!({"success":true,"data":{"purpose":"add_method","connectionGoal":"hybrid","addMethod":"linked_devices","id":"link","url":"https://quick.example.com/link","connection":"authorized-support","expiresAt":null}}).to_string();
stream.write_all(format!("HTTP/1.1 200 OK\r\ncontent-type: application/json\r\ncontent-length: {}\r\nconnection: close\r\n\r\n{body}",body.len()).as_bytes()).await.unwrap();
});
let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
@@ -215,7 +215,7 @@ async fn connect_and_conversation_require_app_session_and_keep_assignment_on_ser
username_hash: digest("user"),
password_hash: digest("fixture"),
user_id: "app-user".into(),
- session: "authorized-support".into(),
+ connection: "authorized-support".into(),
origin: origin.clone(),
peer: "+15550001234".into(),
webhook_secret: "local-test-signing-key".into(),
@@ -253,7 +253,7 @@ async fn connect_and_conversation_require_app_session_and_keep_assignment_on_ser
.json::()
.await
.unwrap(),
- json!({"messages":[],"peer":"+15550001234","session":"authorized-support","receivedEvents":0,"lastEvent":"","localTest":true})
+ json!({"messages":[],"peer":"+15550001234","connection":"authorized-support","receivedEvents":0,"lastEvent":"","localTest":true})
);
assert_eq!(
client
@@ -269,7 +269,7 @@ async fn connect_and_conversation_require_app_session_and_keep_assignment_on_ser
.post(format!("{origin}/api/polymorfa/connect"))
.header("origin", &origin)
.header("cookie", "polymorfa_example_session=opaque-app-session")
- .json(&json!({"session":"foreign"}))
+ .json(&json!({"connection":"foreign"}))
.send()
.await
.unwrap();
@@ -315,7 +315,7 @@ async fn native_inbox_sends_once_and_consumes_signed_peer_reply_after_reload() {
username_hash: digest("example-user"),
password_hash: digest("test-only-password"),
user_id: "app-user-id".into(),
- session: "authorized-support".into(),
+ connection: "authorized-support".into(),
origin: origin.clone(),
users: Mutex::new(HashMap::new()),
peer: "+15550001234".into(),
@@ -387,7 +387,7 @@ async fn native_inbox_sends_once_and_consumes_signed_peer_reply_after_reload() {
let event = polymorfa_sdk::webhooks::WebhookEvent::Unknown(
polymorfa_sdk::webhooks::WebhookEnvelope {
id: "event-1".into(),
- session: "authorized-support".into(),
+ connection: "authorized-support".into(),
timestamp: "2026-10-18T10:00:01Z".into(),
event: "message.received".into(),
external_id: None,
diff --git a/packages/calls/README.md b/packages/calls/README.md
index f0bf3135e..71a7792ee 100644
--- a/packages/calls/README.md
+++ b/packages/calls/README.md
@@ -3,7 +3,7 @@
This directory is the source of the `@polymorfa/sdk/calls` subpath. It is built
into the `@polymorfa/sdk` package and is not published on its own.
-Programmatic Polymorfa Calls: a client you run from code that follows a session,
+Programmatic Polymorfa Calls: a client you run from code that follows a connection,
rings on inbound WhatsApp calls, places outbound ones, and hands you each call's
audio and video to read and write. The browser call UI in `@polymorfa/ui-kit/react` and
`@polymorfa/ui-kit/web-components` uses the same call model with WebRTC as its media path.
@@ -13,7 +13,7 @@ import { CallsClient } from "@polymorfa/sdk/calls";
const client = new CallsClient({
token: process.env.POLYMORFA_API_KEY!, // or a client-token provider
- session: "support",
+ connection: "support",
participant: "voice-agent", // server credentials only
});
@@ -37,13 +37,13 @@ const call = await client.place("+15550100", { video: false });
- Browser and other untrusted clients use a client token. Your server mints it
with `POST /platform/client-tokens` and grants `voip_place`, `voip_answer`,
- and `voip_signal`. The token decides the session and the participant.
+ and `voip_signal`. The token decides the connection and the participant.
- Server applications use a team key or project token. They may
set `participant` (`[A-Za-z0-9._:@-]{1,128}`, default `default`); the
platform refers to them as `server:`.
Never put a server credential in a browser. There is no calling ticket, token
-exchange, or session answer mode.
+exchange, or connection answer mode.
## Answering, joining, and claims
@@ -69,13 +69,13 @@ promise: it resolves once media connects and rejects if media fails.
## Model
-- **`CallsClient`** — one per session. `connect()` starts receiving the
- session's calls and resolves once the first attempt settles.
+- **`CallsClient`** — one per connection. `connect()` starts receiving the
+ connection's calls and resolves once the first attempt settles.
`participantReference` names this client once known. A replacement token
- must belong to the same team, project, session and participant.
+ must belong to the same team, project, connection and participant.
The client replaces the token before it expires, reconnects with backoff, and detects dead connections. When the token stops
working it emits a `CallsAuthError` (`code: "unauthorized"`) and asks the
- provider for a fresh token. An invalid session or participant stops
+ provider for a fresh token. An invalid connection or participant stops
reconnection with `invalid_request`; `rate_limited` keeps retrying with
backoff. Events: `incoming`, `call`, `ended`, `ready`,
`disconnected`, `error`. `disconnect()` leaves joined calls and ends
@@ -85,8 +85,8 @@ promise: it resolves once media connects and rejects if media fails.
`connectionId`, and `startedAt` / `connectedAt` / `duration`.
- **`call.audio`** — merged call audio as signed 16-bit mono PCM at `sampleRate`
(16 kHz unless the platform names another rate), both directions. It never
- contains your own audio. With the session's `conferenceMode` call setting
- on (the default) it also carries the session's other participants; with it
+ contains your own audio. With the connection's `conferenceMode` call setting
+ on (the default) it also carries the connection's other participants; with it
off, only the WhatsApp party.
- **`call.video`** — one outgoing H.264 stream and one received stream per
remote participant. `sources` maps each `CallVideoSource.id` to its `label`
@@ -128,7 +128,7 @@ answer or an exclusive placement) and otherwise leaves with its
reported; the call then ends with `connection_failed` and the media error.
A call another participant claimed is not released.
-While calling is turned off for the session in its call settings, placing,
+While calling is turned off for the connection in its call settings, placing,
answering, joining, inviting and connecting media reject with
`CallsDisabledError` (`code: "calls_disabled"`). Calls in progress continue.
@@ -183,14 +183,14 @@ const groupCall = await client.placeGroup("9007199254740996");
```
Pass 2 to 31 distinct phone numbers or public user IDs. The server checks each
-recipient's destination policy and the Number's calling restrictions before
-placing the group call. Cloud API Numbers refuse group origination and re-ring.
+recipient's destination policy and the Connection's calling restrictions before
+placing the group call. Cloud API Connections refuse group origination and re-ring.
Re-ring applies to a non-connected participant already in the call roster;
a successful request does not change the roster until WhatsApp reports it.
The browser controller exposes the same `place` array input and
`ringParticipant` method for custom React, web component and Next.js interfaces.
-`placeGroup(groupId)` uses the public group ID. The Number must be a member;
+`placeGroup(groupId)` uses the public group ID. The Connection must be a member;
the server obtains the live roster and checks every remote member. Groups must
contain 2 to 31 remote members. Changed membership during placement refuses
the call. The browser controller exposes the same `placeGroup` method; it does
@@ -233,9 +233,9 @@ reaction and `call.sendReaction("")` clears it. Listen for `reaction`; the sende
is either `{self: true}` or a public `participantId`. Reconnection does not
replay reactions. The SDK does not retry an uncertain send.
-`call.setHandRaised(true)` raises the Number's hand and `false` lowers it.
+`call.setHandRaised(true)` raises the Connection's hand and `false` lowers it.
`call.handRaised` and the `handState` event report the confirmed state. One
-Number shares its hand state across all application connections; remote hands
+Connection shares its hand state across all application connections; remote hands
are reported in `participant.handRaised` and disappear with the participant.
These controls require an attached connection and runtime support. Cloud API
calls refuse them. This source addition still needs a published package and
@@ -266,7 +266,7 @@ Browsers use the matching methods on the UI Kit Calls controller. React's
`ParticipantList` and the `` Web Component show guest labels and
pending-participant controls when the current connection is an administrator.
The browser receives snapshots on WebRTC and sends moderation through the
-Messaging API so every command rechecks its credential and Number/project
+Messaging API so every command rechecks its credential and Connection/project
authority. The credential-less data channel refuses moderation effects.
Programmatic processes keep the authenticated media WebSocket and its credential
rechecks. Both paths use the same public identities and provider acknowledgements.
diff --git a/packages/calls/src/api.ts b/packages/calls/src/api.ts
index b41985521..bb4659077 100644
--- a/packages/calls/src/api.ts
+++ b/packages/calls/src/api.ts
@@ -44,8 +44,8 @@ export interface AcceptCallResult {
}
export interface PlaceCallRequest {
- /** Source session. Sent for server credentials; client tokens are bound to one. */
- readonly session: string;
+ /** Source connection. Sent for server credentials; client tokens are bound to one. */
+ readonly connection: string;
readonly to: string;
readonly participants?: readonly string[];
readonly groupId?: string;
@@ -147,11 +147,11 @@ export interface HttpCallsApiOptions {
/** Socket host; defaults to `ws(s)://` on the API host. */
readonly socketBaseUrl?: string;
/**
- * The number a Customer-scoped client token acts for, sent as `?session=`
- * on every Calls request. Session tokens are bound to one number and need
+ * The Connection a Customer-scoped client token acts for, sent as `?connection=`
+ * on every Calls request. Connection tokens are bound to one Connection and need
* no value.
*/
- readonly clientTokenSession?: string;
+ readonly clientTokenConnection?: string;
readonly now?: () => number;
}
@@ -207,10 +207,10 @@ export class HttpCallsApi implements CallsApi {
readonly #baseUrl: string;
readonly #fetch: FetchLike;
readonly #socketBaseUrl: string;
- readonly #clientTokenSession: string | undefined;
+ readonly #clientTokenConnection: string | undefined;
constructor(options: HttpCallsApiOptions) {
- this.#clientTokenSession = options.clientTokenSession;
+ this.#clientTokenConnection = options.clientTokenConnection;
const credential = options.token ?? options.apiKey;
if (credential === undefined)
throw new CallsApiError(
@@ -249,7 +249,7 @@ export class HttpCallsApi implements CallsApi {
"POST",
"/messaging/voip/calls",
async (token) => ({
- ...(isClientToken(token) ? {} : { session: input.session }),
+ ...(isClientToken(token) ? {} : { connection: input.connection }),
...(input.groupId !== undefined
? { groupId: input.groupId }
: input.participants === undefined
@@ -454,8 +454,8 @@ export class HttpCallsApi implements CallsApi {
...(signal === undefined ? {} : { signal }),
};
const target =
- this.#clientTokenSession !== undefined && isClientToken(token.value)
- ? `${path}${path.includes("?") ? "&" : "?"}session=${encodeURIComponent(this.#clientTokenSession)}`
+ this.#clientTokenConnection !== undefined && isClientToken(token.value)
+ ? `${path}${path.includes("?") ? "&" : "?"}connection=${encodeURIComponent(this.#clientTokenConnection)}`
: path;
const response = await this.#fetch(`${this.#baseUrl}${target}`, init);
const text = await response.text();
diff --git a/packages/calls/src/call.ts b/packages/calls/src/call.ts
index 89bacafbb..ae7f4ec72 100644
--- a/packages/calls/src/call.ts
+++ b/packages/calls/src/call.ts
@@ -299,7 +299,7 @@ export function capabilitiesFrom(
export interface CallInit {
readonly id: string;
- readonly session: string;
+ readonly connection: string;
readonly direction: CallDirection;
/** The other party as the platform presents it: number or public ID. */
readonly peer: string;
@@ -342,7 +342,7 @@ const RELEASE_TIMEOUT_MS = 5_000;
*/
export class Call extends Emitter {
readonly id: string;
- readonly session: string;
+ readonly connection: string;
readonly direction: CallDirection;
readonly peer: string;
/** True when the call offered video and the call can carry it. */
@@ -454,7 +454,7 @@ export class Call extends Emitter {
constructor(init: CallInit) {
super();
this.id = init.id;
- this.session = init.session;
+ this.connection = init.connection;
this.direction = init.direction;
this.peer = init.peer;
this.#capabilities = init.capabilities ?? DEFAULT_CALL_CAPABILITIES;
diff --git a/packages/calls/src/client.ts b/packages/calls/src/client.ts
index ec8a1e037..58d5eb2c0 100644
--- a/packages/calls/src/client.ts
+++ b/packages/calls/src/client.ts
@@ -29,19 +29,19 @@ export interface CallsClientOptions {
readonly token?: string | CallsTokenProvider;
/** Server API key or project token; same as passing it as `token`. */
readonly apiKey?: string;
- /** The session whose calls this client follows and places from. */
- readonly session: string;
+ /** The connection whose calls this client follows and places from. */
+ readonly connection: string;
/**
* Participant name for server credentials (`[A-Za-z0-9._:@-]{1,128}`,
* default `default`). Client tokens always act as their own participant.
*/
readonly participant?: string;
/**
- * The number a Customer-scoped client token acts for, sent as `?session=`
- * on Calls requests and the lifecycle socket. Leave unset for session
+ * The Connection a Customer-scoped client token acts for, sent as `?connection=`
+ * on Calls requests and the lifecycle socket. Leave unset for Connection
* tokens and server credentials.
*/
- readonly clientTokenSession?: string;
+ readonly clientTokenConnection?: string;
/** Defaults to `https://api.polymorfa.com`. */
readonly baseUrl?: string;
/** Media reattach attempts after an unexpected drop. Default 3. */
@@ -91,7 +91,7 @@ export interface PlaceOptions {
type ClientEvents = {
/**
- * A call is ringing this session. Answer, join, reject, or ignore it; the
+ * A call is ringing this connection. Answer, join, reject, or ignore it; the
* client never declines on its own.
*/
incoming: [Call];
@@ -106,12 +106,12 @@ type ClientEvents = {
};
/**
- * The programmatic Calls client: follows one session, rings on inbound calls,
+ * The programmatic Calls client: follows one connection, rings on inbound calls,
* places outbound ones, and hands each call back as a {@link Call} with media
* you read and write from code.
*
* ```ts
- * const client = new CallsClient({ token: getToken, session: "support" });
+ * const client = new CallsClient({ token: getToken, connection: "support" });
* client.on("incoming", async (call) => {
* await call.answer({ exclusive: true });
* call.audio.on("data", (pcm) => transcribe(pcm));
@@ -121,7 +121,7 @@ type ClientEvents = {
* ```
*/
export class CallsClient extends Emitter {
- readonly session: string;
+ readonly connection: string;
/** Bumped by disconnect(); a placement that resolves later is ended. */
#connectGeneration = 0;
readonly #api: CallsApi;
@@ -144,7 +144,7 @@ export class CallsClient extends Emitter {
super();
const options = publicOptions as InternalCallsClientOptions;
this.#o = options;
- this.session = options.session;
+ this.connection = options.connection;
if (
options.participant !== undefined &&
!isParticipantName(options.participant)
@@ -158,9 +158,9 @@ export class CallsClient extends Emitter {
this.#api =
options.api ??
new HttpCallsApi({
- ...(options.clientTokenSession === undefined
+ ...(options.clientTokenConnection === undefined
? {}
- : { clientTokenSession: options.clientTokenSession }),
+ : { clientTokenConnection: options.clientTokenConnection }),
token: credential!,
...(options.baseUrl === undefined ? {} : { baseUrl: options.baseUrl }),
...(options.fetch === undefined ? {} : { fetch: options.fetch }),
@@ -170,13 +170,13 @@ export class CallsClient extends Emitter {
options.createIdempotencyKey ?? (() => crypto.randomUUID());
this.#socket = new LifecycleSocket({
api: this.#api,
- session: options.session,
+ connection: options.connection,
...(options.participant === undefined
? {}
: { participant: options.participant }),
- ...(options.clientTokenSession === undefined
+ ...(options.clientTokenConnection === undefined
? {}
- : { clientTokenSession: options.clientTokenSession }),
+ : { clientTokenConnection: options.clientTokenConnection }),
...timerOptions(options),
...(options.now === undefined ? {} : { now: options.now }),
});
@@ -242,7 +242,7 @@ export class CallsClient extends Emitter {
}
/**
- * Stop following the session. Calls this client joined are left, not
+ * Stop following the connection. Calls this client joined are left, not
* ended; outbound calls still ringing are ended; ringing inbound calls
* are only forgotten locally.
*/
@@ -294,7 +294,7 @@ export class CallsClient extends Emitter {
options.signal?.throwIfAborted();
const video = options.video ?? false;
const input = {
- session: this.session,
+ connection: this.connection,
to: primary,
...(participants ? { participants: [...participants] } : {}),
...(groupId ? { groupId } : {}),
@@ -337,7 +337,7 @@ export class CallsClient extends Emitter {
return new Call({
exclusive,
id,
- session: this.session,
+ connection: this.connection,
direction,
peer,
video,
diff --git a/packages/calls/src/errors.ts b/packages/calls/src/errors.ts
index 6fe6fcc75..48500b3b8 100644
--- a/packages/calls/src/errors.ts
+++ b/packages/calls/src/errors.ts
@@ -31,7 +31,7 @@ export class CallClaimedError extends CallsApiError {
}
/**
- * Calling is turned off for the session in its call settings. Placing,
+ * Calling is turned off for the connection in its call settings. Placing,
* answering, joining, inviting and attaching media are refused until it is
* turned back on; calls in progress continue.
*/
@@ -48,7 +48,9 @@ export class CallsDisabledError extends CallsApiError {
* The client asks the token provider for a fresh token before reconnecting.
*/
export class CallsAuthError extends CallsError {
- constructor(message = "The credential no longer authorizes this session.") {
+ constructor(
+ message = "The credential no longer authorizes this connection.",
+ ) {
super("unauthorized", message);
this.name = "CallsAuthError";
}
diff --git a/packages/calls/src/lifecycle.ts b/packages/calls/src/lifecycle.ts
index 8acd74d56..3d4373ae6 100644
--- a/packages/calls/src/lifecycle.ts
+++ b/packages/calls/src/lifecycle.ts
@@ -26,7 +26,7 @@ export interface LifecycleCandidate {
}
export interface LifecycleReady {
- readonly session?: string;
+ readonly connection?: string;
/** Participant reference of the authenticated credential, when the platform sends it. */
readonly participant?: string;
}
@@ -34,17 +34,17 @@ export interface LifecycleReady {
export interface LifecycleSocketOptions {
readonly api: Pick;
/**
- * Session to follow. Sent as `?session=` for server credentials only;
- * client tokens are bound to one session and send no query parameters.
+ * Connection to follow. Sent as `?connection=` for server credentials only;
+ * client tokens are bound to one connection and send no query parameters.
*/
- readonly session?: string;
+ readonly connection?: string;
/**
* Participant name for server credentials, sent as `?participant=`.
* Ignored for client tokens.
*/
readonly participant?: string;
- /** The number a Customer-scoped client token acts for, sent as `?session=`. */
- readonly clientTokenSession?: string;
+ /** The Connection a Customer-scoped client token acts for, sent as `?connection=`. */
+ readonly clientTokenConnection?: string;
readonly WebSocket?: typeof globalThis.WebSocket;
readonly setTimeout?: typeof globalThis.setTimeout;
readonly clearTimeout?: typeof globalThis.clearTimeout;
@@ -88,11 +88,11 @@ type Events = {
export const SocketCloseCode = {
/** The credential does not (or no longer) authorize the socket. */
Unauthorized: AUTH_FAILED_CLOSE_CODE,
- /** Call or session state refused the socket (for example a claimed call). */
+ /** Call or connection state refused the socket (for example a claimed call). */
Conflict: 4409,
/** Too many attempts. */
RateLimited: 4429,
- /** The request is invalid (for example an unknown session or participant). */
+ /** The request is invalid (for example an unknown connection or participant). */
InvalidRequest: 4400,
/** A policy violation, including no auth frame within 5 seconds. */
PolicyViolation: 1008,
@@ -352,9 +352,9 @@ export class LifecycleSocket extends Emitter {
this.#scheduleRefresh(socket, token);
try {
this.emit("ready", {
- ...(frame.session === undefined
+ ...(frame.connection === undefined
? {}
- : { session: frame.session }),
+ : { connection: frame.connection }),
...(frame.participant === undefined
? {}
: { participant: frame.participant }),
@@ -444,7 +444,7 @@ export class LifecycleSocket extends Emitter {
/**
* Replace the token on the open socket before it expires. The platform
* re-validates the latest token on its own schedule and closes with 4401
- * when it no longer authorizes the session.
+ * when it no longer authorizes the connection.
*/
#scheduleRefresh(socket: WebSocket, token: CallsToken): void {
this.#clearRefresh();
@@ -502,16 +502,17 @@ export class LifecycleSocket extends Emitter {
}
/**
- * `/voip/ws`. Server credentials name the session and participant; a
- * Customer-scoped client token names only the number it acts for.
+ * `/voip/ws`. Server credentials name the connection and participant; a
+ * Customer-scoped client token names only the Connection it acts for.
*/
#path(token: CallsToken): string {
if (isClientToken(token.value))
- return this.#o.clientTokenSession === undefined
+ return this.#o.clientTokenConnection === undefined
? LIFECYCLE_SOCKET_PATH
- : `${LIFECYCLE_SOCKET_PATH}?session=${encodeURIComponent(this.#o.clientTokenSession)}`;
+ : `${LIFECYCLE_SOCKET_PATH}?connection=${encodeURIComponent(this.#o.clientTokenConnection)}`;
const query = new URLSearchParams();
- if (this.#o.session !== undefined) query.set("session", this.#o.session);
+ if (this.#o.connection !== undefined)
+ query.set("connection", this.#o.connection);
if (this.#o.participant !== undefined)
query.set("participant", this.#o.participant);
const search = query.toString();
@@ -591,7 +592,7 @@ function closeError(code: number | undefined): CallsError | undefined {
case SocketCloseCode.Conflict:
return new CallsError(
"socket_conflict",
- "The platform refused the socket for the current session state.",
+ "The platform refused the socket for the current connection state.",
);
case SocketCloseCode.RateLimited:
return new CallsError(
@@ -601,7 +602,7 @@ function closeError(code: number | undefined): CallsError | undefined {
case SocketCloseCode.InvalidRequest:
return new CallsError(
"invalid_request",
- "The platform refused the socket request; check the session and participant. Reconnection stopped.",
+ "The platform refused the socket request; check the connection and participant. Reconnection stopped.",
);
default:
return undefined;
diff --git a/packages/calls/src/protocol.ts b/packages/calls/src/protocol.ts
index a2dcb134f..8ff0df3b7 100644
--- a/packages/calls/src/protocol.ts
+++ b/packages/calls/src/protocol.ts
@@ -10,12 +10,12 @@ import type { MediaStateRequest, MediaStateReply } from "./media-state.js";
*
* 1. The **lifecycle socket** (`GET /voip/ws`) — one per client. No credential
* travels in the URL: the first frame is `{ type: "auth", token }` and the
- * platform answers `ready`. Server credentials name the session with
- * `?session=` (and optionally `&participant=`); client tokens send no query
+ * platform answers `ready`. Server credentials name the connection with
+ * `?connection=` (and optionally `&participant=`); client tokens send no query
* parameters. A later `auth` frame replaces an expiring token and must
- * resolve to the same team, project, session and participant. The
+ * resolve to the same team, project, connection and participant. The
* platform closes the socket with 4401 once the token stops authorizing
- * the session.
+ * the connection.
*
* 2. The **media socket** (`GET /voip/calls/{callId}/media`, subprotocol
* `pmfa.calls.v2`) — one per media connection. The first frame is
@@ -80,7 +80,7 @@ export interface TrickleCandidate {
export type LifecycleFrame =
| {
readonly type: "ready";
- readonly session?: string;
+ readonly connection?: string;
/** Participant reference of the authenticated credential, when sent. */
readonly participant?: string;
}
@@ -116,7 +116,7 @@ export function parseLifecycleFrame(data: unknown): LifecycleFrame | undefined {
if (f === undefined) return undefined;
switch (f["type"]) {
case "ready":
- return optionalString(f["session"]) && optionalString(f["participant"])
+ return optionalString(f["connection"]) && optionalString(f["participant"])
? (f as LifecycleFrame)
: undefined;
case "event":
diff --git a/packages/calls/src/token.ts b/packages/calls/src/token.ts
index 7ba6a650f..d1f053118 100644
--- a/packages/calls/src/token.ts
+++ b/packages/calls/src/token.ts
@@ -28,7 +28,7 @@ export interface CallsTokenSourceOptions {
readonly expirySkewMs?: number;
}
-/** Client tokens are bound to one session and one participant by the platform. */
+/** Client tokens are bound to one connection and one participant by the platform. */
export function isClientToken(value: string): boolean {
return value.startsWith("pmfa_ct_");
}
@@ -36,7 +36,7 @@ export function isClientToken(value: string): boolean {
/**
* Caches a provider's token until shortly before it expires. A static string
* never expires from the client's point of view; the platform still closes
- * sockets with 4401 when it stops authorizing the session.
+ * sockets with 4401 when it stops authorizing the connection.
*/
export class CallsTokenSource {
readonly #provider: CallsTokenProvider;
diff --git a/packages/calls/test/client.test.ts b/packages/calls/test/client.test.ts
index 4ecda6c75..561cc0533 100644
--- a/packages/calls/test/client.test.ts
+++ b/packages/calls/test/client.test.ts
@@ -16,7 +16,7 @@ function clientWith(
FakeWebSocket.instances = [];
const t = timers();
const client = createInternalCallsClient({
- session: "support",
+ connection: "support",
api,
WebSocket: FakeWebSocket as unknown as typeof globalThis.WebSocket,
setInterval: t.setInterval,
@@ -179,7 +179,7 @@ describe("CallsClient", () => {
const call = await h.client.place("+15550100", { video: true });
expect(h.api.place).toHaveBeenCalledWith(
expect.objectContaining({
- session: "support",
+ connection: "support",
to: "+15550100",
video: true,
}),
@@ -334,13 +334,13 @@ describe("CallsClient", () => {
// Nothing but ready is processed before authentication.
ring(life);
expect(h.client.calls).toEqual([]);
- life.text({ type: "ready", session: "support" });
+ life.text({ type: "ready", connection: "support" });
await connecting;
expect(h.client.connected).toBe(true);
await h.client.disconnect();
});
- it("names the session in the query for server credentials only", async () => {
+ it("names the connection in the query for server credentials only", async () => {
const client = clientWith();
await connected(client);
// Client tokens send no query parameters.
@@ -351,7 +351,7 @@ describe("CallsClient", () => {
api.token.mockResolvedValue({ value: "pmfa_live_server" });
const h = clientWith(api);
await connected(h);
- expect(h.ws(0).url).toBe("wss://api.example/voip/ws?session=support");
+ expect(h.ws(0).url).toBe("wss://api.example/voip/ws?connection=support");
// The auth frame is exactly { type, token }.
expect(h.ws(0).texts[0]).toEqual({
type: "auth",
@@ -756,7 +756,9 @@ describe("CallsClient", () => {
});
it("refuses to construct without a credential or an api seam", () => {
- expect(() => createInternalCallsClient({ session: "s" })).toThrow(/token/);
+ expect(() => createInternalCallsClient({ connection: "s" })).toThrow(
+ /token/,
+ );
});
});
@@ -853,7 +855,7 @@ describe("CallsClient — review round one", () => {
FakeWebSocket.instances = [];
const t = timers();
const client = createInternalCallsClient({
- session: "support",
+ connection: "support",
api,
WebSocket: FakeWebSocket as unknown as typeof globalThis.WebSocket,
setInterval: t.setInterval,
@@ -912,7 +914,7 @@ describe("CallsClient — review round one", () => {
FakeWebSocket.instances = [];
const t = timers();
const client = createInternalCallsClient({
- session: "support",
+ connection: "support",
api,
WebSocket: FakeWebSocket as unknown as typeof globalThis.WebSocket,
setInterval: t.setInterval,
diff --git a/packages/calls/test/diagnostics.test.ts b/packages/calls/test/diagnostics.test.ts
index afccae3d7..a71a1ac17 100644
--- a/packages/calls/test/diagnostics.test.ts
+++ b/packages/calls/test/diagnostics.test.ts
@@ -156,7 +156,7 @@ describe("Call diagnostics (socket media)", () => {
const api = fakeApi();
const t = timers();
const c = createInternalCallsClient({
- session: "support",
+ connection: "support",
api,
WebSocket: FakeWebSocket as unknown as typeof globalThis.WebSocket,
setInterval: t.setInterval,
diff --git a/packages/calls/test/external-media.test.ts b/packages/calls/test/external-media.test.ts
index d3bc6ba5f..dec823ea5 100644
--- a/packages/calls/test/external-media.test.ts
+++ b/packages/calls/test/external-media.test.ts
@@ -10,7 +10,7 @@ function inbound(
) {
return new Call({
id: "CALL-IN",
- session: "support",
+ connection: "support",
direction: "inbound",
peer: "+15550100",
video: false,
@@ -43,7 +43,7 @@ describe("externally managed call media", () => {
const api = fakeApi();
const call = new Call({
id: "CALL-OUT",
- session: "support",
+ connection: "support",
direction: "outbound",
peer: "+15550100",
video: false,
@@ -67,7 +67,7 @@ describe("externally managed call media", () => {
}),
);
const client = createInternalCallsClient({
- session: "support",
+ connection: "support",
api,
mediaMode: "external",
WebSocket: FakeWebSocket as unknown as typeof WebSocket,
@@ -102,7 +102,7 @@ describe("externally managed call media", () => {
const api = fakeApi();
const call = new Call({
id: "C",
- session: "s",
+ connection: "s",
direction: "inbound",
peer: "",
video: false,
@@ -115,7 +115,7 @@ describe("externally managed call media", () => {
() =>
new Call({
id: "C",
- session: "s",
+ connection: "s",
direction: "inbound",
peer: "",
video: false,
@@ -248,7 +248,7 @@ describe("answer, join and claims", () => {
const t = timers();
const call = new Call({
id: "CALL-IN",
- session: "support",
+ connection: "support",
direction: "inbound",
peer: "+15550100",
video: false,
@@ -288,7 +288,7 @@ describe("answer, join and claims", () => {
const t = timers();
const call = new Call({
id: "CALL-IN",
- session: "support",
+ connection: "support",
direction: "inbound",
peer: "+15550100",
video: false,
diff --git a/packages/calls/test/helpers.ts b/packages/calls/test/helpers.ts
index 1218d3694..cdf093928 100644
--- a/packages/calls/test/helpers.ts
+++ b/packages/calls/test/helpers.ts
@@ -60,7 +60,9 @@ export class FakeWebSocket {
this.onerror?.({});
}
/** Open and answer the auth frame with `ready`, as the platform does. */
- authenticate(ready: Record = { session: "support" }): void {
+ authenticate(
+ ready: Record = { connection: "support" },
+ ): void {
this.open();
this.text({ type: "ready", ...ready });
}
diff --git a/packages/calls/test/lifecycle.test.ts b/packages/calls/test/lifecycle.test.ts
index 87c4e0ddd..8a04bb1b1 100644
--- a/packages/calls/test/lifecycle.test.ts
+++ b/packages/calls/test/lifecycle.test.ts
@@ -10,7 +10,7 @@ function lifecycleWith(report = vi.fn(), now = () => 0) {
const t = timers();
const socket = new LifecycleSocket({
api,
- session: "support",
+ connection: "support",
WebSocket: FakeWebSocket as unknown as typeof globalThis.WebSocket,
setTimeout: t.setTimeout,
clearTimeout: t.clearTimeout,
@@ -40,7 +40,7 @@ describe("LifecycleSocket authentication", () => {
expect(h.socket.sendCandidate("c", "conn-0001", { candidate: "x" })).toBe(
false,
);
- ws.text({ type: "ready", session: "support", participant: "client:e1" });
+ ws.text({ type: "ready", connection: "support", participant: "client:e1" });
await connecting;
expect(states).toEqual([true]);
expect(h.socket.connected).toBe(true);
@@ -114,14 +114,14 @@ describe("LifecycleSocket authentication", () => {
h.socket.close();
});
- it("names the session and participant in the query for server credentials", async () => {
+ it("names the connection and participant in the query for server credentials", async () => {
FakeWebSocket.instances = [];
const api = fakeApi();
api.token.mockResolvedValue({ value: "pmfa_live_key" });
const t = timers();
const socket = new LifecycleSocket({
api,
- session: "support",
+ connection: "support",
participant: "voice-agent",
WebSocket: FakeWebSocket as unknown as typeof globalThis.WebSocket,
setTimeout: t.setTimeout,
@@ -133,13 +133,13 @@ describe("LifecycleSocket authentication", () => {
await flush();
const ws = FakeWebSocket.instances[0]!;
expect(ws.url).toBe(
- "wss://api.example/voip/ws?session=support&participant=voice-agent",
+ "wss://api.example/voip/ws?connection=support&participant=voice-agent",
);
ws.open();
expect(ws.texts).toEqual([{ type: "auth", token: "pmfa_live_key" }]);
ws.text({
type: "ready",
- session: "support",
+ connection: "support",
participant: "server:voice-agent",
});
await connecting;
@@ -343,8 +343,8 @@ describe("Customer-scoped client tokens", () => {
const t = timers();
const socket = new LifecycleSocket({
api: fakeApi(),
- session: "support",
- clientTokenSession: "sales",
+ connection: "support",
+ clientTokenConnection: "sales",
WebSocket: FakeWebSocket as unknown as typeof globalThis.WebSocket,
setTimeout: t.setTimeout,
clearTimeout: t.clearTimeout,
@@ -354,7 +354,7 @@ describe("Customer-scoped client tokens", () => {
void socket.connect().catch(() => undefined);
await flush();
expect(FakeWebSocket.instances[0]!.url).toBe(
- "wss://api.example/voip/ws?session=sales",
+ "wss://api.example/voip/ws?connection=sales",
);
socket.close();
});
diff --git a/packages/calls/test/public-api.test.ts b/packages/calls/test/public-api.test.ts
index 6b9604be6..8ddae13db 100644
--- a/packages/calls/test/public-api.test.ts
+++ b/packages/calls/test/public-api.test.ts
@@ -23,7 +23,7 @@ describe("@polymorfa/sdk/calls public entry point", () => {
it("reports video sources and frames without transport details", () => {
const call = new Call({
id: "C",
- session: "s",
+ connection: "s",
direction: "inbound",
peer: "",
video: true,
@@ -88,7 +88,7 @@ describe("@polymorfa/sdk/calls public entry point", () => {
(metadata, label) => {
const call = new Call({
id: "C",
- session: "s",
+ connection: "s",
direction: "inbound",
peer: "",
video: true,
diff --git a/packages/calls/test/social.test.ts b/packages/calls/test/social.test.ts
index b821e7bbb..b3c482c88 100644
--- a/packages/calls/test/social.test.ts
+++ b/packages/calls/test/social.test.ts
@@ -27,7 +27,7 @@ describe("call interactions", () => {
};
const call = new Call({
id: "call",
- session: "support",
+ connection: "support",
direction: "inbound",
peer: "123",
video: false,
@@ -83,7 +83,7 @@ describe("call interactions", () => {
});
describe("Customer-scoped client tokens", () => {
- it("send ?session= on Calls requests only when a number is named", async () => {
+ it("send ?connection= on Calls requests only when a number is named", async () => {
const fetch = vi.fn<(url: string, init: RequestInit) => Promise>(
async () =>
new Response(JSON.stringify({ success: true }), {
@@ -95,7 +95,7 @@ describe("Customer-scoped client tokens", () => {
token: "pmfa_ct_dG9rZW4",
fetch,
baseUrl: "https://api.x",
- clientTokenSession: "sales",
+ clientTokenConnection: "sales",
}).sendReaction("call", "connection-1", "👍");
await new HttpCallsApi({
token: "pmfa_ct_dG9rZW4",
@@ -103,7 +103,7 @@ describe("Customer-scoped client tokens", () => {
baseUrl: "https://api.x",
}).sendReaction("call", "connection-1", "👍");
expect(fetch.mock.calls.map(([url]) => url)).toEqual([
- "https://api.x/messaging/voip/calls/call/reaction?session=sales",
+ "https://api.x/messaging/voip/calls/call/reaction?connection=sales",
"https://api.x/messaging/voip/calls/call/reaction",
]);
});
diff --git a/packages/dotnet/README.md b/packages/dotnet/README.md
index 16eb34717..bb78da1db 100644
--- a/packages/dotnet/README.md
+++ b/packages/dotnet/README.md
@@ -33,13 +33,13 @@ retry limits and replay behavior still apply.
`Webhooks.ConstructEvent` verifies native HMAC signatures against the exact raw request bytes before parsing. `ConstructLocalEvent` separately verifies timestamped CLI forwarding signatures. Unknown event names retain their envelope and payload. Deduplicate processed event IDs in your application. `Webhooks.CreateFixture` signs exact JSON bytes for application tests.
-Typed resources include sessions, all 20 message content kinds, QuickLinks, webhooks, Business, Channels, contacts, groups, hosted history, profile, presence, labels, privacy, identities, client token rules, team metadata, billing, customer management, project settings, BanSafe, Flows, Functions, Voice, usage, SIP, and call controls. Native HTTP tests check the methods recorded in `coverage.json`.
+Typed resources include Connections, all 20 message content kinds, QuickLinks, webhooks, Business, Channels, contacts, groups, hosted history, profile, presence, labels, privacy, identities, client token rules, team metadata, billing, customer management, project settings, BanSafe, Flows, Functions, Voice, usage, SIP, and call controls. Native HTTP tests check the methods recorded in `coverage.json`.
Known webhooks have typed payloads for all 84 names in the pinned TypeScript contract. Unknown events retain their envelope and payload. Event streams provide asynchronous enumeration and resume from a saved cursor. `MessagingMedia.SignedUrlExpiry` reads a previously received URL's expiry without a request. Media helpers verify SHA-256 and HMAC before releasing decrypted content; API downloads use a separate credential-free storage client. Voice upload sends bytes over that independent storage transport, then completes the asset through the API.
`Events.LiveSource` and `EventStreamSource` feed decoded webhook bodies to an application-owned store. Each subscription resumes from its saved cursor and skips events whose body was not retained. Dispose the subscription to stop delivery; await `DisposeAsync` or `Completion` to wait for stream cleanup. `OnError` receives terminal stream or listener failures.
-The existing coverage ledger records 445 covered operations. The separate campaign/custody supplement adds 30 source implementations with TCP fixtures; its ledger adoption is pending. Graph and testing-phone supplements retain their separate fixtures. This is source-level contract coverage, not a registry release or hosted acceptance result.
+The existing coverage ledger records 454 covered operations. The separate campaign/custody supplement adds 30 source implementations with TCP fixtures; its ledger adoption is pending. Graph and testing-phone supplements retain their separate fixtures. This is source-level contract coverage, not a registry release or hosted acceptance result.
`CallsClient` tracks incoming and outgoing calls. `Call` provides answer, join, reject, leave, end, participant controls and typed media frames. Connections authenticate in the first WebSocket frame, refresh expiring credentials, detect missed heartbeats and reconnect within a bounded attempt budget. Media reconnect preserves connection identity and acknowledged preferences. `CallsTokenSource` shares concurrent provider requests while preserving each caller's cancellation. PCM uses the rate announced in `Call.SampleRate`; H.264 frames retain timestamps. Outgoing H.264 uses the protocol's reserved source zero; received source ownership is exposed separately.
@@ -54,7 +54,7 @@ Signal cryptography and key custody remain in the customer-operated Signal servi
### Campaign, audience profiles and custody defaults
The 30-operation campaign/custody supplement follows API source
-`f97ad78b172e80788c33bdc0fcf28f75db9283ec`. These helpers use
+`15db8b1c9d88e2ceccb58c851e731feabb659a39`. These helpers use
`Polymorfa-Version: 2026-10-14` when `RequestOptions.ApiVersion` is absent.
An explicit override is preserved. Existing helpers retain their `2026-09-22`
default. This is unpublished source; the supplement remains held for release.
@@ -98,7 +98,7 @@ Console.WriteLine(defaults.Data.EffectiveSignalMode);
A null reply-flow ID detaches the flow. Customer custody null restores Project
inheritance. Project updates require a concrete `SignalCustodyMode`; these
-settings affect future defaults and do not move existing Number keys. The four
+settings affect future defaults and do not move existing Connection keys. The four
bound `SignalCustody` methods unwrap the data envelope once and retain metadata.
The equivalent team `Projects` and `Customers` aliases retain
`DataEnvelope`. Disposing a borrowed Project view does not
@@ -207,7 +207,7 @@ constructors are unchanged.
## Customer-owned media, history and Signal service
These unpublished helpers follow TypeScript `254fc6a2d073e7fc79420cf95f9b03927d00c04a`
-and Signal service `8aa191ef0d4c318229c91bcdf474bf2d79dac47c`. Local implementation
+and Signal service `61209057729b002a2122b898d744a8813a702fc7`. Local implementation
does not establish deployed access or enrollment. New media/history operations
and descriptor sends select API revision `2026-10-14` per request; existing
operations keep their previous default.
@@ -230,7 +230,7 @@ await client.Messages.SendAsync("support",
new(new(PhoneNumber: "+15551234567"), new DescriptorImageContent(descriptor)));
```
-Relay sends ciphertext only through the session's connection. `UploadDirectAsync`
+Relay sends ciphertext only through the connection's connection. `UploadDirectAsync`
uses a short-lived grant and a separate HTTPS client confined to WhatsApp media
hosts. It preserves grant parameters, refuses redirects, refreshes unauthorized
grants, resumes interrupted uploads and sends documents above 50 MiB in parts.
@@ -239,7 +239,7 @@ No changed source can reach multipart finalization.
Standard `DescriptorImageContent`, `DescriptorVideoContent`,
`DescriptorFileContent`, `DescriptorVoiceContent` and `StickerContent` send the
-media key through the API. For zero-knowledge sessions, pass
+media key through the API. For zero-knowledge connections, pass
`descriptor.ToSignalDescriptor(...)` to the local `SignalClient` instead.
That conversion rejects thumbnail, waveform and animation metadata because the
pinned service does not accept them.
@@ -285,7 +285,7 @@ notifications into verified download inputs.
### Customer-owned storage
Implement `IWhatsAppMediaUploadTransport` for application-owned uploads and pass
-it to `WhatsAppMedia.UploadAsync(session, prepared, transport, cancellation)`.
+it to `WhatsAppMedia.UploadAsync(connection, prepared, transport, cancellation)`.
Its `WhatsAppEncryptedUploadBody` exposes media type, encrypted SHA-256, encrypted
length and `OpenAsync(offset)`. It exposes no media key, plaintext or API
credential. Hash getters return copies, and the returned upload information is
@@ -300,8 +300,8 @@ Changed-source integrity errors and caller transport errors remain unchanged.
Pre-cancellation prevents transport invocation; in-progress cancellation returns
control to the caller. Custom network code must observe its cancellation token.
-`Polymorfa.Sdk.Storage` provides schema-2 operations, deterministic per-field
-merges, conditional checkpoints, durable session leases and a memory adapter.
+`Polymorfa.Sdk.Storage` provides schema-3 operations, deterministic per-field
+merges, conditional checkpoints, durable connection leases and a memory adapter.
`D1BridgeStorageAdapter.ConnectAsync` verifies a signed handshake with a
customer-hosted D1 Worker binding before returning an atomic adapter. Read the
expected authority and table prefix from trusted application configuration and
@@ -317,10 +317,10 @@ using var adapter = await D1BridgeStorageAdapter.ConnectAsync(new(
var storage = new CustomerStorage(adapter);
```
-The bridge protocol is `polymorfa-d1-storage-v1`, schema 2, source
-`9ae35e671f7f4868a67c1562422c5af9284b95c1`. Every response must match the
+The bridge protocol is `polymorfa-d1-storage-v1`, schema 3, source
+`d80b581c9df122411e9149a7e39a33700a51571c`. Every response must match the
request nonce, valid exact-body HMAC, expected authority, table prefix and schema.
-Commits contain at most 50 writes, including the engine's session fence; reads
+Commits contain at most 50 writes, including the engine's connection fence; reads
and queries are paged at 1,000 rows. Request and response bodies are limited to
8 MiB. Schema setup requires explicit operator enablement in the Worker.
The adapter does not use D1 administrative REST or assume its batches are atomic.
@@ -333,7 +333,7 @@ then acknowledge the application event. Storage never enables hosted history or
automatically acknowledges Signal events.
The schema/merge baseline is storage source
-`3bacf46f9c4213426314001586f5bae43aaa77de`; the native engine additionally
+`d80b581c9df122411e9149a7e39a33700a51571c`; the native engine additionally
stops after the first failed CAS chunk. Memory and the D1 bridge are included in
the base SDK. Other provider adapters and full event/history reducers remain in
progress. This package remains unpublished.
@@ -352,7 +352,7 @@ connection strings. They do not read Polymorfa database settings. Configure TLS
and customer database roles explicitly; a table prefix is naming, not tenant
authorization. PostgreSQL also accepts an explicit schema. Set
`SqlStorageOptions.CreateTables = false` for operator-managed tables and export
-schema-2 DDL with `StorageSqlSchema.Statements`.
+schema-3 DDL with `StorageSqlSchema.Statements`.
```csharp
using Polymorfa.Storage.Sql;
@@ -364,8 +364,8 @@ var storage = new Polymorfa.Sdk.Storage.CustomerStorage(adapter);
Every SQL commit uses a database transaction and rolls back all writes after a
stale revision. Commit capacities are 500 writes for SQLite and 1,000 for
-PostgreSQL/MySQL, including the engine's session fence. Scope and cursor indexes
-follow schema 2. Invalid or oversized derived identifiers fail before connecting,
+PostgreSQL/MySQL, including the engine's connection fence. Scope and cursor indexes
+follow schema 3. Invalid or oversized derived identifiers fail before connecting,
preventing PostgreSQL name truncation. Driver errors omit connection strings, SQL
and customer values. SQL adapters require a server application. Hosted
Supabase/Neon/PlanetScale authority and deployment acceptance remain customer
@@ -386,7 +386,7 @@ var store = new S3MediaStore(new(customerS3Client, "customer-media", "app/"));
var archived = await store.ArchiveAsync(descriptor,
new("incoming/photo", customerPrivateSpoolDirectory));
var uploaded = await store.UploadToWhatsAppAsync(
- new(messaging.WhatsAppMedia, sessionId, "incoming/photo",
+ new(messaging.WhatsAppMedia, connectionId, "incoming/photo",
Polymorfa.Sdk.WhatsAppUploadMediaType.Image));
```
@@ -418,14 +418,19 @@ credentials, IAM policies and deployment behavior remain separate acceptance
gates. This package has not been published.
-`Polymorfa.Storage.Sql.SupabaseStoragePreset.Sql` exports the schema-2 customer
-tables, live session memberships and forced-RLS policies from storage source
-`3bacf46f9c4213426314001586f5bae43aaa77de`. Review and install it once in a
+`Polymorfa.Storage.Sql.SupabaseStoragePreset.Sql` exports the schema-3 customer
+tables, live connection memberships and forced-RLS policies from storage source
+`d80b581c9df122411e9149a7e39a33700a51571c`. Review and install it once in a
customer-owned migration using `SupabasePresetOptions`. Adapter setup never
installs these policies. Reuse the schema and prefix in `SqlStorageOptions` and
set `CreateTables = false` for the server SQL adapter.
-The separate reader role can select only sessions mapped to `auth.uid()` in
+The preset grants the writer SELECT on the schema-version marker for these
+checks. For an earlier schema-3 preset, grant SELECT on
+`.storage_schema` to the configured writer. The writer does not
+need permission to update that marker.
+
+The separate reader role can select only connections mapped to `auth.uid()` in
`storage_memberships`. It cannot write storage data or memberships. Configure
trusted Supabase/PostgREST JWT enforcement; never expose a direct reader SQL
credential or let a browser set the database subject. Keep reader and server
@@ -448,14 +453,14 @@ these key names. Set `CreateTable = true` only for explicit table creation; AWS
table activation is a separate provisioning gate. Namespaces separate stored
keys; configure customer IAM/table authority independently.
-Conditional transactions contain at most 100 writes, including the session
+Conditional transactions contain at most 100 writes, including the connection
fence. Strongly consistent queries page at 1,000 rows and scan the entity
partition before applying its schema index. `MaxQueryRows` defaults to 100,000
for the complete scanned partition. DynamoDB item and transaction byte limits
still apply. Timeout and transport failures can leave a commit outcome unknown;
resume with saved event/checkpoint state and conditional revisions.
-The storage source is `3bacf46f9c4213426314001586f5bae43aaa77de`. DynamoDB
+The storage source is `d80b581c9df122411e9149a7e39a33700a51571c`. DynamoDB
Local tests use the official driver and cover all 17 entities, JSON scalars,
atomic rollback, 2,000-message history, replay, cursor paging, checkpoints,
expired-writer fences and caller-mutation capture. Hosted AWS credentials, IAM
@@ -467,7 +472,7 @@ The separate, unpublished `Polymorfa.Storage.MongoDb` package adds
MongoDB driver. Pass a customer-owned `IMongoDatabase` and
`new MongoDbStorageOptions(namespace)`. The caller configures credentials, TLS,
server selection, connection and operation timeouts and owns client lifetime.
-The adapter derives sessions from that database's client, never reads Polymorfa
+The adapter derives connections from that database's client, never reads Polymorfa
API credentials and requires a server app.
```csharp
@@ -477,13 +482,13 @@ var adapter = new MongoDbStorageAdapter(customerDatabase,
```
Use a replica set or sharded deployment with transaction support. Setup refuses
-standalone servers before index changes and creates schema-2 indexes by
+standalone servers before index changes and creates schema-3 indexes by
default. Set `CreateIndexes = false` for operator-managed indexes. Collections
are named `polymorfa_{namespace}_{entity}`; configure database permissions
separately from the namespace.
Commits use native snapshot/majority transactions and at most 500 writes,
-including the session fence. Conditional revisions and the native driver's
+including the connection fence. Conditional revisions and the native driver's
transaction retries preserve atomicity. MongoDB document and transaction
lifetime limits still apply. A transport failure or timeout may leave a commit
outcome unknown; recover using saved event/checkpoint state and conditional
@@ -495,7 +500,7 @@ retention or configure the limit for the workload. JSON remains JSON, including
literal `$date`, `$binary` and `$numberLong` objects; BSON-specific stored types
are refused. Caller row and query values are captured before asynchronous work.
-The storage source is `3bacf46f9c4213426314001586f5bae43aaa77de`.
+The storage source is `d80b581c9df122411e9149a7e39a33700a51571c`.
Actual local replica-set tests cover all 17 entities, literal/scalar JSON,
2,000-message history, atomic rollback, replay, checkpoints, expired-writer
fences, namespaces, read bounds and mutation during a request. Actual standalone
@@ -526,7 +531,7 @@ Namespace keys complement customer account/container permissions and do not
replace them.
Conditional commits use native atomic batches with at most 100 writes,
-including the session fence. Each replacement carries the ETag from its point
+including the connection fence. Each replacement carries the ETag from its point
read, so a concurrent writer rolls back the complete batch. Deletes replace
payloads with tombstones to preserve conditional identity. Tombstones consume
customer storage; this adapter does not silently purge them. Cosmos document,
@@ -540,7 +545,7 @@ before applying the schema index, range and cursor. `MaxQueryRows` defaults to
retention and configure operation deadlines and lease duration for the workload.
Caller rows and query scopes are captured before asynchronous work.
-The schema source is `3bacf46f9c4213426314001586f5bae43aaa77de`.
+The schema source is `d80b581c9df122411e9149a7e39a33700a51571c`.
Actual local Cosmos DB emulator tests use the official driver and cover all
17 entities, literal/scalar JSON, 2,000-message history, replay, checkpoints,
expired-writer fences, tombstones, namespace/read bounds, incorrect partition
@@ -576,7 +581,7 @@ provision collections or indexes. The customer configures required composite
indexes and retention. Firestore document, nesting, field-name and transaction
limits still apply.
-This implements source `3bacf46f9c4213426314001586f5bae43aaa77de`. Literal
+This implements source `d80b581c9df122411e9149a7e39a33700a51571c`. Literal
JSON tag-shaped objects remain ordinary objects; Firestore-native timestamps,
references, blobs and other non-JSON values are refused. Actual emulator tests
use the official driver for all 17 schema entities, JSON values, 2,000 history
@@ -589,10 +594,10 @@ production availability remain separate verification gates.
The separate, unpublished `Polymorfa.Storage.LibSql` package adds
`LibSqlStorageAdapter` using Turso's maintained
`Turso.Data.Sqlite.Provider` 0.8.3. It reuses `Polymorfa.Storage.Sql` and its
-schema-2 DDL, typed rows and revision checks. Install the optional package only
+schema-3 DDL, typed rows and revision checks. Install the optional package only
in server applications; the base SDK gains no database dependency. This package
also includes the existing SQL package's SQLite, PostgreSQL and MySQL drivers.
-The storage source is `3bacf46f9c4213426314001586f5bae43aaa77de`.
+The storage source is `d80b581c9df122411e9149a7e39a33700a51571c`.
```csharp
using Polymorfa.Storage.LibSql;
@@ -630,7 +635,7 @@ it open when disposed. Give each adapter an exclusive connection; application
commands and another adapter must not share that connection while it is in use.
Each commit uses an explicit database transaction, including conditional deletes
and inserts. A revision or duplicate-key conflict rolls back the entire commit.
-The 500-write limit includes the engine's session fence. A provider batch alone
+The 500-write limit includes the engine's connection fence. A provider batch alone
does not establish atomicity. Driver failures surfaced by adapter operations
omit raw errors, inner exceptions, URLs, SQL and stored values. Cancellation
retains a sanitized `OperationCanceledException`. Network failures during commit
@@ -640,7 +645,7 @@ rather than an assumed revision conflict. A fresh retry still checks the origina
expected revision. The adapter does not silently retry an uncertain commit.
`CreateTables = false` supports customer-managed schema installation. Export
-SQLite schema-2 statements with `StorageSqlSchema.Statements` and
+SQLite schema-3 statements with `StorageSqlSchema.Statements` and
`StorageSqlDialect.Sqlite`. Direct remote Hrana connections are exercised by
the adapter tests. Replica sync, failover and production Turso credentials are
not acceptance-tested. This source package is not published and does not establish hosted service availability or a feature release.
@@ -666,15 +671,15 @@ mutation test fail.
### Entity Framework Core models
The separate, unpublished `Polymorfa.Storage.EntityFrameworkCore` package exports
-schema-2 models for all 17 customer-owned SQL entities. It uses EF Core 8.0.32
+schema-3 models for all 17 customer-owned SQL entities. It uses EF Core 8.0.32
and the SQL package's existing drivers. This configures models only; it does
not connect to a database, install tables or change access policies.
Use `PolymorfaStorageDbContext` with application-owned provider options and the
same `StorageSqlDialect` and `SqlStorageOptions` as the native SQL adapter.
Each entity is an EF shared-type property bag. Property names follow the
-portable schema (`sessionId`, `messageId`, `timestamp`); physical column names
-match the native adapter (`session_id`, `message_id`, `timestamp`). JSON
+portable schema (`connectionId`, `messageId`, `timestamp`); physical column names
+match the native adapter (`connection_id`, `message_id`, `timestamp`). JSON
properties use `JsonElement?`, `_v` uses `JsonElement`, and `_rev` is a `long`
concurrency token. Optional scalar properties are nullable.
@@ -688,7 +693,7 @@ await using var context = new PolymorfaStorageDbContext(
customerEfOptions, StorageSqlDialect.Postgres,
new SqlStorageOptions { TablePrefix = "app_" });
var recent = await context.StorageRows(StorageEntity.Messages).AsNoTracking()
- .Where(row => EF.Property(row, "sessionId") == sessionId)
+ .Where(row => EF.Property(row, "connectionId") == connectionId)
.OrderByDescending(row => EF.Property(row, "timestamp"))
.Take(50).ToListAsync();
```
@@ -710,7 +715,7 @@ rules. Model JSON converters preserve ordinary JSON, including literal
`$date`/`$binary` objects, and snapshot parsed values independently of a
`JsonDocument` lifetime.
-This follows source `3bacf46f9c4213426314001586f5bae43aaa77de`. Actual SQLite,
+This follows source `d80b581c9df122411e9149a7e39a33700a51571c`. Actual SQLite,
PostgreSQL and MySQL checks prove all 17 native-table mappings, nullable values,
JSON replacement, stale EF revisions and model-cache separation. An EF-created
SQLite schema also passes the native engine's complete conformance suite,
@@ -719,7 +724,7 @@ application migrations remain customer acceptance gates.
### Store events and decoded history
-`StorageReducers.ReduceEvent` maps the 24 stored webhook event types to schema-2 operations. `ReduceHistoryChunk` accepts `StorageHistoryInput` and typed `StorageHistoryChunk` objects from a full WhatsApp protobuf decoder. It maps messages, media references, receipts, reactions, group membership, push names, PN/LID mappings and history progress. An explicit `StorageHistoryIdentityIndex` joins native identifiers to Polymorfa IDs; unmatched identifiers use stable `wa:` keys. Revokes and deletes permanently clear the contract's content and media secret fields. Other event types produce empty batches.
+`StorageReducers.ReduceEvent` maps the 24 stored webhook event types to schema-3 operations. `ReduceHistoryChunk` accepts `StorageHistoryInput` and typed `StorageHistoryChunk` objects from a full WhatsApp protobuf decoder. It maps messages, media references, receipts, reactions, group membership, push names, PN/LID mappings and history progress. An explicit `StorageHistoryIdentityIndex` joins native identifiers to Polymorfa IDs; unmatched identifiers use stable `wa:` keys. Revokes and deletes permanently clear the contract's content and media secret fields. Other event types produce empty batches.
The HTTP history reader preserves raw protobuf bytes and decodes its documented subset. Supply a full-schema decoder to populate the storage history models. The storage reducer does not infer missing protobuf fields or download media bytes.
@@ -736,7 +741,7 @@ await sync.Completion;
`ApplyEventAsync` also accepts `StorageApplyEventOptions.DecodeHistory` for linked `history.sync` notifications. The callback receives the typed notification and verified event, and returns a fully decoded `StorageHistoryChunk` or `null` for progress only. Replay checks the stored event ID before invoking the callback. Cloud inline history notifications do not invoke it. `storage.WebhookHandler(options)` returns the corresponding async webhook handler; verify the original body signature before calling it.
-`SyncToStorage` requests manual acknowledgement and resumes the saved cursor. It stores the reduced event and deduplication marker, saves the cursor with a compare-and-set guard, then acknowledges the stream. The default checkpoint is session `*`, stream `events`. Missing event bodies and retention gaps stop consumption without advancing the checkpoint or acknowledgement. Set `RequirePayload = false` only for intentional metadata-only consumption. `OnApplied` runs after acknowledgement; a failure there leaves the event and cursor stored.
+`SyncToStorage` requests manual acknowledgement and resumes the saved cursor. It stores the reduced event and deduplication marker, saves the cursor with a compare-and-set guard, then acknowledges the stream. The default checkpoint is connection `*`, stream `events`. Missing event bodies and retention gaps stop consumption without advancing the checkpoint or acknowledgement. Set `RequirePayload = false` only for intentional metadata-only consumption. `OnApplied` runs after acknowledgement; a failure there leaves the event and cursor stored.
`Stop()`, disposal and cancellation stop admission of the next event. An event already admitted finishes storage, checkpoint and acknowledgement with independent operation lifetimes. Await `Completion` or `DisposeAsync` to observe its outcome. Stopping the stream does not hide failures from an admitted storage or acknowledgement operation. Adapter, decoder, checkpoint and acknowledgement failures propagate; an unacknowledged event can replay and deduplicate. `IStorageEventStreamSource` allows an application-owned stream with the same persistence ordering. These helpers acknowledge the Platform event stream; they do not change any local Signal service acknowledgement.
@@ -745,10 +750,10 @@ This source is unpublished. The SDK's existing server browser-credential restric
### Blazor WebAssembly IndexedDB storage
The separate, unpublished `Polymorfa.Storage.IndexedDb` package adds
-`IndexedDbStorageAdapter` for browser-local schema-2 storage. It uses the
+`IndexedDbStorageAdapter` for browser-local schema-3 storage. Ordinary opens refuse schema 2. With other writers stopped, call `IndexedDbStorageAdapter.UpgradeSchema2Async(runtime, options, cancellation)` explicitly to preserve all 17 stores, stable row IDs, revisions, opaque fields and the namespace owner. Conflicts, blocking and cancellation abort the upgrade. It uses the
application's `IJSRuntime` and a packaged JavaScript module with native
IndexedDB transactions. The source contract is
-`3bacf46f9c4213426314001586f5bae43aaa77de`. The base SDK gains no browser runtime
+`d80b581c9df122411e9149a7e39a33700a51571c`. The base SDK gains no browser runtime
or database dependency.
Call it after Blazor's JavaScript runtime is available, such as from a
@@ -783,16 +788,17 @@ same origin. The application owns login/logout handling, account changes,
retention and deletion of its device data. Browser storage can be denied,
limited or evicted; do not treat it as a guaranteed permanent archive.
-All 17 entity stores use schema version 2. Setup upgrades an existing version-1
-database without discarding its existing rows. An upgrade blocked by an older
-open connection returns a safe provider error; close that connection and retry.
-Native version changes close the old connection. Unsupported newer database
-versions fail to open. Index names and scopes come from the SDK's closed schema.
+All 17 entity stores use schema version 3. Ordinary setup opens a fresh database
+or an existing version-3 database. For a version-2 database, stop other writers
+and call `UpgradeSchema2Async` explicitly. Version 1 and newer unsupported
+versions are refused. An upgrade blocked by an older open connection returns a
+provider error; close that connection and retry. Native version changes close
+the old connection. Index names and scopes come from the SDK's closed schema.
Queries scan the selected entity within `MaxQueryRows` (1-100000, default
100000); exceeding that count fails before loading its rows. This adapter does
not create native secondary indexes or claim unbounded query performance.
-Each commit supports at most 1000 writes, including the engine's session fence.
+Each commit supports at most 1000 writes, including the engine's connection fence.
The module reads every expected revision and queues every write in one native
read/write transaction. It returns success only after the transaction's
`complete` event. A conflict or confirmed abort leaves the entire commit
@@ -863,9 +869,9 @@ Writes use `HistorySyncDeliveryOverride.Descriptor`. Delivery-specific writes
and resets, initial QuickLink custody, and QuickLink delivery select
`2026-10-14` only when the request has no explicit `ApiVersion`. Existing GETs,
whole-history resets and requests without new intent retain the client default.
-`Session.SignalMode` is an optional immutable fact, separate from configuration.
-Initial QuickLinks cannot select an existing session. Supplementary links require
-both session and connection, and cannot choose custody, Customer, external ID,
+`Connection.SignalMode` is an optional immutable fact, separate from configuration.
+Initial QuickLinks cannot select an existing connection. Supplementary links require
+both connection and addMethod, and cannot choose custody, Customer, external ID,
billing controls or a single-connection goal.
Direct grants and history retry/delete require server credentials. Prepared
@@ -936,7 +942,7 @@ environment acceptance remain separate release gates.
Media downloads retain the successful API request deadline through body EOF. Each approved storage redirect hop has its own request deadline, retained through the final body. Async and synchronous body reads distinguish the request deadline from caller cancellation. Disposing a download releases its response, timer and owned storage transport; it does not dispose the API client. Body failures do not replay the download. Calls WebSockets retain the configured base-path prefix and authenticate in the first frame. Raw cursor pages reject repeated cursors before requesting them again, including cycles across manually requested pages.
-Signal finite JSON requests share one header/body deadline. Event streams enforce a requested session and report incomplete lines or frames at EOF; they retain their idle timeout and manual acknowledgment policy. ACK success requires exactly HTTP 204. Usage iteration preserves a starting cursor and rejects its repetition. Native HTTP fixtures verify these local consumer rules; they do not establish service deployment or registry availability.
+Signal finite JSON requests share one header/body deadline. Event streams enforce a requested connection and report incomplete lines or frames at EOF; they retain their idle timeout and manual acknowledgment policy. ACK success requires exactly HTTP 204. Usage iteration preserves a starting cursor and rejects its repetition. Native HTTP fixtures verify these local consumer rules; they do not establish service deployment or registry availability.
## Credential handling
@@ -968,7 +974,7 @@ order. These changes are unreleased source behavior.
## Official API round-2 betas
-Native Number catalog-cache reads/sync, marketing status, Official group JPEG
+Native Connection catalog-cache reads/sync, marketing status, Official group JPEG
upload, identity changes, incoming carts and signed webhook batches have source
counterparts. These additions remain unreleased betas and may return
`feature_unavailable`. They grant no enrollment or provider authority. See
@@ -986,7 +992,7 @@ The following uses an existing server client. Preserve the API's opaque cursor;
stop when the response omits it. Catalog prices remain exact strings.
```csharp
-var page = await client.Catalogs.ListProductsAsync("number-id", "123", new(100, "opaque_-"), new() { CancellationToken = cancellationToken });
+var page = await client.Catalogs.ListProductsAsync("connection-id", "123", new(100, "opaque_-"), new() { CancellationToken = cancellationToken });
var nextCursor = page.Data.Data.NextCursor;
```
@@ -1004,7 +1010,7 @@ off-to-on transition. Project tokens may disable it. The SDK forwards values
without guessing the stored state. Existing `invalid_parameter`,
`permission_denied` and `state_conflict` errors remain authoritative.
-The setting affects linked-device Numbers. Cloud API Numbers ignore it.
+The setting affects linked-device Connections. Cloud API Connections ignore it.
Unlimited concurrent calls differ from WhatsApp's apps and void Ban Insurance
when the 30-day claim window overlaps an enabled period. Claim verdicts and
`bansafe.claim` webhook verdicts recognize `simultaneous_calls`. Claim evidence
@@ -1085,8 +1091,8 @@ The new nullable response value is an init-only property.
## Direct passkey relay (unreleased)
-Use server credentials with `sessions:manage` for every operation, including reads.
-The API also checks live Number ownership, direct-pairing access, relay enrollment
+Use server credentials with `connections:manage` for every operation, including reads.
+The API also checks live Connection ownership, direct-pairing access, relay enrollment
and the current attempt. These methods accept ceremony data supplied by an
external participant. They do not run WebAuthn, store credentials, poll, or confirm
a pairing automatically. Hosted QuickLink and extension relay endpoints are excluded.
@@ -1111,25 +1117,25 @@ The matching API source is accepted. Package qualification and publication are
still required before using a released package.
```csharp
-var ticket = await client.Passkeys.IssueChallengeAsync(session);
-await client.Passkeys.GetChallengeAsync(session, ticket.Data.Data.Ticket);
-await client.Passkeys.SubmitAssertionAsync(session, suppliedAssertion);
-var state = await client.Passkeys.GetConfirmationAsync(session);
+var ticket = await client.Passkeys.IssueChallengeAsync(connection);
+await client.Passkeys.GetChallengeAsync(connection, ticket.Data.Data.Ticket);
+await client.Passkeys.SubmitAssertionAsync(connection, suppliedAssertion);
+var state = await client.Passkeys.GetConfirmationAsync(connection);
// Invoke only after an explicit caller decision based on the current state.
Task>> ConfirmExplicitly() =>
- client.Passkeys.ConfirmAsync(session, suppliedConfirmation);
+ client.Passkeys.ConfirmAsync(connection, suppliedConfirmation);
```
-## Number call history (unreleased source)
+## Connection call history (unreleased source)
-Read one number's calls with the other party's identity through
-`GET /messaging/{session}/calls`. Client tokens need `read_calls`.
+Read one Connection's calls with the other party's identity through
+`GET /messaging/{connection}/calls`. Client tokens need `read_calls`.
The route requires the regional call-history API deployment; this source
change does not make it available on a deployed API or package registry.
```csharp
var page = await messaging.Calls.ListAsync("support",
- new ListSessionCallsParameters(Limit: 25, Outcome: "missed"));
+ new ListConnectionCallsParameters(Limit: 25, Outcome: "missed"));
```
The response contains `data` and a nullable `nextCursor` (`Data` and
@@ -1138,16 +1144,16 @@ next request. Filters include direction, outcome and ISO 8601 start-time
bounds `since`/`until`. `peer` may be null; its user ID, phone number and
username may each be absent. Platform call records keep `peerRef`.
-## Number-scoped Test operations
+## Connection-scoped Test operations
-The Test phone methods take a Number ID, without a project argument:
+The Test phone methods take a Connection ID, without a project argument:
~~~csharp
var phone = await client.Testing.GetPhoneAsync("support");
-var testEvent = await client.Testing.TriggerEventAsync("support", new("call.missed", FromNumber: "sales"));
+var testEvent = await client.Testing.TriggerEventAsync("support", new("call.missed", FromConnection: "sales"));
var fixtures = await client.Testing.ListEventFixturesAsync();
~~~
-Send-phone-message and unlink-device helpers use the same Number scope. The trigger body contains event, optional overrides and optional fromNumber; it does not contain session or fromSession. The static fixture catalog has no project argument. History-fixture creation remains project-scoped. These operations require a server credential and the API’s Test-number access checks; a helper does not grant access or make a real Number a Test number.
+Send-phone-message and unlink-device helpers use the same Connection scope. The trigger body contains event, optional overrides and optional fromConnection; the target Connection is a separate method argument. The static fixture catalog has no project argument. History-fixture creation remains project-scoped. These operations require a server credential and the API’s Test-Connection access checks; a helper does not grant access or make a real Connection a Test Connection.
## Guest participants and waiting rooms (unreleased)
@@ -1181,10 +1187,16 @@ with `enabled`, or `admit`/`deny` with the pending participant's public ID.
Server credentials may name their connection's participant; client tokens omit
that field and need `voip_signal`.
-The API checks current credential and Number/project authority per request. Read
+The API checks current credential and Connection/project authority per request. Read
`data.ok` and `data.code`; HTTP success alone does not confirm the provider action.
The SDK disables automatic network retries for this operation. A missing reply
or unknown outcome must not be replayed. Browser UI-kit controls use this HTTP
path; programmatic media WebSocket controls retain their credential rechecks.
This source requires the matching unreleased backend. It does not enable a
customer environment or advance package/API availability.
+
+
+Event-stream items expose a decoded Connection view. A retained native body's
+old account selector becomes `connection` in that view. The event's encoded
+payload keeps the original bytes. Mixed selector generations are refused;
+active webhook verification and parsing keep the current envelope contract.
diff --git a/packages/dotnet/coverage.json b/packages/dotnet/coverage.json
index 52e856f5a..d9e1e9a9b 100644
--- a/packages/dotnet/coverage.json
+++ b/packages/dotnet/coverage.json
@@ -5,7 +5,7 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/business/collections/{collectionId}",
+ "path": "/messaging/{connection}/business/collections/{collectionId}",
"status": "covered",
"sdkMethod": "MessagingClient.Business.DeleteCollectionAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -13,7 +13,7 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/business/products/{productId}",
+ "path": "/messaging/{connection}/business/products/{productId}",
"status": "covered",
"sdkMethod": "MessagingClient.Business.DeleteProductAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -21,7 +21,7 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/business/profile/cover-photo/{coverPhotoId}",
+ "path": "/messaging/{connection}/business/profile/cover-photo/{coverPhotoId}",
"status": "covered",
"sdkMethod": "MessagingClient.Business.DeleteCoverPhotoAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -29,7 +29,7 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/business/quick-replies/{quickReplyId}",
+ "path": "/messaging/{connection}/business/quick-replies/{quickReplyId}",
"status": "covered",
"sdkMethod": "MessagingClient.QuickReplies.DeleteAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -37,7 +37,7 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/channels/{id}",
+ "path": "/messaging/{connection}/channels/{id}",
"status": "covered",
"sdkMethod": "MessagingClient.Channels.DeleteAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -45,7 +45,7 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/chats/{conversation}/messages/{messageId}",
+ "path": "/messaging/{connection}/chats/{conversation}/messages/{messageId}",
"status": "covered",
"sdkMethod": "MessagingClient.Chats.DeleteMessageAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -53,7 +53,7 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/groups/{id}",
+ "path": "/messaging/{connection}/groups/{id}",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.DeleteAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -61,7 +61,7 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/labels/{labelId}",
+ "path": "/messaging/{connection}/labels/{labelId}",
"status": "covered",
"sdkMethod": "MessagingClient.Labels.DeleteAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -69,7 +69,7 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/official-groups/{group}",
+ "path": "/messaging/{connection}/official-groups/{group}",
"status": "covered",
"sdkMethod": "MessagingClient.OfficialGroups.DeleteAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialGroupTests.cs"
@@ -77,7 +77,7 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/profile/picture",
+ "path": "/messaging/{connection}/profile/picture",
"status": "covered",
"sdkMethod": "MessagingClient.Profile.DeletePictureAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -85,7 +85,7 @@
{
"family": "messaging",
"method": "DELETE",
- "path": "/messaging/{session}/templates/{name}",
+ "path": "/messaging/{connection}/templates/{name}",
"status": "covered",
"sdkMethod": "MessagingClient.CloudTemplates.DeleteAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/TemplateTests.cs"
@@ -133,7 +133,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/catalog",
+ "path": "/messaging/{connection}/business/catalog",
"status": "covered",
"sdkMethod": "MessagingClient.Business.GetCatalogAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -141,7 +141,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/collections",
+ "path": "/messaging/{connection}/business/collections",
"status": "covered",
"sdkMethod": "MessagingClient.Business.ListCollectionsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -149,7 +149,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/collections/{collectionId}",
+ "path": "/messaging/{connection}/business/collections/{collectionId}",
"status": "covered",
"sdkMethod": "MessagingClient.Business.GetCollectionAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -157,7 +157,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/compliance",
+ "path": "/messaging/{connection}/business/compliance",
"status": "covered",
"sdkMethod": "MessagingClient.Business.GetMerchantComplianceAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -165,7 +165,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/eligibility",
+ "path": "/messaging/{connection}/business/eligibility",
"status": "covered",
"sdkMethod": "MessagingClient.Business.GetEligibilityAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -173,7 +173,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/linked-accounts",
+ "path": "/messaging/{connection}/business/linked-accounts",
"status": "covered",
"sdkMethod": "MessagingClient.Business.GetLinkedAccountsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -181,7 +181,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/products/{productId}",
+ "path": "/messaging/{connection}/business/products/{productId}",
"status": "covered",
"sdkMethod": "MessagingClient.Business.GetProductAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -189,7 +189,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/profile",
+ "path": "/messaging/{connection}/business/profile",
"status": "covered",
"sdkMethod": "MessagingClient.Business.GetProfileAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -197,7 +197,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/business/quick-replies",
+ "path": "/messaging/{connection}/business/quick-replies",
"status": "covered",
"sdkMethod": "MessagingClient.QuickReplies.ListAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -205,7 +205,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/call-permissions/{to}",
+ "path": "/messaging/{connection}/call-permissions/{to}",
"status": "covered",
"sdkMethod": "MessagingClient.Calls.RetrieveCallPermissionAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/CallsTests.cs"
@@ -213,7 +213,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/channels",
+ "path": "/messaging/{connection}/channels",
"status": "covered",
"sdkMethod": "MessagingClient.Channels.ListAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -221,7 +221,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/channels/{id}",
+ "path": "/messaging/{connection}/channels/{id}",
"status": "covered",
"sdkMethod": "MessagingClient.Channels.RetrieveAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -229,7 +229,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/channels/{id}/message-updates",
+ "path": "/messaging/{connection}/channels/{id}/message-updates",
"status": "covered",
"sdkMethod": "MessagingClient.Channels.ListMessageUpdatesAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -237,7 +237,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/channels/{id}/messages",
+ "path": "/messaging/{connection}/channels/{id}/messages",
"status": "covered",
"sdkMethod": "MessagingClient.Channels.ListMessagesAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -245,7 +245,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/chats",
+ "path": "/messaging/{connection}/chats",
"status": "covered",
"sdkMethod": "MessagingClient.Chats.ListAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -253,7 +253,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/chats/{conversation}",
+ "path": "/messaging/{connection}/chats/{conversation}",
"status": "covered",
"sdkMethod": "MessagingClient.Chats.RetrieveAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -261,7 +261,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/chats/{conversation}/messages",
+ "path": "/messaging/{connection}/chats/{conversation}/messages",
"status": "covered",
"sdkMethod": "MessagingClient.Chats.ListMessagesAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -269,7 +269,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/chats/{conversation}/messages/{messageId}",
+ "path": "/messaging/{connection}/chats/{conversation}/messages/{messageId}",
"status": "covered",
"sdkMethod": "MessagingClient.Chats.RetrieveMessageAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -277,7 +277,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/chats/{conversation}/messages/{messageId}/media",
+ "path": "/messaging/{connection}/chats/{conversation}/messages/{messageId}/media",
"status": "covered",
"sdkMethod": "MessagingClient.Chats.DownloadMessageMediaAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MediaApiTests.cs"
@@ -285,7 +285,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/chats/{conversation}/service-window",
+ "path": "/messaging/{connection}/chats/{conversation}/service-window",
"status": "covered",
"sdkMethod": "MessagingClient.Chats.GetServiceWindowAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -293,15 +293,15 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/cloud-credentials",
+ "path": "/messaging/{connection}/cloud-credentials",
"status": "covered",
- "sdkMethod": "MessagingClient.Sessions.GetCloudCredentialHealthAsync",
+ "sdkMethod": "MessagingClient.Connections.GetCloudCredentialHealthAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts",
+ "path": "/messaging/{connection}/contacts",
"status": "covered",
"sdkMethod": "MessagingClient.Contacts.ListAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -309,7 +309,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/{contactId}",
+ "path": "/messaging/{connection}/contacts/{contactId}",
"status": "covered",
"sdkMethod": "MessagingClient.Contacts.RetrieveAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -317,7 +317,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/{contactId}/business-profile",
+ "path": "/messaging/{connection}/contacts/{contactId}/business-profile",
"status": "covered",
"sdkMethod": "MessagingClient.Contacts.BusinessProfileAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -325,7 +325,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/{contactId}/devices",
+ "path": "/messaging/{connection}/contacts/{contactId}/devices",
"status": "covered",
"sdkMethod": "MessagingClient.Contacts.DevicesAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -333,7 +333,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/{contactId}/info",
+ "path": "/messaging/{connection}/contacts/{contactId}/info",
"status": "covered",
"sdkMethod": "MessagingClient.Contacts.InfoAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -341,7 +341,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/{contactId}/picture",
+ "path": "/messaging/{connection}/contacts/{contactId}/picture",
"status": "covered",
"sdkMethod": "MessagingClient.Contacts.PictureAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -349,7 +349,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/blocked",
+ "path": "/messaging/{connection}/contacts/blocked",
"status": "covered",
"sdkMethod": "MessagingClient.Contacts.BlocklistAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -357,7 +357,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/contacts/check",
+ "path": "/messaging/{connection}/contacts/check",
"status": "covered",
"sdkMethod": "MessagingClient.Contacts.CheckAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -365,7 +365,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/groups",
+ "path": "/messaging/{connection}/groups",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.ListAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -373,7 +373,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/groups/{id}",
+ "path": "/messaging/{connection}/groups/{id}",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.RetrieveAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -381,7 +381,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/groups/{id}/invite-code",
+ "path": "/messaging/{connection}/groups/{id}/invite-code",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.GetInviteCodeAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -389,7 +389,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/groups/{id}/participants",
+ "path": "/messaging/{connection}/groups/{id}/participants",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.ListParticipantsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -397,7 +397,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/groups/join-info",
+ "path": "/messaging/{connection}/groups/join-info",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.GetJoinInfoAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -405,7 +405,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/hybrid-link",
+ "path": "/messaging/{connection}/hybrid-link",
"status": "covered",
"sdkMethod": "MessagingClient.HybridLink.StateAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OnboardingTests.cs"
@@ -413,7 +413,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/identities/resolve",
+ "path": "/messaging/{connection}/identities/resolve",
"status": "covered",
"sdkMethod": "MessagingClient.Identities.ResolveAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/AccountTests.cs"
@@ -421,7 +421,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/labels",
+ "path": "/messaging/{connection}/labels",
"status": "covered",
"sdkMethod": "MessagingClient.Labels.ListAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -429,7 +429,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/labels/chats/{conversation}",
+ "path": "/messaging/{connection}/labels/chats/{conversation}",
"status": "covered",
"sdkMethod": "MessagingClient.Labels.ListForChatAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -437,23 +437,23 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/meta-pricing",
+ "path": "/messaging/{connection}/meta-pricing",
"status": "covered",
- "sdkMethod": "MessagingClient.Sessions.GetMetaPricingAsync",
+ "sdkMethod": "MessagingClient.Connections.GetMetaPricingAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/observation-policy",
+ "path": "/messaging/{connection}/observation-policy",
"status": "covered",
- "sdkMethod": "MessagingClient.ObservationPolicies.RetrieveForSessionAsync",
+ "sdkMethod": "MessagingClient.ObservationPolicies.RetrieveForConnectionAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OnboardingTests.cs"
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/official-groups",
+ "path": "/messaging/{connection}/official-groups",
"status": "covered",
"sdkMethod": "MessagingClient.OfficialGroups.ListAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialGroupTests.cs"
@@ -461,7 +461,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/official-groups/{group}",
+ "path": "/messaging/{connection}/official-groups/{group}",
"status": "covered",
"sdkMethod": "MessagingClient.OfficialGroups.RetrieveAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialGroupTests.cs"
@@ -469,7 +469,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/official-groups/{group}/invite-link",
+ "path": "/messaging/{connection}/official-groups/{group}/invite-link",
"status": "covered",
"sdkMethod": "MessagingClient.OfficialGroups.GetInviteLinkAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialGroupTests.cs"
@@ -477,7 +477,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/official-groups/{group}/join-requests",
+ "path": "/messaging/{connection}/official-groups/{group}/join-requests",
"status": "covered",
"sdkMethod": "MessagingClient.OfficialGroups.ListJoinRequestsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialGroupTests.cs"
@@ -485,7 +485,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/operations/{operationId}",
+ "path": "/messaging/{connection}/operations/{operationId}",
"status": "covered",
"sdkMethod": "MessagingClient.Messages.OperationStatusAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/AccountTests.cs"
@@ -493,15 +493,15 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/pair/qr",
+ "path": "/messaging/{connection}/pair/qr",
"status": "covered",
- "sdkMethod": "MessagingClient.Sessions.QrAsync",
+ "sdkMethod": "MessagingClient.Connections.QrAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ProjectPairingTests.cs"
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/presence",
+ "path": "/messaging/{connection}/presence",
"status": "covered",
"sdkMethod": "MessagingClient.Presence.GetAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -509,7 +509,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/presence/{conversation}",
+ "path": "/messaging/{connection}/presence/{conversation}",
"status": "covered",
"sdkMethod": "MessagingClient.Presence.GetForChatAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -517,7 +517,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/privacy",
+ "path": "/messaging/{connection}/privacy",
"status": "covered",
"sdkMethod": "MessagingClient.Privacy.GetAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -525,7 +525,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/profile",
+ "path": "/messaging/{connection}/profile",
"status": "covered",
"sdkMethod": "MessagingClient.Profile.GetAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -533,15 +533,15 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/safe-mode",
+ "path": "/messaging/{connection}/safe-mode",
"status": "covered",
- "sdkMethod": "MessagingClient.BanSafe.GetSessionSafeModeAsync",
+ "sdkMethod": "MessagingClient.BanSafe.GetConnectionSafeModeAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ProjectSettingsTests.cs"
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/templates",
+ "path": "/messaging/{connection}/templates",
"status": "covered",
"sdkMethod": "MessagingClient.CloudTemplates.ListAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/TemplateTests.cs"
@@ -549,7 +549,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/templates/{name}",
+ "path": "/messaging/{connection}/templates/{name}",
"status": "covered",
"sdkMethod": "MessagingClient.CloudTemplates.RetrieveAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/TemplateTests.cs"
@@ -557,7 +557,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/users/{id}/security-code",
+ "path": "/messaging/{connection}/users/{id}/security-code",
"status": "covered",
"sdkMethod": "MessagingClient.Users.GetSecurityCodeAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -762,7 +762,7 @@
{
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/business/catalog/cart",
+ "path": "/messaging/{connection}/business/catalog/cart",
"status": "covered",
"sdkMethod": "MessagingClient.Business.SetCartEnabledAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -770,7 +770,7 @@
{
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/business/collections/{collectionId}",
+ "path": "/messaging/{connection}/business/collections/{collectionId}",
"status": "covered",
"sdkMethod": "MessagingClient.Business.UpdateCollectionAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -778,7 +778,7 @@
{
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/business/products/{productId}/visibility",
+ "path": "/messaging/{connection}/business/products/{productId}/visibility",
"status": "covered",
"sdkMethod": "MessagingClient.Business.SetProductVisibilityAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -786,7 +786,7 @@
{
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/business/profile",
+ "path": "/messaging/{connection}/business/profile",
"status": "covered",
"sdkMethod": "MessagingClient.Business.UpdateProfileAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -794,7 +794,7 @@
{
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/official-groups/{group}",
+ "path": "/messaging/{connection}/official-groups/{group}",
"status": "covered",
"sdkMethod": "MessagingClient.OfficialGroups.UpdateAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialGroupTests.cs"
@@ -802,7 +802,7 @@
{
"family": "messaging",
"method": "PATCH",
- "path": "/messaging/{session}/templates/{name}",
+ "path": "/messaging/{connection}/templates/{name}",
"status": "covered",
"sdkMethod": "MessagingClient.CloudTemplates.UpdateAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/TemplateTests.cs"
@@ -833,7 +833,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/catalog",
+ "path": "/messaging/{connection}/business/catalog",
"status": "covered",
"sdkMethod": "MessagingClient.Business.CreateCatalogAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -841,7 +841,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/collections",
+ "path": "/messaging/{connection}/business/collections",
"status": "covered",
"sdkMethod": "MessagingClient.Business.CreateCollectionAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -849,7 +849,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/collections/{collectionId}/appeal",
+ "path": "/messaging/{connection}/business/collections/{collectionId}/appeal",
"status": "covered",
"sdkMethod": "MessagingClient.Business.AppealCollectionAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -857,7 +857,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/collections/reorder",
+ "path": "/messaging/{connection}/business/collections/reorder",
"status": "covered",
"sdkMethod": "MessagingClient.Business.ReorderCollectionsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -865,7 +865,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/orders/{orderId}/lookup",
+ "path": "/messaging/{connection}/business/orders/{orderId}/lookup",
"status": "covered",
"sdkMethod": "MessagingClient.Business.GetOrderAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -873,7 +873,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/products",
+ "path": "/messaging/{connection}/business/products",
"status": "covered",
"sdkMethod": "MessagingClient.Business.CreateProductAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -881,7 +881,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/products/{productId}/appeal",
+ "path": "/messaging/{connection}/business/products/{productId}/appeal",
"status": "covered",
"sdkMethod": "MessagingClient.Business.AppealProductAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -889,7 +889,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/business/quick-replies",
+ "path": "/messaging/{connection}/business/quick-replies",
"status": "covered",
"sdkMethod": "MessagingClient.QuickReplies.CreateAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -897,7 +897,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/calls/{callId}/reject",
+ "path": "/messaging/{connection}/calls/{callId}/reject",
"status": "covered",
"sdkMethod": "MessagingClient.Calls.RejectIncomingAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ProjectPairingTests.cs"
@@ -905,7 +905,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels",
+ "path": "/messaging/{connection}/channels",
"status": "covered",
"sdkMethod": "MessagingClient.Channels.CreateAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -913,7 +913,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/follow",
+ "path": "/messaging/{connection}/channels/{id}/follow",
"status": "covered",
"sdkMethod": "MessagingClient.Channels.FollowAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -921,7 +921,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/live-updates",
+ "path": "/messaging/{connection}/channels/{id}/live-updates",
"status": "covered",
"sdkMethod": "MessagingClient.Channels.SubscribeToLiveUpdatesAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -929,7 +929,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/messages/{messageId}/reaction",
+ "path": "/messaging/{connection}/channels/{id}/messages/{messageId}/reaction",
"status": "covered",
"sdkMethod": "MessagingClient.Channels.ReactToMessageAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -937,7 +937,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/messages/{messageId}/viewed",
+ "path": "/messaging/{connection}/channels/{id}/messages/{messageId}/viewed",
"status": "covered",
"sdkMethod": "MessagingClient.Channels.MarkMessageViewedAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -945,7 +945,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/mute",
+ "path": "/messaging/{connection}/channels/{id}/mute",
"status": "covered",
"sdkMethod": "MessagingClient.Channels.MuteAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -953,7 +953,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/unfollow",
+ "path": "/messaging/{connection}/channels/{id}/unfollow",
"status": "covered",
"sdkMethod": "MessagingClient.Channels.UnfollowAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -961,7 +961,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/channels/{id}/unmute",
+ "path": "/messaging/{connection}/channels/{id}/unmute",
"status": "covered",
"sdkMethod": "MessagingClient.Channels.UnmuteAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -969,7 +969,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/chats/{conversation}/archive",
+ "path": "/messaging/{connection}/chats/{conversation}/archive",
"status": "covered",
"sdkMethod": "MessagingClient.Chats.ArchiveAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -977,7 +977,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/chats/{conversation}/unarchive",
+ "path": "/messaging/{connection}/chats/{conversation}/unarchive",
"status": "covered",
"sdkMethod": "MessagingClient.Chats.UnarchiveAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -985,15 +985,15 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/cloud-credentials/reauthorize",
+ "path": "/messaging/{connection}/cloud-credentials/reauthorize",
"status": "covered",
- "sdkMethod": "MessagingClient.Sessions.ReauthorizeCloudCredentialsAsync",
+ "sdkMethod": "MessagingClient.Connections.ReauthorizeCloudCredentialsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/contacts/{contactId}/block",
+ "path": "/messaging/{connection}/contacts/{contactId}/block",
"status": "covered",
"sdkMethod": "MessagingClient.Contacts.BlockAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1001,7 +1001,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/contacts/{contactId}/unblock",
+ "path": "/messaging/{connection}/contacts/{contactId}/unblock",
"status": "covered",
"sdkMethod": "MessagingClient.Contacts.UnblockAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1009,7 +1009,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups",
+ "path": "/messaging/{connection}/groups",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.CreateAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1017,7 +1017,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/{id}/admin/demote",
+ "path": "/messaging/{connection}/groups/{id}/admin/demote",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.DemoteParticipantsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1025,7 +1025,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/{id}/admin/promote",
+ "path": "/messaging/{connection}/groups/{id}/admin/promote",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.PromoteParticipantsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1033,7 +1033,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/{id}/invite-code/revoke",
+ "path": "/messaging/{connection}/groups/{id}/invite-code/revoke",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.RevokeInviteCodeAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1041,7 +1041,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/{id}/leave",
+ "path": "/messaging/{connection}/groups/{id}/leave",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.LeaveAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1049,7 +1049,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/{id}/participants/add",
+ "path": "/messaging/{connection}/groups/{id}/participants/add",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.AddParticipantsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1057,7 +1057,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/{id}/participants/remove",
+ "path": "/messaging/{connection}/groups/{id}/participants/remove",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.RemoveParticipantsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1065,7 +1065,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/groups/join",
+ "path": "/messaging/{connection}/groups/join",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.JoinAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1073,7 +1073,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/labels",
+ "path": "/messaging/{connection}/labels",
"status": "covered",
"sdkMethod": "MessagingClient.Labels.CreateAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -1081,7 +1081,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/react",
+ "path": "/messaging/{connection}/messages/react",
"status": "covered",
"sdkMethod": "MessagingClient.Messages.ReactAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/AccountTests.cs"
@@ -1089,7 +1089,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/seen",
+ "path": "/messaging/{connection}/messages/seen",
"status": "covered",
"sdkMethod": "MessagingClient.Messages.MarkSeenAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/AccountTests.cs"
@@ -1097,7 +1097,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/send",
+ "path": "/messaging/{connection}/messages/send",
"status": "covered",
"sdkMethod": "MessagingClient.Messages.SendAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessageContentTests.cs"
@@ -1105,7 +1105,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/star",
+ "path": "/messaging/{connection}/messages/star",
"status": "covered",
"sdkMethod": "MessagingClient.Messages.StarAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/AccountTests.cs"
@@ -1113,7 +1113,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/messages/typing",
+ "path": "/messaging/{connection}/messages/typing",
"status": "covered",
"sdkMethod": "MessagingClient.Messages.SetTypingAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/AccountTests.cs"
@@ -1121,7 +1121,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/official-groups",
+ "path": "/messaging/{connection}/official-groups",
"status": "covered",
"sdkMethod": "MessagingClient.OfficialGroups.CreateAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialGroupTests.cs"
@@ -1129,7 +1129,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/official-groups/{group}/invite-link/reset",
+ "path": "/messaging/{connection}/official-groups/{group}/invite-link/reset",
"status": "covered",
"sdkMethod": "MessagingClient.OfficialGroups.ResetInviteLinkAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialGroupTests.cs"
@@ -1137,7 +1137,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/official-groups/{group}/join-requests/approve",
+ "path": "/messaging/{connection}/official-groups/{group}/join-requests/approve",
"status": "covered",
"sdkMethod": "MessagingClient.OfficialGroups.ApproveJoinRequestsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialGroupTests.cs"
@@ -1145,7 +1145,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/official-groups/{group}/join-requests/reject",
+ "path": "/messaging/{connection}/official-groups/{group}/join-requests/reject",
"status": "covered",
"sdkMethod": "MessagingClient.OfficialGroups.RejectJoinRequestsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialGroupTests.cs"
@@ -1153,7 +1153,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/official-groups/{group}/participants/remove",
+ "path": "/messaging/{connection}/official-groups/{group}/participants/remove",
"status": "covered",
"sdkMethod": "MessagingClient.OfficialGroups.RemoveParticipantsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialGroupTests.cs"
@@ -1161,7 +1161,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/official-groups/{group}/pins",
+ "path": "/messaging/{connection}/official-groups/{group}/pins",
"status": "covered",
"sdkMethod": "MessagingClient.OfficialGroups.PinAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialGroupTests.cs"
@@ -1169,15 +1169,15 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/pair/code",
+ "path": "/messaging/{connection}/pair/code",
"status": "covered",
- "sdkMethod": "MessagingClient.Sessions.RequestPairingCodeAsync",
+ "sdkMethod": "MessagingClient.Connections.RequestPairingCodeAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ProjectPairingTests.cs"
},
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/presence",
+ "path": "/messaging/{connection}/presence",
"status": "covered",
"sdkMethod": "MessagingClient.Presence.SetAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -1185,7 +1185,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/presence/{conversation}/subscribe",
+ "path": "/messaging/{connection}/presence/{conversation}/subscribe",
"status": "covered",
"sdkMethod": "MessagingClient.Presence.SubscribeAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -1193,7 +1193,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/templates",
+ "path": "/messaging/{connection}/templates",
"status": "covered",
"sdkMethod": "MessagingClient.CloudTemplates.CreateAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/TemplateTests.cs"
@@ -1313,9 +1313,9 @@
"family": "messaging",
"method": "POST",
"path": "/messaging/quicklinks",
- "status": "partial",
- "reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (primaryPlatform) that this SDK does not yet type.",
- "milestone": "contract-f180dc1ee2-sync"
+ "status": "covered",
+ "sdkMethod": "MessagingClient.QuickLinks.CreateAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionContractsTests.cs"
},
{
"family": "messaging",
@@ -1473,7 +1473,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/quicklink/{token}/connection",
+ "path": "/quicklink/{token}/method",
"status": "excluded",
"reason": "Public onboarding capability route is owned by the hosted QuickLink flow, not a machine credential resource."
},
@@ -1508,7 +1508,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/business/compliance",
+ "path": "/messaging/{connection}/business/compliance",
"status": "covered",
"sdkMethod": "MessagingClient.Business.SetMerchantComplianceAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -1516,7 +1516,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/business/products/{productId}",
+ "path": "/messaging/{connection}/business/products/{productId}",
"status": "covered",
"sdkMethod": "MessagingClient.Business.UpdateProductAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -1524,7 +1524,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/business/profile/cover-photo",
+ "path": "/messaging/{connection}/business/profile/cover-photo",
"status": "covered",
"sdkMethod": "MessagingClient.Business.SetCoverPhotoAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BusinessTests.cs"
@@ -1532,7 +1532,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/business/quick-replies/{quickReplyId}",
+ "path": "/messaging/{connection}/business/quick-replies/{quickReplyId}",
"status": "covered",
"sdkMethod": "MessagingClient.QuickReplies.ReplaceAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ChannelCloudTests.cs"
@@ -1540,7 +1540,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/chats/{conversation}/disappearing",
+ "path": "/messaging/{connection}/chats/{conversation}/disappearing",
"status": "covered",
"sdkMethod": "MessagingClient.Chats.SetDisappearingTimerAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -1548,7 +1548,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/chats/{conversation}/messages/{messageId}",
+ "path": "/messaging/{connection}/chats/{conversation}/messages/{messageId}",
"status": "covered",
"sdkMethod": "MessagingClient.Chats.EditMessageAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -1556,7 +1556,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/groups/{id}/description",
+ "path": "/messaging/{connection}/groups/{id}/description",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.SetDescriptionAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1564,7 +1564,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/groups/{id}/picture",
+ "path": "/messaging/{connection}/groups/{id}/picture",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.SetPictureAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1572,7 +1572,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/groups/{id}/settings/info-edit",
+ "path": "/messaging/{connection}/groups/{id}/settings/info-edit",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.SetInfoEditingAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1580,7 +1580,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/groups/{id}/settings/join-approval",
+ "path": "/messaging/{connection}/groups/{id}/settings/join-approval",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.SetJoinApprovalAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1588,7 +1588,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/groups/{id}/settings/member-add",
+ "path": "/messaging/{connection}/groups/{id}/settings/member-add",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.SetMemberAddModeAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1596,7 +1596,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/groups/{id}/settings/messages",
+ "path": "/messaging/{connection}/groups/{id}/settings/messages",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.SetMessagingAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1604,7 +1604,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/groups/{id}/subject",
+ "path": "/messaging/{connection}/groups/{id}/subject",
"status": "covered",
"sdkMethod": "MessagingClient.Groups.SetSubjectAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1612,7 +1612,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/hybrid-link",
+ "path": "/messaging/{connection}/hybrid-link",
"status": "covered",
"sdkMethod": "MessagingClient.HybridLink.SetPausedAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OnboardingTests.cs"
@@ -1620,7 +1620,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/labels/{labelId}",
+ "path": "/messaging/{connection}/labels/{labelId}",
"status": "covered",
"sdkMethod": "MessagingClient.Labels.UpdateAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -1628,7 +1628,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/labels/chats/{conversation}",
+ "path": "/messaging/{connection}/labels/chats/{conversation}",
"status": "covered",
"sdkMethod": "MessagingClient.Labels.ReplaceForChatAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/MessagingUtilityTests.cs"
@@ -1636,7 +1636,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/privacy/{setting}",
+ "path": "/messaging/{connection}/privacy/{setting}",
"status": "covered",
"sdkMethod": "MessagingClient.Privacy.SetAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1644,7 +1644,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/privacy/disappearing/default",
+ "path": "/messaging/{connection}/privacy/disappearing/default",
"status": "covered",
"sdkMethod": "MessagingClient.Privacy.SetDefaultDisappearingTimerAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1652,7 +1652,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/profile/name",
+ "path": "/messaging/{connection}/profile/name",
"status": "covered",
"sdkMethod": "MessagingClient.Profile.SetNameAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1660,7 +1660,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/profile/picture",
+ "path": "/messaging/{connection}/profile/picture",
"status": "covered",
"sdkMethod": "MessagingClient.Profile.SetPictureAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1668,7 +1668,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/profile/status",
+ "path": "/messaging/{connection}/profile/status",
"status": "covered",
"sdkMethod": "MessagingClient.Profile.SetStatusAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ResourceTests.cs"
@@ -1676,9 +1676,9 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/safe-mode",
+ "path": "/messaging/{connection}/safe-mode",
"status": "covered",
- "sdkMethod": "MessagingClient.BanSafe.UpdateSessionSafeModeAsync",
+ "sdkMethod": "MessagingClient.BanSafe.UpdateConnectionSafeModeAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ProjectSettingsTests.cs"
},
{
@@ -1919,7 +1919,7 @@
{
"family": "platform",
"method": "DELETE",
- "path": "/platform/sessions/{session}/client-rules",
+ "path": "/platform/connections/{connection}/client-rules",
"status": "covered",
"sdkMethod": "TeamClient.ClientTokens.DeleteRulesAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/AccountTests.cs"
@@ -1927,10 +1927,10 @@
{
"family": "platform",
"method": "DELETE",
- "path": "/platform/sessions/{sessionId}",
+ "path": "/platform/connections/{connectionId}",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.DeleteAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.DeleteAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
@@ -2037,7 +2037,7 @@
{
"family": "platform",
"method": "GET",
- "path": "/console/call-settings/{sessionId}",
+ "path": "/console/call-settings/{connectionId}",
"status": "excluded",
"reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
@@ -2086,7 +2086,7 @@
{
"family": "platform",
"method": "GET",
- "path": "/console/insights/number-options",
+ "path": "/console/insights/connection-options",
"status": "excluded",
"reason": "Private Console selector requires dashboard identity; team API keys and project tokens are not accepted."
},
@@ -2170,7 +2170,7 @@
{
"family": "platform",
"method": "GET",
- "path": "/console/session-configuration/{sessionId}",
+ "path": "/console/connection-configuration/{connectionId}",
"status": "excluded",
"reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
@@ -2281,7 +2281,7 @@
"method": "GET",
"path": "/platform/bans",
"status": "covered",
- "sdkMethod": "TeamClient.SessionBans.ListAsync",
+ "sdkMethod": "TeamClient.ConnectionBans.ListAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/AccountTests.cs"
},
{
@@ -2289,7 +2289,7 @@
"method": "GET",
"path": "/platform/bans/active",
"status": "covered",
- "sdkMethod": "TeamClient.SessionBans.ListActiveAsync",
+ "sdkMethod": "TeamClient.ConnectionBans.ListActiveAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/AccountTests.cs"
},
{
@@ -2351,7 +2351,7 @@
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/health/{session}",
+ "path": "/platform/bansafe/health/{connection}",
"status": "covered",
"sdkMethod": "TeamClient.BanSafe.GetHealthAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BanSafeTests.cs"
@@ -2359,7 +2359,7 @@
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/health/{session}/history",
+ "path": "/platform/bansafe/health/{connection}/history",
"status": "covered",
"sdkMethod": "TeamClient.BanSafe.ListHealthHistoryAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BanSafeTests.cs"
@@ -2383,7 +2383,7 @@
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/telemetry/{session}",
+ "path": "/platform/bansafe/telemetry/{connection}",
"status": "covered",
"sdkMethod": "TeamClient.BanSafe.GetTelemetryAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BanSafeTests.cs"
@@ -2391,7 +2391,7 @@
{
"family": "platform",
"method": "GET",
- "path": "/platform/bansafe/telemetry/{session}/history",
+ "path": "/platform/bansafe/telemetry/{connection}/history",
"status": "covered",
"sdkMethod": "TeamClient.BanSafe.ListTelemetryHistoryAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/BanSafeTests.cs"
@@ -2583,9 +2583,9 @@
{
"family": "platform",
"method": "GET",
- "path": "/platform/customers/{customerId}/numbers",
+ "path": "/platform/customers/{customerId}/connections",
"status": "covered",
- "sdkMethod": "TeamClient.Customers.ListNumbersAsync",
+ "sdkMethod": "TeamClient.Customers.ListConnectionsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/CustomerTests.cs"
},
{
@@ -2951,23 +2951,23 @@
{
"family": "platform",
"method": "GET",
- "path": "/platform/session-configuration",
+ "path": "/platform/connection-configuration",
"status": "covered",
"sdkMethod": "TeamClient.Configuration.RetrieveAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions",
+ "path": "/platform/connections",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.ListAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.ListAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{session}/call-settings",
+ "path": "/platform/connections/{connection}/call-settings",
"status": "covered",
"sdkMethod": "TeamClient.Calls.RetrieveCallSettingsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/CallsTests.cs"
@@ -2975,7 +2975,7 @@
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{session}/client-rules",
+ "path": "/platform/connections/{connection}/client-rules",
"status": "covered",
"sdkMethod": "TeamClient.ClientTokens.RetrieveRulesAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/AccountTests.cs"
@@ -2983,42 +2983,42 @@
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{sessionId}",
+ "path": "/platform/connections/{connectionId}",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.RetrieveAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.RetrieveAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{sessionId}/capabilities",
+ "path": "/platform/connections/{connectionId}/capabilities",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.GetCapabilitiesAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.GetCapabilitiesAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{sessionId}/me",
+ "path": "/platform/connections/{connectionId}/me",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.AccountAsync",
+ "sdkMethod": "TeamClient.Connections.AccountAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ProjectPairingTests.cs"
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{sessionId}/safe-mode",
+ "path": "/platform/connections/{connectionId}/safe-mode",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.GetSafeModeAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.GetSafeModeAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
"method": "GET",
- "path": "/platform/sessions/{sessionId}/tier-quotes/{quoteId}",
+ "path": "/platform/connections/{connectionId}/tier-quotes/{quoteId}",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.RetrieveTierChangeAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.RetrieveTierChangeAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
@@ -3262,10 +3262,10 @@
{
"family": "platform",
"method": "PATCH",
- "path": "/platform/sessions/{sessionId}",
+ "path": "/platform/connections/{connectionId}",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.SetTierOverrideAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.SetTierOverrideAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
@@ -3336,7 +3336,7 @@
{
"family": "platform",
"method": "POST",
- "path": "/console/bansafe/enforcement/{session}/appeal",
+ "path": "/console/bansafe/enforcement/{connection}/appeal",
"status": "excluded",
"reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
@@ -3735,9 +3735,9 @@
{
"family": "platform",
"method": "POST",
- "path": "/platform/customers/{customerId}/numbers/{sessionId}/transfer",
+ "path": "/platform/customers/{customerId}/connections/{connectionId}/transfer",
"status": "covered",
- "sdkMethod": "TeamClient.Customers.TransferNumberAsync",
+ "sdkMethod": "TeamClient.Customers.TransferConnectionAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/CustomerTests.cs"
},
{
@@ -3991,86 +3991,86 @@
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/handoff-ack",
+ "path": "/platform/connections/{connectionId}/handoff-ack",
"status": "excluded",
"reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/handoff-import",
+ "path": "/platform/connections/{connectionId}/handoff-import",
"status": "excluded",
"reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/handoff-keys",
+ "path": "/platform/connections/{connectionId}/handoff-keys",
"status": "excluded",
"reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/logout",
+ "path": "/platform/connections/{connectionId}/logout",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.LogoutAsync",
+ "sdkMethod": "TeamClient.Connections.LogoutAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ProjectPairingTests.cs"
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/restart",
+ "path": "/platform/connections/{connectionId}/restart",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.RestartAsync",
+ "sdkMethod": "TeamClient.Connections.RestartAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/ProjectPairingTests.cs"
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/start",
+ "path": "/platform/connections/{connectionId}/start",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.StartAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.StartAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/stop",
+ "path": "/platform/connections/{connectionId}/stop",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.StopAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.StopAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/tier-quotes",
+ "path": "/platform/connections/{connectionId}/tier-quotes",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.QuoteTierChangeAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.QuoteTierChangeAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/upload-appstate-keys",
+ "path": "/platform/connections/{connectionId}/upload-appstate-keys",
"status": "excluded",
"reason": "Encrypted session handoff remains outside the public SDK until its dedicated security and atomicity contract is complete."
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/delete",
+ "path": "/platform/connections/delete",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.DeleteManyAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.DeleteManyAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/stop",
+ "path": "/platform/connections/stop",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.StopManyAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.StopManyAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
@@ -4191,7 +4191,7 @@
{
"family": "platform",
"method": "PUT",
- "path": "/console/call-settings/{sessionId}",
+ "path": "/console/call-settings/{connectionId}",
"status": "excluded",
"reason": "Console-only operation requires dashboard identity; not available to SDK credentials."
},
@@ -4254,7 +4254,7 @@
{
"family": "platform",
"method": "PUT",
- "path": "/console/session-configuration/{sessionId}",
+ "path": "/console/connection-configuration/{connectionId}",
"status": "excluded",
"reason": "Hosted QuickLink recipient and authenticated Console-only operations are outside the trusted-server SDK surface."
},
@@ -4373,15 +4373,15 @@
{
"family": "platform",
"method": "PUT",
- "path": "/platform/session-configuration",
+ "path": "/platform/connection-configuration",
"status": "covered",
"sdkMethod": "TeamClient.Configuration.UpdateAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
"method": "PUT",
- "path": "/platform/sessions/{session}/call-settings",
+ "path": "/platform/connections/{connection}/call-settings",
"status": "partial",
"reason": "Contract revision f180dc1ee2 of polymorfa/polymorfa#887 adds request or enum fields (acceptTerms, termsLocale) that this SDK does not yet type.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4389,7 +4389,7 @@
{
"family": "platform",
"method": "PUT",
- "path": "/platform/sessions/{session}/client-rules",
+ "path": "/platform/connections/{connection}/client-rules",
"status": "covered",
"sdkMethod": "TeamClient.ClientTokens.UpdateRulesAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/AccountTests.cs"
@@ -4397,18 +4397,18 @@
{
"family": "platform",
"method": "PUT",
- "path": "/platform/sessions/{sessionId}",
+ "path": "/platform/connections/{connectionId}",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.UpdateAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.UpdateAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
"method": "PUT",
- "path": "/platform/sessions/{sessionId}/safe-mode",
+ "path": "/platform/connections/{connectionId}/safe-mode",
"status": "covered",
- "sdkMethod": "TeamClient.Sessions.UpdateSafeModeAsync",
- "testFile": "tests/Polymorfa.Sdk.Tests/SessionTests.cs"
+ "sdkMethod": "TeamClient.Connections.UpdateSafeModeAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ConnectionTests.cs"
},
{
"family": "platform",
@@ -4452,15 +4452,15 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/calls",
- "status": "missing",
- "reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
- "milestone": "contract-f180dc1ee2-sync"
+ "path": "/messaging/{connection}/calls",
+ "status": "covered",
+ "sdkMethod": "MessagingClient.Calls.ListAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/ProjectPairingTests.cs"
},
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/catalogs",
+ "path": "/messaging/{connection}/catalogs",
"status": "covered",
"sdkMethod": "MessagingClient.Catalogs.ListAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialRound2Tests.cs"
@@ -4468,7 +4468,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/catalogs/{catalogId}",
+ "path": "/messaging/{connection}/catalogs/{catalogId}",
"status": "covered",
"sdkMethod": "MessagingClient.Catalogs.RetrieveAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialRound2Tests.cs"
@@ -4476,7 +4476,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/catalogs/{catalogId}/products",
+ "path": "/messaging/{connection}/catalogs/{catalogId}/products",
"status": "covered",
"sdkMethod": "MessagingClient.Catalogs.ListProductsAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialRound2Tests.cs"
@@ -4484,7 +4484,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/groups/{id}/capabilities",
+ "path": "/messaging/{connection}/groups/{id}/capabilities",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4492,7 +4492,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/marketing-messages/status",
+ "path": "/messaging/{connection}/marketing-messages/status",
"status": "covered",
"sdkMethod": "MessagingClient.CloudGraph.GetMarketingMessagesStatusAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialRound2Tests.cs"
@@ -4500,7 +4500,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/passkey/challenge/{ticketId}",
+ "path": "/messaging/{connection}/passkey/challenge/{ticketId}",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4508,7 +4508,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/passkey/confirmation",
+ "path": "/messaging/{connection}/passkey/confirmation",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4516,7 +4516,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/phone",
+ "path": "/messaging/{connection}/phone",
"status": "covered",
"sdkMethod": "MessagingClient.Testing.GetPhoneAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OnboardingTests.cs"
@@ -4524,7 +4524,7 @@
{
"family": "messaging",
"method": "GET",
- "path": "/messaging/{session}/stickers",
+ "path": "/messaging/{connection}/stickers",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4564,7 +4564,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/catalogs/{catalogId}/sync",
+ "path": "/messaging/{connection}/catalogs/{catalogId}/sync",
"status": "covered",
"sdkMethod": "MessagingClient.Catalogs.SyncAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialRound2Tests.cs"
@@ -4572,7 +4572,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/history/chunks/retry",
+ "path": "/messaging/{connection}/history/chunks/retry",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4580,7 +4580,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/history/media/delete",
+ "path": "/messaging/{connection}/history/media/delete",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4588,7 +4588,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/media/upload-grants",
+ "path": "/messaging/{connection}/media/upload-grants",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4596,7 +4596,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/media/uploads",
+ "path": "/messaging/{connection}/media/uploads",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4604,7 +4604,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/passkey/assertion",
+ "path": "/messaging/{connection}/passkey/assertion",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4612,7 +4612,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/passkey/challenge",
+ "path": "/messaging/{connection}/passkey/challenge",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4620,7 +4620,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/passkey/confirmation",
+ "path": "/messaging/{connection}/passkey/confirmation",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4628,7 +4628,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/phone/devices/{deviceId}/unlink",
+ "path": "/messaging/{connection}/phone/devices/{deviceId}/unlink",
"status": "covered",
"sdkMethod": "MessagingClient.Testing.UnlinkPhoneDeviceAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OnboardingTests.cs"
@@ -4636,7 +4636,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/phone/messages",
+ "path": "/messaging/{connection}/phone/messages",
"status": "covered",
"sdkMethod": "MessagingClient.Testing.SendPhoneMessageAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OnboardingTests.cs"
@@ -4644,7 +4644,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/stickers/recents/bootstrap",
+ "path": "/messaging/{connection}/stickers/recents/bootstrap",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4652,7 +4652,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/stickers/recents/remove",
+ "path": "/messaging/{connection}/stickers/recents/remove",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4660,7 +4660,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/stickers/reuploads",
+ "path": "/messaging/{connection}/stickers/reuploads",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4668,7 +4668,7 @@
{
"family": "messaging",
"method": "POST",
- "path": "/messaging/{session}/test-events",
+ "path": "/messaging/{connection}/test-events",
"status": "covered",
"sdkMethod": "MessagingClient.Testing.TriggerEventAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OnboardingTests.cs"
@@ -4740,7 +4740,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/official-groups/{group}/picture",
+ "path": "/messaging/{connection}/official-groups/{group}/picture",
"status": "covered",
"sdkMethod": "MessagingClient.OfficialGroups.SetPictureAsync",
"testFile": "tests/Polymorfa.Sdk.Tests/OfficialRound2Tests.cs"
@@ -4748,7 +4748,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/phone/account-mode",
+ "path": "/messaging/{connection}/phone/account-mode",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4756,7 +4756,7 @@
{
"family": "messaging",
"method": "PUT",
- "path": "/messaging/{session}/stickers/favorite",
+ "path": "/messaging/{connection}/stickers/favorite",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -4836,7 +4836,7 @@
{
"family": "platform",
"method": "GET",
- "path": "/console/projects/{projectId}/numbers/{session}/catalogs",
+ "path": "/console/projects/{projectId}/connections/{connection}/catalogs",
"status": "excluded",
"reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
"milestone": "not-server-sdk"
@@ -4844,7 +4844,7 @@
{
"family": "platform",
"method": "GET",
- "path": "/console/projects/{projectId}/numbers/{session}/catalogs/{catalogId}",
+ "path": "/console/projects/{projectId}/connections/{connection}/catalogs/{catalogId}",
"status": "excluded",
"reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
"milestone": "not-server-sdk"
@@ -4852,7 +4852,7 @@
{
"family": "platform",
"method": "GET",
- "path": "/console/projects/{projectId}/numbers/{session}/catalogs/{catalogId}/products",
+ "path": "/console/projects/{projectId}/connections/{connection}/catalogs/{catalogId}/products",
"status": "excluded",
"reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
"milestone": "not-server-sdk"
@@ -5068,7 +5068,7 @@
{
"family": "platform",
"method": "POST",
- "path": "/console/projects/{projectId}/numbers/{session}/catalogs/{catalogId}/sync",
+ "path": "/console/projects/{projectId}/connections/{connection}/catalogs/{catalogId}/sync",
"status": "excluded",
"reason": "Dashboard-identity Console or account route; it grants no server SDK authority.",
"milestone": "not-server-sdk"
@@ -5164,7 +5164,7 @@
{
"family": "platform",
"method": "POST",
- "path": "/platform/sessions/{sessionId}/inspector/claim/release",
+ "path": "/platform/connections/{connectionId}/inspector/claim/release",
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
@@ -5232,6 +5232,14 @@
"status": "missing",
"reason": "Added by contract revision f180dc1ee2 of polymorfa/polymorfa#887 and not yet attributed to a native SDK method in this ledger.",
"milestone": "contract-f180dc1ee2-sync"
+ },
+ {
+ "family": "messaging",
+ "method": "POST",
+ "path": "/messaging/voip/calls/{id}/waiting-room",
+ "status": "covered",
+ "sdkMethod": "MessagingClient.Calls.ModerateWaitingRoomAsync",
+ "testFile": "tests/Polymorfa.Sdk.Tests/CallsTests.cs"
}
],
"supplements": {
diff --git a/packages/dotnet/examples/README.md b/packages/dotnet/examples/README.md
index b56b916cc..89e33078e 100644
--- a/packages/dotnet/examples/README.md
+++ b/packages/dotnet/examples/README.md
@@ -4,21 +4,21 @@ These source examples use the development SDK. They do not establish registry or
## ASP.NET Core
-`aspnet-core` compiles against .NET 8. Set `POLYMORFA_PROJECT_TOKEN` (or `POLYMORFA_API_KEY`), `POLYMORFA_SESSION`, `POLYMORFA_RECIPIENT` and `POLYMORFA_WEBHOOK_SECRET` in server configuration. Run `dotnet run --project aspnet-core/Polymorfa.Example.AspNet.csproj` from this directory.
+`aspnet-core` compiles against .NET 8. Set `POLYMORFA_PROJECT_TOKEN` (or `POLYMORFA_API_KEY`), `POLYMORFA_CONNECTION`, `POLYMORFA_RECIPIENT` and `POLYMORFA_WEBHOOK_SECRET` in server configuration. Run `dotnet run --project aspnet-core/Polymorfa.Example.AspNet.csproj` from this directory.
-The Development-only sign-in route requires `POLYMORFA_EXAMPLE_PASSWORD`; it is disabled without that setting or outside Development. It signs an opaque HttpOnly cookie, validates its server-owned session on every request and revokes it at logout. Restarting this example clears its sessions and signing authority. Replace this demonstration identity with your application's authentication scheme before deployment. Token requests require an authenticated subject and a `polymorfa_session` claim equal to the configured session. Resolve that claim from trusted application authorization; never copy a browser-supplied session or customer identifier into it. The token endpoint uses POST, checks the same origin, returns a five-minute client token and disables caching. The token body includes the browser grant; untrusted request fields cannot change the subject or session.
+The Development-only sign-in route requires `POLYMORFA_EXAMPLE_PASSWORD`; it is disabled without that setting or outside Development. It signs an opaque HttpOnly cookie, validates its server-owned session on every request and revokes it at logout. Restarting this example clears its sessions and signing authority. Replace this demonstration identity with your application's authentication scheme before deployment. Token requests require an authenticated subject and a `polymorfa_connection` claim equal to the configured connection. Resolve that claim from trusted application authorization; never copy a browser-supplied connection or customer identifier into it. The token endpoint uses POST, checks the same origin, returns a five-minute client token and disables caching. The token body includes the browser grant; untrusted request fields cannot change the subject or connection.
-The webhook endpoint verifies the exact bounded raw body using `x-webhook-signature`. The ASP.NET native inbox projects assigned-Number replies and receipts into a bounded application-owned conversation after signature verification. Do not log the request body.
+The webhook endpoint verifies the exact bounded raw body using `x-webhook-signature`. The ASP.NET native inbox projects assigned Connection replies and receipts into a bounded application-owned conversation after signature verification. Do not log the request body.
From the repository root run `npm ci`, `npm run build:workspaces`, and `node packages/dotnet/examples/build-elements.mjs` before starting the example. It mounts the existing Web Components with a custom application data source. Every
text send calls the native C# SDK on the server. Replies arrive through a signed
-native webhook, restricted to the assigned Number and canonical conversation ID.
+native webhook, restricted to the assigned Connection and canonical conversation ID.
The state holds up to 100 messages, 128 send attempts and 1024 recent event IDs
until the server stops. It does not enable HMS. A UUID key belongs to one text;
unknown outcomes retain it for retry. Display timestamps use whole seconds,
matching native events. Reload restores the authenticated inbox.
-Set `POLYMORFA_EXAMPLE_TRANSPORT=local-test-number` to label simulated transport.
+Set `POLYMORFA_EXAMPLE_TRANSPORT=local-test-connection` to label simulated transport.
The local Inspector recording covers the ASP.NET custom UI, a paired simulated
WhatsApp peer, signed HTTPS delivery, reload and logout. It does not establish
registry, staging or production availability. Blazor and MAUI below still use
@@ -42,13 +42,13 @@ See [the MAUI instructions](maui/README.md) for the supported workload, build an
## Programmatic Calls
-`calls-agent` connects the server lifecycle socket, answers incoming calls and consumes typed PCM frames. Set `POLYMORFA_API_KEY` and `POLYMORFA_SESSION`, then run `dotnet run --project calls-agent/Polymorfa.Example.Calls.csproj`. Add consent and application policy before answering. Ctrl+C cancels the event and media consumers. Production providers can use `CallsTokenSource` to supply and refresh short-lived credentials.
+`calls-agent` connects the server lifecycle socket, answers incoming calls and consumes typed PCM frames. Set `POLYMORFA_API_KEY` and `POLYMORFA_CONNECTION`, then run `dotnet run --project calls-agent/Polymorfa.Example.Calls.csproj`. Add consent and application policy before answering. Ctrl+C cancels the event and media consumers. Production providers can use `CallsTokenSource` to supply and refresh short-lived credentials.
The client reconnects media with the same connection identity, restores acknowledged media preferences and bounds retry attempts. Browser call media remains in the TypeScript Calls package.
The authenticated ASP.NET connect route adds Linked Devices to its server-assigned
-Number. Set `POLYMORFA_SESSION` to an existing Number with an eligible Official
+Connection. Set `POLYMORFA_CONNECTION` to an existing Connection with an eligible Official
API connection. The route requests a supplementary hybrid QuickLink and ignores
-client-supplied session choices. Initial invitations must omit session and
+client-supplied connection choices. Initial invitations must omit connection and
addConnection. Blazor and MAUI use this same authenticated route; bridge/build
checks do not establish browser pairing or live provider acceptance.
diff --git a/packages/dotnet/examples/aspnet-core/NativeConversation.cs b/packages/dotnet/examples/aspnet-core/NativeConversation.cs
index a853df012..7eb57ebf6 100644
--- a/packages/dotnet/examples/aspnet-core/NativeConversation.cs
+++ b/packages/dotnet/examples/aspnet-core/NativeConversation.cs
@@ -3,7 +3,7 @@
using Polymorfa.Sdk;
internal sealed record ExampleMessage(string Id, string? ClientId, string Text, long CreatedAt, string Direction, string Status, string Receipt);
-internal sealed class NativeConversation(string session, string peer, bool localTest)
+internal sealed class NativeConversation(string connection, string peer, bool localTest)
{
private readonly object state = new();
private readonly SemaphoreSlim sendGate = new(1, 1);
@@ -12,7 +12,7 @@ internal sealed class NativeConversation(string session, string peer, bool local
private readonly Queue eventIds = new();
private string peerId = "", lastEvent = "";
private int received;
- public object Snapshot() { lock (state) return new { messages = messages.ToArray(), peer, session, receivedEvents = received, lastEvent, localTest }; }
+ public object Snapshot() { lock (state) return new { messages = messages.ToArray(), peer, connection, receivedEvents = received, lastEvent, localTest }; }
public async Task SendAsync(MessagingClient client, byte[] body, string key, CancellationToken cancellation)
{
string text;
@@ -40,7 +40,7 @@ public async Task SendAsync(MessagingClient client, byte[] body, string
}
try
{
- var response = await client.Messages.SendAsync(session, new(new(PhoneNumber: peer), new TextContent(text)), new() { IdempotencyKey = key, Timeout = TimeSpan.FromSeconds(60), CancellationToken = cancellation });
+ var response = await client.Messages.SendAsync(connection, new(new(PhoneNumber: peer), new TextContent(text)), new() { IdempotencyKey = key, Timeout = TimeSpan.FromSeconds(60), CancellationToken = cancellation });
var receipt = response.Data.Data;
if (!response.Data.Success || string.IsNullOrEmpty(receipt.Id) || !DateTimeOffset.TryParse(receipt.Timestamp, out var at)) return Results.StatusCode(502);
var message = new ExampleMessage(receipt.Id, key, text, at.ToUnixTimeSeconds() * 1000, "outbound", "sent", receipt.Status);
@@ -63,7 +63,7 @@ private void Upsert(ExampleMessage message)
public void Receive(WebhookEvent webhook)
{
var envelope = webhook.Envelope;
- if (envelope.Session != session) return;
+ if (envelope.Connection != connection) return;
lock (state)
{
if (eventIds.Contains(envelope.Id)) return;
diff --git a/packages/dotnet/examples/aspnet-core/Program.cs b/packages/dotnet/examples/aspnet-core/Program.cs
index 724142220..fbcaf85d6 100644
--- a/packages/dotnet/examples/aspnet-core/Program.cs
+++ b/packages/dotnet/examples/aspnet-core/Program.cs
@@ -9,10 +9,10 @@
var applicationSessions = new ConcurrentDictionary();
var builder = WebApplication.CreateBuilder(args);
-var session = builder.Configuration["POLYMORFA_SESSION"] ?? throw new InvalidOperationException("POLYMORFA_SESSION is required.");
+var connection = builder.Configuration["POLYMORFA_CONNECTION"] ?? throw new InvalidOperationException("POLYMORFA_CONNECTION is required.");
var peer = builder.Configuration["POLYMORFA_RECIPIENT"] ?? throw new InvalidOperationException("POLYMORFA_RECIPIENT is required.");
if (string.IsNullOrWhiteSpace(peer)) throw new InvalidOperationException("An assigned recipient is required.");
-var conversation = new NativeConversation(session, peer, builder.Configuration["POLYMORFA_EXAMPLE_TRANSPORT"] == "local-test-number");
+var conversation = new NativeConversation(connection, peer, builder.Configuration["POLYMORFA_EXAMPLE_TRANSPORT"] == "local-test-number");
builder.Services.AddSingleton(new MessagingClient(builder.Configuration["POLYMORFA_PROJECT_TOKEN"] is { Length: > 0 } projectToken ? Credential.ProjectToken(projectToken) : Credential.TeamApiKey(builder.Configuration["POLYMORFA_API_KEY"] ?? throw new InvalidOperationException("Configure a server project token or team API key.")), new() { BaseUrl = new(builder.Configuration["POLYMORFA_API_BASE_URL"] ?? "https://api.polymorfa.com") }));
// Replace this application's cookie sign-in with your own identity provider.
builder.Services.AddDataProtection().UseEphemeralDataProtectionProvider();
@@ -28,7 +28,7 @@
options.Events.OnRedirectToLogin = context => { context.Response.StatusCode = 401; return Task.CompletedTask; };
options.Events.OnRedirectToAccessDenied = context => { context.Response.StatusCode = 403; return Task.CompletedTask; };
});
-builder.Services.AddAuthorization(options => options.AddPolicy("PolymorfaSession", policy => policy.RequireAuthenticatedUser().RequireClaim("polymorfa_session", session)));
+builder.Services.AddAuthorization(options => options.AddPolicy("PolymorfaConnection", policy => policy.RequireAuthenticatedUser().RequireClaim("polymorfa_connection", connection)));
var app = builder.Build();
var staticTypes = new Microsoft.AspNetCore.StaticFiles.FileExtensionContentTypeProvider();
staticTypes.Mappings[".dat"] = "application/octet-stream"; // Blazor globalization data.
@@ -43,11 +43,11 @@
if (!context.Request.HasFormContentType) return Results.StatusCode(415);
var form = await context.Request.ReadFormAsync(context.RequestAborted);
if (!CryptographicOperations.FixedTimeEquals(SHA256.HashData(Encoding.UTF8.GetBytes(form["password"].ToString())), SHA256.HashData(Encoding.UTF8.GetBytes(password)))) return Results.Unauthorized();
- // Both identity and session belong to this server configuration, never to the submitted form.
+ // Both identity and connection belong to this server configuration, never to the submitted form.
foreach (var prior in applicationSessions.Where(entry => entry.Value <= DateTimeOffset.UtcNow)) applicationSessions.TryRemove(prior.Key, out _);
if (applicationSessions.Count >= 128) return Results.StatusCode(429);
var applicationId = Guid.NewGuid().ToString("N"); applicationSessions[applicationId] = DateTimeOffset.UtcNow.AddMinutes(20);
- var identity = new ClaimsIdentity(new[] { new Claim("example_session", applicationId), new Claim(ClaimTypes.NameIdentifier, "example-operator"), new Claim("polymorfa_session", session) }, CookieAuthenticationDefaults.AuthenticationScheme);
+ var identity = new ClaimsIdentity(new[] { new Claim("example_session", applicationId), new Claim(ClaimTypes.NameIdentifier, "example-operator"), new Claim("polymorfa_connection", connection) }, CookieAuthenticationDefaults.AuthenticationScheme);
await context.SignInAsync(CookieAuthenticationDefaults.AuthenticationScheme, new ClaimsPrincipal(identity));
context.Response.Headers.CacheControl = "no-store"; return Results.NoContent();
});
@@ -62,13 +62,13 @@
context.Response.Headers.CacheControl = "no-store";
try
{
- var response = await client.ClientTokens.MintAsync(new("example:" + subject, Session: session, TtlSeconds: 300), new() { CancellationToken = context.RequestAborted });
+ var response = await client.ClientTokens.MintAsync(new("example:" + subject, Connection: connection, TtlSeconds: 300), new() { CancellationToken = context.RequestAborted });
if (!response.Data.Data.Token.StartsWith("pmfa_ct_", StringComparison.Ordinal) || response.Data.Data.Token.Length <= 8 || !DateTimeOffset.TryParse(response.Data.Data.ExpiresAt, out var expiry)) return Results.StatusCode(502);
- return Results.Json(new { value = response.Data.Data.Token, audience = "browser", expiresAt = expiry.ToUnixTimeMilliseconds(), scopes = new[] { "read_messages", "connect_whatsapp" }, grant = new { session, conversations = Array.Empty(), allow = new[] { "read_messages", "connect_whatsapp" } } });
+ return Results.Json(new { value = response.Data.Data.Token, audience = "browser", expiresAt = expiry.ToUnixTimeMilliseconds(), scopes = new[] { "read_messages", "connect_whatsapp" }, grant = new { connection, conversations = Array.Empty(), allow = new[] { "read_messages", "connect_whatsapp" } } });
}
catch (PolymorfaException error) { return Results.StatusCode(error.Status is >= 400 and < 500 ? 403 : 502); }
-}).RequireAuthorization("PolymorfaSession");
-app.MapGet("/api/polymorfa/conversation", (HttpContext context) => { context.Response.Headers.CacheControl = "no-store"; return Results.Json(conversation.Snapshot()); }).RequireAuthorization("PolymorfaSession");
+}).RequireAuthorization("PolymorfaConnection");
+app.MapGet("/api/polymorfa/conversation", (HttpContext context) => { context.Response.Headers.CacheControl = "no-store"; return Results.Json(conversation.Snapshot()); }).RequireAuthorization("PolymorfaConnection");
app.MapPost("/api/polymorfa/send", async (HttpContext context, MessagingClient client) =>
{
if (context.Request.Headers.Origin.ToString() != $"{context.Request.Scheme}://{context.Request.Host}") return Results.StatusCode(403);
@@ -77,16 +77,16 @@
while (true) { var count = await context.Request.Body.ReadAsync(buffer, context.RequestAborted); if (count == 0) break; if (body.Length + count > 16384) return Results.StatusCode(413); await body.WriteAsync(buffer.AsMemory(0, count), context.RequestAborted); }
context.Response.Headers.CacheControl = "no-store";
return await conversation.SendAsync(client, body.ToArray(), context.Request.Headers["Idempotency-Key"].ToString(), context.RequestAborted);
-}).RequireAuthorization("PolymorfaSession");
+}).RequireAuthorization("PolymorfaConnection");
// Separate browser-grant examples retain their original empty source. The native inbox uses /conversation.
-app.MapGet("/api/polymorfa/history/conversations", (HttpContext context) => { context.Response.Headers.CacheControl = "no-store"; return Results.Json(new { data = Array.Empty(), nextCursor = (string?)null }); }).RequireAuthorization("PolymorfaSession");
+app.MapGet("/api/polymorfa/history/conversations", (HttpContext context) => { context.Response.Headers.CacheControl = "no-store"; return Results.Json(new { data = Array.Empty(), nextCursor = (string?)null }); }).RequireAuthorization("PolymorfaConnection");
app.MapPost("/api/polymorfa/connect", async (HttpContext context, MessagingClient client) =>
{
if (context.Request.Headers.Origin.ToString() != $"{context.Request.Scheme}://{context.Request.Host}") return Results.StatusCode(403);
context.Response.Headers.CacheControl = "no-store";
- try { var response = await client.QuickLinks.CreateAsync(new(Purpose: "add_connection", Session: session, AddConnection: "linked_devices", ConnectionGoal: "hybrid"), new() { CancellationToken = context.RequestAborted }); return Results.Json(new { data = new { response.Data.Data.Id, response.Data.Data.Url, response.Data.Data.ExpiresAt } }); }
+ try { var response = await client.QuickLinks.CreateAsync(new(Purpose: "add_method", Connection: connection, AddMethod: "linked_devices", ConnectionGoal: "hybrid"), new() { CancellationToken = context.RequestAborted }); return Results.Json(new { data = new { response.Data.Data.Id, response.Data.Data.Url, response.Data.Data.ExpiresAt } }); }
catch (PolymorfaException error) { return Results.StatusCode(error.Status is >= 400 and < 500 ? 403 : 502); }
-}).RequireAuthorization("PolymorfaSession");
+}).RequireAuthorization("PolymorfaConnection");
app.MapPost("/webhooks/polymorfa", async (HttpContext context) =>
{
if (context.Request.ContentLength > 65536) return Results.StatusCode(413);
diff --git a/packages/dotnet/examples/aspnet-core/wwwroot/elements.ts b/packages/dotnet/examples/aspnet-core/wwwroot/elements.ts
index 8ee80c3eb..1c0b10eb5 100644
--- a/packages/dotnet/examples/aspnet-core/wwwroot/elements.ts
+++ b/packages/dotnet/examples/aspnet-core/wwwroot/elements.ts
@@ -25,7 +25,7 @@ export async function mount() {
};
const row = (snapshot: Snapshot): InboxConversation => {
const last = snapshot.messages.at(-1);
- return { id: snapshot.peer, session: snapshot.session, name: "Assigned recipient", phoneNumber: snapshot.peer,
+ return { id: snapshot.peer, connection: snapshot.session, name: "Assigned recipient", phoneNumber: snapshot.peer,
lastActivity: last?.createdAt ?? 0, unreadCount: 0,
...(last ? {lastMessage:{text:last.text,createdAt:last.createdAt,direction:last.direction}} : {}) };
};
diff --git a/packages/dotnet/examples/calls-agent/Program.cs b/packages/dotnet/examples/calls-agent/Program.cs
index a60f2a09a..c27e31bec 100644
--- a/packages/dotnet/examples/calls-agent/Program.cs
+++ b/packages/dotnet/examples/calls-agent/Program.cs
@@ -3,8 +3,8 @@
using var stop = new CancellationTokenSource();
Console.CancelKeyPress += (_, e) => { e.Cancel = true; stop.Cancel(); };
var token = Environment.GetEnvironmentVariable("POLYMORFA_API_KEY") ?? throw new InvalidOperationException("POLYMORFA_API_KEY is required.");
-var session = Environment.GetEnvironmentVariable("POLYMORFA_SESSION") ?? throw new InvalidOperationException("POLYMORFA_SESSION is required.");
-await using var calls = new CallsClient(token, new() { Session = session, Participant = "agent" });
+var connection = Environment.GetEnvironmentVariable("POLYMORFA_CONNECTION") ?? throw new InvalidOperationException("POLYMORFA_CONNECTION is required.");
+await using var calls = new CallsClient(token, new() { Connection = connection, Participant = "agent" });
await calls.ConnectAsync(stop.Token);
try
{
diff --git a/packages/dotnet/examples/maui/README.md b/packages/dotnet/examples/maui/README.md
index c723c312f..f54e4b030 100644
--- a/packages/dotnet/examples/maui/README.md
+++ b/packages/dotnet/examples/maui/README.md
@@ -17,7 +17,7 @@ dotnet build packages/dotnet/examples/maui/app/Polymorfa.Example.Maui.csproj -f
open "packages/dotnet/examples/maui/app/bin/Debug/net10.0-maccatalyst26.5/maccatalyst-arm64/Polymorfa MAUI.app"
```
-Start the [ASP.NET Core example](../README.md#aspnet-core) at `http://127.0.0.1:58284` with its Development demonstration identity configured before signing in. Its server owns `POLYMORFA_API_KEY`, `POLYMORFA_SESSION` and `POLYMORFA_EXAMPLE_PASSWORD`. Enter only the application password in MAUI. Keep API credentials in server configuration. Replace the demonstration identity with your application's authorization before deployment.
+Start the [ASP.NET Core example](../README.md#aspnet-core) at `http://127.0.0.1:58284` with its Development demonstration identity configured before signing in. Its server owns `POLYMORFA_API_KEY`, `POLYMORFA_CONNECTION` and `POLYMORFA_EXAMPLE_PASSWORD`. Enter only the application password in MAUI. Keep API credentials in server configuration. Replace the demonstration identity with your application's authorization before deployment.
`app/MauiProgram.cs` sets the trusted application server at build time. Debug uses the loopback address above. Release uses `https://your-application.example/`; replace that placeholder with your application server's HTTPS address before building a release. JavaScript, request bodies and runtime environment variables cannot select another server. The local networking entitlement permits the development loopback host; it does not disable certificate verification or permit arbitrary insecure origins.
diff --git a/packages/dotnet/examples/maui/bridge-tests/Program.cs b/packages/dotnet/examples/maui/bridge-tests/Program.cs
index ff038fc04..aa6213b94 100644
--- a/packages/dotnet/examples/maui/bridge-tests/Program.cs
+++ b/packages/dotnet/examples/maui/bridge-tests/Program.cs
@@ -95,7 +95,7 @@ error.InnerException is SocketException socketError &&
Check((await bridge.RequestAsync("conversations")).Body.Contains("nextCursor"), "App-owned authorized history");
Check((await bridge.RequestAsync("connect")).Status == 200, "App-owned authorized connect");
var before = requests.Count;
- foreach (var action in new[] { "https://example.com/", "../token", "token?session=foreign", "/api/polymorfa/token", "Token" })
+ foreach (var action in new[] { "https://example.com/", "../token", "token?connection=foreign", "/api/polymorfa/token", "Token" })
{
try { await bridge.RequestAsync(action); throw new Exception("Unknown action accepted"); } catch (ArgumentException) { }
}
diff --git a/packages/dotnet/examples/maui/bridge-tests/native-bridge.test.mjs b/packages/dotnet/examples/maui/bridge-tests/native-bridge.test.mjs
index 8120bb455..db7bfc9de 100644
--- a/packages/dotnet/examples/maui/bridge-tests/native-bridge.test.mjs
+++ b/packages/dotnet/examples/maui/bridge-tests/native-bridge.test.mjs
@@ -7,12 +7,12 @@ const bridged = [];
const context = vm.createContext({ URL, Request, Response, DOMException, location: { href: "https://0.0.0.1/", origin: "https://0.0.0.1" }, fetch: async (...args) => { forwarded.push(args); return new Response("{}"); } });
vm.runInContext(source + ";globalThis.testInstall=install;globalThis.testDispose=dispose", context);
context.testInstall({ invokeMethodAsync: async (_, action) => { bridged.push(action); return { status: 200, body: "{}", contentType: "application/json" }; } });
-assert.equal((await context.fetch("/api/polymorfa/token", { method: "POST", headers: { Origin: "https://evil.example", Cookie: "stolen" }, body: '{"session":"foreign"}' })).status, 200);
+assert.equal((await context.fetch("/api/polymorfa/token", { method: "POST", headers: { Origin: "https://evil.example", Cookie: "stolen" }, body: '{"connection":"foreign"}' })).status, 200);
assert.equal(bridged.join(","), "token");
assert.equal((await context.fetch("/api/polymorfa/token")).status, 405);
await context.fetch("https://api.polymorfa.com/messaging/support/status", { headers: { Authorization: "Bearer pmfa_ct_Zml4dHVyZQ" } });
assert.equal(forwarded.length, 1);
-await context.fetch("/api/polymorfa/token?session=foreign", { method: "POST" });
+await context.fetch("/api/polymorfa/token?connection=foreign", { method: "POST" });
assert.equal(bridged.length, 1);
const abort = new AbortController(); abort.abort();
await assert.rejects(context.fetch("/example/config", { signal: abort.signal }), { name: "AbortError" });
diff --git a/packages/dotnet/src/Polymorfa.Sdk/AccountResources.cs b/packages/dotnet/src/Polymorfa.Sdk/AccountResources.cs
index bb2d655f4..f1714d2ee 100644
--- a/packages/dotnet/src/Polymorfa.Sdk/AccountResources.cs
+++ b/packages/dotnet/src/Polymorfa.Sdk/AccountResources.cs
@@ -10,10 +10,10 @@ public sealed record ApiKeyDeactivation(bool Ok, string KeyId);
public sealed record ProjectToken(string Id, string Start, string Last4, string? Label, long Scopes, long? ExpiresAt, long CreatedAt, long? LastUsedAt, long? RevokedAt);
public sealed record AuditLog(string Id, string ActorEmail, string? ActorUserId, string? ActorRole, string Action, string Resource, string? ProjectId, string? ProjectName, string? Ip, string? UserAgent, long? Duration, string? Source, string? Description, string Result, JsonElement Metadata, long CreatedAt);
public sealed record ListAuditLogsParameters(string? Action = null, string? Resource = null, int? Limit = null);
-public sealed record SessionBan(string Id, string SessionName, int? BanCode, string? BanReason, long? BanExpiresAt, long OccurredAt, string Status);
+public sealed record ConnectionBan(string Id, string ConnectionName, int? BanCode, string? BanReason, long? BanExpiresAt, long OccurredAt, string Status);
public sealed record SecurityIncident(string Id, string KeyId, string TokenType, string Source, string? Url, string? Ref, string Resolution, long DetectedAt, long? AcknowledgedAt, string? AcknowledgedBy, long CreatedAt);
public sealed record SecurityIncidentAcknowledgement(bool Acknowledged);
-public sealed record MintClientTokenRequest(string EphemeralId, string? Session = null, string? Customer = null, IReadOnlyList? Allow = null, int? TtlSeconds = null);
+public sealed record MintClientTokenRequest(string EphemeralId, string? Connection = null, string? Customer = null, IReadOnlyList? Allow = null, int? TtlSeconds = null);
public sealed record ClientTokenValue(string Token, string ExpiresAt) { public override string ToString() => $"ClientTokenValue(redacted, expiresAt={ExpiresAt})"; }
public sealed record ClientRules(string RecipientMode, string AllowedActions, int RateLimit, int MaxDaily, string AllowedOrigins, int ConversationTtlSeconds, int MaxConcurrency, int MaxSetupsPerMinute, string AllowedNumber, bool Enabled);
public sealed record SetClientRulesRequest(string RecipientMode, bool Enabled, string? AllowedActions = null, int? RateLimit = null, int? MaxDaily = null, string? AllowedOrigins = null, int? ConversationTtlSeconds = null, int? MaxConcurrency = null, int? MaxSetupsPerMinute = null, string? AllowedNumber = null);
@@ -53,33 +53,33 @@ internal SecurityIncidents(HttpTransport http) : base(http) { }
public Task>>> ListAsync(RequestOptions? options = null) => Get>>("/platform/incidents", options);
public Task>> AcknowledgeAsync(string id, RequestOptions? options = null) => Post>("/platform/incidents/" + E(id) + "/acknowledge", null, options);
}
-public sealed class SessionBans : Resource
+public sealed class ConnectionBans : Resource
{
- internal SessionBans(HttpTransport http) : base(http) { }
- public Task>>> ListAsync(RequestOptions? options = null) => Get>>("/platform/bans", options);
- public Task>>> ListActiveAsync(RequestOptions? options = null) => Get>>("/platform/bans/active", options);
+ internal ConnectionBans(HttpTransport http) : base(http) { }
+ public Task>>> ListAsync(RequestOptions? options = null) => Get>>("/platform/bans", options);
+ public Task>>> ListActiveAsync(RequestOptions? options = null) => Get>>("/platform/bans/active", options);
}
public sealed class ClientTokens : Resource
{
internal ClientTokens(HttpTransport http) : base(http) { }
- private static string Path(string session) => $"/platform/sessions/{E(session)}/client-rules";
+ private static string Path(string connection) => $"/platform/connections/{E(connection)}/client-rules";
public Task>> MintAsync(MintClientTokenRequest body, RequestOptions? options = null)
{
Http.Credential.RequireServer();
- if (string.IsNullOrEmpty(body.Session) == string.IsNullOrEmpty(body.Customer)) throw new PolymorfaConfigurationException("Specify exactly one session or customer.");
+ if (string.IsNullOrEmpty(body.Connection) == string.IsNullOrEmpty(body.Customer)) throw new PolymorfaConfigurationException("Specify exactly one connection or customer.");
return Post>("/platform/client-tokens", body, options);
}
- public Task>> RetrieveRulesAsync(string session, RequestOptions? options = null) { Http.Credential.RequireServer(); return Get>(Path(session), options); }
- public Task> UpdateRulesAsync(string session, SetClientRulesRequest body, RequestOptions? options = null) { Http.Credential.RequireServer(); return Put(Path(session), body, options); }
- public Task> DeleteRulesAsync(string session, RequestOptions? options = null) { Http.Credential.RequireServer(); return Delete(Path(session), options); }
+ public Task>> RetrieveRulesAsync(string connection, RequestOptions? options = null) { Http.Credential.RequireServer(); return Get>(Path(connection), options); }
+ public Task> UpdateRulesAsync(string connection, SetClientRulesRequest body, RequestOptions? options = null) { Http.Credential.RequireServer(); return Put(Path(connection), body, options); }
+ public Task> DeleteRulesAsync(string connection, RequestOptions? options = null) { Http.Credential.RequireServer(); return Delete(Path(connection), options); }
}
public sealed class Identities : Resource
{
internal Identities(HttpTransport http) : base(http) { }
- public Task>> ResolveAsync(string session, ResolveIdentityParameters parameters, RequestOptions? options = null) => Get>($"/messaging/{E(session)}/identities/resolve", options, parameters);
+ public Task>> ResolveAsync(string connection, ResolveIdentityParameters parameters, RequestOptions? options = null) => Get>($"/messaging/{E(connection)}/identities/resolve", options, parameters);
}
public sealed class Users : Resource
{
internal Users(HttpTransport http) : base(http) { }
- public Task>> GetSecurityCodeAsync(string session, string user, RequestOptions? options = null) => Get>($"/messaging/{E(session)}/users/{E(user)}/security-code", options);
+ public Task>> GetSecurityCodeAsync(string connection, string user, RequestOptions? options = null) => Get>($"/messaging/{E(connection)}/users/{E(user)}/security-code", options);
}
diff --git a/packages/dotnet/src/Polymorfa.Sdk/Analytics.cs b/packages/dotnet/src/Polymorfa.Sdk/Analytics.cs
index 71340fae9..a5f74671c 100644
--- a/packages/dotnet/src/Polymorfa.Sdk/Analytics.cs
+++ b/packages/dotnet/src/Polymorfa.Sdk/Analytics.cs
@@ -78,34 +78,34 @@ public record WhatsAppMetrics
public WhatsAppAccountActivity AccountActivity { get; init; } = null!;
public WhatsAppResponseQueue? ResponseQueue { get; init; }
}
-public sealed record WhatsAppAnalyticsSummary : WhatsAppMetrics { public long TotalNumbers { get; init; } public long MeasuredNumbers { get; init; } public long ConnectedNumbers { get; init; } }
-public sealed record WhatsAppAnalyticsNumber : WhatsAppMetrics { public string SessionId { get; init; } = ""; public string ProjectId { get; init; } = ""; public string ProjectName { get; init; } = ""; public string Name { get; init; } = ""; public string Backend { get; init; } = ""; public string Status { get; init; } = ""; }
-public sealed record WhatsAppAnalyticsCallSeries : CallOutcomeMetrics { public string SessionId { get; init; } = ""; public long Ts { get; init; } }
-public sealed record WhatsAppAnalyticsSeries(long CustomerOnlineSignals, long CustomerTypingSignals, long PrimaryPhoneMessages, long OtherDeviceMessages, long PrimaryPhoneReplies, long PhoneActivePeriods, long CompletedPhoneActivityPeriods, long PhoneActivityMs, long PhoneQuietGaps, long PhoneQuietMs, string SessionId, long Ts, long OutgoingMessages, long IncomingMessages, long SendFailures, long BusinessReplies, decimal? AverageBusinessResponseMs, long OnlineMs, long Disconnects);
+public sealed record WhatsAppAnalyticsSummary : WhatsAppMetrics { public long TotalConnections { get; init; } public long MeasuredConnections { get; init; } public long ConnectedConnections { get; init; } }
+public sealed record WhatsAppAnalyticsConnection : WhatsAppMetrics { public string ConnectionId { get; init; } = ""; public string ProjectId { get; init; } = ""; public string ProjectName { get; init; } = ""; public string Name { get; init; } = ""; public string Backend { get; init; } = ""; public string Status { get; init; } = ""; }
+public sealed record WhatsAppAnalyticsCallSeries : CallOutcomeMetrics { public string ConnectionId { get; init; } = ""; public long Ts { get; init; } }
+public sealed record WhatsAppAnalyticsSeries(long CustomerOnlineSignals, long CustomerTypingSignals, long PrimaryPhoneMessages, long OtherDeviceMessages, long PrimaryPhoneReplies, long PhoneActivePeriods, long CompletedPhoneActivityPeriods, long PhoneActivityMs, long PhoneQuietGaps, long PhoneQuietMs, string ConnectionId, long Ts, long OutgoingMessages, long IncomingMessages, long SendFailures, long BusinessReplies, decimal? AverageBusinessResponseMs, long OnlineMs, long Disconnects);
public sealed record AnalyticsPeriod(long Start, long End);
public sealed record AnalyticsRequestVitals(long Requests, long Failures, decimal? ErrorRate);
-public sealed record WhatsAppAnalytics(IReadOnlyList CallSeries, bool Enabled, AnalyticsPeriod Period, AnalyticsRequestVitals RequestVitals, WhatsAppAnalyticsSummary? Summary, IReadOnlyList Numbers, IReadOnlyList Series);
-public sealed record AnalyticsParameters(string? ProjectId = null, string? SessionId = null, long? Start = null, long? End = null);
-public sealed record AnalyticsMetricsParameters(string? ProjectId = null, string? SessionId = null, int? WindowHours = null, bool? Segments = null, string? Format = null);
+public sealed record WhatsAppAnalytics(IReadOnlyList CallSeries, bool Enabled, AnalyticsPeriod Period, AnalyticsRequestVitals RequestVitals, WhatsAppAnalyticsSummary? Summary, IReadOnlyList Connections, IReadOnlyList Series);
+public sealed record AnalyticsParameters(string? ProjectId = null, string? ConnectionId = null, long? Start = null, long? End = null);
+public sealed record AnalyticsMetricsParameters(string? ProjectId = null, string? ConnectionId = null, int? WindowHours = null, bool? Segments = null, string? Format = null);
public sealed class Analytics : Resource
{
private readonly string? projectId;
private string Path => projectId is null ? "/platform/analytics" : "/platform/projects/" + E(projectId) + "/analytics";
internal Analytics(HttpTransport http, string? projectId) : base(http) => this.projectId = projectId;
- private void Validate(string? project, string? session)
+ private void Validate(string? project, string? connection)
{
- foreach (var id in new[] { project, session }) if (id is not null && !Guid.TryParseExact(id, "D", out _)) throw new PolymorfaValidationException("Analytics filters require UUIDs.", "invalid_analytics_filter");
+ foreach (var id in new[] { project, connection }) if (id is not null && !Guid.TryParseExact(id, "D", out _)) throw new PolymorfaValidationException("Analytics filters require UUIDs.", "invalid_analytics_filter");
if (projectId is not null && project is not null && !projectId.Equals(project, StringComparison.OrdinalIgnoreCase)) throw new PolymorfaValidationException("Analytics cannot read outside the client's project.", "invalid_analytics_filter");
}
public async Task> GetAsync(AnalyticsParameters? parameters = null, RequestOptions? options = null)
{
- parameters ??= new(); Validate(parameters.ProjectId, parameters.SessionId);
+ parameters ??= new(); Validate(parameters.ProjectId, parameters.ConnectionId);
if (parameters.Start is < 0 or > 9007199254740991 || parameters.End is < 0 or > 9007199254740991 || parameters.Start is { } start && parameters.End is { } end && (end < start || end - start > 366L * 86400000)) throw new PolymorfaValidationException("Choose an ordered analytics range of up to 366 days.", "invalid_analytics_range");
var r = await ExistingContractCodec.Request>(Http, HttpMethod.Get, Path, options: options, query: Query(parameters with { ProjectId = projectId is null ? parameters.ProjectId : null })).ConfigureAwait(false); return new(r.Data.Data, r.Metadata);
}
public async Task> MetricsAsync(AnalyticsMetricsParameters? parameters = null, RequestOptions? options = null)
{
- parameters ??= new(); Validate(parameters.ProjectId, parameters.SessionId); if (parameters.WindowHours is < 1 or > 168) throw new PolymorfaValidationException("windowHours must be from 1 to 168.", "invalid_analytics_range"); var format = parameters.Format ?? "prometheus"; if (format is not ("prometheus" or "openmetrics")) throw new PolymorfaValidationException("Invalid metrics format.", "invalid_analytics_filter");
+ parameters ??= new(); Validate(parameters.ProjectId, parameters.ConnectionId); if (parameters.WindowHours is < 1 or > 168) throw new PolymorfaValidationException("windowHours must be from 1 to 168.", "invalid_analytics_range"); var format = parameters.Format ?? "prometheus"; if (format is not ("prometheus" or "openmetrics")) throw new PolymorfaValidationException("Invalid metrics format.", "invalid_analytics_filter");
var accept = format == "openmetrics" ? "application/openmetrics-text" : "text/plain";
var r = await Http.RequestTextAsync(Path + "/metrics", accept, options, Query(parameters with { ProjectId = projectId is null ? parameters.ProjectId : null, Format = format })).ConfigureAwait(false);
if (r.Metadata.Headers.GetValueOrDefault("content-type")?.Split(';')[0].Trim().ToLowerInvariant() != accept || !System.Text.RegularExpressions.Regex.IsMatch(r.Data, "^# TYPE polymorfa_analytics_enabled gauge$", System.Text.RegularExpressions.RegexOptions.Multiline) || format == "openmetrics" && !r.Data.EndsWith("# EOF\n", StringComparison.Ordinal)) throw new PolymorfaServerException("Invalid analytics metrics response.", "invalid_response", r.Metadata); return r;
diff --git a/packages/dotnet/src/Polymorfa.Sdk/BanSafe.cs b/packages/dotnet/src/Polymorfa.Sdk/BanSafe.cs
index 47cf84854..1eb60ce6f 100644
--- a/packages/dotnet/src/Polymorfa.Sdk/BanSafe.cs
+++ b/packages/dotnet/src/Polymorfa.Sdk/BanSafe.cs
@@ -24,26 +24,26 @@ public record BanSafeHealthProjection
public BanSafeHealthExplanation? HealthExplanation { get; init; }
public BanSafeObservedAccountState? ObservedAccountState { get; init; }
}
-public record BanSafeNumber : BanSafeHealthProjection
+public record BanSafeConnection : BanSafeHealthProjection
{
- public string SessionId { get; init; } = null!;
- public string Session { get; init; } = null!;
+ public string ConnectionId { get; init; } = null!;
+ public string Connection { get; init; } = null!;
public string PhoneNumber { get; init; } = null!;
public string ProjectId { get; init; } = null!;
- public BanSafeNumberEnforcement? Enforcement { get; init; }
+ public BanSafeConnectionEnforcement? Enforcement { get; init; }
}
-public sealed record BanSafeNumberEnforcement(string Rung, string PreviousRung, string TeamFloor, string Reason, string Source, decimal? ThroughputPerMinute, bool BlocksUnsolicited, bool Suspended, string StartedAt, string? EligibleLiftAt, decimal ExitProgress, IReadOnlyList BlockingFindings, bool OperatorHold, string AppealState, string State);
-public sealed record BanSafeNumberWarmup(bool Enabled, string? TenureSource, int TenureDay, int? Allowance, int? SentToday, string? ResetsAt, IReadOnlyList Curve);
-public sealed record BanSafeNumberDetail : BanSafeNumber
+public sealed record BanSafeConnectionEnforcement(string Rung, string PreviousRung, string TeamFloor, string Reason, string Source, decimal? ThroughputPerMinute, bool BlocksUnsolicited, bool Suspended, string StartedAt, string? EligibleLiftAt, decimal ExitProgress, IReadOnlyList BlockingFindings, bool OperatorHold, string AppealState, string State);
+public sealed record BanSafeConnectionWarmup(bool Enabled, string? TenureSource, int TenureDay, int? Allowance, int? SentToday, string? ResetsAt, IReadOnlyList Curve);
+public sealed record BanSafeConnectionDetail : BanSafeConnection
{
- public BanSafeNumberWarmup Warmup { get; init; } = null!;
+ public BanSafeConnectionWarmup Warmup { get; init; } = null!;
public IReadOnlyList Findings { get; init; } = null!;
public string? LiftRequires { get; init; }
public string AppealState { get; init; } = null!;
}
-public sealed record BanSafeHealthHistory(string SessionId, string Session, IReadOnlyList Points);
-public sealed record BanSafeFinding(string? Id, string Key, string Title, string Summary, string Fix, string Status, string? Severity, long Occurrences, long ReopenedCount, IReadOnlyDictionary Evidence, string SessionId, string Session, string PhoneNumber, string? FirstSeenAt, string? LastSeenAt, string? AcknowledgedAt, string? AcknowledgedBy, string? AcknowledgementNote, string? SnoozedUntil, string? ResolvedAt, string? ResolveReason);
-public sealed record BanSafeEnforcementSummary : BanSafeNumber
+public sealed record BanSafeHealthHistory(string ConnectionId, string Connection, IReadOnlyList Points);
+public sealed record BanSafeFinding(string? Id, string Key, string Title, string Summary, string Fix, string Status, string? Severity, long Occurrences, long ReopenedCount, IReadOnlyDictionary Evidence, string ConnectionId, string Connection, string PhoneNumber, string? FirstSeenAt, string? LastSeenAt, string? AcknowledgedAt, string? AcknowledgedBy, string? AcknowledgementNote, string? SnoozedUntil, string? ResolvedAt, string? ResolveReason);
+public sealed record BanSafeEnforcementSummary : BanSafeConnection
{
public string Rung { get; init; } = null!;
public string PreviousRung { get; init; } = null!;
@@ -61,11 +61,11 @@ public sealed record BanSafeEnforcementSummary : BanSafeNumber
public string AppealState { get; init; } = null!;
public string State { get; init; } = null!;
}
-public sealed record BanSafeIncident(string Id, string SessionId, string Session, string PhoneNumber, string ProjectId, string Kind, string Source, string Resolution, bool Ambiguous, string StartedAt, string? EndsAt, string? ClosedAt, string? ClosedBy, string? ClaimId, string? Note, string? ReportedBy, string CreatedAt);
-public sealed record ReportBanSafeIncidentRequest(string Session, string? OccurredAt = null, string? Note = null);
-public sealed record BanSafeIncidentReceipt(string IncidentId, bool Created, string SessionId, string Session, string OccurredAt);
+public sealed record BanSafeIncident(string Id, string ConnectionId, string Connection, string PhoneNumber, string ProjectId, string Kind, string Source, string Resolution, bool Ambiguous, string StartedAt, string? EndsAt, string? ClosedAt, string? ClosedBy, string? ClaimId, string? Note, string? ReportedBy, string CreatedAt);
+public sealed record ReportBanSafeIncidentRequest(string Connection, string? OccurredAt = null, string? Note = null);
+public sealed record BanSafeIncidentReceipt(string IncidentId, bool Created, string ConnectionId, string Connection, string OccurredAt);
public sealed record BanSafeClaimEvidence(long? AttributionRuleVersion, int WindowDays, bool DeviceEvidence, long OtherDevices, bool RestrictedInWindow, long CriticalFindingDays, bool SharedConnection, decimal MeasuredHours, bool SimultaneousCalls, bool LinkedDeviceInteractive);
-public sealed record BanSafeClaim(string Id, string IncidentId, string SessionId, string Session, string PhoneNumber, string ProjectId, string Status, string Verdict, string WindowStart, string WindowEnd, decimal MeasuredCents, decimal CapCents, decimal AmountCents, BanSafeClaimEvidence Evidence, string Summary, string Reason, string? DecidedAt, string? PaidAt, string CreatedAt);
+public sealed record BanSafeClaim(string Id, string IncidentId, string ConnectionId, string Connection, string PhoneNumber, string ProjectId, string Status, string Verdict, string WindowStart, string WindowEnd, decimal MeasuredCents, decimal CapCents, decimal AmountCents, BanSafeClaimEvidence Evidence, string Summary, string Reason, string? DecidedAt, string? PaidAt, string CreatedAt);
public sealed record BanSafeSignalDefinition(string Key, string Label, string Group, string Kind, string Unit, string Description);
public sealed record BanSafeCodeCount(long Code, long Count);
[JsonConverter(typeof(BanSafeSignalValueConverter))]
@@ -89,27 +89,27 @@ public override void Write(Utf8JsonWriter writer, BanSafeSignalValue value, Json
}
public sealed record BanSafeCollectionStatus(string State, string? LatestFlushedAt, string? LatestReceivedAt, string? FreshUntil, long? RecordVersion, long? CollectorVersion, bool? Partial, long? DroppedRecords);
public sealed record BanSafeTelemetrySnapshot(string BucketStart, string FlushedAt, string ReceivedAt, bool Partial, long? RecordVersion, IReadOnlyList Signals);
-public sealed record BanSafeCollectionSession(string SessionId, string Session, string ProjectId, BanSafeCollectionStatus Collection);
-public sealed record BanSafeTelemetryDetail(string SessionId, string Session, string ProjectId, BanSafeCollectionStatus Collection, BanSafeTelemetrySnapshot? Snapshot);
-public sealed record BanSafeHealthAction(string Id, string SessionId, string Session, string ProjectId, string Mode, string Action, string Status, decimal Health, decimal Threshold, string HealthSource, string EstimatorVersion, string? ModelVersion, decimal? SlowDownMps, string EvaluatedAt, string CreatedAt, string? CompletedAt, string? Outcome);
+public sealed record BanSafeCollectionConnection(string ConnectionId, string Connection, string ProjectId, BanSafeCollectionStatus Collection);
+public sealed record BanSafeTelemetryDetail(string ConnectionId, string Connection, string ProjectId, BanSafeCollectionStatus Collection, BanSafeTelemetrySnapshot? Snapshot);
+public sealed record BanSafeHealthAction(string Id, string ConnectionId, string Connection, string ProjectId, string Mode, string Action, string Status, decimal Health, decimal Threshold, string HealthSource, string EstimatorVersion, string? ModelVersion, decimal? SlowDownMps, string EvaluatedAt, string CreatedAt, string? CompletedAt, string? Outcome);
public sealed record ListBanSafeHealthParameters(string? ProjectId = null, string? Cursor = null, int? Limit = null);
public sealed record ListBanSafeHistoryParameters(string? Since = null, int? Limit = null);
-public sealed record ListBanSafeFindingsParameters(string? ProjectId = null, string? Cursor = null, int? Limit = null, string? Session = null, string? Status = null, string? Severity = null);
+public sealed record ListBanSafeFindingsParameters(string? ProjectId = null, string? Cursor = null, int? Limit = null, string? Connection = null, string? Status = null, string? Severity = null);
public sealed record ListBanSafeEnforcementParameters(string? ProjectId = null, string? Cursor = null, int? Limit = null, string? Rung = null);
-public sealed record ListBanSafeIncidentsParameters(string? ProjectId = null, string? Cursor = null, int? Limit = null, string? Session = null);
-public sealed record ListBanSafeClaimsParameters(string? ProjectId = null, string? Cursor = null, int? Limit = null, string? Session = null, string? Status = null);
+public sealed record ListBanSafeIncidentsParameters(string? ProjectId = null, string? Cursor = null, int? Limit = null, string? Connection = null);
+public sealed record ListBanSafeClaimsParameters(string? ProjectId = null, string? Cursor = null, int? Limit = null, string? Connection = null, string? Status = null);
public sealed record ListBanSafeTelemetryHistoryParameters(string? Since = null, string? Until = null, string? Cursor = null, int? Limit = null);
-public sealed record ListBanSafeHealthActionsParameters(string? ProjectId = null, string? Cursor = null, int? Limit = null, string? Session = null, string? Status = null);
+public sealed record ListBanSafeHealthActionsParameters(string? ProjectId = null, string? Cursor = null, int? Limit = null, string? Connection = null, string? Status = null);
public sealed class BanSafe : Resource
{
internal BanSafe(HttpTransport http) : base(http) { }
- public Task> ListHealthAsync(ListBanSafeHealthParameters? parameters = null, RequestOptions? options = null) => Page("health", parameters, options);
- public Task>> GetHealthAsync(string session, RequestOptions? options = null) => Get>("/platform/bansafe/health/" + E(session), options);
- public Task>> ListHealthHistoryAsync(string session, ListBanSafeHistoryParameters? parameters = null, RequestOptions? options = null) => Get>("/platform/bansafe/health/" + E(session) + "/history", options, parameters);
+ public Task> ListHealthAsync(ListBanSafeHealthParameters? parameters = null, RequestOptions? options = null) => Page("health", parameters, options);
+ public Task>> GetHealthAsync(string connection, RequestOptions? options = null) => Get>("/platform/bansafe/health/" + E(connection), options);
+ public Task>> ListHealthHistoryAsync(string connection, ListBanSafeHistoryParameters? parameters = null, RequestOptions? options = null) => Get>("/platform/bansafe/health/" + E(connection) + "/history", options, parameters);
public Task>>> ListSignalsAsync(RequestOptions? options = null) => Get>>("/platform/bansafe/signals", options);
- public Task>> GetTelemetryAsync(string session, RequestOptions? options = null) => Get>("/platform/bansafe/telemetry/" + E(session), options);
- public Task> ListTelemetryHistoryAsync(string session, ListBanSafeTelemetryHistoryParameters? parameters = null, RequestOptions? options = null) => Page("telemetry/" + E(session) + "/history", parameters, options);
- public Task> ListCollectionAsync(ListBanSafeHealthParameters? parameters = null, RequestOptions? options = null) => Page("collection", parameters, options);
+ public Task>> GetTelemetryAsync(string connection, RequestOptions? options = null) => Get>("/platform/bansafe/telemetry/" + E(connection), options);
+ public Task> ListTelemetryHistoryAsync(string connection, ListBanSafeTelemetryHistoryParameters? parameters = null, RequestOptions? options = null) => Page("telemetry/" + E(connection) + "/history", parameters, options);
+ public Task> ListCollectionAsync(ListBanSafeHealthParameters? parameters = null, RequestOptions? options = null) => Page("collection", parameters, options);
public Task> ListHealthActionsAsync(ListBanSafeHealthActionsParameters? parameters = null, RequestOptions? options = null) => Page("health-actions", parameters, options);
public Task> ListFindingsAsync(ListBanSafeFindingsParameters? parameters = null, RequestOptions? options = null) => Page("findings", parameters, options);
public Task> ListEnforcementAsync(ListBanSafeEnforcementParameters? parameters = null, RequestOptions? options = null) => Page("enforcement", parameters, options);
diff --git a/packages/dotnet/src/Polymorfa.Sdk/Billing.cs b/packages/dotnet/src/Polymorfa.Sdk/Billing.cs
index d5dc073be..0ca876671 100644
--- a/packages/dotnet/src/Polymorfa.Sdk/Billing.cs
+++ b/packages/dotnet/src/Polymorfa.Sdk/Billing.cs
@@ -4,12 +4,12 @@
namespace Polymorfa.Sdk;
public sealed record BillingBalance(decimal BalanceCents, string PreferredCurrency);
-public sealed record BillingUsage(long ActiveNumbers, decimal TotalChargedCents);
-public sealed record BillingTransaction(string Id, decimal AmountCents, decimal BalanceAfterCents, string Type, string Description, string? SessionId, string? ProjectId, string? Tier, string? Currency, string PaymentStatus, long CreatedAt);
+public sealed record BillingUsage(long ActiveConnections, decimal TotalChargedCents);
+public sealed record BillingTransaction(string Id, decimal AmountCents, decimal BalanceAfterCents, string Type, string Description, string? ConnectionId, string? ProjectId, string? Tier, string? Currency, string PaymentStatus, long CreatedAt);
public sealed record TierPricing(string Id, string Tier, decimal DailyRateCents, string Label, string Description, IReadOnlyList Features);
public sealed record BillingPriority(string Id, string Name, int Priority);
public sealed record ProjectResourcePriority(string Id, string Name, int Priority, string ProjectId);
-public sealed record BillingPriorities(long Revision, IReadOnlyList Projects, IReadOnlyList Customers, IReadOnlyList Numbers);
+public sealed record BillingPriorities(long Revision, IReadOnlyList Projects, IReadOnlyList Customers, IReadOnlyList Connections);
public sealed record BillingLimit(string Scope, string ResourceId, string ProjectId, string Name, decimal? LimitCredits, decimal SpentCredits, decimal ReservedCredits, long Revision);
public sealed record DailyCredits(string Date, decimal Credits);
public sealed record BillingLimits(string CheckedAt, string PeriodStart, string PeriodEnd, decimal TodayCredits, decimal MonthCredits, IReadOnlyList Daily, IReadOnlyList Budgets);
@@ -45,7 +45,7 @@ public Task>> ReorderPrioritiesAsync
{
var resources = body.Resources ?? throw Invalid("resources is required.");
if (body.ResourceIds is not null || resources.Count > 1000000) throw Invalid("Invalid resource ordering.");
- var normalized = resources.Select(row => row.Scope is "customer" or "number" ? new BillingResourceOrder(row.Scope, Id(row.ResourceId)) : throw Invalid("Resource scope must be customer or number.")).ToArray();
+ var normalized = resources.Select(row => row.Scope is "customer" or "connection" ? new BillingResourceOrder(row.Scope, Id(row.ResourceId)) : throw Invalid("Resource scope must be customer or connection.")).ToArray();
if (normalized.Distinct().Count() != normalized.Length) throw Invalid("Resources must be unique.");
return Put>("/platform/billing/priorities", body with { ProjectId = Id(body.ProjectId!), Resources = normalized }, options);
}
@@ -61,7 +61,7 @@ public Task>> ReorderPrioritiesAsync
return parameters?.ProjectId is null ? parameters : parameters with { ProjectId = Id(parameters.ProjectId) };
}
internal static string Id(string value) { if (value is null || !Regex.IsMatch(value, "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$")) throw Invalid("Resource ID must be a UUID."); return value.ToLowerInvariant(); }
- internal static void Scope(string value) { if (value is not ("project" or "customer" or "number")) throw Invalid("Scope must be project, customer, or number."); }
+ internal static void Scope(string value) { if (value is not ("project" or "customer" or "connection")) throw Invalid("Scope must be project, customer, or connection."); }
internal static void Revision(long value) { if (value is < 0 or > 2147483646) throw Invalid("Invalid expected revision."); }
internal static void Priority(int value) { if (value is < 0 or > 1000000) throw Invalid("Priority must be between 0 and 1000000."); }
internal static void Limit(decimal? value) { if (value is < 0 or > 1000000 || value is decimal number && decimal.Round(number, 6) != number) throw Invalid("Credit limits require at most six decimal places and must be between 0 and 1000000."); }
diff --git a/packages/dotnet/src/Polymorfa.Sdk/Business.cs b/packages/dotnet/src/Polymorfa.Sdk/Business.cs
index d1b3a874e..1ddcadc7c 100644
--- a/packages/dotnet/src/Polymorfa.Sdk/Business.cs
+++ b/packages/dotnet/src/Polymorfa.Sdk/Business.cs
@@ -3,35 +3,35 @@ namespace Polymorfa.Sdk;
public sealed class Business : Resource
{
internal Business(HttpTransport http) : base(http) { }
- private static string Path(string session) => $"/messaging/{E(session)}/business";
- private static string Profile(string session) => Path(session) + "/profile";
- private static string Product(string session, string product) => Path(session) + "/products/" + E(product);
- private static string Collection(string session, string collection) => Path(session) + "/collections/" + E(collection);
- public Task>> GetProfileAsync(string session, RequestOptions? options = null) => Get>(Profile(session), options);
- public Task>>> UpdateProfileAsync(string session, BusinessProfileUpdateRequest body, RequestOptions? options = null) => Patch>>(Profile(session), body, options);
- public Task>>> SetCoverPhotoAsync(string session, PictureRequest body, RequestOptions? options = null) { ValidateImage(body.Url, body.Base64); return Put>>(Profile(session) + "/cover-photo", body, options); }
- public Task>>> DeleteCoverPhotoAsync(string session, string coverPhotoId, RequestOptions? options = null) => Delete>>(Profile(session) + "/cover-photo/" + E(coverPhotoId), options);
- public Task>> GetCatalogAsync(string session, BusinessCatalogParameters parameters, RequestOptions? options = null) => Get>(Path(session) + "/catalog", options, parameters);
- public Task>>> CreateCatalogAsync(string session, RequestOptions? options = null) => Post>>(Path(session) + "/catalog", null, options);
- public Task>>> SetCartEnabledAsync(string session, bool enabled, RequestOptions? options = null) => Patch>>(Path(session) + "/catalog/cart", new { enabled }, options);
- public Task>> GetProductAsync(string session, string productId, string businessId, RequestOptions? options = null) => Get>(Product(session, productId), options, new { id = businessId });
- public Task>>> CreateProductAsync(string session, BusinessProductMutationRequest body, RequestOptions? options = null) { ValidateProduct(body); return Post>>(Path(session) + "/products", body, options); }
- public Task>>> UpdateProductAsync(string session, string productId, BusinessProductMutationRequest body, RequestOptions? options = null) { ValidateProduct(body); return Put>>(Product(session, productId), body, options); }
- public Task>>> DeleteProductAsync(string session, string productId, RequestOptions? options = null) => Delete>>(Product(session, productId), options);
- public Task>>> SetProductVisibilityAsync(string session, string productId, bool hidden, RequestOptions? options = null) => Patch>>(Product(session, productId) + "/visibility", new { hidden }, options);
- public Task>>> AppealProductAsync(string session, string productId, BusinessCatalogAppealRequest body, RequestOptions? options = null) => Post>>(Product(session, productId) + "/appeal", body, options);
- public Task>> ListCollectionsAsync(string session, BusinessCollectionsParameters parameters, RequestOptions? options = null) => Get>(Path(session) + "/collections", options, parameters);
- public Task>> GetCollectionAsync(string session, string collectionId, BusinessCatalogParameters parameters, RequestOptions? options = null) => Get>(Collection(session, collectionId), options, parameters);
- public Task>>> CreateCollectionAsync(string session, BusinessCollectionCreateRequest body, RequestOptions? options = null) => Post>>(Path(session) + "/collections", body, options);
- public Task>>> UpdateCollectionAsync(string session, string collectionId, BusinessCollectionUpdateRequest body, RequestOptions? options = null) => Patch>>(Collection(session, collectionId), body, options);
- public Task>>> DeleteCollectionAsync(string session, string collectionId, RequestOptions? options = null) => Delete>>(Collection(session, collectionId), options);
- public Task>>> ReorderCollectionsAsync(string session, BusinessCollectionReorderRequest body, RequestOptions? options = null) => Post>>(Path(session) + "/collections/reorder", body, options);
- public Task>>> AppealCollectionAsync(string session, string collectionId, BusinessCatalogAppealRequest body, RequestOptions? options = null) => Post>>(Collection(session, collectionId) + "/appeal", body, options);
- public Task>>> GetOrderAsync(string session, string orderId, BusinessOrderLookupRequest body, RequestOptions? options = null) => Post>>(Path(session) + "/orders/" + E(orderId) + "/lookup", body, options);
- public Task>> GetMerchantComplianceAsync(string session, RequestOptions? options = null) => Get>(Path(session) + "/compliance", options);
- public Task>>> SetMerchantComplianceAsync(string session, BusinessMerchantCompliance body, RequestOptions? options = null) => Put>>(Path(session) + "/compliance", body, options);
- public Task>> GetLinkedAccountsAsync(string session, RequestOptions? options = null) => Get>(Path(session) + "/linked-accounts", options);
- public Task>> GetEligibilityAsync(string session, RequestOptions? options = null) => Get>(Path(session) + "/eligibility", options);
+ private static string Path(string connection) => $"/messaging/{E(connection)}/business";
+ private static string Profile(string connection) => Path(connection) + "/profile";
+ private static string Product(string connection, string product) => Path(connection) + "/products/" + E(product);
+ private static string Collection(string connection, string collection) => Path(connection) + "/collections/" + E(collection);
+ public Task>> GetProfileAsync(string connection, RequestOptions? options = null) => Get>(Profile(connection), options);
+ public Task>>> UpdateProfileAsync(string connection, BusinessProfileUpdateRequest body, RequestOptions? options = null) => Patch>>(Profile(connection), body, options);
+ public Task>>> SetCoverPhotoAsync(string connection, PictureRequest body, RequestOptions? options = null) { ValidateImage(body.Url, body.Base64); return Put>>(Profile(connection) + "/cover-photo", body, options); }
+ public Task