@amigo-ai/platform-sdk 0.26.0 → 0.29.0

package/README.md

@@ -446,6 +446,68 @@ const url = client.conversations.textStreamUrl({ serviceId: 'service-id', token:
 const socket = new WebSocket(url)
 ```
 
+### Real-time event streams
+
+For workspace-wide events (calls, surfaces, pipeline, operators, channels), use the typed SSE consumer:
+
+```typescript
+const handle = client.events.subscribeToWorkspace({
+  onEvent: (event) => {
+    switch (event.event_type) {
+      case 'call.started': console.log('call started:', event.call_sid); break
+      case 'pipeline.error': console.error('pipeline error:', event); break
+    }
+  },
+  onError: (err) => console.error('terminal:', err),
+  onReconnect: (attempt) => console.warn(`reconnect #${attempt}`),
+})
+
+// Later: handle.unsubscribe(); await handle.done
+```
+
+The helper handles automatic reconnect (exp backoff with jitter, server-sent
+`retry:` honored), gapless replay via `Last-Event-ID`, and discriminated-union
+dispatch. Server emits a structured `error` frame with a stable `code` on
+terminal failures — narrow with the typed error guard:
+
+```typescript
+import { isWorkspaceEventStreamError } from '@amigo-ai/platform-sdk'
+
+onError: (err) => {
+  if (isWorkspaceEventStreamError(err)) {
+    if (err.code === 'too_many_streams') {
+      // workspace has too many open streams; close another tab
+    } else if (err.retryable) {
+      // SDK already retried up to maxReconnects; safe to try again later
+    }
+  }
+}
+```
+
+For per-call voice observation (`agent_transcript_delta`, `latency`, `session_*`,
+`participant_*`, etc.), use the WebSocket-based observer helper:
+
+```typescript
+const observerHandle = client.observers.subscribe({
+  callSid: 'CAxxx',
+  token: bearerToken,
+  onEvent: (event) => {
+    switch (event.type) {
+      case 'agent_transcript_delta': renderAgentDelta(event.delta); break
+      case 'session_end': showSummary(event); break
+    }
+  },
+  onError: (err) => console.error('observer terminal:', err.reason, err.closeCode),
+})
+```
+
+Both helpers are built on the shared `ReconnectingWebSocket` primitive, which
+maps platform-specific WebSocket close codes (4001 client error, 4029 rate
+limit, 4403 auth, 4100 token expired) to a typed reason taxonomy and applies an
+idle watchdog (default 45s) so a half-dead socket forces a reconnect rather
+than hanging indefinitely. Compose it directly via `createReconnectingWebSocket`
+when you need a managed WebSocket outside these resources.
+
 ### Analytics
 
 ```typescript

package/api.md

@@ -66,7 +66,6 @@ All workspace-scoped resources also expose `withOptions(options)`.
 
 ### `workspaces`
 
-- `createSelfService`
 - `list`
 - `listAutoPaging`
 - `get`
@@ -75,6 +74,12 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `provision`
 - `checkEnvironment`
 - `convertEnvironment`
+- `testCallerNumbers.get`
+- `testCallerNumbers.update`
+
+### `me`
+
+- `createWorkspace`
 
 ### `apiKeys`
 
@@ -230,6 +235,9 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `getBenchmarks`
 - `getPhoneVolume`
 - `getTraceAnalysis`
+- `listTraces`
+- `getMetrics`
+- `createOutbound`
 
 ### `conversations`
 
@@ -282,6 +290,10 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `getOperatorPerformance`
 - `getAdvancedCallStats`
 - `compareCallPeriods`
+- `surfaces.getCompletionRates`
+- `surfaces.getChannelEffectiveness`
+- `surfaces.getFieldAbandonment`
+- `surfaces.getForEntity`
 
 ### `simulations`
 
@@ -291,6 +303,18 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `step`
 - `recommend`
 - `getIntelligence`
+- `runs.list`
+- `runs.create`
+- `runs.get`
+- `runs.complete`
+- `runs.createSession`
+- `bridge.plan`
+- `bridge.run`
+- `services.getGraph`
+- `services.deleteGraph`
+- `services.getGraphPaths`
+- `services.listSessions`
+- `services.listTurns`
 
 ### `metrics`
 
@@ -317,6 +341,8 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `behaviors.update`
 - `gapScanner.get`
 - `gapScanner.update`
+- `gapScanner.preview`
+- `gapScanner.scan`
 - `scribe.get`
 - `scribe.update`
 - `metrics.get`
@@ -434,4 +460,147 @@ All workspace-scoped resources also expose `withOptions(options)`.
 
 - `subscribe`
 
+### `fhir`
+
+- `getStatus`
+- `getSyncFailures`
+- `import`
+- `searchPatients`
+- `getPatientSummary`
+- `getPatientTimeline`
+- `resources.search`
+- `resources.create`
+- `resources.get`
+- `resources.update`
+- `resources.getHistory`
+- `views.patients`
+- `views.appointments`
+- `views.practitioners`
+- `views.organizations`
+- `views.locations`
+- `views.slots`
+
+### `insights`
+
+- `getDigest`
+- `getSchema`
+- `getSuggestions`
+- `runSql`
+- `sessions.create`
+- `sessions.get`
+- `sessions.chat`
+
+### `monitorConcepts`
+
+- `create`
+- `list`
+- `listAutoPaging`
+- `get`
+- `update`
+- `delete`
+
+### `unificationRules`
+
+- `create`
+- `list`
+- `listAutoPaging`
+- `get`
+- `update`
+- `delete`
+
+### `crm`
+
+- `getStatus`
+- `contacts.list`
+- `contacts.get`
+- `contacts.getTimeline`
+- `companies.list`
+- `companies.get`
+- `deals.list`
+- `deals.get`
+- `deals.getPipeline`
+
+### `commandCenter`
+
+- `get`
+
+### `sensorium`
+
+- `getConnectorHealth`
+- `getLoopLatency`
+
+### `dataQuery`
+
+- `run`
+
+### `briefs`
+
+- `get`
+- `regenerate`
+- `getForEntity`
+- `regenerateForEntity`
+
+### `desktopSessions`
+
+- `create`
+- `disconnect`
+- `sendAction`
+- `getScreenshot`
+- `getStatus`
+
+### `intake`
+
+- `links.list`
+- `links.create`
+- `links.delete`
+- `links.listUploads`
+- `links.downloadUpload`
+
+### `network`
+
+- `getEgressIps`
+
+### `pipeline`
+
+- `getStatus`
+- `getThroughput`
+- `getReview`
+- `getEntityResolution`
+- `outbound.list`
+- `outbound.getLog`
+- `sources.list`
+- `sources.getOverview`
+- `sources.listEvents`
+- `sources.getHistory`
+
+### `tasks`
+
+- `get`
+- `listByCall`
+
+### `tools`
+
+- `execute`
+- `resolveForService`
+
+### `surfaces`
+
+- `list`
+- `listAutoPaging`
+- `listForReview`
+- `create`
+- `get`
+- `update`
+- `archive`
+- `deliver`
+- `getProgress`
+- `approve`
+- `reject`
+- `reshape`
+
+### `sessions`
+
+- `listActive`
+- `inject`
+
 ### `api`