@knowledge-stack/ksapi 1.88.1 → 1.90.0

package/docs/WorkflowRunsApi.md

@@ -4,22 +4,23 @@ All URIs are relative to *http://localhost:8000*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**approveWorkflowRunFile**](WorkflowRunsApi.md#approveworkflowrunfile) | **POST** /v1/workflow-runs/{run_id}/files/{path_part_id}/approve | Approve Workflow Run File Handler |
+| [**cloneWorkflowRun**](WorkflowRunsApi.md#cloneworkflowrunoperation) | **POST** /v1/workflow-runs/{run_id}/clone | Clone Workflow Run Handler |
 | [**deleteWorkflowRun**](WorkflowRunsApi.md#deleteworkflowrun) | **DELETE** /v1/workflow-runs/{run_id} | Delete Workflow Run Handler |
 | [**getWorkflowRun**](WorkflowRunsApi.md#getworkflowrun) | **GET** /v1/workflow-runs/{run_id} | Get Workflow Run Handler |
-| [**rejectWorkflowRunFile**](WorkflowRunsApi.md#rejectworkflowrunfile) | **POST** /v1/workflow-runs/{run_id}/files/{path_part_id}/reject | Reject Workflow Run File Handler |
-| [**unapproveWorkflowRunFile**](WorkflowRunsApi.md#unapproveworkflowrunfile) | **POST** /v1/workflow-runs/{run_id}/files/{path_part_id}/unapprove | Unapprove Workflow Run File Handler |
+| [**setWorkflowRunApproval**](WorkflowRunsApi.md#setworkflowrunapprovaloperation) | **POST** /v1/workflow-runs/{run_id}/approval | Set Workflow Run Approval Handler |
+| [**startWorkflowRun**](WorkflowRunsApi.md#startworkflowrun) | **POST** /v1/workflow-runs/{run_id}/start | Start Workflow Run Handler |
+| [**updateWorkflowRun**](WorkflowRunsApi.md#updateworkflowrunoperation) | **PATCH** /v1/workflow-runs/{run_id} | Update Workflow Run Handler |
 | [**workflowRunCallback**](WorkflowRunsApi.md#workflowruncallbackoperation) | **POST** /v1/workflow-runs/{run_id}/callback | Workflow Run Callback Handler |
 
 
 
-## approveWorkflowRunFile
+## cloneWorkflowRun
 
-> PathPartApprovalResponse approveWorkflowRunFile(runId, pathPartId, authorization, ksUat)
+> WorkflowRunResponse cloneWorkflowRun(runId, cloneWorkflowRunRequest, authorization, ksUat)
 
-Approve Workflow Run File Handler
+Clone Workflow Run Handler
 
-Approve a generated file or the run folder itself.  Open to any user with ``can_write`` on the run path — both individual child files and the run folder (the final verdict that flips the run to APPROVED). Folder approval still requires no descendants in ``pending`` or ``rejected`` state.
+Clone a started run into a new NOT_STARTED draft.  ``include_inputs=True`` pins the source\'s snapshotted inputs onto the new run; uploads stay in the source\'s ``inputs/`` and are referenced by path_part_id. No S3 copy. A NOT_STARTED source has no snapshot to pin → 409. The clone is born NOT_STARTED so the user can edit it (PATCH) before pressing Start.
 
 ### Example
 
@@ -28,7 +29,7 @@ import {
   Configuration,
   WorkflowRunsApi,
 } from '@knowledge-stack/ksapi';
-import type { ApproveWorkflowRunFileRequest } from '@knowledge-stack/ksapi';
+import type { CloneWorkflowRunOperationRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
@@ -37,16 +38,16 @@ async function example() {
   const body = {
     // string
     runId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string
-    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // CloneWorkflowRunRequest
+    cloneWorkflowRunRequest: ...,
     // string (optional)
     authorization: authorization_example,
     // string (optional)
     ksUat: ksUat_example,
-  } satisfies ApproveWorkflowRunFileRequest;
+  } satisfies CloneWorkflowRunOperationRequest;
 
   try {
-    const data = await api.approveWorkflowRunFile(body);
+    const data = await api.cloneWorkflowRun(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -63,13 +64,13 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **runId** | `string` |  | [Defaults to `undefined`] |
-| **pathPartId** | `string` |  | [Defaults to `undefined`] |
+| **cloneWorkflowRunRequest** | [CloneWorkflowRunRequest](CloneWorkflowRunRequest.md) |  | |
 | **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
-[**PathPartApprovalResponse**](PathPartApprovalResponse.md)
+[**WorkflowRunResponse**](WorkflowRunResponse.md)
 
 ### Authorization
 
@@ -77,14 +78,14 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: `application/json`
 - **Accept**: `application/json`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Successful Response |  -  |
+| **201** | Successful Response |  -  |
 | **422** | Validation Error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
@@ -234,13 +235,13 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## rejectWorkflowRunFile
+## setWorkflowRunApproval
 
-> PathPartApprovalResponse rejectWorkflowRunFile(runId, pathPartId, rejectFileRequest, authorization, ksUat)
+> WorkflowRunResponse setWorkflowRunApproval(runId, setWorkflowRunApprovalRequest, authorization, ksUat)
 
-Reject Workflow Run File Handler
+Set Workflow Run Approval Handler
 
-Reject a generated file or the run folder itself with a reason.  Open to any user with ``can_write`` on the run path — both individual child files and the run folder (the final verdict that flips the run to REJECTED).
+Approve an entire completed run in one call.  Approves every output document under ``outputs/`` then the run folder. The run must be ``COMPLETED`` and its definition must have required approval. Requires write access to the run folder. ``run_id`` is the WorkflowRun id.
 
 ### Example
 
@@ -249,7 +250,7 @@ import {
   Configuration,
   WorkflowRunsApi,
 } from '@knowledge-stack/ksapi';
-import type { RejectWorkflowRunFileRequest } from '@knowledge-stack/ksapi';
+import type { SetWorkflowRunApprovalOperationRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
@@ -258,18 +259,16 @@ async function example() {
   const body = {
     // string
     runId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string
-    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // RejectFileRequest
-    rejectFileRequest: ...,
+    // SetWorkflowRunApprovalRequest
+    setWorkflowRunApprovalRequest: ...,
     // string (optional)
     authorization: authorization_example,
     // string (optional)
     ksUat: ksUat_example,
-  } satisfies RejectWorkflowRunFileRequest;
+  } satisfies SetWorkflowRunApprovalOperationRequest;
 
   try {
-    const data = await api.rejectWorkflowRunFile(body);
+    const data = await api.setWorkflowRunApproval(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -286,14 +285,13 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **runId** | `string` |  | [Defaults to `undefined`] |
-| **pathPartId** | `string` |  | [Defaults to `undefined`] |
-| **rejectFileRequest** | [RejectFileRequest](RejectFileRequest.md) |  | |
+| **setWorkflowRunApprovalRequest** | [SetWorkflowRunApprovalRequest](SetWorkflowRunApprovalRequest.md) |  | |
 | **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
-[**PathPartApprovalResponse**](PathPartApprovalResponse.md)
+[**WorkflowRunResponse**](WorkflowRunResponse.md)
 
 ### Authorization
 
@@ -314,13 +312,13 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## unapproveWorkflowRunFile
+## startWorkflowRun
 
-> PathPartApprovalResponse unapproveWorkflowRunFile(runId, pathPartId, authorization, ksUat)
+> WorkflowRunResponse startWorkflowRun(runId, authorization, ksUat)
 
-Unapprove Workflow Run File Handler
+Start Workflow Run Handler
 
-Revert an approved or rejected file to ``pending``.  Open to any user with ``can_write`` on the run path. Cannot unapprove a leaf whose ancestor is currently ``approved`` — unapprove the ancestor first.
+Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
 
 ### Example
 
@@ -329,7 +327,7 @@ import {
   Configuration,
   WorkflowRunsApi,
 } from '@knowledge-stack/ksapi';
-import type { UnapproveWorkflowRunFileRequest } from '@knowledge-stack/ksapi';
+import type { StartWorkflowRunRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
@@ -338,16 +336,14 @@ async function example() {
   const body = {
     // string
     runId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string
-    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string (optional)
     authorization: authorization_example,
     // string (optional)
     ksUat: ksUat_example,
-  } satisfies UnapproveWorkflowRunFileRequest;
+  } satisfies StartWorkflowRunRequest;
 
   try {
-    const data = await api.unapproveWorkflowRunFile(body);
+    const data = await api.startWorkflowRun(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -364,13 +360,12 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **runId** | `string` |  | [Defaults to `undefined`] |
-| **pathPartId** | `string` |  | [Defaults to `undefined`] |
 | **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
-[**PathPartApprovalResponse**](PathPartApprovalResponse.md)
+[**WorkflowRunResponse**](WorkflowRunResponse.md)
 
 ### Authorization
 
@@ -382,6 +377,83 @@ No authorization required
 - **Accept**: `application/json`
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateWorkflowRun
+
+> WorkflowRunResponse updateWorkflowRun(runId, updateWorkflowRunRequest, authorization, ksUat)
+
+Update Workflow Run Handler
+
+Edit a NOT_STARTED run\'s KB scope and / or display name.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowRunsApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateWorkflowRunOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new WorkflowRunsApi();
+
+  const body = {
+    // string
+    runId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateWorkflowRunRequest
+    updateWorkflowRunRequest: ...,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateWorkflowRunOperationRequest;
+
+  try {
+    const data = await api.updateWorkflowRun(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **runId** | `string` |  | [Defaults to `undefined`] |
+| **updateWorkflowRunRequest** | [UpdateWorkflowRunRequest](UpdateWorkflowRunRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**WorkflowRunResponse**](WorkflowRunResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
@@ -393,10 +465,12 @@ No authorization required
 
 ## workflowRunCallback
 
-> WorkflowCallbackResponse workflowRunCallback(runId, workflowRunCallbackRequest)
+> WorkflowCallbackResponse workflowRunCallback(runId, workflowRunCallbackRequest, authorization, ksUat)
 
 Workflow Run Callback Handler
 
+Terminal-state write seam for the in-process agent runner.  The gating Temporal activities ``mark_run_completed_activity`` and ``mark_run_failed_activity`` authenticate as the triggering user (via ``assume_user``) and POST here. Only the user who triggered the run (or OWNER/ADMIN) may write its terminal state. The handler is idempotent: a callback against an already-terminal row returns ``already_terminal`` and the activity-level retry treats it as a no-op.
+
 ### Example
 
 ```ts
@@ -415,6 +489,10 @@ async function example() {
     runId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // WorkflowRunCallbackRequest
     workflowRunCallbackRequest: ...,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
   } satisfies WorkflowRunCallbackOperationRequest;
 
   try {
@@ -436,6 +514,8 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **runId** | `string` |  | [Defaults to `undefined`] |
 | **workflowRunCallbackRequest** | [WorkflowRunCallbackRequest](WorkflowRunCallbackRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 

package/docs/{ListMemoryChunksResponse.md → XlsxCellAnchorInput.md}

@@ -1,22 +1,31 @@
 
-# ListMemoryChunksResponse
+# XlsxCellAnchorInput
 
+One citation anchored to a cell in an .xlsx deliverable.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`chunks` | [Array<MemoryChunkResponse>](MemoryChunkResponse.md)
+`type` | string
+`sheetName` | string
+`cellAddress` | string
+`citations` | [Array<CitedChunk>](CitedChunk.md)
+`anchorText` | string
 
 ## Example
 
 ```typescript
-import type { ListMemoryChunksResponse } from '@knowledge-stack/ksapi'
+import type { XlsxCellAnchorInput } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
-  "chunks": null,
-} satisfies ListMemoryChunksResponse
+  "type": null,
+  "sheetName": null,
+  "cellAddress": null,
+  "citations": null,
+  "anchorText": null,
+} satisfies XlsxCellAnchorInput
 
 console.log(example)
 
@@ -25,7 +34,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ListMemoryChunksResponse
+const exampleParsed = JSON.parse(exampleJSON) as XlsxCellAnchorInput
 console.log(exampleParsed)
 ```
 

package/docs/XlsxCellAnchorInputOrDocxParagraphAnchorInput.md

@@ -0,0 +1,46 @@
+
+# XlsxCellAnchorInputOrDocxParagraphAnchorInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`sheetName` | string
+`cellAddress` | string
+`citations` | [Array<CitedChunk>](CitedChunk.md)
+`anchorText` | string
+`paragraphIndex` | number
+`commentId` | number
+
+## Example
+
+```typescript
+import type { XlsxCellAnchorInputOrDocxParagraphAnchorInput } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "sheetName": null,
+  "cellAddress": null,
+  "citations": null,
+  "anchorText": null,
+  "paragraphIndex": null,
+  "commentId": null,
+} satisfies XlsxCellAnchorInputOrDocxParagraphAnchorInput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as XlsxCellAnchorInputOrDocxParagraphAnchorInput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/XlsxCellAnchorOutput.md

@@ -0,0 +1,45 @@
+
+# XlsxCellAnchorOutput
+
+One citation anchored to a cell in an .xlsx deliverable.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`sheetName` | string
+`cellAddress` | string
+`citations` | [Array<CitedChunk>](CitedChunk.md)
+`anchorText` | string
+`chunkIds` | Array<string>
+
+## Example
+
+```typescript
+import type { XlsxCellAnchorOutput } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "sheetName": null,
+  "cellAddress": null,
+  "citations": null,
+  "anchorText": null,
+  "chunkIds": null,
+} satisfies XlsxCellAnchorOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as XlsxCellAnchorOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.md

@@ -0,0 +1,48 @@
+
+# XlsxCellAnchorOutputOrDocxParagraphAnchorOutput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`sheetName` | string
+`cellAddress` | string
+`citations` | [Array<CitedChunk>](CitedChunk.md)
+`anchorText` | string
+`chunkIds` | Array<string>
+`paragraphIndex` | number
+`commentId` | number
+
+## Example
+
+```typescript
+import type { XlsxCellAnchorOutputOrDocxParagraphAnchorOutput } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "sheetName": null,
+  "cellAddress": null,
+  "citations": null,
+  "anchorText": null,
+  "chunkIds": null,
+  "paragraphIndex": null,
+  "commentId": null,
+} satisfies XlsxCellAnchorOutputOrDocxParagraphAnchorOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as XlsxCellAnchorOutputOrDocxParagraphAnchorOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.88.1",
+  "version": "1.90.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {