@amigo-ai/platform-sdk 0.85.0 → 0.86.0

package/dist/resources/use-cases.js

@@ -0,0 +1,58 @@
+import { WorkspaceScopedResource, extractData } from './base.js';
+/**
+ * Channel use cases — voice/email/SMS/iMessage channel setup, workspace
+ * ownership, and the service binding that activates a use case for runtime
+ * traffic.
+ */
+export class UseCasesResource extends WorkspaceScopedResource {
+    /** List use cases in the workspace, optionally filtered by entity/channel/setup. */
+    async list(params) {
+        return extractData(await this.client.GET('/v1/{workspace_id}/use-cases', {
+            params: { path: { workspace_id: this.workspaceId }, query: params },
+        }));
+    }
+    /** List channel-manager use case IDs owned by the current workspace. */
+    async listOwned() {
+        return extractData(await this.client.GET('/v1/{workspace_id}/use-cases/ownership', {
+            params: { path: { workspace_id: this.workspaceId } },
+        }));
+    }
+    /** Return this workspace's ownership record for a use case. Throws NotFoundError if unowned. */
+    async getOwnership(useCaseId) {
+        return extractData(await this.client.GET('/v1/{workspace_id}/use-cases/{use_case_id}/ownership', {
+            params: { path: { workspace_id: this.workspaceId, use_case_id: useCaseId } },
+        }));
+    }
+    /** Claim ownership of a channel-manager use case for this workspace. */
+    async assignOwnership(useCaseId) {
+        return extractData(await this.client.PUT('/v1/{workspace_id}/use-cases/{use_case_id}/ownership', {
+            params: { path: { workspace_id: this.workspaceId, use_case_id: useCaseId } },
+        }));
+    }
+    /** Release this workspace's ownership of a use case after unbinding services. */
+    async releaseOwnership(useCaseId) {
+        await this.client.DELETE('/v1/{workspace_id}/use-cases/{use_case_id}/ownership', {
+            params: { path: { workspace_id: this.workspaceId, use_case_id: useCaseId } },
+        });
+    }
+    /** Return the service currently bound to a use case. Throws NotFoundError if unbound. */
+    async getServiceBinding(useCaseId) {
+        return extractData(await this.client.GET('/v1/{workspace_id}/use-cases/{use_case_id}/service-binding', {
+            params: { path: { workspace_id: this.workspaceId, use_case_id: useCaseId } },
+        }));
+    }
+    /** Bind or rebind a use case to the platform service that should handle its traffic. */
+    async bindToService(useCaseId, body) {
+        return extractData(await this.client.PUT('/v1/{workspace_id}/use-cases/{use_case_id}/service-binding', {
+            params: { path: { workspace_id: this.workspaceId, use_case_id: useCaseId } },
+            body,
+        }));
+    }
+    /** Release a use case from its currently bound platform service. */
+    async unbindFromService(useCaseId) {
+        await this.client.DELETE('/v1/{workspace_id}/use-cases/{use_case_id}/service-binding', {
+            params: { path: { workspace_id: this.workspaceId, use_case_id: useCaseId } },
+        });
+    }
+}
+//# sourceMappingURL=use-cases.js.map

package/dist/resources/use-cases.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-cases.js","sourceRoot":"","sources":["../../src/resources/use-cases.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAYhE;;;;GAIG;AACH,MAAM,OAAO,gBAAiB,SAAQ,uBAAuB;IAC3D,oFAAoF;IACpF,KAAK,CAAC,IAAI,CAAC,MAA2B;QACpC,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,8BAA8B,EAAE;YACpD,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;SACpE,CAAC,CACH,CAAA;IACH,CAAC;IAED,wEAAwE;IACxE,KAAK,CAAC,SAAS;QACb,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,wCAAwC,EAAE;YAC9D,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE;SACrD,CAAC,CACH,CAAA;IACH,CAAC;IAED,gGAAgG;IAChG,KAAK,CAAC,YAAY,CAAC,SAAiB;QAClC,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,sDAAsD,EAAE;YAC5E,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE;SAC7E,CAAC,CACH,CAAA;IACH,CAAC;IAED,wEAAwE;IACxE,KAAK,CAAC,eAAe,CAAC,SAAiB;QACrC,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,sDAAsD,EAAE;YAC5E,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE;SAC7E,CAAC,CACH,CAAA;IACH,CAAC;IAED,iFAAiF;IACjF,KAAK,CAAC,gBAAgB,CAAC,SAAiB;QACtC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,sDAAsD,EAAE;YAC/E,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE;SAC7E,CAAC,CAAA;IACJ,CAAC;IAED,yFAAyF;IACzF,KAAK,CAAC,iBAAiB,CAAC,SAAiB;QACvC,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,4DAA4D,EAAE;YAClF,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE;SAC7E,CAAC,CACH,CAAA;IACH,CAAC;IAED,wFAAwF;IACxF,KAAK,CAAC,aAAa,CACjB,SAAiB,EACjB,IAA+B;QAE/B,OAAO,WAAW,CAChB,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,4DAA4D,EAAE;YAClF,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE;YAC5E,IAAI;SACL,CAAC,CACH,CAAA;IACH,CAAC;IAED,oEAAoE;IACpE,KAAK,CAAC,iBAAiB,CAAC,SAAiB;QACvC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,4DAA4D,EAAE;YACrF,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE;SAC7E,CAAC,CAAA;IACJ,CAAC;CACF"}

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

