@knowledge-stack/ksapi 1.88.1 → 1.90.0

package/docs/PathPartApprovalDecision.md

@@ -1,7 +1,7 @@
 
 # PathPartApprovalDecision
 
-Per-file review status within a run (SeaHonor pilot).  Now retained as the audit-history record (one row per (run, file)); the current state of truth is ``path_part.approval_state``. The service dual-writes both.
+Audit-row decision label.  The PG enum ``path_part_approval_decision`` carries a legacy ``\'rejected\'`` value that is intentionally NOT mapped here. It survives in the database as a noop — never written, never read. Loading a row whose column holds ``\'rejected\'`` will fail to decode; prod is empty of such rows.
 
 ## Properties
 

package/docs/PathPartApprovalResponse.md

@@ -1,21 +1,18 @@
 
 # PathPartApprovalResponse
 
-Approval audit-history row over any path_part (file or folder).  ``run_id`` is optional — None when the path_part was approved directly without a workflow-run context.
+Current approval decision over any path_part (file or folder).
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `id` | string
-`runId` | string
 `pathPartId` | string
 `status` | [PathPartApprovalDecision](PathPartApprovalDecision.md)
 `reviewerId` | string
 `reviewedAt` | Date
-`rejectionReason` | string
-`unapprovedBy` | string
-`unapprovedAt` | Date
+`reason` | string
 `createdAt` | Date
 `updatedAt` | Date
 
@@ -27,14 +24,11 @@ import type { PathPartApprovalResponse } from '@knowledge-stack/ksapi'
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "runId": null,
   "pathPartId": null,
   "status": null,
   "reviewerId": null,
   "reviewedAt": null,
-  "rejectionReason": null,
-  "unapprovedBy": null,
-  "unapprovedAt": null,
+  "reason": null,
   "createdAt": null,
   "updatedAt": null,
 } satisfies PathPartApprovalResponse

package/docs/{InvokeWorkflowRequest.md → PathPartApprovalState.md}

@@ -1,25 +1,21 @@
 
-# InvokeWorkflowRequest
+# PathPartApprovalState
 
-Request body for invoking a workflow definition.
+Approval state on any path_part.  The PG enum ``path_part_approval_state`` carries a legacy ``\'rejected\'`` value that is intentionally NOT mapped here. It survives in the database as a noop — never written, never read. Loading a row whose column holds ``\'rejected\'`` will fail to decode; prod is empty of such rows.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`idempotencyKey` | string
-`inputPathPartIds` | Array<string>
 
 ## Example
 
 ```typescript
-import type { InvokeWorkflowRequest } from '@knowledge-stack/ksapi'
+import type { PathPartApprovalState } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
-  "idempotencyKey": null,
-  "inputPathPartIds": null,
-} satisfies InvokeWorkflowRequest
+} satisfies PathPartApprovalState
 
 console.log(example)
 
@@ -28,7 +24,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as InvokeWorkflowRequest
+const exampleParsed = JSON.parse(exampleJSON) as PathPartApprovalState
 console.log(exampleParsed)
 ```
 

package/docs/PathPartApprovalsApi.md

