@knowledge-stack/ksapi 1.57.0 → 1.58.0

package/.openapi-generator/FILES

@@ -125,6 +125,7 @@ docs/SubtreeChunksResponse.md
 docs/SupportedLanguage.md
 docs/TagResponse.md
 docs/TagsApi.md
+docs/TemporalWorkflowStatusResponse.md
 docs/TenantBrandingResponse.md
 docs/TenantResponse.md
 docs/TenantSettingsResponse.md
@@ -157,8 +158,8 @@ docs/UserResponse.md
 docs/UsersApi.md
 docs/ValidationError.md
 docs/VersionChunkIdsResponse.md
-docs/WorkflowAction.md
 docs/WorkflowActionResponse.md
+docs/WorkflowCancelResponse.md
 docs/WorkflowDetailResponse.md
 docs/WorkflowSummaryResponse.md
 docs/WorkflowsApi.md
@@ -294,6 +295,7 @@ src/models/SubtreeChunkGroup.ts
 src/models/SubtreeChunksResponse.ts
 src/models/SupportedLanguage.ts
 src/models/TagResponse.ts
+src/models/TemporalWorkflowStatusResponse.ts
 src/models/TenantBrandingResponse.ts
 src/models/TenantResponse.ts
 src/models/TenantSettingsResponse.ts
@@ -321,8 +323,8 @@ src/models/UserMessageResponse.ts
 src/models/UserResponse.ts
 src/models/ValidationError.ts
 src/models/VersionChunkIdsResponse.ts
-src/models/WorkflowAction.ts
 src/models/WorkflowActionResponse.ts
+src/models/WorkflowCancelResponse.ts
 src/models/WorkflowDetailResponse.ts
 src/models/WorkflowSummaryResponse.ts
 src/models/index.ts

package/README.md

@@ -1,4 +1,4 @@
-# @knowledge-stack/ksapi@1.57.0
+# @knowledge-stack/ksapi@1.58.0
 
 A TypeScript SDK client for the localhost API.
 