@@ -713,6 +713,80 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/{workspace_id}/agent-definitions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List Agent Definitions */
+        get: operations["list_agent_definitions_v1__workspace_id__agent_definitions_get"];
+        put?: never;
+        /** Register Agent Definition */
+        post: operations["register_agent_definition_v1__workspace_id__agent_definitions_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/{workspace_id}/agent-definitions/validate": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Validate Agent Definition
+         * @description Dry-run clamp validation — nothing is stored. 422 with the offending
+         *     paths on failure (the same shape push returns).
+         */
+        post: operations["validate_agent_definition_v1__workspace_id__agent_definitions_validate_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/{workspace_id}/agent-definitions/{definition_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get Agent Definition */
+        get: operations["get_agent_definition_v1__workspace_id__agent_definitions__definition_id__get"];
+        put?: never;
+        post?: never;
+        /** Archive Agent Definition */
+        delete: operations["archive_agent_definition_v1__workspace_id__agent_definitions__definition_id__delete"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/{workspace_id}/agent-definitions/{definition_id}/versions/{version}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get Agent Definition Version */
+        get: operations["get_agent_definition_version_v1__workspace_id__agent_definitions__definition_id__versions__version__get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/{workspace_id}/agent-runs": {
         parameters: {
             query?: never;
@@ -8152,6 +8226,97 @@ export interface components {
             /** Period */
             period?: string | null;
         };
+        /** AgentDefinitionDetail */
+        AgentDefinitionDetail: {
+            /**
+             * Definition Id
+             * Format: uuid
+             */
+            definition_id: string;
+            /**
+             * Framework
+             * @enum {string}
+             */
+            framework: "claude-agent-sdk" | "openai-agents" | "crewai";
+            /** Name */
+            name: string;
+            /**
+             * Status
+             * @enum {string}
+             */
+            status: "active" | "archived";
+            /** Versions */
+            versions: components["schemas"]["AgentDefinitionVersionMeta"][];
+        };
+        /** AgentDefinitionListResponse */
+        AgentDefinitionListResponse: {
+            /** Continuation Token */
+            continuation_token?: unknown;
+            /** Has More */
+            has_more: boolean;
+            /** Items */
+            items: components["schemas"]["AgentDefinitionSummary"][];
+        };
+        /** AgentDefinitionSummary */
+        AgentDefinitionSummary: {
+            /**
+             * Definition Id
+             * Format: uuid
+             */
+            definition_id: string;
+            /**
+             * Framework
+             * @enum {string}
+             */
+            framework: "claude-agent-sdk" | "openai-agents" | "crewai";
+            /** Name */
+            name: string;
+            /**
+             * Status
+             * @enum {string}
+             */
+            status: "active" | "archived";
+        };
+        /** AgentDefinitionVersionDetail */
+        AgentDefinitionVersionDetail: {
+            /** Agent Count */
+            agent_count: number;
+            /** Body */
+            body: {
+                [key: string]: unknown;
+            };
+            /** Body Sha256 */
+            body_sha256: string;
+            /**
+             * Definition Id
+             * Format: uuid
+             */
+            definition_id: string;
+            /**
+             * Framework
+             * @enum {string}
+             */
+            framework: "claude-agent-sdk" | "openai-agents" | "crewai";
+            /** Has Write Tools */
+            has_write_tools: boolean;
+            /** Validator Rev */
+            validator_rev: string;
+            /** Version */
+            version: number;
+        };
+        /** AgentDefinitionVersionMeta */
+        AgentDefinitionVersionMeta: {
+            /** Agent Count */
+            agent_count: number;
+            /** Body Sha256 */
+            body_sha256: string;
+            /** Has Write Tools */
+            has_write_tools: boolean;
+            /** Validator Rev */
+            validator_rev: string;
+            /** Version */
+            version: number;
+        };
         /** AgentResponse */
         AgentResponse: {
             /**
@@ -11177,20 +11342,21 @@ export interface components {
         CreateAgentRunRequest: {
             /**
              * Framework
-             * @description Agent framework the run executes on — runs unmodified in the framework's own design.
-             * @enum {string}
+             * @description Framework a PLATFORM run executes on. For a native run the framework comes from the definition.
              */
-            framework: "claude-agent-sdk" | "openai-agents";
+            framework?: ("claude-agent-sdk" | "openai-agents") | null;
             /**
              * Message
              * @description User message the framework agent is invoked with.
              */
             message: string;
+            /** @description Run a native (bring-your-own) agent definition instead of a platform service. */
+            native?: components["schemas"]["NativeRunRef"] | null;
             /**
              * Service Id
-             * Format: uuid
+             * @description Platform-authored run: the service whose pinned config the agent runs.
              */
-            service_id: string;
+            service_id?: string | null;
             /**
              * Timeout S
              * @description Server-side wall-clock budget for the run, in seconds (max 300).
@@ -11198,7 +11364,7 @@ export interface components {
              */
             timeout_s?: number;
             /**
-             * @description Named version set on the service whose pinned config the run uses.
+             * @description Named version set on the service whose pinned config the run uses (platform runs).
              * @default release
              */
             version_set?: components["schemas"]["NameString"];
@@ -16132,6 +16298,14 @@ export interface components {
              *     bumped the *same* document. Null for manual uploads and snapshot rows.
              */
             source_file_id?: string | null;
+            /**
+             * Source Folder Path
+             * @description Where the file lived within the mapped Drive folder tree (V279) — the
+             *     relative path, folder names joined by ``/`` (e.g. ``clinical/notes``); ``''``
+             *     at the mapped root. Lets the console show the original folder structure. Null
+             *     for manual uploads and snapshot rows.
+             */
+            source_folder_path?: string | null;
             /**
              * Source Type
              * @description Origin of the document this version belongs to — ``manual`` for console
@@ -17590,6 +17764,32 @@ export interface components {
             /** Version */
             version: string;
         };
+        /**
+         * NativeRunRef
+         * @description Run a customer-authored NATIVE agent definition (inc-10): a REGISTERED
+         *     definition by id (``version`` omitted = latest), or an INLINE body for
+         *     dev/playground iteration. The definition's own ``framework`` selects the
+         *     runtime — no top-level ``framework`` needed.
+         */
+        NativeRunRef: {
+            /**
+             * Definition Id
+             * @description Registered definition to run. Omit `version` for the latest.
+             */
+            definition_id?: string | null;
+            /**
+             * Inline
+             * @description Inline definition document (dev/playground). Validated by the platform clamp schema.
+             */
+            inline?: {
+                [key: string]: unknown;
+            } | null;
+            /**
+             * Version
+             * @description Pinned definition version; omit for latest.
+             */
+            version?: number | null;
+        };
         /** NavTimingEvent */
         NavTimingEvent: {
             /**
@@ -20162,6 +20362,44 @@ export interface components {
              */
             status?: "available";
         };
+        /** RegisterAgentDefinitionRequest */
+        RegisterAgentDefinitionRequest: {
+            /**
+             * Body
+             * @description The framework-native definition document (its 'framework' field selects the shape). Validated by the platform clamp schema — a non-whitelisted field is rejected.
+             */
+            body: {
+                [key: string]: unknown;
+            };
+            /** @description Stable slug identifying this definition within the workspace. */
+            name: components["schemas"]["SlugString"];
+        };
+        /** RegisterAgentDefinitionResponse */
+        RegisterAgentDefinitionResponse: {
+            /** Agent Count */
+            agent_count: number;
+            /** Body Sha256 */
+            body_sha256: string;
+            /**
+             * Created
+             * @description False when an identical body was already registered (idempotent push).
+             */
+            created: boolean;
+            /**
+             * Definition Id
+             * Format: uuid
+             */
+            definition_id: string;
+            /**
+             * Framework
+             * @enum {string}
+             */
+            framework: "claude-agent-sdk" | "openai-agents" | "crewai";
+            /** Has Write Tools */
+            has_write_tools: boolean;
+            /** Version */
+            version: number;
+        };
         /**
          * RegisterSchemaRequest
          * @description Create Schema payload (intake-ui-mvp-design.md §5.4, §5.9).
@@ -26405,6 +26643,23 @@ export interface components {
              */
             type: "user_transcript";
         };
+        /** ValidateAgentDefinitionResponse */
+        ValidateAgentDefinitionResponse: {
+            /** Agent Count */
+            agent_count: number;
+            /**
+             * Framework
+             * @enum {string}
+             */
+            framework: "claude-agent-sdk" | "openai-agents" | "crewai";
+            /** Has Write Tools */
+            has_write_tools: boolean;
+            /**
+             * Valid
+             * @constant
+             */
+            valid: true;
+        };
         /** ValidationError */
         ValidationError: {
             /** Context */
@@ -29758,6 +30013,207 @@ export interface operations {
             };
         };
     };
+    list_agent_definitions_v1__workspace_id__agent_definitions_get: {
+        parameters: {
+            query?: {
+                framework?: ("claude-agent-sdk" | "openai-agents" | "crewai") | null;
+                include_archived?: boolean;
+                limit?: number;
+                continuation_token?: unknown;
+            };
+            header?: never;
+            path: {
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AgentDefinitionListResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    register_agent_definition_v1__workspace_id__agent_definitions_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RegisterAgentDefinitionRequest"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RegisterAgentDefinitionResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    validate_agent_definition_v1__workspace_id__agent_definitions_validate_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RegisterAgentDefinitionRequest"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ValidateAgentDefinitionResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    get_agent_definition_v1__workspace_id__agent_definitions__definition_id__get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+                definition_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AgentDefinitionDetail"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    archive_agent_definition_v1__workspace_id__agent_definitions__definition_id__delete: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+                definition_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    get_agent_definition_version_v1__workspace_id__agent_definitions__definition_id__versions__version__get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+                definition_id: string;
+                version: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AgentDefinitionVersionDetail"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     create_agent_run_v1__workspace_id__agent_runs_post: {
         parameters: {
             query?: never;