@knowledge-stack/ksapi 1.63.0 → 1.64.0

package/src/apis/WorkflowRunsApi.ts

@@ -0,0 +1,296 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  HTTPValidationError,
+  WorkflowCallbackResponse,
+  WorkflowRunCallbackRequest,
+  WorkflowRunResponse,
+} from '../models/index';
+import {
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    WorkflowCallbackResponseFromJSON,
+    WorkflowCallbackResponseToJSON,
+    WorkflowRunCallbackRequestFromJSON,
+    WorkflowRunCallbackRequestToJSON,
+    WorkflowRunResponseFromJSON,
+    WorkflowRunResponseToJSON,
+} from '../models/index';
+
+export interface DeleteWorkflowRunRequest {
+    runId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
+export interface GetWorkflowRunRequest {
+    runId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
+export interface WorkflowRunCallbackOperationRequest {
+    runId: string;
+    workflowRunCallbackRequest: WorkflowRunCallbackRequest;
+}
+
+/**
+ * WorkflowRunsApi - interface
+ * 
+ * @export
+ * @interface WorkflowRunsApiInterface
+ */
+export interface WorkflowRunsApiInterface {
+    /**
+     * Creates request options for deleteWorkflowRun without sending the request
+     * @param {string} runId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof WorkflowRunsApiInterface
+     */
+    deleteWorkflowRunRequestOpts(requestParameters: DeleteWorkflowRunRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Delete Workflow Run Handler
+     * @param {string} runId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowRunsApiInterface
+     */
+    deleteWorkflowRunRaw(requestParameters: DeleteWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Delete Workflow Run Handler
+     */
+    deleteWorkflowRun(requestParameters: DeleteWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates request options for getWorkflowRun without sending the request
+     * @param {string} runId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof WorkflowRunsApiInterface
+     */
+    getWorkflowRunRequestOpts(requestParameters: GetWorkflowRunRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Get Workflow Run Handler
+     * @param {string} runId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowRunsApiInterface
+     */
+    getWorkflowRunRaw(requestParameters: GetWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
+
+    /**
+     * Get Workflow Run Handler
+     */
+    getWorkflowRun(requestParameters: GetWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
+
+    /**
+     * Creates request options for workflowRunCallback without sending the request
+     * @param {string} runId 
+     * @param {WorkflowRunCallbackRequest} workflowRunCallbackRequest 
+     * @throws {RequiredError}
+     * @memberof WorkflowRunsApiInterface
+     */
+    workflowRunCallbackRequestOpts(requestParameters: WorkflowRunCallbackOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Workflow Run Callback Handler
+     * @param {string} runId 
+     * @param {WorkflowRunCallbackRequest} workflowRunCallbackRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowRunsApiInterface
+     */
+    workflowRunCallbackRaw(requestParameters: WorkflowRunCallbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowCallbackResponse>>;
+
+    /**
+     * Workflow Run Callback Handler
+     */
+    workflowRunCallback(requestParameters: WorkflowRunCallbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowCallbackResponse>;
+
+}
+
+/**
+ * 
+ */
+export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiInterface {
+
+    /**
+     * Creates request options for deleteWorkflowRun without sending the request
+     */
+    async deleteWorkflowRunRequestOpts(requestParameters: DeleteWorkflowRunRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['runId'] == null) {
+            throw new runtime.RequiredError(
+                'runId',
+                'Required parameter "runId" was null or undefined when calling deleteWorkflowRun().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/workflow-runs/{run_id}`;
+        urlPath = urlPath.replace(`{${"run_id"}}`, encodeURIComponent(String(requestParameters['runId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Delete Workflow Run Handler
+     */
+    async deleteWorkflowRunRaw(requestParameters: DeleteWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteWorkflowRunRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete Workflow Run Handler
+     */
+    async deleteWorkflowRun(requestParameters: DeleteWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteWorkflowRunRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getWorkflowRun without sending the request
+     */
+    async getWorkflowRunRequestOpts(requestParameters: GetWorkflowRunRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['runId'] == null) {
+            throw new runtime.RequiredError(
+                'runId',
+                'Required parameter "runId" was null or undefined when calling getWorkflowRun().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/workflow-runs/{run_id}`;
+        urlPath = urlPath.replace(`{${"run_id"}}`, encodeURIComponent(String(requestParameters['runId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get Workflow Run Handler
+     */
+    async getWorkflowRunRaw(requestParameters: GetWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>> {
+        const requestOptions = await this.getWorkflowRunRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowRunResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get Workflow Run Handler
+     */
+    async getWorkflowRun(requestParameters: GetWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse> {
+        const response = await this.getWorkflowRunRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for workflowRunCallback without sending the request
+     */
+    async workflowRunCallbackRequestOpts(requestParameters: WorkflowRunCallbackOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['runId'] == null) {
+            throw new runtime.RequiredError(
+                'runId',
+                'Required parameter "runId" was null or undefined when calling workflowRunCallback().'
+            );
+        }
+
+        if (requestParameters['workflowRunCallbackRequest'] == null) {
+            throw new runtime.RequiredError(
+                'workflowRunCallbackRequest',
+                'Required parameter "workflowRunCallbackRequest" was null or undefined when calling workflowRunCallback().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/workflow-runs/{run_id}/callback`;
+        urlPath = urlPath.replace(`{${"run_id"}}`, encodeURIComponent(String(requestParameters['runId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: WorkflowRunCallbackRequestToJSON(requestParameters['workflowRunCallbackRequest']),
+        };
+    }
+
+    /**
+     * Workflow Run Callback Handler
+     */
+    async workflowRunCallbackRaw(requestParameters: WorkflowRunCallbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowCallbackResponse>> {
+        const requestOptions = await this.workflowRunCallbackRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowCallbackResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Workflow Run Callback Handler
+     */
+    async workflowRunCallback(requestParameters: WorkflowRunCallbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowCallbackResponse> {
+        const response = await this.workflowRunCallbackRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -20,4 +20,6 @@ export * from './ThreadMessagesApi';
 export * from './ThreadsApi';
 export * from './UserPermissionsApi';
 export * from './UsersApi';
+export * from './WorkflowDefinitionsApi';
+export * from './WorkflowRunsApi';
 export * from './WorkflowsApi';

package/src/models/ABCDPathSnapshot.ts

@@ -0,0 +1,111 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { PartType } from './PartType';
+import {
+    PartTypeFromJSON,
+    PartTypeFromJSONTyped,
+    PartTypeToJSON,
+    PartTypeToJSONTyped,
+} from './PartType';
+
+/**
+ * Snapshot of a single ABCD path reference at trigger time.
+ * @export
+ * @interface ABCDPathSnapshot
+ */
+export interface ABCDPathSnapshot {
+    /**
+     * 
+     * @type {string}
+     * @memberof ABCDPathSnapshot
+     */
+    pathPartId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ABCDPathSnapshot
+     */
+    materializedPath: string;
+    /**
+     * 
+     * @type {PartType}
+     * @memberof ABCDPathSnapshot
+     */
+    partType: PartType;
+}
+
+
+
+/**
+ * Check if a given object implements the ABCDPathSnapshot interface.
+ */
+export function instanceOfABCDPathSnapshot(value: object): value is ABCDPathSnapshot {
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
+    if (!('partType' in value) || value['partType'] === undefined) return false;
+    return true;
+}
+
+export function ABCDPathSnapshotFromJSON(json: any): ABCDPathSnapshot {
+    return ABCDPathSnapshotFromJSONTyped(json, false);
+}
+
+export function ABCDPathSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): ABCDPathSnapshot {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'pathPartId': json['path_part_id'],
+        'materializedPath': json['materialized_path'],
+        'partType': PartTypeFromJSON(json['part_type']),
+    };
+}
+
+export function ABCDPathSnapshotToJSON(json: any): ABCDPathSnapshot {
+    return ABCDPathSnapshotToJSONTyped(json, false);
+}
+
+export function ABCDPathSnapshotToJSONTyped(value?: ABCDPathSnapshot | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path_part_id': value['pathPartId'],
+        'materialized_path': value['materializedPath'],
+        'part_type': PartTypeToJSON(value['partType']),
+    };
+}
+
+export const ABCDPathSnapshotPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+

package/src/models/CreateWorkflowDefinitionRequest.ts

@@ -0,0 +1,192 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { SelfHostedRunnerConfig } from './SelfHostedRunnerConfig';
+import {
+    SelfHostedRunnerConfigFromJSON,
+    SelfHostedRunnerConfigFromJSONTyped,
+    SelfHostedRunnerConfigToJSON,
+    SelfHostedRunnerConfigToJSONTyped,
+} from './SelfHostedRunnerConfig';
+import type { WorkflowRunnerType } from './WorkflowRunnerType';
+import {
+    WorkflowRunnerTypeFromJSON,
+    WorkflowRunnerTypeFromJSONTyped,
+    WorkflowRunnerTypeToJSON,
+    WorkflowRunnerTypeToJSONTyped,
+} from './WorkflowRunnerType';
+
+/**
+ * Create a new workflow definition.
+ * @export
+ * @interface CreateWorkflowDefinitionRequest
+ */
+export interface CreateWorkflowDefinitionRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    description?: string | null;
+    /**
+     * 
+     * @type {WorkflowRunnerType}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    runnerType: WorkflowRunnerType;
+    /**
+     * 
+     * @type {SelfHostedRunnerConfig}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    runnerConfig?: SelfHostedRunnerConfig;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    maxRunDurationSeconds?: number;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    sourcePathPartIds: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    instructionPathPartIds: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    outputPathPartIds: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    templatePathPartId?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the CreateWorkflowDefinitionRequest interface.
+ */
+export function instanceOfCreateWorkflowDefinitionRequest(value: object): value is CreateWorkflowDefinitionRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('runnerType' in value) || value['runnerType'] === undefined) return false;
+    if (!('sourcePathPartIds' in value) || value['sourcePathPartIds'] === undefined) return false;
+    if (!('instructionPathPartIds' in value) || value['instructionPathPartIds'] === undefined) return false;
+    if (!('outputPathPartIds' in value) || value['outputPathPartIds'] === undefined) return false;
+    return true;
+}
+
+export function CreateWorkflowDefinitionRequestFromJSON(json: any): CreateWorkflowDefinitionRequest {
+    return CreateWorkflowDefinitionRequestFromJSONTyped(json, false);
+}
+
+export function CreateWorkflowDefinitionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateWorkflowDefinitionRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'runnerType': WorkflowRunnerTypeFromJSON(json['runner_type']),
+        'runnerConfig': json['runner_config'] == null ? undefined : SelfHostedRunnerConfigFromJSON(json['runner_config']),
+        'maxRunDurationSeconds': json['max_run_duration_seconds'] == null ? undefined : json['max_run_duration_seconds'],
+        'sourcePathPartIds': json['source_path_part_ids'],
+        'instructionPathPartIds': json['instruction_path_part_ids'],
+        'outputPathPartIds': json['output_path_part_ids'],
+        'templatePathPartId': json['template_path_part_id'] == null ? undefined : json['template_path_part_id'],
+    };
+}
+
+export function CreateWorkflowDefinitionRequestToJSON(json: any): CreateWorkflowDefinitionRequest {
+    return CreateWorkflowDefinitionRequestToJSONTyped(json, false);
+}
+
+export function CreateWorkflowDefinitionRequestToJSONTyped(value?: CreateWorkflowDefinitionRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'runner_type': WorkflowRunnerTypeToJSON(value['runnerType']),
+        'runner_config': SelfHostedRunnerConfigToJSON(value['runnerConfig']),
+        'max_run_duration_seconds': value['maxRunDurationSeconds'],
+        'source_path_part_ids': value['sourcePathPartIds'],
+        'instruction_path_part_ids': value['instructionPathPartIds'],
+        'output_path_part_ids': value['outputPathPartIds'],
+        'template_path_part_id': value['templatePathPartId'],
+    };
+}
+
+export const CreateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    name: {
+        maxLength: 255,
+    },
+    maxRunDurationSeconds: {
+        maximum: 86400,
+        exclusiveMaximum: false,
+        minimum: 60,
+        exclusiveMinimum: false,
+    },
+    sourcePathPartIds: {
+        maxItems: 20,
+        minItems: 1,
+        uniqueItems: false,
+    },
+    instructionPathPartIds: {
+        maxItems: 20,
+        minItems: 1,
+        uniqueItems: false,
+    },
+    outputPathPartIds: {
+        maxItems: 20,
+        minItems: 1,
+        uniqueItems: false,
+    },
+}
+

package/src/models/InvokeWorkflowRequest.ts

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Request body for invoking a workflow definition.
+ * @export
+ * @interface InvokeWorkflowRequest
+ */
+export interface InvokeWorkflowRequest {
+    /**
+     * Optional key to prevent duplicate runs from retries
+     * @type {string}
+     * @memberof InvokeWorkflowRequest
+     */
+    idempotencyKey?: string | null;
+}
+
+/**
+ * Check if a given object implements the InvokeWorkflowRequest interface.
+ */
+export function instanceOfInvokeWorkflowRequest(value: object): value is InvokeWorkflowRequest {
+    return true;
+}
+
+export function InvokeWorkflowRequestFromJSON(json: any): InvokeWorkflowRequest {
+    return InvokeWorkflowRequestFromJSONTyped(json, false);
+}
+
+export function InvokeWorkflowRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvokeWorkflowRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'idempotencyKey': json['idempotency_key'] == null ? undefined : json['idempotency_key'],
+    };
+}
+
+export function InvokeWorkflowRequestToJSON(json: any): InvokeWorkflowRequest {
+    return InvokeWorkflowRequestToJSONTyped(json, false);
+}
+
+export function InvokeWorkflowRequestToJSONTyped(value?: InvokeWorkflowRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'idempotency_key': value['idempotencyKey'],
+    };
+}
+
+export const InvokeWorkflowRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    idempotencyKey: {
+        maxLength: 255,
+    },
+}
+