@amigo-ai/platform-sdk 0.99.0 → 0.101.0

package/dist/resources/runs.js

@@ -0,0 +1,100 @@
+import { WorkspaceScopedResource, extractData } from './base.js';
+/**
+ * Unified runs — the channel-neutral run backbone.
+ *
+ * Every agent trajectory is a Run: a conversation run (voice / text / sms /
+ * email / web, from Lakebase `world.conversations`) OR a framework run
+ * (claude-agent-sdk / openai-agents, from the Delta `world.runs` MV), federated
+ * behind one `Run` contract. This resource is the SDK surface for that backbone:
+ * list + summary + single-run detail + framework trajectory (reads), plus the
+ * run-scoped operator verbs (guidance / takeover / handback / switch-mode /
+ * access-token) addressed by the channel-neutral `run_id`.
+ *
+ * Distinct from {@link AgentRunsResource} (`/agent-runs`, framework-only) and the
+ * conversation surface (`/conversations`, conversation-only): neither spans the
+ * other, and only this resource speaks the unified `run_id`.
+ */
+export class RunsResource extends WorkspaceScopedResource {
+    /**
+     * Paginated, newest-first list of runs. `kind` / `channel` / `status` are
+     * multi-value OR-filters (repeat within an axis, AND across axes); `status`
+     * accepts the virtual `live` (running + paused). `continuationToken` is the
+     * opaque cursor from a prior page — round-trip it verbatim.
+     */
+    async list(params) {
+        return extractData(await this.client.GET('/v1/{workspace_id}/runs', {
+            params: {
+                path: { workspace_id: this.workspaceId },
+                query: {
+                    limit: params?.limit,
+                    continuation_token: params?.continuationToken,
+                    kind: params?.kind,
+                    channel: params?.channel,
+                    status: params?.status,
+                    sort_by: params?.sortBy,
+                },
+            },
+        }));
+    }
+    /** Aggregate run counts (total / live / by-status / by-kind). */
+    async summary(params) {
+        return extractData(await this.client.GET('/v1/{workspace_id}/runs/summary', {
+            params: {
+                path: { workspace_id: this.workspaceId },
+                query: { kind: params?.kind, channel: params?.channel },
+            },
+        }));
+    }
+    /** Resolve one run by its channel-neutral `run_id`, at any status. */
+    async get(runId) {
+        return extractData(await this.client.GET('/v1/{workspace_id}/runs/{run_id}', {
+            params: { path: { workspace_id: this.workspaceId, run_id: runId } },
+        }));
+    }
+    /**
+     * The ordered structural steps of a FRAMEWORK run's trajectory (perception /
+     * decision / tool / completion). 409 for conversation runs (they have per-turn
+     * detail via the conversation surface).
+     */
+    async trajectory(runId) {
+        return extractData(await this.client.GET('/v1/{workspace_id}/runs/{run_id}/trajectory', {
+            params: { path: { workspace_id: this.workspaceId, run_id: runId } },
+        }));
+    }
+    /** Send operator guidance to a LIVE run (the agent folds it into its next turn). */
+    async sendGuidance(runId, body) {
+        return extractData(await this.client.POST('/v1/{workspace_id}/runs/{run_id}/guidance', {
+            params: { path: { workspace_id: this.workspaceId, run_id: runId } },
+            body,
+        }));
+    }
+    /** Take a live run over (operator drives). Returns the audio-leg coordinates for voice. */
+    async takeOver(runId, body) {
+        return extractData(await this.client.POST('/v1/{workspace_id}/runs/{run_id}/takeover', {
+            params: { path: { workspace_id: this.workspaceId, run_id: runId } },
+            body,
+        }));
+    }
+    /** Hand a taken-over run back to the agent. */
+    async handBack(runId, body) {
+        return extractData(await this.client.POST('/v1/{workspace_id}/runs/{run_id}/handback', {
+            params: { path: { workspace_id: this.workspaceId, run_id: runId } },
+            body,
+        }));
+    }
+    /** Switch the operator's mode on a live run (listen ↔ takeover). */
+    async switchMode(runId, body) {
+        return extractData(await this.client.POST('/v1/{workspace_id}/runs/{run_id}/switch-mode', {
+            params: { path: { workspace_id: this.workspaceId, run_id: runId } },
+            body,
+        }));
+    }
+    /** Mint a run-scoped browser access token (voice takeover audio leg). */
+    async accessToken(runId, body) {
+        return extractData(await this.client.POST('/v1/{workspace_id}/runs/{run_id}/access-token', {
+            params: { path: { workspace_id: this.workspaceId, run_id: runId } },
+            body,
+        }));
+    }
+}
+//# sourceMappingURL=runs.js.map

package/dist/resources/runs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runs.js","sourceRoot":"","sources":["../../src/resources/runs.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEhE;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,YAAa,SAAQ,uBAAuB;IACvD;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,MAOV;QACC,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yBAAyB,EAAE;YAC/C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE;gBACxC,KAAK,EAAE;oBACL,KAAK,EAAE,MAAM,EAAE,KAAK;oBACpB,kBAAkB,EAAE,MAAM,EAAE,iBAAiB;oBAC7C,IAAI,EAAE,MAAM,EAAE,IAAI;oBAClB,OAAO,EAAE,MAAM,EAAE,OAAO;oBACxB,MAAM,EAAE,MAAM,EAAE,MAAM;oBACtB,OAAO,EAAE,MAAM,EAAE,MAAM;iBACxB;aACF;SACF,CAAC,CACH,CAAA;IACH,CAAC;IAED,iEAAiE;IACjE,KAAK,CAAC,OAAO,CAAC,MAGb;QACC,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iCAAiC,EAAE;YACvD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE;gBACxC,KAAK,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;aACxD;SACF,CAAC,CACH,CAAA;IACH,CAAC;IAED,sEAAsE;IACtE,KAAK,CAAC,GAAG,CAAC,KAAa;QACrB,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,kCAAkC,EAAE;YACxD,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;SACpE,CAAC,CACH,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,KAAa;QAC5B,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6CAA6C,EAAE;YACnE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;SACpE,CAAC,CACH,CAAA;IACH,CAAC;IAED,oFAAoF;IACpF,KAAK,CAAC,YAAY,CAAC,KAAa,EAAE,IAAiD;QACjF,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2CAA2C,EAAE;YAClE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;YACnE,IAAI;SACL,CAAC,CACH,CAAA;IACH,CAAC;IAED,2FAA2F;IAC3F,KAAK,CAAC,QAAQ,CAAC,KAAa,EAAE,IAAiD;QAC7E,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2CAA2C,EAAE;YAClE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;YACnE,IAAI;SACL,CAAC,CACH,CAAA;IACH,CAAC;IAED,+CAA+C;IAC/C,KAAK,CAAC,QAAQ,CAAC,KAAa,EAAE,IAAiD;QAC7E,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2CAA2C,EAAE;YAClE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;YACnE,IAAI;SACL,CAAC,CACH,CAAA;IACH,CAAC;IAED,oEAAoE;IACpE,KAAK,CAAC,UAAU,CAAC,KAAa,EAAE,IAAmD;QACjF,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,8CAA8C,EAAE;YACrE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;YACnE,IAAI;SACL,CAAC,CACH,CAAA;IACH,CAAC;IAED,yEAAyE;IACzE,KAAK,CAAC,WAAW,CAAC,KAAa,EAAE,IAAoD;QACnF,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,+CAA+C,EAAE;YACtE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;YACnE,IAAI;SACL,CAAC,CACH,CAAA;IACH,CAAC;CACF"}

package/dist/types/generated/api.d.ts

