@knowledge-stack/ksapi 1.62.2 → 1.64.0

package/docs/WorkflowRunCallbackRequest.md

@@ -0,0 +1,37 @@
+
+# WorkflowRunCallbackRequest
+
+Request body for the runner callback endpoint.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`error` | string
+
+## Example
+
+```typescript
+import type { WorkflowRunCallbackRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "error": null,
+} satisfies WorkflowRunCallbackRequest
+
+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 WorkflowRunCallbackRequest
+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/WorkflowRunResponse.md

@@ -0,0 +1,55 @@
+
+# WorkflowRunResponse
+
+Workflow run response.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`workflowDefinitionId` | string
+`userId` | string
+`runnerType` | [WorkflowRunnerType](WorkflowRunnerType.md)
+`status` | [WorkflowRunStatus](WorkflowRunStatus.md)
+`startedAt` | Date
+`completedAt` | Date
+`runSnapshot` | [WorkflowRunSnapshot](WorkflowRunSnapshot.md)
+`error` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { WorkflowRunResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "workflowDefinitionId": null,
+  "userId": null,
+  "runnerType": null,
+  "status": null,
+  "startedAt": null,
+  "completedAt": null,
+  "runSnapshot": null,
+  "error": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies WorkflowRunResponse
+
+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 WorkflowRunResponse
+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/WorkflowRunSnapshot.md

@@ -0,0 +1,51 @@
+
+# WorkflowRunSnapshot
+
+Frozen ABCD configuration captured at workflow trigger time.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`workflowDefinitionId` | string
+`workflowName` | string
+`runnerType` | [WorkflowRunnerType](WorkflowRunnerType.md)
+`userId` | string
+`maxRunDurationSeconds` | number
+`sources` | [Array<ABCDPathSnapshot>](ABCDPathSnapshot.md)
+`instructions` | [Array<ABCDPathSnapshot>](ABCDPathSnapshot.md)
+`outputs` | [Array<ABCDPathSnapshot>](ABCDPathSnapshot.md)
+`template` | [ABCDPathSnapshot](ABCDPathSnapshot.md)
+
+## Example
+
+```typescript
+import type { WorkflowRunSnapshot } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "workflowDefinitionId": null,
+  "workflowName": null,
+  "runnerType": null,
+  "userId": null,
+  "maxRunDurationSeconds": null,
+  "sources": null,
+  "instructions": null,
+  "outputs": null,
+  "template": null,
+} satisfies WorkflowRunSnapshot
+
+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 WorkflowRunSnapshot
+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/WorkflowRunStatus.md

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

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

@@ -0,0 +1,224 @@
+# WorkflowRunsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deleteWorkflowRun**](WorkflowRunsApi.md#deleteworkflowrun) | **DELETE** /v1/workflow-runs/{run_id} | Delete Workflow Run Handler |
+| [**getWorkflowRun**](WorkflowRunsApi.md#getworkflowrun) | **GET** /v1/workflow-runs/{run_id} | Get Workflow Run Handler |
+| [**workflowRunCallback**](WorkflowRunsApi.md#workflowruncallbackoperation) | **POST** /v1/workflow-runs/{run_id}/callback | Workflow Run Callback Handler |
+
+
+
+## deleteWorkflowRun
+
+> deleteWorkflowRun(runId, authorization, ksUat)
+
+Delete Workflow Run Handler
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowRunsApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteWorkflowRunRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new WorkflowRunsApi();
+
+  const body = {
+    // string
+    runId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteWorkflowRunRequest;
+
+  try {
+    const data = await api.deleteWorkflowRun(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **runId** | `string` |  | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | 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)
+
+
+## getWorkflowRun
+
+> WorkflowRunResponse getWorkflowRun(runId, authorization, ksUat)
+
+Get Workflow Run Handler
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowRunsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetWorkflowRunRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new WorkflowRunsApi();
+
+  const body = {
+    // string
+    runId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetWorkflowRunRequest;
+
+  try {
+    const data = await api.getWorkflowRun(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **runId** | `string` |  | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**WorkflowRunResponse**](WorkflowRunResponse.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)
+
+
+## workflowRunCallback
+
+> WorkflowCallbackResponse workflowRunCallback(runId, workflowRunCallbackRequest)
+
+Workflow Run Callback Handler
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowRunsApi,
+} from '@knowledge-stack/ksapi';
+import type { WorkflowRunCallbackOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new WorkflowRunsApi();
+
+  const body = {
+    // string
+    runId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // WorkflowRunCallbackRequest
+    workflowRunCallbackRequest: ...,
+  } satisfies WorkflowRunCallbackOperationRequest;
+
+  try {
+    const data = await api.workflowRunCallback(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **runId** | `string` |  | [Defaults to `undefined`] |
+| **workflowRunCallbackRequest** | [WorkflowRunCallbackRequest](WorkflowRunCallbackRequest.md) |  | |
+
+### Return type
+
+[**WorkflowCallbackResponse**](WorkflowCallbackResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **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.62.2",
+  "version": "1.64.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {