@knowledge-stack/ksapi 1.56.0 → 1.58.0

package/docs/WorkflowsApi.md

@@ -4,19 +4,21 @@ All URIs are relative to *http://localhost:8000*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**getWorkflow**](WorkflowsApi.md#getworkflow) | **GET** /v1/workflows/{workflow_id} | Get Workflow Handler |
-| [**listWorkflows**](WorkflowsApi.md#listworkflows) | **GET** /v1/workflows | List Workflows Handler |
-| [**workflowAction**](WorkflowsApi.md#workflowaction) | **POST** /v1/workflows/{workflow_id} | Workflow Action Handler |
+| [**cancelTemporalWorkflow**](WorkflowsApi.md#canceltemporalworkflow) | **DELETE** /v1/workflows/{workflow_id} | Cancel Temporal Workflow Handler |
+| [**dvWorkflowRerun**](WorkflowsApi.md#dvworkflowrerun) | **POST** /v1/workflows/document_versions/{workflow_id} | Dv Workflow Rerun Handler |
+| [**getDvWorkflow**](WorkflowsApi.md#getdvworkflow) | **GET** /v1/workflows/document_versions/{workflow_id} | Get Dv Workflow Handler |
+| [**getTemporalWorkflowStatus**](WorkflowsApi.md#gettemporalworkflowstatus) | **GET** /v1/workflows/{workflow_id} | Get Temporal Workflow Status Handler |
+| [**listDvWorkflows**](WorkflowsApi.md#listdvworkflows) | **GET** /v1/workflows/document_versions | List Dv Workflows Handler |
 
 
 
-## getWorkflow
+## cancelTemporalWorkflow
 
-> WorkflowDetailResponse getWorkflow(workflowId, authorization, ksUat)
+> WorkflowCancelResponse cancelTemporalWorkflow(workflowId, authorization, ksUat)
 
-Get Workflow Handler
+Cancel Temporal Workflow Handler
 
-Get single workflow detail with live Temporal status.
+Cancel any Temporal workflow owned by the caller\'s tenant.  No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side.
 
 ### Example
 
@@ -25,7 +27,7 @@ import {
   Configuration,
   WorkflowsApi,
 } from '@knowledge-stack/ksapi';
-import type { GetWorkflowRequest } from '@knowledge-stack/ksapi';
+import type { CancelTemporalWorkflowRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
@@ -38,10 +40,10 @@ async function example() {
     authorization: authorization_example,
     // string (optional)
     ksUat: ksUat_example,
-  } satisfies GetWorkflowRequest;
+  } satisfies CancelTemporalWorkflowRequest;
 
   try {
-    const data = await api.getWorkflow(body);
+    const data = await api.cancelTemporalWorkflow(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -63,7 +65,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**WorkflowDetailResponse**](WorkflowDetailResponse.md)
+[**WorkflowCancelResponse**](WorkflowCancelResponse.md)
 
 ### Authorization
 
@@ -84,13 +86,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)
 
 
-## listWorkflows
+## dvWorkflowRerun
 
-> PaginatedResponseWorkflowSummaryResponse listWorkflows(limit, offset, authorization, ksUat)
+> WorkflowActionResponse dvWorkflowRerun(workflowId, authorization, ksUat)
 
-List Workflows Handler
+Dv Workflow Rerun Handler
 
-List all workflows for the current tenant (paginated, DB-backed).
+Rerun a workflow. USER role requires ``can_write`` on the document path.
 
 ### Example
 
@@ -99,25 +101,23 @@ import {
   Configuration,
   WorkflowsApi,
 } from '@knowledge-stack/ksapi';
-import type { ListWorkflowsRequest } from '@knowledge-stack/ksapi';
+import type { DvWorkflowRerunRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
   const api = new WorkflowsApi();
 
   const body = {
-    // number | Number of items per page (optional)
-    limit: 56,
-    // number | Number of items to skip (optional)
-    offset: 56,
+    // string
+    workflowId: workflowId_example,
     // string (optional)
     authorization: authorization_example,
     // string (optional)
     ksUat: ksUat_example,
-  } satisfies ListWorkflowsRequest;
+  } satisfies DvWorkflowRerunRequest;
 
   try {
-    const data = await api.listWorkflows(body);
+    const data = await api.dvWorkflowRerun(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -133,14 +133,13 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
-| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
+| **workflowId** | `string` |  | [Defaults to `undefined`] |
 | **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
-[**PaginatedResponseWorkflowSummaryResponse**](PaginatedResponseWorkflowSummaryResponse.md)
+[**WorkflowActionResponse**](WorkflowActionResponse.md)
 
 ### Authorization
 
@@ -161,13 +160,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)
 
 
-## workflowAction
+## getDvWorkflow
 
-> WorkflowActionResponse workflowAction(workflowId, action, authorization, ksUat)
+> WorkflowDetailResponse getDvWorkflow(workflowId, authorization, ksUat)
 
-Workflow Action Handler
+Get Dv Workflow Handler
 
-Cancel or rerun a workflow (OWNER/ADMIN only).
+Get single workflow detail with live Temporal status.
 
 ### Example
 
@@ -176,7 +175,7 @@ import {
   Configuration,
   WorkflowsApi,
 } from '@knowledge-stack/ksapi';
-import type { WorkflowActionRequest } from '@knowledge-stack/ksapi';
+import type { GetDvWorkflowRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
@@ -185,16 +184,14 @@ async function example() {
   const body = {
     // string
     workflowId: workflowId_example,
-    // WorkflowAction | Action to perform
-    action: ...,
     // string (optional)
     authorization: authorization_example,
     // string (optional)
     ksUat: ksUat_example,
-  } satisfies WorkflowActionRequest;
+  } satisfies GetDvWorkflowRequest;
 
   try {
-    const data = await api.workflowAction(body);
+    const data = await api.getDvWorkflow(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -211,13 +208,163 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **workflowId** | `string` |  | [Defaults to `undefined`] |
-| **action** | `WorkflowAction` | Action to perform | [Defaults to `undefined`] [Enum: rerun, cancel] |
 | **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
-[**WorkflowActionResponse**](WorkflowActionResponse.md)
+[**WorkflowDetailResponse**](WorkflowDetailResponse.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)
+
+
+## getTemporalWorkflowStatus
+
+> TemporalWorkflowStatusResponse getTemporalWorkflowStatus(workflowId, authorization, ksUat)
+
+Get Temporal Workflow Status Handler
+
+Get live Temporal status for any workflow owned by the caller\'s tenant.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetTemporalWorkflowStatusRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new WorkflowsApi();
+
+  const body = {
+    // string
+    workflowId: workflowId_example,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetTemporalWorkflowStatusRequest;
+
+  try {
+    const data = await api.getTemporalWorkflowStatus(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **workflowId** | `string` |  | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**TemporalWorkflowStatusResponse**](TemporalWorkflowStatusResponse.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)
+
+
+## listDvWorkflows
+
+> PaginatedResponseWorkflowSummaryResponse listDvWorkflows(limit, offset, authorization, ksUat)
+
+List Dv Workflows Handler
+
+List all workflows for the current tenant (paginated, DB-backed).  ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowsApi,
+} from '@knowledge-stack/ksapi';
+import type { ListDvWorkflowsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new WorkflowsApi();
+
+  const body = {
+    // 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 ListDvWorkflowsRequest;
+
+  try {
+    const data = await api.listDvWorkflows(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **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
+
+[**PaginatedResponseWorkflowSummaryResponse**](PaginatedResponseWorkflowSummaryResponse.md)
 
 ### Authorization
 

package/package.json

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

package/src/apis/DocumentVersionsApi.ts

@@ -18,6 +18,7 @@ import type {
   ClearVersionContentsResponse,
   DocumentVersionAction,
   DocumentVersionActionResponse,
+  DocumentVersionContentTypeFilter,
   DocumentVersionMetadataUpdate,
   DocumentVersionResponse,
   HTTPValidationError,
@@ -31,6 +32,8 @@ import {
     DocumentVersionActionToJSON,
     DocumentVersionActionResponseFromJSON,
     DocumentVersionActionResponseToJSON,
+    DocumentVersionContentTypeFilterFromJSON,
+    DocumentVersionContentTypeFilterToJSON,
     DocumentVersionMetadataUpdateFromJSON,
     DocumentVersionMetadataUpdateToJSON,
     DocumentVersionResponseFromJSON,
@@ -77,6 +80,7 @@ export interface GetDocumentVersionRequest {
 export interface GetDocumentVersionContentsRequest {
     versionId: string;
     sectionId?: string | null;
+    contentType?: DocumentVersionContentTypeFilter;
     limit?: number;
     offset?: number;
     authorization?: string | null;
@@ -251,6 +255,7 @@ export interface DocumentVersionsApiInterface {
      * Creates request options for getDocumentVersionContents without sending the request
      * @param {string} versionId DocumentVersion ID
      * @param {string} [sectionId] Optional section ID to scope traversal to a subtree
+     * @param {DocumentVersionContentTypeFilter} [contentType] Filter by content type: SECTION or CHUNK. Omit to return both types.
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {string} [authorization] 
@@ -261,10 +266,11 @@ export interface DocumentVersionsApiInterface {
     getDocumentVersionContentsRequestOpts(requestParameters: GetDocumentVersionContentsRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").
+     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").  Use `content_type` to return only one type (e.g. `content_type=CHUNK` for chunk-only pagination where offset/limit apply only to chunks).
      * @summary Get Document Version Contents Handler
      * @param {string} versionId DocumentVersion ID
      * @param {string} [sectionId] Optional section ID to scope traversal to a subtree
+     * @param {DocumentVersionContentTypeFilter} [contentType] Filter by content type: SECTION or CHUNK. Omit to return both types.
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {string} [authorization] 
@@ -276,7 +282,7 @@ export interface DocumentVersionsApiInterface {
     getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator>>;
 
     /**
-     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").
+     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").  Use `content_type` to return only one type (e.g. `content_type=CHUNK` for chunk-only pagination where offset/limit apply only to chunks).
      * Get Document Version Contents Handler
      */
     getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator>;
@@ -632,6 +638,10 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
             queryParameters['section_id'] = requestParameters['sectionId'];
         }
 
+        if (requestParameters['contentType'] != null) {
+            queryParameters['content_type'] = requestParameters['contentType'];
+        }
+
         if (requestParameters['limit'] != null) {
             queryParameters['limit'] = requestParameters['limit'];
         }
@@ -659,7 +669,7 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
     }
 
     /**
-     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").
+     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").  Use `content_type` to return only one type (e.g. `content_type=CHUNK` for chunk-only pagination where offset/limit apply only to chunks).
      * Get Document Version Contents Handler
      */
     async getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator>> {
@@ -670,7 +680,7 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
     }
 
     /**
-     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").
+     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").  Use `content_type` to return only one type (e.g. `content_type=CHUNK` for chunk-only pagination where offset/limit apply only to chunks).
      * Get Document Version Contents Handler
      */
     async getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator> {

package/src/apis/ThreadMessagesApi.ts

@@ -129,7 +129,7 @@ export interface ThreadMessagesApiInterface {
      * Creates request options for listThreadMessages without sending the request
      * @param {string} threadId 
      * @param {Date} [before] Cursor for keyset pagination: only return messages with created_at < this value
-     * @param {boolean} [withDetails] Include execution steps in response (default false to reduce payload size)
+     * @param {boolean} [withDetails] Include execution steps in response (default true)
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {string} [authorization] 
@@ -140,11 +140,11 @@ export interface ThreadMessagesApiInterface {
     listThreadMessagesRequestOpts(requestParameters: ListThreadMessagesRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * List messages in a thread, ordered by created_at descending.  Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.  Use `with_details=true` to include execution step data. Details are excluded by default to avoid loading large TOAST data.
+     * List messages in a thread, ordered by created_at descending.  Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.  Use `with_details=false` to exclude execution step data and reduce payload size.
      * @summary List Thread Messages Handler
      * @param {string} threadId 
      * @param {Date} [before] Cursor for keyset pagination: only return messages with created_at &lt; this value
-     * @param {boolean} [withDetails] Include execution steps in response (default false to reduce payload size)
+     * @param {boolean} [withDetails] Include execution steps in response (default true)
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {string} [authorization] 
@@ -156,7 +156,7 @@ export interface ThreadMessagesApiInterface {
     listThreadMessagesRaw(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseThreadMessageResponse>>;
 
     /**
-     * List messages in a thread, ordered by created_at descending.  Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.  Use `with_details=true` to include execution step data. Details are excluded by default to avoid loading large TOAST data.
+     * List messages in a thread, ordered by created_at descending.  Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.  Use `with_details=false` to exclude execution step data and reduce payload size.
      * List Thread Messages Handler
      */
     listThreadMessages(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseThreadMessageResponse>;
@@ -340,7 +340,7 @@ export class ThreadMessagesApi extends runtime.BaseAPI implements ThreadMessages
     }
 
     /**
-     * List messages in a thread, ordered by created_at descending.  Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.  Use `with_details=true` to include execution step data. Details are excluded by default to avoid loading large TOAST data.
+     * List messages in a thread, ordered by created_at descending.  Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.  Use `with_details=false` to exclude execution step data and reduce payload size.
      * List Thread Messages Handler
      */
     async listThreadMessagesRaw(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseThreadMessageResponse>> {
@@ -351,7 +351,7 @@ export class ThreadMessagesApi extends runtime.BaseAPI implements ThreadMessages
     }
 
     /**
-     * List messages in a thread, ordered by created_at descending.  Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.  Use `with_details=true` to include execution step data. Details are excluded by default to avoid loading large TOAST data.
+     * List messages in a thread, ordered by created_at descending.  Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.  Use `with_details=false` to exclude execution step data and reduce payload size.
      * List Thread Messages Handler
      */
     async listThreadMessages(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseThreadMessageResponse> {