@@ -1311,6 +1311,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/{workspace_id}/api-keys/permission-catalog": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get the API-key role/permission catalog
+         * @description Return the authoritative role→permission model: each role's default permission set (what an API key of that role may carry) plus the full permission universe. Clients use this to build the create-key form instead of hard-coding the matrix. Requires `ApiKey.view` permission.
+         */
+        get: operations["get-api-key-permission-catalog"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/{workspace_id}/api-keys/{key_id}": {
         parameters: {
             query?: never;
@@ -3403,22 +3423,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /**
-         * Process Intake Batch
-         * @description Start processing a batch (idempotent + resumable). Dispatches only the
-         *     still-``received`` files, so re-running picks up any that weren't triggered:
-         *
-         *     * **Snapshot/CSV — ordered:** CDC depends on the prior curated baseline, so
-         *       only the lowest-version file fires now; each verdict chains the next via the
-         *       status write-back.
-         *     * **Documents — one batch run:** a single extract-job run processes every
-         *       received file (it pulls them from the processing-manifest). NOT one run-now
-         *       per file — that serialised on the request path and 504'd for large batches.
-         *
-         *     The batch rolls up to completed/failed (via the write-back) once every file
-         *     reaches a terminal verdict. Allowed from ``ready`` or ``processing`` (re-kick
-         *     a partially-dispatched batch); a terminal batch is a 409.
-         */
+        /** Process Intake Batch */
         post: operations["process_intake_batch_v1__workspace_id__intake_batches__batch_id__process_post"];
         delete?: never;
         options?: never;
@@ -3466,6 +3471,31 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/{workspace_id}/intake/datasets/{dataset}/update": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Update Intake Dataset
+         * @description Run the customer-facing dataset update flow.
+         *
+         *     This is the one-click orchestration path for the console: check mapped Drive
+         *     folders, prepare any newly landed files, and publish immediately when no
+         *     preparation is needed. If preparation is async, the run remains durable and
+         *     is advanced by file write-backs or by refresh.
+         */
+        post: operations["update_intake_dataset_v1__workspace_id__intake_datasets__dataset__update_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/{workspace_id}/intake/files": {
         parameters: {
             query?: never;
@@ -3725,6 +3755,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/{workspace_id}/intake/update-runs/{run_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get Intake Update Run */
+        get: operations["get_intake_update_run_v1__workspace_id__intake_update_runs__run_id__get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/{workspace_id}/integrations": {
         parameters: {
             query?: never;
@@ -5332,6 +5379,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/{workspace_id}/runs/{run_id}/trajectory": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a framework run's step-by-step trajectory
+         * @description Ordered structural steps (perception / decision / tool / completion) of a FRAMEWORK run, read from the durable Delta trace source by the run's correlation id. 404 if the run does not exist in this workspace; 409 if the run is a conversation run (use ``/conversations/{id}`` for per-turn detail).
+         */
+        get: operations["get_run_trajectory_v1__workspace_id__runs__run_id__trajectory_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/{workspace_id}/scheduling-rule-sets": {
         parameters: {
             query?: never;
@@ -12976,6 +13043,34 @@ export interface components {
             /** Schema Version */
             schema_version: string;
         };
+        /**
+         * DatasetUpdateRunResponse
+         * @description Durable status for one dataset update action.
+         */
+        DatasetUpdateRunResponse: {
+            /** Batch Ids */
+            batch_ids: string[];
+            /** Completed At */
+            completed_at?: string | null;
+            /** Created At */
+            created_at: string;
+            /** Dataset */
+            dataset: string;
+            /** Error */
+            error?: string | null;
+            /** Materialize Run Id */
+            materialize_run_id?: number | null;
+            /**
+             * Run Id
+             * Format: uuid
+             */
+            run_id: string;
+            /** Source Ids */
+            source_ids: string[];
+            status: components["schemas"]["_DatasetUpdateStatus"];
+            /** Updated At */
+            updated_at: string;
+        };
         /**
          * DecisionFactor
          * @description A specific audio input that drove an agent decision.
@@ -19675,6 +19770,32 @@ export interface components {
              */
             workspace_id: string;
         };
+        /**
+         * PermissionCatalogResponse
+         * @description The authoritative role→permission model for API-key creation.
+         *
+         *     Serves the server-side source of truth (``DEFAULT_ROLE_DEFINITIONS``) so
+         *     clients (console, SDK) stop hand-copying the matrix and drifting out of
+         *     sync — a drift previously shipped `Data:Query` as a viewer default and
+         *     made the default create flow 422. Human-facing labels/descriptions for
+         *     individual permissions stay client-side (pure presentation); this payload
+         *     is authorization truth only.
+         */
+        PermissionCatalogResponse: {
+            /** Permissions */
+            permissions: components["schemas"]["PermissionEntry"][];
+            /** Roles */
+            roles: components["schemas"]["RoleEntry"][];
+        };
+        /** PermissionEntry */
+        PermissionEntry: {
+            /** Action */
+            action: string;
+            /** Name */
+            name: string;
+            /** Namespace */
+            namespace: string;
+        };
         PhoneE164: string;
         /** PhoneNumberCallVolume */
         PhoneNumberCallVolume: {
@@ -21083,6 +21204,17 @@ export interface components {
              */
             level?: "low" | "medium" | "high" | "critical";
         };
+        /** RoleEntry */
+        RoleEntry: {
+            /** Description */
+            description: string;
+            /** Name */
+            name: string;
+            /** Permission Names */
+            permission_names: string[];
+            /** Priority */
+            priority: number;
+        };
         /** RoleGrantItem */
         RoleGrantItem: {
             access: components["schemas"]["_Access"];
@@ -21401,6 +21533,13 @@ export interface components {
              */
             run_id: string;
         };
+        /** RunTrajectoryResponse */
+        RunTrajectoryResponse: {
+            /** Steps */
+            steps: components["schemas"]["TrajectoryStep"][];
+            /** Truncated */
+            truncated: boolean;
+        };
         /** RunsResponse */
         RunsResponse: {
             /** Continuation Token */
@@ -25797,6 +25936,36 @@ export interface components {
              */
             resourceSpans: components["schemas"]["ResourceSpans"][];
         };
+        /**
+         * TrajectoryStep
+         * @description One structural step of a framework run's trajectory. Fields are best-effort
+         *     (only those the step actually carries are present), all optional, and free ``str``
+         *     for the same read-model resilience the ``Run`` descriptive fields use.
+         */
+        TrajectoryStep: {
+            /** Actor */
+            actor?: string | null;
+            /** Decision From State */
+            decision_from_state?: string | null;
+            /** Decision To State */
+            decision_to_state?: string | null;
+            /** Effective At */
+            effective_at?: string | null;
+            /** Kind */
+            kind?: string | null;
+            /** Seq */
+            seq?: number | null;
+            /** State */
+            state?: string | null;
+            /** Tool Input Summary */
+            tool_input_summary?: string | null;
+            /** Tool Name */
+            tool_name?: string | null;
+            /** Tool Result Summary */
+            tool_result_summary?: string | null;
+            /** Tool Succeeded */
+            tool_succeeded?: boolean | null;
+        };
         /** TranscriptSegment */
         TranscriptSegment: {
             /** Confidence */
@@ -27816,6 +27985,8 @@ export interface components {
         /** @enum {string} */
         _Access: "read" | "write";
         _DatasetSlug: string;
+        /** @enum {string} */
+        _DatasetUpdateStatus: "checking_drive" | "preparing" | "publishing" | "completed" | "needs_review" | "failed";
         /**
          * _DayHours
          * @description Open-hours window for one weekday. Times in 24h ``HH:MM`` form,
@@ -32167,6 +32338,42 @@ export interface operations {
             };
         };
     };
+    "get-api-key-permission-catalog": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PermissionCatalogResponse"];
+                };
+            };
+            /** @description Missing or invalid API key. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Insufficient permissions. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     "delete-api-key": {
         parameters: {
             query?: never;
@@ -37411,6 +37618,38 @@ export interface operations {
             };
         };
     };
+    update_intake_dataset_v1__workspace_id__intake_datasets__dataset__update_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+                dataset: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DatasetUpdateRunResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     list_intake_files_v1__workspace_id__intake_files_get: {
         parameters: {
             query?: {
@@ -37980,6 +38219,38 @@ export interface operations {
             };
         };
     };
+    get_intake_update_run_v1__workspace_id__intake_update_runs__run_id__get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+                run_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DatasetUpdateRunResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     "list-integrations": {
         parameters: {
             query?: {
@@ -41717,6 +41988,38 @@ export interface operations {
             };
         };
     };
+    get_run_trajectory_v1__workspace_id__runs__run_id__trajectory_get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+                run_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RunTrajectoryResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     "list-scheduling-rule-sets": {
         parameters: {
             query?: {