@@ -0,0 +1,161 @@
+# PathPartApprovalsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getPathPartApproval**](PathPartApprovalsApi.md#getpathpartapproval) | **GET** /v1/path-parts/{path_part_id}/approval | Get Path Part Approval Handler |
+| [**setPathPartApproval**](PathPartApprovalsApi.md#setpathpartapproval) | **POST** /v1/path-parts/{path_part_id}/approval | Set Path Part Approval Handler |
+
+
+
+## getPathPartApproval
+
+> PathPartApprovalResponse getPathPartApproval(pathPartId, authorization, ksUat)
+
+Get Path Part Approval Handler
+
+Return the current approval audit row for a path_part.  Exposes ``reviewer_id`` / ``reason`` and the decision timestamps so a caller can re-read who decided what and why. 404 if the path_part never entered the approval flow (its ``approval_state`` is still ``not_required``).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PathPartApprovalsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetPathPartApprovalRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new PathPartApprovalsApi();
+
+  const body = {
+    // string
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetPathPartApprovalRequest;
+
+  try {
+    const data = await api.getPathPartApproval(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` |  | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PathPartApprovalResponse**](PathPartApprovalResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 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)
+
+
+## setPathPartApproval
+
+> PathPartApprovalResponse setPathPartApproval(pathPartId, setApprovalStateRequest, authorization, ksUat)
+
+Set Path Part Approval Handler
+
+Set the approval state on a path_part.  | current ↓ / target → | pending                  | approved                 | | -------------------- | ------------------------ | ------------------------ | | not_required         | 200 request              | 409                      | | pending              | 200 (returns current row)| 200 approve              | | approved             | 200 unapprove            | 200 (returns current row)|  ``reason`` is forwarded to whichever service method handles the transition and persisted on the audit row (for ``approved``) or captured in the corresponding event payload (for ``pending``).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PathPartApprovalsApi,
+} from '@knowledge-stack/ksapi';
+import type { SetPathPartApprovalRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new PathPartApprovalsApi();
+
+  const body = {
+    // string
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // SetApprovalStateRequest
+    setApprovalStateRequest: ...,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies SetPathPartApprovalRequest;
+
+  try {
+    const data = await api.setPathPartApproval(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` |  | [Defaults to `undefined`] |
+| **setApprovalStateRequest** | [SetApprovalStateRequest](SetApprovalStateRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PathPartApprovalResponse**](PathPartApprovalResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 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)
+

package/docs/PathPartsApi.md

@@ -567,7 +567,7 @@ No authorization required
 
 List Path Parts Handler
 
-List path parts (folders) under a parent with traversal.  This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts.  - If parent_path_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.  For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
+List path parts under a parent with traversal.  This is a generic endpoint for traversing the path hierarchy. It returns the navigable, container-like nodes of the tree: FOLDER, WORKFLOW_DEFINITION, and WORKFLOW_RUN path parts.  - If parent_path_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.  For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
 
 ### Example
 

package/docs/SectionContentItem.md

@@ -16,6 +16,7 @@ Name | Type
 `pageNumber` | number
 `materializedPath` | string
 `systemManaged` | boolean
+`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
 `createdAt` | Date
 `updatedAt` | Date
 
@@ -35,6 +36,7 @@ const example = {
   "pageNumber": null,
   "materializedPath": null,
   "systemManaged": null,
+  "approvalState": null,
   "createdAt": null,
   "updatedAt": null,
 } satisfies SectionContentItem

package/docs/SectionContentItemOrChunkContentItem.md

@@ -15,6 +15,7 @@ Name | Type
 `pageNumber` | number
 `materializedPath` | string
 `systemManaged` | boolean
+`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
 `createdAt` | Date
 `updatedAt` | Date
 `content` | string
@@ -37,6 +38,7 @@ const example = {
   "pageNumber": null,
   "materializedPath": null,
   "systemManaged": null,
+  "approvalState": null,
   "createdAt": null,
   "updatedAt": null,
   "content": null,

package/docs/SetApprovalStateRequest.md

@@ -0,0 +1,37 @@
+
+# SetApprovalStateRequest
+
+Body for ``POST /v1/path-parts/{path_part_id}/approval``.  Single endpoint covers every transition in the state machine:  * ``{state: \"pending\"}`` — request approval (from ``not_required``) OR   unapprove (from ``approved``). Server dispatches on current state. * ``{state: \"approved\", reason?}`` — approve. For folders, fails 409   if any descendant is still ``pending``. ``reason`` is an optional   reviewer note persisted on the audit row.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`state` | string
+`reason` | string
+
+## Example
+
+```typescript
+import type { SetApprovalStateRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "state": null,
+  "reason": null,
+} satisfies SetApprovalStateRequest
+
+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 SetApprovalStateRequest
+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/SetWorkflowRunApprovalRequest.md

@@ -0,0 +1,37 @@
+
+# SetWorkflowRunApprovalRequest
+
+Body for ``POST /v1/workflow-runs/{run_id}/approval``.  Approves an entire completed run in one call — every output document under ``outputs/`` plus the run folder itself. ``reason`` is an optional reviewer note persisted on each approval audit row.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`state` | string
+`reason` | string
+
+## Example
+
+```typescript
+import type { SetWorkflowRunApprovalRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "state": null,
+  "reason": null,
+} satisfies SetWorkflowRunApprovalRequest
+
+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 SetWorkflowRunApprovalRequest
+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/ThreadMessageResponse.md

@@ -1,7 +1,6 @@
 
 # ThreadMessageResponse
 
-Thread message response model.
 
 ## Properties
 
@@ -16,6 +15,7 @@ Name | Type
 `parentPathId` | string
 `materializedPath` | string
 `tenantId` | string
+`authorTenantUserId` | string
 `createdAt` | Date
 `updatedAt` | Date
 
@@ -35,6 +35,7 @@ const example = {
   "parentPathId": null,
   "materializedPath": null,
   "tenantId": null,
+  "authorTenantUserId": null,
   "createdAt": null,
   "updatedAt": null,
 } satisfies ThreadMessageResponse

package/docs/ThreadResponse.md

@@ -1,7 +1,6 @@
 
 # ThreadResponse
 
-Thread response model.
 
 ## Properties
 

package/docs/UpdateThreadRequest.md

@@ -1,7 +1,6 @@
 
 # UpdateThreadRequest
 
-Request to update a thread.
 
 ## Properties
 

package/docs/UpdateWorkflowDefinitionRequest.md

@@ -1,7 +1,7 @@
 
 # UpdateWorkflowDefinitionRequest
 
-Full replacement (PUT semantics).  ``instruction_path_part_ids``:  - ``KS_INTERNAL``: must remain ``len == 1`` (the auto-provisioned doc). - ``SELF_HOSTED``: ``len ≥ 1``; callers may swap or add documents.
+Full replacement (PUT semantics).
 
 ## Properties
 
@@ -9,13 +9,8 @@ Name | Type
 ------------ | -------------
 `name` | string
 `description` | string
-`runnerType` | [WorkflowRunnerType](WorkflowRunnerType.md)
-`runnerConfig` | [SelfHostedRunnerConfig](SelfHostedRunnerConfig.md)
 `maxRunDurationSeconds` | number
-`sourcePathPartIds` | Array<string>
-`instructionPathPartIds` | Array<string>
-`outputPathPartIds` | Array<string>
-`templatePathPartId` | string
+`instructionPathPartId` | string
 `isActive` | boolean
 `approvalRequired` | boolean
 
@@ -28,13 +23,8 @@ import type { UpdateWorkflowDefinitionRequest } from '@knowledge-stack/ksapi'
 const example = {
   "name": null,
   "description": null,
-  "runnerType": null,
-  "runnerConfig": null,
   "maxRunDurationSeconds": null,
-  "sourcePathPartIds": null,
-  "instructionPathPartIds": null,
-  "outputPathPartIds": null,
-  "templatePathPartId": null,
+  "instructionPathPartId": null,
   "isActive": null,
   "approvalRequired": null,
 } satisfies UpdateWorkflowDefinitionRequest

package/docs/UpdateWorkflowRunRequest.md

@@ -0,0 +1,37 @@
+
+# UpdateWorkflowRunRequest
+
+PATCH body for ``/v1/workflow-runs/{id}`` — NOT_STARTED runs only.  Both fields are optional. A body with both ``None`` is rejected as 400 (no-op PATCH). ``input_scope`` replaces the row\'s KB-ref list wholesale; ``name`` renames the run path_part (the trigger cascades ``materialized_path`` to every descendant).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`inputScope` | Array<string>
+`name` | string
+
+## Example
+
+```typescript
+import type { UpdateWorkflowRunRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "inputScope": null,
+  "name": null,
+} satisfies UpdateWorkflowRunRequest
+
+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 UpdateWorkflowRunRequest
+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/{RejectFileRequest.md → UserInfo.md}

@@ -1,23 +1,27 @@
 
-# RejectFileRequest
+# UserInfo
 
-Body for ``POST /workflow-runs/{run}/files/{file}/reject``.
+Minimal user identity for embedding on other responses.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`reason` | string
+`userId` | string
+`firstName` | string
+`lastName` | string
 
 ## Example
 
 ```typescript
-import type { RejectFileRequest } from '@knowledge-stack/ksapi'
+import type { UserInfo } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
-  "reason": null,
-} satisfies RejectFileRequest
+  "userId": null,
+  "firstName": null,
+  "lastName": null,
+} satisfies UserInfo
 
 console.log(example)
 
@@ -26,7 +30,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as RejectFileRequest
+const exampleParsed = JSON.parse(exampleJSON) as UserInfo
 console.log(exampleParsed)
 ```
 

package/docs/UserMessageRequest.md

@@ -1,7 +1,6 @@
 
 # UserMessageRequest
 
-Request to send a user message and trigger agent generation.
 
 ## Properties
 

package/docs/UserMessageResponse.md

@@ -1,7 +1,6 @@
 
 # UserMessageResponse
 
-202 response from POST /{thread_id}/user_message.
 
 ## Properties
 

package/docs/WorkflowDefinitionResponse.md

@@ -1,24 +1,25 @@
 
 # WorkflowDefinitionResponse
 
-Workflow definition response.
+Workflow definition response.  Doubles as a discriminated-union variant for folder-listing responses. The ``part_type`` literal is the discriminator: when the FE walks a folder tree it sees this shape mixed in with ``FolderResponse`` / ``DocumentResponse`` and can route to the dedicated workflow page based on ``part_type``.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
+`partType` | string
 `id` | string
+`pathPartId` | string
+`parentPathPartId` | string
+`materializedPath` | string
+`tenantId` | string
 `name` | string
 `description` | string
-`runnerType` | [WorkflowRunnerType](WorkflowRunnerType.md)
-`runnerConfig` | [SelfHostedRunnerConfigResponse](SelfHostedRunnerConfigResponse.md)
 `maxRunDurationSeconds` | number
-`sourcePathPartIds` | Array<string>
-`instructionPathPartIds` | Array<string>
-`outputPathPartIds` | Array<string>
-`templatePathPartId` | string
+`instructionPathPartId` | string
 `isActive` | boolean
 `approvalRequired` | boolean
+`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
 `createdAt` | Date
 `updatedAt` | Date
 
@@ -29,18 +30,19 @@ import type { WorkflowDefinitionResponse } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
+  "partType": null,
   "id": null,
+  "pathPartId": null,
+  "parentPathPartId": null,
+  "materializedPath": null,
+  "tenantId": null,
   "name": null,
   "description": null,
-  "runnerType": null,
-  "runnerConfig": null,
   "maxRunDurationSeconds": null,
-  "sourcePathPartIds": null,
-  "instructionPathPartIds": null,
-  "outputPathPartIds": null,
-  "templatePathPartId": null,
+  "instructionPathPartId": null,
   "isActive": null,
   "approvalRequired": null,
+  "approvalState": null,
   "createdAt": null,
   "updatedAt": null,
 } satisfies WorkflowDefinitionResponse