Merge pull request #39 from gleanwork/speakeasy-sdk-regen-1749236901

chore: 🐝 Update SDK - Generate 0.5.3

Author: rwjblue-glean

.speakeasy/gen.lock

@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 664aaca5-a41f-4434-8f2a-642dba92fe68
 management:
-  docChecksum: d74f93d052b62c1709b537bca6b5e9cb
+  docChecksum: a0748babeea2c91be038da9e477a97f3
   docVersion: 0.9.0
   speakeasyVersion: 1.551.0
   generationVersion: 2.610.0
-  releaseVersion: 0.5.1
-  configChecksum: 7a534d2eb610053ed728cbb280131186
+  releaseVersion: 0.5.3
+  configChecksum: f4be71cf1dbe0f8d7bc0a4f061b7c9ce
   repoURL: https://github.com/gleanwork/api-client-typescript.git
   installationURL: https://github.com/gleanwork/api-client-typescript
   published: true
@@ -2225,7 +2225,7 @@ examples:
         query: {}
       responses:
         "200":
-          application/json: {"agent_id": "<id>", "name": "<value>", "capabilities": {}}
+          application/json: {"agent_id": "mho4lwzylcozgoc2", "name": "HR Policy Agent", "description": "This agent answers questions about the current company HR policies.", "capabilities": {}}
   getAgentSchemas:
     speakeasy-default-get-agent-schemas:
       parameters:
@@ -2234,14 +2234,14 @@ examples:
         query: {}
       responses:
         "200":
-          application/json: {"agent_id": "<id>", "input_schema": {}, "output_schema": {}}
+          application/json: {"agent_id": "mho4lwzylcozgoc2", "input_schema": {}, "output_schema": {}}
   searchAgents:
     speakeasy-default-search-agents:
       requestBody:
-        application/json: {}
+        application/json: {"name": "HR Policy Agent"}
       responses:
         "200":
-          application/json: {}
+          application/json: {"agents": [{"agent_id": "mho4lwzylcozgoc2", "name": "HR Policy Agent", "description": "This agent answers questions about the current company HR policies.", "capabilities": {}}]}
   createAndStreamRun:
     speakeasy-default-create-and-stream-run:
       requestBody:

.speakeasy/gen.yaml

@@ -25,13 +25,14 @@ generation:
     generateNewTests: true
     skipResponseBodyAssertions: true
 typescript:
-  version: 0.5.1
+  version: 0.5.3
   additionalDependencies:
     dependencies: {}
     devDependencies: {}
     peerDependencies: {}
   additionalPackageJSON: {}
   author: Speakeasy
+  baseErrorName: GleanBaseError
   clientServerStatusCodesAsErrors: true
   defaultErrorName: GleanError
   enableCustomCodeRegions: false

.speakeasy/glean-merged-spec.yaml

@@ -756,8 +756,8 @@ paths:
         get:
             tags:
                 - Agents
-            summary: Get Agent
-            description: Get an agent by ID. This endpoint implements the LangChain Agent Protocol, specifically part of the Agents stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/agents/GET/agents/{agent_id}). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol.
+            summary: Retrieve an agent
+            description: Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder.
             operationId: getAgent
             x-visibility: Preview
             parameters:
@@ -795,8 +795,8 @@ paths:
         get:
             tags:
                 - Agents
-            summary: Get Agent Schemas
-            description: Get an agent's schemas by ID. This endpoint implements the LangChain Agent Protocol, specifically part of the Agents stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/agents/GET/agents/{agent_id}/schemas). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol.
+            summary: List an agent's schemas
+            description: Return [agent](https://developers.glean.com/agents/agents-api)'s input and output schemas. You can use these schemas to detect changes to an agent's input or output structure.
             operationId: getAgentSchemas
             x-visibility: Preview
             parameters:
@@ -840,8 +840,8 @@ paths:
         post:
             tags:
                 - Agents
-            summary: Search Agents
-            description: List Agents available in this service. This endpoint implements the LangChain Agent Protocol, specifically part of the Agents stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/agents/POST/agents/search). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol.
+            summary: Search agents
+            description: "Search for [agents](https://developers.glean.com/agents/agents-api) by agent name. "
             operationId: searchAgents
             x-visibility: Preview
             requestBody:
