@amigo-ai/platform-sdk 0.56.0 → 0.58.0

package/README.md

@@ -126,6 +126,56 @@ const client = new AmigoClient({ apiKey: result.accessToken, workspaceId: result
 
 See [`examples/auth/device-code-login.ts`](./examples/auth/device-code-login.ts) for a complete working example.
 
+### Exchange an API key for a JWT
+
+Use `client.tokens.exchangeApiKey()` to swap a long-lived API key for a
+short-lived identity-issued JWT. This is useful when you want to mint a
+narrowly scoped, time-bound token from a privileged server (for example to
+forward to a browser via a BFF proxy, or to call the platform from a runtime
+that can't safely hold the raw API key).
+
+The call posts to `POST /token` on the configured `baseUrl` and is **not**
+workspace-scoped — `workspaceId` is still required on the client because it
+governs every other resource call on the same instance, but `POST /token`
+itself ignores it. The SDK also unconditionally strips the configured
+`Authorization` header for this one request and sends the exchange key only
+as the `api_key` form field, so the configured client key is never sent over
+the wire on the exchange call.
+
+```typescript
+import { AmigoClient } from '@amigo-ai/platform-sdk'
+
+const apiKey = process.env.AMIGO_API_KEY
+const workspaceId = process.env.AMIGO_WORKSPACE_ID
+if (!apiKey || !workspaceId) {
+  throw new Error('AMIGO_API_KEY and AMIGO_WORKSPACE_ID must be set')
+}
+
+const client = new AmigoClient({ apiKey, workspaceId })
+
+const { access_token, expires_in, scope } = await client.tokens.exchangeApiKey({
+  apiKey,
+  // Optional: request a narrower scope on the issued JWT. Enforcement is
+  // server-side — the SDK just forwards the value as a form field.
+  scope: 'entities:read agents:read',
+})
+
+console.log(`Got JWT, expires in ${expires_in}s with scope "${scope}"`)
+
+// Use the JWT in a second client. JWTs are passed as `apiKey` — Bearer auth.
+const scopedClient = new AmigoClient({ apiKey: access_token, workspaceId })
+
+const { items: agents } = await scopedClient.agents.list({ limit: 5 })
+console.log(agents.map((agent) => agent.name))
+```
+
+The response is the standard OAuth-style token payload (`access_token`,
+`token_type`, `expires_in`, `scope`, plus optional `session_id` /
+`refresh_token` when applicable). The `apiKey` you pass to
+`exchangeApiKey()` can be a different key than the one configured on the
+client — the configured key is not used to authenticate the exchange
+request itself.
+
 ## Configuration
 
 | Option        | Type           | Required | Description                                                          |
@@ -280,6 +330,19 @@ const client = new AmigoClient({
 
 ## Resources
 
+### Tokens
+
+Exchange a long-lived API key for a short-lived identity-issued JWT. See
+[Exchange an API key for a JWT](#exchange-an-api-key-for-a-jwt) under
+Authentication for the full walkthrough.
+
+```typescript
+const { access_token, expires_in } = await client.tokens.exchangeApiKey({
+  apiKey: process.env.AMIGO_API_KEY!,
+  scope: 'entities:read agents:read',
+})
+```
+
 ### Agents
 
 ```typescript
@@ -715,15 +778,18 @@ const fn = await client.functions.get('my-function')
 const result = await client.functions.test('my-function', { input: { query: 'test' } })
 ```
 
-### Webhook Destinations
+### Workspace Data Queries
 
 ```typescript
-const dest = await client.webhookDestinations.create({
-  name: 'My Webhook',
-  url: 'https://example.com/webhook',
-  events: ['call.completed'],
+const query = await client.workspaceDataQueries.create({
+  name: 'recent_orders',
+  description: 'Recent orders by status',
+  sql_template: 'select * from custom.orders where status = :status',
+  parameters: [{ name: 'status', type: 'string', description: 'Order status' }],
+})
+const result = await client.workspaceDataQueries.invoke(query.id, {
+  input: { status: 'open' },
 })
-const deliveries = await client.webhookDestinations.listDeliveries(dest.id)
 ```
 
 ## Webhook Verification

package/api.md

@@ -90,6 +90,10 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `revoke`
 - `rotate`
 
+### `tokens`
+
+- `exchangeApiKey`
+
 ### `agents`
 
 - `create`
@@ -221,11 +225,6 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `getTimeline`
 - `getTimelineAutoPaging`
 - `getSyncStatusBySink`
-- `listSyncEvents`
-- `listSyncEventsAutoPaging`
-- `getSyncQueueDepth`
-- `retrySyncEvent`
-- `retryAllSyncEvents`
 - `getStats`
 - `getSourceBreakdown`
 
@@ -275,9 +274,13 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `get`
 - `update`
 - `delete`
+- `listEndpoints`
+- `listEndpointsAutoPaging`
+- `getEndpoint`
+- `createEndpoint`
+- `updateEndpoint`
+- `deleteEndpoint`
 - `testEndpoint`
-- `testConnection`
-- `getHealthCheck`
 
 ### `analytics`
 
@@ -339,8 +342,6 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `memory.update`
 - `retention.get`
 - `retention.update`
-- `behaviors.get`
-- `behaviors.update`
 - `gapScanner.get`
 - `gapScanner.update`
 - `gapScanner.preview`
@@ -349,8 +350,6 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `metrics.update`
 - `environments.get`
 - `environments.update`
-- `workflows.get`
-- `workflows.update`
 
 ### `billing`
 
@@ -409,18 +408,6 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `getEntityAccessLog`
 - `getEntityAccessLogAutoPaging`
 
-### `webhookDestinations`
-
-- `list`
-- `listAutoPaging`
-- `create`
-- `get`
-- `update`
-- `delete`
-- `listDeliveries`
-- `listDeliveriesAutoPaging`
-- `rotateSecret`
-
 ### `compliance`
 
 - `getDashboard`
@@ -447,7 +434,6 @@ All workspace-scoped resources also expose `withOptions(options)`.
 ### `fhir`
 
 - `getStatus`
-- `getSyncFailures`
 - `import`
 - `searchPatients`
 - `getPatientSummary`
@@ -574,4 +560,13 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `deleteQueryTool`
 - `testQueryTool`
 
+### `workspaceDataQueries`
+
+- `list`
+- `create`
+- `get`
+- `update`
+- `delete`
+- `invoke`
+
 ### `api`

package/dist/core/branded-types.js

@@ -9,6 +9,7 @@ export const contextGraphId = (id) => id;
 export const callId = (id) => id;
 export const phoneNumberId = (id) => id;
 export const integrationId = (id) => id;
+export const integrationEndpointId = (id) => id;
 export const entityId = (id) => id;
 export const eventId = (id) => id;
 export const surfaceId = (id) => id;

package/dist/core/branded-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"branded-types.js","sourceRoot":"","sources":["../../src/core/branded-types.ts"],"names":[],"mappings":"AA+BA,uBAAuB;AACvB,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,EAAU,EAAe,EAAE,CAAC,EAAiB,CAAA;AACzE,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAY,EAAE,CAAC,EAAc,CAAA;AAChE,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,EAAU,EAAW,EAAE,CAAC,EAAa,CAAA;AAC7D,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,EAAU,EAAW,EAAE,CAAC,EAAa,CAAA;AAC7D,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAY,EAAE,CAAC,EAAc,CAAA;AAChE,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,EAAU,EAAa,EAAE,CAAC,EAAe,CAAA;AACnE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,EAAU,EAAkB,EAAE,CAAC,EAAoB,CAAA;AAClF,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,EAAU,EAAU,EAAE,CAAC,EAAY,CAAA;AAC1D,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,EAAU,EAAiB,EAAE,CAAC,EAAmB,CAAA;AAC/E,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,EAAU,EAAiB,EAAE,CAAC,EAAmB,CAAA;AAC/E,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAY,EAAE,CAAC,EAAc,CAAA;AAChE,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,EAAU,EAAW,EAAE,CAAC,EAAa,CAAA;AAC7D,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,EAAU,EAAa,EAAE,CAAC,EAAe,CAAA;AACnE,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,EAAU,EAAc,EAAE,CAAC,EAAgB,CAAA;AACtE,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,EAAU,EAAa,EAAE,CAAC,EAAe,CAAA;AACnE,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,EAAU,EAAmB,EAAE,CAAC,EAAqB,CAAA;AACrF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,EAAU,EAAuB,EAAE,CAAC,EAAyB,CAAA;AACjG,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,EAAU,EAAmB,EAAE,CAAC,EAAqB,CAAA;AACrF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,EAAU,EAAc,EAAE,CAAC,EAAgB,CAAA;AACtE,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAAU,EAAgB,EAAE,CAAC,EAAkB,CAAA"}
+{"version":3,"file":"branded-types.js","sourceRoot":"","sources":["../../src/core/branded-types.ts"],"names":[],"mappings":"AAgCA,uBAAuB;AACvB,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,EAAU,EAAe,EAAE,CAAC,EAAiB,CAAA;AACzE,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAY,EAAE,CAAC,EAAc,CAAA;AAChE,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,EAAU,EAAW,EAAE,CAAC,EAAa,CAAA;AAC7D,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,EAAU,EAAW,EAAE,CAAC,EAAa,CAAA;AAC7D,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAY,EAAE,CAAC,EAAc,CAAA;AAChE,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,EAAU,EAAa,EAAE,CAAC,EAAe,CAAA;AACnE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,EAAU,EAAkB,EAAE,CAAC,EAAoB,CAAA;AAClF,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,EAAU,EAAU,EAAE,CAAC,EAAY,CAAA;AAC1D,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,EAAU,EAAiB,EAAE,CAAC,EAAmB,CAAA;AAC/E,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,EAAU,EAAiB,EAAE,CAAC,EAAmB,CAAA;AAC/E,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,EAAU,EAAyB,EAAE,CACzE,EAA2B,CAAA;AAC7B,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAY,EAAE,CAAC,EAAc,CAAA;AAChE,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,EAAU,EAAW,EAAE,CAAC,EAAa,CAAA;AAC7D,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,EAAU,EAAa,EAAE,CAAC,EAAe,CAAA;AACnE,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,EAAU,EAAc,EAAE,CAAC,EAAgB,CAAA;AACtE,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,EAAU,EAAa,EAAE,CAAC,EAAe,CAAA;AACnE,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,EAAU,EAAmB,EAAE,CAAC,EAAqB,CAAA;AACrF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,EAAU,EAAuB,EAAE,CAAC,EAAyB,CAAA;AACjG,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,EAAU,EAAmB,EAAE,CAAC,EAAqB,CAAA;AACrF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,EAAU,EAAc,EAAE,CAAC,EAAgB,CAAA;AACtE,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAAU,EAAgB,EAAE,CAAC,EAAkB,CAAA"}