@knowledge-stack/ksapi 1.57.0 → 1.59.0

package/docs/TemporalWorkflowStatusResponse.md

@@ -0,0 +1,47 @@
+
+# TemporalWorkflowStatusResponse
+
+Generic Temporal workflow status — no DB interaction.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`workflowId` | string
+`temporalStatus` | string
+`workflowType` | string
+`taskQueue` | string
+`startTime` | Date
+`closeTime` | Date
+`runId` | string
+
+## Example
+
+```typescript
+import type { TemporalWorkflowStatusResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "workflowId": null,
+  "temporalStatus": null,
+  "workflowType": null,
+  "taskQueue": null,
+  "startTime": null,
+  "closeTime": null,
+  "runId": null,
+} satisfies TemporalWorkflowStatusResponse
+
+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 TemporalWorkflowStatusResponse
+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/WorkflowActionResponse.md

@@ -1,7 +1,7 @@
 
 # WorkflowActionResponse
 
-POST response for cancel/rerun.
+POST response for rerun.
 
 ## Properties
 

package/docs/WorkflowCancelResponse.md

@@ -0,0 +1,37 @@
+
+# WorkflowCancelResponse
+
+Response for generic workflow cancellation.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`workflowId` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { WorkflowCancelResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "workflowId": null,
+  "message": null,
+} satisfies WorkflowCancelResponse
+
+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 WorkflowCancelResponse
+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/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.57.0",
+  "version": "1.59.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/FoldersApi.ts

@@ -23,6 +23,8 @@ import type {
   PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator,
   PaginatedResponseFolderResponse,
   PathOrder,
+  SearchSortOrder,
+  SearchablePartType,
   UpdateFolderRequest,
 } from '../models/index';
 import {
@@ -42,6 +44,10 @@ import {
     PaginatedResponseFolderResponseToJSON,
     PathOrderFromJSON,
     PathOrderToJSON,
+    SearchSortOrderFromJSON,
+    SearchSortOrderToJSON,
+    SearchablePartTypeFromJSON,
+    SearchablePartTypeToJSON,
     UpdateFolderRequestFromJSON,
     UpdateFolderRequestToJSON,
 } from '../models/index';
@@ -77,7 +83,6 @@ export interface ListFolderContentsRequest {
     maxDepth?: number;
     sortOrder?: PathOrder;
     withTags?: boolean;
-    nameLike?: string | null;
     limit?: number;
     offset?: number;
     authorization?: string | null;
@@ -94,6 +99,18 @@ export interface ListFoldersRequest {
     ksUat?: string | null;
 }
 
+export interface SearchItemsRequest {
+    nameLike: string;
+    sortOrder?: SearchSortOrder;
+    partType?: SearchablePartType;
+    withTags?: boolean;
+    parentPathPartId?: string | null;
+    limit?: number;
+    offset?: number;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
 export interface UpdateFolderOperationRequest {
     folderId: string;
     updateFolderRequest: UpdateFolderRequest;
@@ -230,7 +247,6 @@ export interface FoldersApiInterface {
      * @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
      * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
      * @param {boolean} [withTags] Include tag IDs for each item (default: false)
-     * @param {string} [nameLike] Case-insensitive partial name search filter
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {string} [authorization] 
@@ -247,7 +263,6 @@ export interface FoldersApiInterface {
      * @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
      * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
      * @param {boolean} [withTags] Include tag IDs for each item (default: false)
-     * @param {string} [nameLike] Case-insensitive partial name search filter
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {string} [authorization] 
@@ -300,6 +315,46 @@ export interface FoldersApiInterface {
      */
     listFolders(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
 
+    /**
+     * Creates request options for searchItems without sending the request
+     * @param {string} nameLike Case-insensitive partial name search
+     * @param {SearchSortOrder} [sortOrder] Sort order for results (default: NAME)
+     * @param {SearchablePartType} [partType] Filter by item type (default: both folders and documents)
+     * @param {boolean} [withTags] Include tags in the response (default: false)
+     * @param {string} [parentPathPartId] Scope search to descendants of this folder\&#39;s path part
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof FoldersApiInterface
+     */
+    searchItemsRequestOpts(requestParameters: SearchItemsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Search for folders and documents by name.  Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions.  When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
+     * @summary Search Items Handler
+     * @param {string} nameLike Case-insensitive partial name search
+     * @param {SearchSortOrder} [sortOrder] Sort order for results (default: NAME)
+     * @param {SearchablePartType} [partType] Filter by item type (default: both folders and documents)
+     * @param {boolean} [withTags] Include tags in the response (default: false)
+     * @param {string} [parentPathPartId] Scope search to descendants of this folder\&#39;s path part
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoldersApiInterface
+     */
+    searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>>;
+
+    /**
+     * Search for folders and documents by name.  Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions.  When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
+     * Search Items Handler
+     */
+    searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>;
+
     /**
      * Creates request options for updateFolder without sending the request
      * @param {string} folderId 
@@ -582,10 +637,6 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
             queryParameters['with_tags'] = requestParameters['withTags'];
         }
 
-        if (requestParameters['nameLike'] != null) {
-            queryParameters['name_like'] = requestParameters['nameLike'];
-        }
-
         if (requestParameters['limit'] != null) {
             queryParameters['limit'] = requestParameters['limit'];
         }
@@ -695,6 +746,84 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
         return await response.value();
     }
 
+    /**
+     * Creates request options for searchItems without sending the request
+     */
+    async searchItemsRequestOpts(requestParameters: SearchItemsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['nameLike'] == null) {
+            throw new runtime.RequiredError(
+                'nameLike',
+                'Required parameter "nameLike" was null or undefined when calling searchItems().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['nameLike'] != null) {
+            queryParameters['name_like'] = requestParameters['nameLike'];
+        }
+
+        if (requestParameters['sortOrder'] != null) {
+            queryParameters['sort_order'] = requestParameters['sortOrder'];
+        }
+
+        if (requestParameters['partType'] != null) {
+            queryParameters['part_type'] = requestParameters['partType'];
+        }
+
+        if (requestParameters['withTags'] != null) {
+            queryParameters['with_tags'] = requestParameters['withTags'];
+        }
+
+        if (requestParameters['parentPathPartId'] != null) {
+            queryParameters['parent_path_part_id'] = requestParameters['parentPathPartId'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/folders/search`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Search for folders and documents by name.  Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions.  When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
+     * Search Items Handler
+     */
+    async searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>> {
+        const requestOptions = await this.searchItemsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminatorFromJSON(jsonValue));
+    }
+
+    /**
+     * Search for folders and documents by name.  Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions.  When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
+     * Search Items Handler
+     */
+    async searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator> {
+        const response = await this.searchItemsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for updateFolder without sending the request
      */