@@ -881,8 +881,8 @@ paths:
         post:
             tags:
                 - Agents
-            summary: Create Run, Stream Output
-            description: Creates and triggers a run of an agent. Streams the output in SSE format. This endpoint implements the LangChain Agent Protocol, specifically part of the Runs stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/runs/POST/runs/stream). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol. Note that running agents that reference third party platform write actions is unsupported as it requires user confirmation.
+            summary: Create an agent run and stream the response
+            description: Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE).
             operationId: createAndStreamRun
             x-visibility: Preview
             requestBody:
@@ -898,12 +898,23 @@ paths:
                         text/event-stream:
                             schema:
                                 type: string
-                                description: |-
-                                    The server will send a stream of events in SSE format.
-                                    **Example event**:
+                                description: The server will send a stream of events in server-sent events (SSE) format.
+                                example: |
                                     id: 1
                                     event: message
-                                    data: {}
+                                    data: {"messages":[{"role":"GLEAN_AI","content":[{"text":"Hello","type":"text"}]}]}
+
+                                    id: 2
+                                    event: message
+                                    data: {"messages":[{"role":"GLEAN_AI","content":[{"text":",","type":"text"}]}]}
+
+                                    id: 3
+                                    event: message
+                                    data: {"messages":[{"role":"GLEAN_AI","content":[{"text":" I'm","type":"text"}]}]}
+
+                                    id: 4
+                                    event: message
+                                    data: {"messages":[{"role":"GLEAN_AI","content":[{"text":" your","type":"text"}]}]}
                 "400":
                     description: Bad request
                 "403":
@@ -934,8 +945,8 @@ paths:
         post:
             tags:
                 - Agents
-            summary: Create Run, Wait for Output
-            description: Creates and triggers a run of an agent. Waits for final output and then returns it. This endpoint implements the LangChain Agent Protocol, specifically part of the Runs stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/runs/POST/runs/wait). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol. Note that running agents that reference third party platform write actions is unsupported as it requires user confirmation.
+            summary: Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
+            description: Executes an agent run and returns the final response.
             operationId: createAndWaitRun
             x-visibility: Preview
             requestBody:
@@ -7417,31 +7428,38 @@ components:
                     type: string
                     title: Agent Id
                     description: The ID of the agent.
+                    example: mho4lwzylcozgoc2
                 name:
                     type: string
                     title: Agent Name
                     description: The name of the agent
+                    example: HR Policy Agent
                 description:
                     type: string
                     title: Description
                     description: The description of the agent.
+                    example: This agent answers questions about the current company HR policies.
                 metadata:
                     type: object
                     title: Metadata
-                    description: The agent metadata.
+                    description: The agent metadata. Currently not implemented.
                 capabilities:
                     type: object
                     title: Agent Capabilities
-                    description: Describes which protocol features the agent supports. In addition to the standard capabilities (prefixed with ap.), implementations can declare custom capabilities, named in reverse domain notation (eg. com.example.some.capability).
+                    description: |-
+                        Describes features that the agent supports. example: {
+                          "ap.io.messages": true,
+                          "ap.io.streaming": true
+                        }
                     properties:
                         ap.io.messages:
                             type: boolean
                             title: Messages
-                            description: Whether the agent supports Messages as input/output/state. If true, the agent uses the `messages` key in threads/runs endpoints.
+                            description: Whether the agent supports messages as an input. If true, you'll pass `messages` as an input when running the agent.
                         ap.io.streaming:
                             type: boolean
                             title: Streaming
-                            description: Whether the agent supports streaming output.
+                            description: Whether the agent supports streaming output. If true, you you can stream agent ouput. All agents currently support streaming.
                     additionalProperties: true
         ErrorResponse:
             type: string
@@ -7453,14 +7471,15 @@ components:
                     type: string
                     title: Agent Id
                     description: The ID of the agent.
+                    example: mho4lwzylcozgoc2
                 input_schema:
                     type: object
                     title: Input Schema
