@knowledge-stack/ksapi 1.82.0 → 1.84.0

package/docs/PathPartApprovalDecision.md

@@ -0,0 +1,33 @@
+
+# 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.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { PathPartApprovalDecision } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies PathPartApprovalDecision
+
+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 PathPartApprovalDecision
+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/PathPartApprovalResponse.md

@@ -0,0 +1,55 @@
+
+# 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.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`runId` | string
+`pathPartId` | string
+`status` | [PathPartApprovalDecision](PathPartApprovalDecision.md)
+`reviewerId` | string
+`reviewedAt` | Date
+`rejectionReason` | string
+`unapprovedBy` | string
+`unapprovedAt` | Date
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+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,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies PathPartApprovalResponse
+
+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 PathPartApprovalResponse
+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/PathPartsApi.md

@@ -4,16 +4,95 @@ All URIs are relative to *http://localhost:8000*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**appendPathPartEvent**](PathPartsApi.md#appendpathpartevent) | **POST** /v1/path-parts/{path_part_id}/events | Append Path Part Event Handler |
 | [**bulkRemovePathPartTags**](PathPartsApi.md#bulkremovepathparttags) | **DELETE** /v1/path-parts/{path_part_id}/tags | Bulk Remove Path Part Tags Handler |
 | [**getPathPart**](PathPartsApi.md#getpathpart) | **GET** /v1/path-parts/{path_part_id} | Get Path Part Handler |
 | [**getPathPartAncestry**](PathPartsApi.md#getpathpartancestry) | **GET** /v1/path-parts/{path_part_id}/ancestry | Get Path Part Ancestry Handler |
 | [**getPathPartSubtreeChunks**](PathPartsApi.md#getpathpartsubtreechunks) | **GET** /v1/path-parts/{path_part_id}/subtree_chunks | Get Path Part Subtree Chunks Handler |
 | [**getPathPartTags**](PathPartsApi.md#getpathparttags) | **GET** /v1/path-parts/{path_part_id}/tags | Get Path Part Tags Handler |
+| [**listPathPartEvents**](PathPartsApi.md#listpathpartevents) | **GET** /v1/path-parts/{path_part_id}/events | List Path Part Events Handler |
 | [**listPathParts**](PathPartsApi.md#listpathparts) | **GET** /v1/path-parts | List Path Parts Handler |
 | [**setPathPartTags**](PathPartsApi.md#setpathparttags) | **POST** /v1/path-parts/{path_part_id}/tags | Set Path Part Tags Handler |
 
 
 
+## appendPathPartEvent
+
+> EventResponse appendPathPartEvent(pathPartId, appendEventRequest, authorization, ksUat)
+
+Append Path Part Event Handler
+
+Record an event for a subject path_part from the frontend.  Auth: caller must hold ``can_write`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Server stamps ``actor_user_id`` from the caller\'s identity — callers cannot impersonate other users on the audit trail.  ``kind`` is free-form text but reserved server namespaces (``workflow.``, ``document.``, ``folder.``, ``permission.``, ``connector.``, ``query.``, ``auth.``, ``tenant.``) are rejected at 422 so clients cannot forge server-emitted audit events. Clients should namespace under ``client.*``. ``payload`` is capped at 64KB encoded JSON.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PathPartsApi,
+} from '@knowledge-stack/ksapi';
+import type { AppendPathPartEventRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new PathPartsApi();
+
+  const body = {
+    // string
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // AppendEventRequest
+    appendEventRequest: ...,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies AppendPathPartEventRequest;
+
+  try {
+    const data = await api.appendPathPartEvent(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`] |
+| **appendEventRequest** | [AppendEventRequest](AppendEventRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**EventResponse**](EventResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **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)
+
+
 ## bulkRemovePathPartTags
 
 > PathPartTagsResponse bulkRemovePathPartTags(pathPartId, bulkTagRequest, authorization, ksUat)
@@ -390,6 +469,98 @@ 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)
 
 
+## listPathPartEvents
+
+> PaginatedResponseEventResponse listPathPartEvents(pathPartId, kind, since, until, recursive, limit, offset, authorization, ksUat)
+
+List Path Part Events Handler
+
+List events anchored to a specific path_part subject.  Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated.  When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PathPartsApi,
+} from '@knowledge-stack/ksapi';
+import type { ListPathPartEventsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new PathPartsApi();
+
+  const body = {
+    // string
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Filter to a single event kind (optional)
+    kind: kind_example,
+    // Date | Only events at or after this timestamp (optional)
+    since: 2013-10-20T19:20:30+01:00,
+    // Date | Only events strictly before this timestamp (optional)
+    until: 2013-10-20T19:20:30+01:00,
+    // boolean | Include events from descendant path_parts as well as the subject itself (optional)
+    recursive: true,
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ListPathPartEventsRequest;
+
+  try {
+    const data = await api.listPathPartEvents(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`] |
+| **kind** | `string` | Filter to a single event kind | [Optional] [Defaults to `undefined`] |
+| **since** | `Date` | Only events at or after this timestamp | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Only events strictly before this timestamp | [Optional] [Defaults to `undefined`] |
+| **recursive** | `boolean` | Include events from descendant path_parts as well as the subject itself | [Optional] [Defaults to `false`] |
+| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedResponseEventResponse**](PaginatedResponseEventResponse.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)
+
+
 ## listPathParts
 
 > PaginatedResponsePathPartResponse listPathParts(parentPathId, maxDepth, sortOrder, limit, offset, authorization, ksUat)

package/docs/RejectFileRequest.md

@@ -0,0 +1,35 @@
+
+# RejectFileRequest
+
+Body for ``POST /workflow-runs/{run}/files/{file}/reject``.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`reason` | string
+
+## Example
+
+```typescript
+import type { RejectFileRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "reason": null,
+} satisfies RejectFileRequest
+
+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 RejectFileRequest
+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/RunLockResponse.md

@@ -0,0 +1,39 @@
+
+# RunLockResponse
+
+Reviewer-lock state on a workflow run.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`runId` | string
+`lockUserId` | string
+`lockAcquiredAt` | Date
+
+## Example
+
+```typescript
+import type { RunLockResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "runId": null,
+  "lockUserId": null,
+  "lockAcquiredAt": null,
+} satisfies RunLockResponse
+
+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 RunLockResponse
+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/UpdateWorkflowDefinitionRequest.md

@@ -17,6 +17,7 @@ Name | Type
 `outputPathPartIds` | Array<string>
 `templatePathPartId` | string
 `isActive` | boolean
+`approvalRequired` | boolean
 
 ## Example
 
@@ -35,6 +36,7 @@ const example = {
   "outputPathPartIds": null,
   "templatePathPartId": null,
   "isActive": null,
+  "approvalRequired": null,
 } satisfies UpdateWorkflowDefinitionRequest
 
 console.log(example)

package/docs/WorkflowDefinitionResponse.md

@@ -18,6 +18,7 @@ Name | Type
 `outputPathPartIds` | Array<string>
 `templatePathPartId` | string
 `isActive` | boolean
+`approvalRequired` | boolean
 `createdAt` | Date
 `updatedAt` | Date
 
@@ -39,6 +40,7 @@ const example = {
   "outputPathPartIds": null,
   "templatePathPartId": null,
   "isActive": null,
+  "approvalRequired": null,
   "createdAt": null,
   "updatedAt": null,
 } satisfies WorkflowDefinitionResponse