Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
682 changes: 343 additions & 339 deletions README.md

Large diffs are not rendered by default.

90 changes: 64 additions & 26 deletions contracts/abprops-capabilities.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"repository": "polymorfa/polymorfa",
"sourceCommit": "2f9efad933b3a7a455f73245a566c827ac004608",
"sourceCommit": "8354399b827d9127210b9759cd055586e967449e",
"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 current Connection capability webhook. Candidate source, unavailable until matching API acceptance and SDK publication.",
"openapi": "3.0.3",
"paths": {
"/messaging/{session}/groups/{id}/capabilities": {
"/messaging/{connection}/groups/{id}/capabilities": {
"get": {
"operationId": "getGroupCapabilities",
"tags": ["Groups"],
Expand All @@ -24,7 +24,7 @@
"type": "string"
},
"required": true,
"name": "session",
"name": "connection",
"in": "path"
},
{
Expand All @@ -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": {
Expand Down Expand Up @@ -252,9 +252,6 @@
}
}
},
"x-mint": {
"content": "<Badge color=\"green\" icon=\"laptop\">Linked Device API</Badge> <Badge color=\"yellow\" icon=\"key\">groups:read</Badge>"
},
"x-protocols": ["Linked Device API"],
"description": "**Protocols:** Linked Device API\n\n**Required scope:** `groups:read`"
}
Expand Down Expand Up @@ -344,6 +341,7 @@
"invalid_request_error",
"authentication_error",
"permission_error",
"billing_error",
"conflict_error",
"rate_limit_error",
"api_error",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -413,24 +420,29 @@
"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",
"whatsapp_group_full",
"whatsapp_group_suspended",
"whatsapp_group_has_no_participants",
"bansafe_suspended",
"bansafe_org_suspended",
"bansafe_team_suspended",
"bansafe_cold_blocked",
"bansafe_cold_held",
"bansafe_throttled",
Expand Down Expand Up @@ -458,7 +470,7 @@
"request_log_url": {
"type": "string",
"format": "uri",
"description": "Console page that shows this request. Returned only to organization and project credentials whose request was logged."
"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"]
Expand All @@ -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
},
Expand Down Expand Up @@ -588,7 +603,7 @@
}
},
"required": [
"session",
"connection",
"projectId",
"status",
"syncedAt",
Expand All @@ -599,6 +614,29 @@
],
"additionalProperties": false
}
},
"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
}
}
}
},
"family": "messaging"
Expand Down
Loading
Loading