-                    description: The schema for the agent input. In JSON Schema format.
+                    description: The schema for the agent input. In JSON schema format.
                 output_schema:
                     type: object
                     title: Output Schema
-                    description: The schema for the agent output. In JSON Schema format.
+                    description: The schema for the agent output. In JSON schema format.
             type: object
             required:
                 - agent_id
@@ -7473,7 +7492,8 @@ components:
             properties:
                 name:
                     type: string
-                    description: Filters on the name of the agent. If empty, acts as no filter.
+                    description: Filters on the name of the agent. The keyword search is case-insensitive. If search string is ommited or empty, acts as no filter.
+                    example: HR Policy Agent
         SearchAgentsResponse:
             type: object
             title: Response Search Agents
@@ -9272,11 +9292,16 @@ components:
                 runCount:
                     $ref: "#/components/schemas/CountInfo"
                     description: This tracks how many times this prompt template was run. If user runs a prompt template after modifying the original one, it still counts as a run for the original template.
-        WorkflowMutableProperties:
+        WorkflowDraftableProperties:
             properties:
                 name:
                     type: string
                     description: The name of the workflow.
+        WorkflowMutableProperties:
+            type: object
+            allOf:
+                - $ref: "#/components/schemas/WorkflowDraftableProperties"
+                - type: object
         WorkflowMetadata:
             allOf:
                 - type: object

.speakeasy/workflow.lock

@@ -2,11 +2,11 @@ speakeasyVersion: 1.551.0
 sources:
     Glean API:
         sourceNamespace: glean-api-specs
-        sourceRevisionDigest: sha256:8fa342ea4c0f50e32d7b0930df581e4f4ec000f1f36a429c40f6ccc3f72c0b6b
-        sourceBlobDigest: sha256:914ea4a50d56c4ac1ef7a111f11756bfd8c21bd1c652b817b729ca8706a0afc7
+        sourceRevisionDigest: sha256:927ebf4c072ddb7d9c4a9501c375fb01ecf9f95a3b50fc73205f2c30e5863107
+        sourceBlobDigest: sha256:552c782f3b9cf6ed461abfbed82233620b573fa3c71fcb6d59dc5a02efd43d35
         tags:
             - latest
-            - speakeasy-sdk-regen-1748395012
+            - speakeasy-sdk-regen-1749236901
     Glean Client API:
         sourceNamespace: glean-client-api
         sourceRevisionDigest: sha256:aec0770b5bcca91068c3a844cb9ef4a091281f6cc3b7d86f2abef1bd6fb2b301
@@ -18,10 +18,10 @@ targets:
     glean:
         source: Glean API
         sourceNamespace: glean-api-specs
-        sourceRevisionDigest: sha256:8fa342ea4c0f50e32d7b0930df581e4f4ec000f1f36a429c40f6ccc3f72c0b6b
-        sourceBlobDigest: sha256:914ea4a50d56c4ac1ef7a111f11756bfd8c21bd1c652b817b729ca8706a0afc7
+        sourceRevisionDigest: sha256:927ebf4c072ddb7d9c4a9501c375fb01ecf9f95a3b50fc73205f2c30e5863107
+        sourceBlobDigest: sha256:552c782f3b9cf6ed461abfbed82233620b573fa3c71fcb6d59dc5a02efd43d35
         codeSamplesNamespace: glean-api-specs-typescript-code-samples
-        codeSamplesRevisionDigest: sha256:98fc3865b8edb43487025b2b2df71f33e5df2af1d85792cf4127e9ce074924a5
+        codeSamplesRevisionDigest: sha256:dbf79590683cfb44f7bb0df22c57219f427a10eb32febfbee5bcd60154d06655
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

README.md

@@ -293,11 +293,11 @@ For more information on obtaining the appropriate token type, please contact you
 
 #### [client.agents](docs/sdks/agents/README.md)
 
