@amigo-ai/platform-sdk 0.5.2 → 0.5.3

package/README.md

@@ -36,14 +36,21 @@ The SDK is the typed client boundary between your runtime and the workspace-scop
 
 ## Documentation
 
-| Need                                        | Best entry point                                         |
-| ------------------------------------------- | -------------------------------------------------------- |
-| Product architecture and deployment context | [docs.amigo.ai](https://docs.amigo.ai/)                  |
+| Need                                        | Best entry point                                                                   |
+| ------------------------------------------- | ---------------------------------------------------------------------------------- |
+| Product architecture and deployment context | [docs.amigo.ai](https://docs.amigo.ai/)                                            |
 | Tutorials and integration guidance          | [Developer Guide](https://docs.amigo.ai/developer-guide/platform-api/platform-sdk) |
-| Endpoint-by-endpoint REST reference         | [API Reference](https://docs.amigo.ai/api-reference)     |
-| Repo-local SDK examples                     | [examples/README.md](./examples/README.md)               |
-| Generated package surface                   | [api.md](./api.md)                                       |
-| Published release history                   | [CHANGELOG.md](./CHANGELOG.md)                           |
+| Endpoint-by-endpoint REST reference         | [API Reference](https://docs.amigo.ai/api-reference)                               |
+| Repo-local SDK examples                     | [examples/README.md](./examples/README.md)                                         |
+| Generated package surface                   | [api.md](./api.md)                                                                 |
+| Published release history                   | [CHANGELOG.md](./CHANGELOG.md)                                                     |
+
+### Guides
+
+| Guide                                                              | Description                                                                     |
+| ------------------------------------------------------------------ | ------------------------------------------------------------------------------- |
+| [Build a Custom Patient Form](./docs/guides/build-a-form.md)       | Create, deliver, and render patient intake forms using surfaces                 |
+| [Build a Custom Clinical Copilot](./docs/guides/build-a-scribe.md) | Real-time ambient documentation with encounter review and voiceprint enrollment |
 
 The docs site remains the primary reference. The repo-local examples stay close to the shipped package surface and are typechecked in CI to reduce drift.
 
@@ -429,6 +436,73 @@ const memory = await client.settings.memory.get()
 console.log(memory.dimensions) // list of configured memory dimensions
 ```
 
+### Surfaces (Patient Forms)
+
+Surfaces are workspace-scoped form specs for collecting patient data. Create a form, deliver it via SMS or email, and track completion. See the full guide: [Build a Custom Patient Form](./docs/guides/build-a-form.md).
+
+```typescript
+// Create a patient intake form
+const surface = await client.POST('/v1/{workspace_id}/surfaces', {
+  body: {
+    entity_id: patientId,
+    title: 'New Patient Intake',
+    channel: 'sms',
+    fields: [
+      { key: 'full_name', label: 'Full Name', field_type: 'text', required: true },
+      { key: 'date_of_birth', label: 'Date of Birth', field_type: 'date', required: true },
+      {
+        key: 'allergies',
+        label: 'Allergies',
+        field_type: 'multiselect',
+        options: ['Penicillin', 'Sulfa', 'None'],
+      },
+    ],
+  },
+})
+console.log(surface.data.url) // Patient-facing token URL
+
+// Deliver via SMS
+await client.POST('/v1/{workspace_id}/surfaces/{surface_id}/deliver', {
+  params: { path: { surface_id: surface.data.id } },
+  body: { channel_address: '+15551234567' },
+})
+
+// Track completion
+const { data: rates } = await client.GET(
+  '/v1/{workspace_id}/analytics/surfaces/completion-rates',
+  {},
+)
+```
+
+Public token routes (`/s/{token}/spec`, `/s/{token}/submit`, etc.) require no API key -- use `openapi-fetch` with the SDK's `paths` type for full type safety on unauthenticated endpoints.
+
+### Scribe (Clinical Copilot)
+
+Build ambient clinical documentation tools. The SDK covers encounter review actions and scribe settings. The real-time copilot WebSocket (`/copilot-stream`) is documented in the full guide: [Build a Custom Clinical Copilot](./docs/guides/build-a-scribe.md).
+
+```typescript
+// Configure scribe settings
+const settings = await client.settings.scribe.get()
+await client.settings.scribe.update({ enabled: true, soap_style: 'detailed' })
+
+// Approve ICD-10 codes after physician review
+await client.POST('/v1/{workspace_id}/scribe/encounters/{encounter_id}/icd10/approve', {
+  params: { path: { encounter_id: encounterId } },
+  body: { code: 'J06.9' },
+})
+
+// Edit SOAP notes
+await client.POST('/v1/{workspace_id}/scribe/encounters/{encounter_id}/soap/edit', {
+  params: { path: { encounter_id: encounterId } },
+  body: { section: 'assessment', content: 'Acute upper respiratory infection...' },
+})
+
+// Finalize for EHR sync
+await client.POST('/v1/{workspace_id}/scribe/encounters/{encounter_id}/finalize', {
+  params: { path: { encounter_id: encounterId } },
+})
+```
+
 ### Billing
 
 ```typescript

package/api.md

@@ -65,6 +65,9 @@ All workspace-scoped resources also expose `withOptions(options)`.
 - `get`
 - `update`
 - `archive`
+- `provision`
+- `checkEnvironment`
+- `convertEnvironment`
 
 ### `apiKeys`
 

package/dist/index.cjs

@@ -744,7 +744,10 @@ var WorkspaceScopedResource = class {
       if (!page.has_more || page.continuation_token === null || page.continuation_token === void 0) {
         break;
       }
-      nextParams = { ...nextParams, continuation_token: page.continuation_token };
+      nextParams = {
+        ...nextParams,
+        continuation_token: page.continuation_token
+      };
     }
   }
   async *iterateOffsetPaginatedList(fetchPage, selectItems, params) {
@@ -890,6 +893,34 @@ var WorkspacesResource = class extends WorkspaceScopedResource {
       })
     );
   }
+  /** Provision a workspace (seed integrations, mark as provisioned) */
+  async provision(id) {
+    return extractData(
+      await this.client.POST("/v1/workspaces/{workspace_id}/provision", {
+        params: { path: { workspace_id: id ?? this.workspaceId } }
+      })
+    );
+  }
+  /** Pre-check environment conversion warnings */
+  async checkEnvironment(target, id) {
+    return extractData(
+      await this.client.GET("/v1/workspaces/{workspace_id}/environment-check", {
+        params: {
+          path: { workspace_id: id ?? this.workspaceId },
+          query: target ? { target } : void 0
+        }
+      })
+    );
+  }
+  /** Convert workspace between staging and production */
+  async convertEnvironment(body, id) {
+    return extractData(
+      await this.client.POST("/v1/workspaces/{workspace_id}/convert-environment", {
+        params: { path: { workspace_id: id ?? this.workspaceId } },
+        body
+      })
+    );
+  }
 };
 
 // src/resources/api-keys.ts
@@ -1143,7 +1174,11 @@ var OperatorsResource = class extends WorkspaceScopedResource {
     );
   }
   listAutoPaging(params) {
-    return this.iterateOffsetPaginatedList((pageParams) => this.list(pageParams), (page) => page.items, params);
+    return this.iterateOffsetPaginatedList(
+      (pageParams) => this.list(pageParams),
+      (page) => page.items,
+      params
+    );
   }
   async create(body) {
     return extractData(
@@ -2736,15 +2771,12 @@ var WebhookDestinationsResource = class extends WorkspaceScopedResource {
   }
   async listDeliveries(destinationId, params) {
     return extractData(
-      await this.client.GET(
-        "/v1/{workspace_id}/webhook-destinations/{destination_id}/deliveries",
-        {
-          params: {
-            path: { workspace_id: this.workspaceId, destination_id: destinationId },
-            query: params
-          }
+      await this.client.GET("/v1/{workspace_id}/webhook-destinations/{destination_id}/deliveries", {
+        params: {
+          path: { workspace_id: this.workspaceId, destination_id: destinationId },
+          query: params
         }
-      )
+      })
     );
   }
   listDeliveriesAutoPaging(destinationId, params) {