@knowledge-stack/ksapi 1.23.4 → 1.24.0

package/docs/WorkflowAction.md

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

@@ -0,0 +1,39 @@
+
+# WorkflowActionResponse
+
+POST response for cancel/rerun.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`workflowId` | string
+`action` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { WorkflowActionResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "workflowId": null,
+  "action": null,
+  "message": null,
+} satisfies WorkflowActionResponse
+
+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 WorkflowActionResponse
+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/WorkflowDetailResponse.md

@@ -0,0 +1,63 @@
+
+# WorkflowDetailResponse
+
+Single item - adds live Temporal fields.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`workflowId` | string
+`documentId` | string
+`documentVersionId` | string
+`status` | [PipelineStatus](PipelineStatus.md)
+`lastActivity` | string
+`error` | string
+`lastRunTimestamp` | Date
+`createdAt` | Date
+`temporalStatus` | string
+`startTime` | Date
+`closeTime` | Date
+`workflowType` | string
+`taskQueue` | string
+`runId` | string
+`chunksProcessed` | number
+
+## Example
+
+```typescript
+import type { WorkflowDetailResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "workflowId": null,
+  "documentId": null,
+  "documentVersionId": null,
+  "status": null,
+  "lastActivity": null,
+  "error": null,
+  "lastRunTimestamp": null,
+  "createdAt": null,
+  "temporalStatus": null,
+  "startTime": null,
+  "closeTime": null,
+  "workflowType": null,
+  "taskQueue": null,
+  "runId": null,
+  "chunksProcessed": null,
+} satisfies WorkflowDetailResponse
+
+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 WorkflowDetailResponse
+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/WorkflowSummaryResponse.md

@@ -0,0 +1,49 @@
+
+# WorkflowSummaryResponse
+
+List item - DB-only fields, no Temporal call per item.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`workflowId` | string
+`documentId` | string
+`documentVersionId` | string
+`status` | [PipelineStatus](PipelineStatus.md)
+`lastActivity` | string
+`error` | string
+`lastRunTimestamp` | Date
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { WorkflowSummaryResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "workflowId": null,
+  "documentId": null,
+  "documentVersionId": null,
+  "status": null,
+  "lastActivity": null,
+  "error": null,
+  "lastRunTimestamp": null,
+  "createdAt": null,
+} satisfies WorkflowSummaryResponse
+
+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 WorkflowSummaryResponse
+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

@@ -0,0 +1,230 @@
+# WorkflowsApi
+
+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 |
+
+
+
+## getWorkflow
+
+> WorkflowDetailResponse getWorkflow(workflowId, ksUat)
+
+Get Workflow Handler
+
+Get single workflow detail with live Temporal status.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetWorkflowRequest } 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)
+    ksUat: ksUat_example,
+  } satisfies GetWorkflowRequest;
+
+  try {
+    const data = await api.getWorkflow(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`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**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)
+
+
+## listWorkflows
+
+> PaginatedResponseWorkflowSummaryResponse listWorkflows(limit, offset, ksUat)
+
+List Workflows Handler
+
+List all workflows for the current tenant (paginated, DB-backed).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowsApi,
+} from '@knowledge-stack/ksapi';
+import type { ListWorkflowsRequest } 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)
+    ksUat: ksUat_example,
+  } satisfies ListWorkflowsRequest;
+
+  try {
+    const data = await api.listWorkflows(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`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedResponseWorkflowSummaryResponse**](PaginatedResponseWorkflowSummaryResponse.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)
+
+
+## workflowAction
+
+> WorkflowActionResponse workflowAction(workflowId, action, ksUat)
+
+Workflow Action Handler
+
+Cancel or rerun a workflow (OWNER/ADMIN only).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowsApi,
+} from '@knowledge-stack/ksapi';
+import type { WorkflowActionRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new WorkflowsApi();
+
+  const body = {
+    // string
+    workflowId: workflowId_example,
+    // WorkflowAction | Action to perform
+    action: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies WorkflowActionRequest;
+
+  try {
+    const data = await api.workflowAction(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`] |
+| **action** | `WorkflowAction` | Action to perform | [Defaults to `undefined`] [Enum: rerun, cancel] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**WorkflowActionResponse**](WorkflowActionResponse.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)
+

package/package.json

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