-* [retrieve](docs/sdks/agents/README.md#retrieve) - Get Agent
-* [retrieveSchemas](docs/sdks/agents/README.md#retrieveschemas) - Get Agent Schemas
-* [list](docs/sdks/agents/README.md#list) - Search Agents
-* [runStream](docs/sdks/agents/README.md#runstream) - Create Run, Stream Output
-* [run](docs/sdks/agents/README.md#run) - Create Run, Wait for Output
+* [retrieve](docs/sdks/agents/README.md#retrieve) - Retrieve an agent
+* [retrieveSchemas](docs/sdks/agents/README.md#retrieveschemas) - List an agent's schemas
+* [list](docs/sdks/agents/README.md#list) - Search agents
+* [runStream](docs/sdks/agents/README.md#runstream) - Create an agent run and stream the response
+* [run](docs/sdks/agents/README.md#run) - Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
 
 #### [client.announcements](docs/sdks/announcements/README.md)
 
@@ -508,11 +508,11 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 - [`clientActivityFeedback`](docs/sdks/activity/README.md#feedback) - Report client activity
 - [`clientActivityReport`](docs/sdks/activity/README.md#report) - Report document activity
-- [`clientAgentsList`](docs/sdks/agents/README.md#list) - Search Agents
-- [`clientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Get Agent
-- [`clientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - Get Agent Schemas
-- [`clientAgentsRun`](docs/sdks/agents/README.md#run) - Create Run, Wait for Output
-- [`clientAgentsRunStream`](docs/sdks/agents/README.md#runstream) - Create Run, Stream Output
+- [`clientAgentsList`](docs/sdks/agents/README.md#list) - Search agents
+- [`clientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Retrieve an agent
+- [`clientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - List an agent's schemas
+- [`clientAgentsRun`](docs/sdks/agents/README.md#run) - Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
+- [`clientAgentsRunStream`](docs/sdks/agents/README.md#runstream) - Create an agent run and stream the response
 - [`clientAnnouncementsCreate`](docs/sdks/announcements/README.md#create) - Create Announcement
 - [`clientAnnouncementsDelete`](docs/sdks/announcements/README.md#delete) - Delete Announcement
 - [`clientAnnouncementsUpdate`](docs/sdks/announcements/README.md#update) - Update Announcement
@@ -647,11 +647,11 @@ To learn about this feature and how to get started, check
 
 - [`useClientActivityFeedbackMutation`](docs/sdks/activity/README.md#feedback) - Report client activity
 - [`useClientActivityReportMutation`](docs/sdks/activity/README.md#report) - Report document activity
-- [`useClientAgentsListMutation`](docs/sdks/agents/README.md#list) - Search Agents
-- [`useClientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Get Agent
-- [`useClientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - Get Agent Schemas
-- [`useClientAgentsRunMutation`](docs/sdks/agents/README.md#run) - Create Run, Wait for Output
-- [`useClientAgentsRunStreamMutation`](docs/sdks/agents/README.md#runstream) - Create Run, Stream Output
+- [`useClientAgentsListMutation`](docs/sdks/agents/README.md#list) - Search agents
+- [`useClientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Retrieve an agent
+- [`useClientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - List an agent's schemas
+- [`useClientAgentsRunMutation`](docs/sdks/agents/README.md#run) - Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
+- [`useClientAgentsRunStreamMutation`](docs/sdks/agents/README.md#runstream) - Create an agent run and stream the response
 - [`useClientAnnouncementsCreateMutation`](docs/sdks/announcements/README.md#create) - Create Announcement
 - [`useClientAnnouncementsDeleteMutation`](docs/sdks/announcements/README.md#delete) - Delete Announcement
 - [`useClientAnnouncementsUpdateMutation`](docs/sdks/announcements/README.md#update) - Update Announcement

RELEASES.md

@@ -168,4 +168,14 @@ Based on:
 ### Generated
 - [typescript v0.5.1] .
 ### Releases
-- [NPM v0.5.1] https://www.npmjs.com/package/@gleanwork/api-client/v/0.5.1 - .
+- [NPM v0.5.1] https://www.npmjs.com/package/@gleanwork/api-client/v/0.5.1 - .
+
+## 2025-06-06 19:43:32
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.551.0 (2.610.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.5.3] .
+### Releases
+- [NPM v0.5.3] https://www.npmjs.com/package/@gleanwork/api-client/v/0.5.3 - .