@@ -147,9 +147,11 @@ All URIs are relative to *http://localhost:8000*
 *UserPermissionsApi* | [**updateUserPermission**](docs/UserPermissionsApi.md#updateuserpermission) | **PATCH** /v1/user-permissions/{permission_id} | Update User Permission Handler
 *UsersApi* | [**getMe**](docs/UsersApi.md#getme) | **GET** /v1/users/me | Get Me Handler
 *UsersApi* | [**updateMe**](docs/UsersApi.md#updateme) | **PATCH** /v1/users | Update Me Handler
-*WorkflowsApi* | [**getWorkflow**](docs/WorkflowsApi.md#getworkflow) | **GET** /v1/workflows/{workflow_id} | Get Workflow Handler
-*WorkflowsApi* | [**listWorkflows**](docs/WorkflowsApi.md#listworkflows) | **GET** /v1/workflows | List Workflows Handler
-*WorkflowsApi* | [**workflowAction**](docs/WorkflowsApi.md#workflowaction) | **POST** /v1/workflows/{workflow_id} | Workflow Action Handler
+*WorkflowsApi* | [**cancelTemporalWorkflow**](docs/WorkflowsApi.md#canceltemporalworkflow) | **DELETE** /v1/workflows/{workflow_id} | Cancel Temporal Workflow Handler
+*WorkflowsApi* | [**dvWorkflowRerun**](docs/WorkflowsApi.md#dvworkflowrerun) | **POST** /v1/workflows/document_versions/{workflow_id} | Dv Workflow Rerun Handler
+*WorkflowsApi* | [**getDvWorkflow**](docs/WorkflowsApi.md#getdvworkflow) | **GET** /v1/workflows/document_versions/{workflow_id} | Get Dv Workflow Handler
+*WorkflowsApi* | [**getTemporalWorkflowStatus**](docs/WorkflowsApi.md#gettemporalworkflowstatus) | **GET** /v1/workflows/{workflow_id} | Get Temporal Workflow Status Handler
+*WorkflowsApi* | [**listDvWorkflows**](docs/WorkflowsApi.md#listdvworkflows) | **GET** /v1/workflows/document_versions | List Dv Workflows Handler
 
 
 ### Models
@@ -264,6 +266,7 @@ All URIs are relative to *http://localhost:8000*
 - [SubtreeChunksResponse](docs/SubtreeChunksResponse.md)
 - [SupportedLanguage](docs/SupportedLanguage.md)
 - [TagResponse](docs/TagResponse.md)
+- [TemporalWorkflowStatusResponse](docs/TemporalWorkflowStatusResponse.md)
 - [TenantBrandingResponse](docs/TenantBrandingResponse.md)
 - [TenantResponse](docs/TenantResponse.md)
 - [TenantSettingsResponse](docs/TenantSettingsResponse.md)
@@ -291,8 +294,8 @@ All URIs are relative to *http://localhost:8000*
 - [UserResponse](docs/UserResponse.md)
 - [ValidationError](docs/ValidationError.md)
 - [VersionChunkIdsResponse](docs/VersionChunkIdsResponse.md)
-- [WorkflowAction](docs/WorkflowAction.md)
 - [WorkflowActionResponse](docs/WorkflowActionResponse.md)
+- [WorkflowCancelResponse](docs/WorkflowCancelResponse.md)
 - [WorkflowDetailResponse](docs/WorkflowDetailResponse.md)
 - [WorkflowSummaryResponse](docs/WorkflowSummaryResponse.md)
 
@@ -308,7 +311,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `0.1.0`
-- Package version: `1.57.0`
+- Package version: `1.58.0`
 - Generator version: `7.20.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/WorkflowsApi.d.ts

@@ -10,21 +10,30 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { PaginatedResponseWorkflowSummaryResponse, WorkflowAction, WorkflowActionResponse, WorkflowDetailResponse } from '../models/index';
-export interface GetWorkflowRequest {
+import type { PaginatedResponseWorkflowSummaryResponse, TemporalWorkflowStatusResponse, WorkflowActionResponse, WorkflowCancelResponse, WorkflowDetailResponse } from '../models/index';
+export interface CancelTemporalWorkflowRequest {
     workflowId: string;
     authorization?: string | null;
     ksUat?: string | null;
 }
-export interface ListWorkflowsRequest {
-    limit?: number;
-    offset?: number;
+export interface DvWorkflowRerunRequest {
+    workflowId: string;
     authorization?: string | null;
     ksUat?: string | null;
 }
-export interface WorkflowActionRequest {
+export interface GetDvWorkflowRequest {
     workflowId: string;
-    action: WorkflowAction;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface GetTemporalWorkflowStatusRequest {
+    workflowId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface ListDvWorkflowsRequest {
+    limit?: number;
+    offset?: number;
     authorization?: string | null;
     ksUat?: string | null;
 }
@@ -36,17 +45,17 @@ export interface WorkflowActionRequest {
  */
 export interface WorkflowsApiInterface {
     /**
-     * Creates request options for getWorkflow without sending the request
+     * Creates request options for cancelTemporalWorkflow without sending the request
      * @param {string} workflowId
      * @param {string} [authorization]
      * @param {string} [ksUat]
      * @throws {RequiredError}
      * @memberof WorkflowsApiInterface
      */
-    getWorkflowRequestOpts(requestParameters: GetWorkflowRequest): Promise<runtime.RequestOpts>;
+    cancelTemporalWorkflowRequestOpts(requestParameters: CancelTemporalWorkflowRequest): Promise<runtime.RequestOpts>;
     /**
-     * Get single workflow detail with live Temporal status.
-     * @summary Get Workflow Handler
+     * 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.
+     * @summary Cancel Temporal Workflow Handler
      * @param {string} workflowId
      * @param {string} [authorization]
      * @param {string} [ksUat]
@@ -54,111 +63,187 @@ export interface WorkflowsApiInterface {
      * @throws {RequiredError}
      * @memberof WorkflowsApiInterface
      */
-    getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
+    cancelTemporalWorkflowRaw(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowCancelResponse>>;
     /**
-     * Get single workflow detail with live Temporal status.
-     * Get Workflow Handler
+     * 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.
+     * Cancel Temporal Workflow Handler
      */
-    getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
+    cancelTemporalWorkflow(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowCancelResponse>;
     /**
-     * Creates request options for listWorkflows without sending the request
-     * @param {number} [limit] Number of items per page
-     * @param {number} [offset] Number of items to skip
+     * Creates request options for dvWorkflowRerun without sending the request
+     * @param {string} workflowId
      * @param {string} [authorization]
      * @param {string} [ksUat]
      * @throws {RequiredError}
      * @memberof WorkflowsApiInterface
      */
-    listWorkflowsRequestOpts(requestParameters: ListWorkflowsRequest): Promise<runtime.RequestOpts>;
+    dvWorkflowRerunRequestOpts(requestParameters: DvWorkflowRerunRequest): Promise<runtime.RequestOpts>;
     /**
-     * List all workflows for the current tenant (paginated, DB-backed).
-     * @summary List Workflows Handler
-     * @param {number} [limit] Number of items per page
-     * @param {number} [offset] Number of items to skip
+     * Rerun a workflow. USER role requires ``can_write`` on the document path.
+     * @summary Dv Workflow Rerun Handler
+     * @param {string} workflowId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    dvWorkflowRerunRaw(requestParameters: DvWorkflowRerunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
+    /**
+     * Rerun a workflow. USER role requires ``can_write`` on the document path.
+     * Dv Workflow Rerun Handler
+     */
+    dvWorkflowRerun(requestParameters: DvWorkflowRerunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
+    /**
+     * Creates request options for getDvWorkflow without sending the request
+     * @param {string} workflowId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    getDvWorkflowRequestOpts(requestParameters: GetDvWorkflowRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get single workflow detail with live Temporal status.
+     * @summary Get Dv Workflow Handler
+     * @param {string} workflowId
      * @param {string} [authorization]
      * @param {string} [ksUat]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WorkflowsApiInterface
      */
-    listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
+    getDvWorkflowRaw(requestParameters: GetDvWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
     /**
-     * List all workflows for the current tenant (paginated, DB-backed).
-     * List Workflows Handler
+     * Get single workflow detail with live Temporal status.
+     * Get Dv Workflow Handler
      */
-    listWorkflows(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
+    getDvWorkflow(requestParameters: GetDvWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
     /**
-     * Creates request options for workflowAction without sending the request
+     * Creates request options for getTemporalWorkflowStatus without sending the request
      * @param {string} workflowId
-     * @param {WorkflowAction} action Action to perform
      * @param {string} [authorization]
      * @param {string} [ksUat]
      * @throws {RequiredError}
      * @memberof WorkflowsApiInterface
      */
-    workflowActionRequestOpts(requestParameters: WorkflowActionRequest): Promise<runtime.RequestOpts>;
+    getTemporalWorkflowStatusRequestOpts(requestParameters: GetTemporalWorkflowStatusRequest): Promise<runtime.RequestOpts>;
     /**
-     * Cancel or rerun a workflow (OWNER/ADMIN only).
-     * @summary Workflow Action Handler
+     * Get live Temporal status for any workflow owned by the caller\'s tenant.
+     * @summary Get Temporal Workflow Status Handler
      * @param {string} workflowId
-     * @param {WorkflowAction} action Action to perform
      * @param {string} [authorization]
      * @param {string} [ksUat]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WorkflowsApiInterface
      */
-    workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
+    getTemporalWorkflowStatusRaw(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TemporalWorkflowStatusResponse>>;
     /**
-     * Cancel or rerun a workflow (OWNER/ADMIN only).
-     * Workflow Action Handler
+     * Get live Temporal status for any workflow owned by the caller\'s tenant.
+     * Get Temporal Workflow Status Handler
+     */
+    getTemporalWorkflowStatus(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemporalWorkflowStatusResponse>;
+    /**
+     * Creates request options for listDvWorkflows without sending the request
+     * @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 WorkflowsApiInterface
      */
-    workflowAction(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
+    listDvWorkflowsRequestOpts(requestParameters: ListDvWorkflowsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List all workflows for the current tenant (paginated, DB-backed).  ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
+     * @summary List Dv Workflows Handler
+     * @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 WorkflowsApiInterface
+     */
+    listDvWorkflowsRaw(requestParameters: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
+    /**
+     * List all workflows for the current tenant (paginated, DB-backed).  ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
+     * List Dv Workflows Handler
+     */
+    listDvWorkflows(requestParameters: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
 }
 /**
  *
  */
 export declare class WorkflowsApi extends runtime.BaseAPI implements WorkflowsApiInterface {
     /**
-     * Creates request options for getWorkflow without sending the request
+     * Creates request options for cancelTemporalWorkflow without sending the request
+     */
+    cancelTemporalWorkflowRequestOpts(requestParameters: CancelTemporalWorkflowRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * Cancel Temporal Workflow Handler
+     */
+    cancelTemporalWorkflowRaw(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowCancelResponse>>;
+    /**
+     * 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.
+     * Cancel Temporal Workflow Handler
+     */
+    cancelTemporalWorkflow(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowCancelResponse>;
+    /**
+     * Creates request options for dvWorkflowRerun without sending the request
+     */
+    dvWorkflowRerunRequestOpts(requestParameters: DvWorkflowRerunRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Rerun a workflow. USER role requires ``can_write`` on the document path.
+     * Dv Workflow Rerun Handler
+     */
+    dvWorkflowRerunRaw(requestParameters: DvWorkflowRerunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
+    /**
+     * Rerun a workflow. USER role requires ``can_write`` on the document path.
+     * Dv Workflow Rerun Handler
+     */
+    dvWorkflowRerun(requestParameters: DvWorkflowRerunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
+    /**
+     * Creates request options for getDvWorkflow without sending the request
      */
-    getWorkflowRequestOpts(requestParameters: GetWorkflowRequest): Promise<runtime.RequestOpts>;
+    getDvWorkflowRequestOpts(requestParameters: GetDvWorkflowRequest): Promise<runtime.RequestOpts>;
     /**
      * Get single workflow detail with live Temporal status.
-     * Get Workflow Handler
+     * Get Dv Workflow Handler
      */
-    getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
+    getDvWorkflowRaw(requestParameters: GetDvWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
     /**
      * Get single workflow detail with live Temporal status.
-     * Get Workflow Handler
+     * Get Dv Workflow Handler
      */
-    getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
+    getDvWorkflow(requestParameters: GetDvWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
     /**
-     * Creates request options for listWorkflows without sending the request
+     * Creates request options for getTemporalWorkflowStatus without sending the request
      */
-    listWorkflowsRequestOpts(requestParameters: ListWorkflowsRequest): Promise<runtime.RequestOpts>;
+    getTemporalWorkflowStatusRequestOpts(requestParameters: GetTemporalWorkflowStatusRequest): Promise<runtime.RequestOpts>;
     /**
-     * List all workflows for the current tenant (paginated, DB-backed).
-     * List Workflows Handler
+     * Get live Temporal status for any workflow owned by the caller\'s tenant.
+     * Get Temporal Workflow Status Handler
      */
-    listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
+    getTemporalWorkflowStatusRaw(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TemporalWorkflowStatusResponse>>;
     /**
-     * List all workflows for the current tenant (paginated, DB-backed).
-     * List Workflows Handler
+     * Get live Temporal status for any workflow owned by the caller\'s tenant.
+     * Get Temporal Workflow Status Handler
      */
-    listWorkflows(requestParameters?: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
+    getTemporalWorkflowStatus(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemporalWorkflowStatusResponse>;
     /**
-     * Creates request options for workflowAction without sending the request
+     * Creates request options for listDvWorkflows without sending the request
      */
-    workflowActionRequestOpts(requestParameters: WorkflowActionRequest): Promise<runtime.RequestOpts>;
+    listDvWorkflowsRequestOpts(requestParameters: ListDvWorkflowsRequest): Promise<runtime.RequestOpts>;
     /**
-     * Cancel or rerun a workflow (OWNER/ADMIN only).
-     * Workflow Action Handler
+     * List all workflows for the current tenant (paginated, DB-backed).  ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
+     * List Dv Workflows Handler
      */
-    workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
+    listDvWorkflowsRaw(requestParameters: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
     /**
-     * Cancel or rerun a workflow (OWNER/ADMIN only).
-     * Workflow Action Handler
+     * List all workflows for the current tenant (paginated, DB-backed).  ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
+     * List Dv Workflows Handler
      */
-    workflowAction(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
+    listDvWorkflows(requestParameters?: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
 }