@knowledge-stack/ksapi 1.82.0 → 1.84.0

package/src/apis/WorkflowMemoryApi.ts

@@ -0,0 +1,522 @@
+/* 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 {
+  AppendMemoryChunkRequest,
+  EditMemoryChunkRequest,
+  HTTPValidationError,
+  ListMemoryChunksResponse,
+  MemoryChunkResponse,
+} from '../models/index';
+import {
+    AppendMemoryChunkRequestFromJSON,
+    AppendMemoryChunkRequestToJSON,
+    EditMemoryChunkRequestFromJSON,
+    EditMemoryChunkRequestToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    ListMemoryChunksResponseFromJSON,
+    ListMemoryChunksResponseToJSON,
+    MemoryChunkResponseFromJSON,
+    MemoryChunkResponseToJSON,
+} from '../models/index';
+
+export interface AppendWorkflowMemoryChunkRequest {
+    definitionId: string;
+    appendMemoryChunkRequest: AppendMemoryChunkRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
+export interface EditWorkflowMemoryChunkRequest {
+    definitionId: string;
+    chunkId: string;
+    editMemoryChunkRequest: EditMemoryChunkRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
+export interface ForgetWorkflowMemoryChunkRequest {
+    definitionId: string;
+    chunkId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
+export interface GetWorkflowMemoryChunkRequest {
+    definitionId: string;
+    chunkId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
+export interface ListWorkflowMemoryChunksRequest {
+    definitionId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
+/**
+ * WorkflowMemoryApi - interface
+ * 
+ * @export
+ * @interface WorkflowMemoryApiInterface
+ */
+export interface WorkflowMemoryApiInterface {
+    /**
+     * Creates request options for appendWorkflowMemoryChunk without sending the request
+     * @param {string} definitionId 
+     * @param {AppendMemoryChunkRequest} appendMemoryChunkRequest 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof WorkflowMemoryApiInterface
+     */
+    appendWorkflowMemoryChunkRequestOpts(requestParameters: AppendWorkflowMemoryChunkRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Append a new memory chunk.  Exposed for external agents (e.g. self-hosted runners) that need to capture learnings without touching the DB directly. The new chunk\'s ``chunk_id`` is server-assigned. Each call snapshots a new DocumentVersion, just like edit/forget.
+     * @summary Append Workflow Memory Chunk Handler
+     * @param {string} definitionId 
+     * @param {AppendMemoryChunkRequest} appendMemoryChunkRequest 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowMemoryApiInterface
+     */
+    appendWorkflowMemoryChunkRaw(requestParameters: AppendWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MemoryChunkResponse>>;
+
+    /**
+     * Append a new memory chunk.  Exposed for external agents (e.g. self-hosted runners) that need to capture learnings without touching the DB directly. The new chunk\'s ``chunk_id`` is server-assigned. Each call snapshots a new DocumentVersion, just like edit/forget.
+     * Append Workflow Memory Chunk Handler
+     */
+    appendWorkflowMemoryChunk(requestParameters: AppendWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MemoryChunkResponse>;
+
+    /**
+     * Creates request options for editWorkflowMemoryChunk without sending the request
+     * @param {string} definitionId 
+     * @param {string} chunkId 
+     * @param {EditMemoryChunkRequest} editMemoryChunkRequest 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof WorkflowMemoryApiInterface
+     */
+    editWorkflowMemoryChunkRequestOpts(requestParameters: EditWorkflowMemoryChunkRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Edit Workflow Memory Chunk Handler
+     * @param {string} definitionId 
+     * @param {string} chunkId 
+     * @param {EditMemoryChunkRequest} editMemoryChunkRequest 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowMemoryApiInterface
+     */
+    editWorkflowMemoryChunkRaw(requestParameters: EditWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MemoryChunkResponse>>;
+
+    /**
+     * Edit Workflow Memory Chunk Handler
+     */
+    editWorkflowMemoryChunk(requestParameters: EditWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MemoryChunkResponse>;
+
+    /**
+     * Creates request options for forgetWorkflowMemoryChunk without sending the request
+     * @param {string} definitionId 
+     * @param {string} chunkId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof WorkflowMemoryApiInterface
+     */
+    forgetWorkflowMemoryChunkRequestOpts(requestParameters: ForgetWorkflowMemoryChunkRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Forget Workflow Memory Chunk Handler
+     * @param {string} definitionId 
+     * @param {string} chunkId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowMemoryApiInterface
+     */
+    forgetWorkflowMemoryChunkRaw(requestParameters: ForgetWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Forget Workflow Memory Chunk Handler
+     */
+    forgetWorkflowMemoryChunk(requestParameters: ForgetWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates request options for getWorkflowMemoryChunk without sending the request
+     * @param {string} definitionId 
+     * @param {string} chunkId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof WorkflowMemoryApiInterface
+     */
+    getWorkflowMemoryChunkRequestOpts(requestParameters: GetWorkflowMemoryChunkRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Get Workflow Memory Chunk Handler
+     * @param {string} definitionId 
+     * @param {string} chunkId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowMemoryApiInterface
+     */
+    getWorkflowMemoryChunkRaw(requestParameters: GetWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MemoryChunkResponse>>;
+
+    /**
+     * Get Workflow Memory Chunk Handler
+     */
+    getWorkflowMemoryChunk(requestParameters: GetWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MemoryChunkResponse>;
+
+    /**
+     * Creates request options for listWorkflowMemoryChunks without sending the request
+     * @param {string} definitionId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof WorkflowMemoryApiInterface
+     */
+    listWorkflowMemoryChunksRequestOpts(requestParameters: ListWorkflowMemoryChunksRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary List Workflow Memory Chunks Handler
+     * @param {string} definitionId 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowMemoryApiInterface
+     */
+    listWorkflowMemoryChunksRaw(requestParameters: ListWorkflowMemoryChunksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListMemoryChunksResponse>>;
+
+    /**
+     * List Workflow Memory Chunks Handler
+     */
+    listWorkflowMemoryChunks(requestParameters: ListWorkflowMemoryChunksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListMemoryChunksResponse>;
+
+}
+
+/**
+ * 
+ */
+export class WorkflowMemoryApi extends runtime.BaseAPI implements WorkflowMemoryApiInterface {
+
+    /**
+     * Creates request options for appendWorkflowMemoryChunk without sending the request
+     */
+    async appendWorkflowMemoryChunkRequestOpts(requestParameters: AppendWorkflowMemoryChunkRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['definitionId'] == null) {
+            throw new runtime.RequiredError(
+                'definitionId',
+                'Required parameter "definitionId" was null or undefined when calling appendWorkflowMemoryChunk().'
+            );
+        }
+
+        if (requestParameters['appendMemoryChunkRequest'] == null) {
+            throw new runtime.RequiredError(
+                'appendMemoryChunkRequest',
+                'Required parameter "appendMemoryChunkRequest" was null or undefined when calling appendWorkflowMemoryChunk().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/workflow-definitions/{definition_id}/memory/chunks`;
+        urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AppendMemoryChunkRequestToJSON(requestParameters['appendMemoryChunkRequest']),
+        };
+    }
+
+    /**
+     * Append a new memory chunk.  Exposed for external agents (e.g. self-hosted runners) that need to capture learnings without touching the DB directly. The new chunk\'s ``chunk_id`` is server-assigned. Each call snapshots a new DocumentVersion, just like edit/forget.
+     * Append Workflow Memory Chunk Handler
+     */
+    async appendWorkflowMemoryChunkRaw(requestParameters: AppendWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MemoryChunkResponse>> {
+        const requestOptions = await this.appendWorkflowMemoryChunkRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MemoryChunkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Append a new memory chunk.  Exposed for external agents (e.g. self-hosted runners) that need to capture learnings without touching the DB directly. The new chunk\'s ``chunk_id`` is server-assigned. Each call snapshots a new DocumentVersion, just like edit/forget.
+     * Append Workflow Memory Chunk Handler
+     */
+    async appendWorkflowMemoryChunk(requestParameters: AppendWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MemoryChunkResponse> {
+        const response = await this.appendWorkflowMemoryChunkRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for editWorkflowMemoryChunk without sending the request
+     */
+    async editWorkflowMemoryChunkRequestOpts(requestParameters: EditWorkflowMemoryChunkRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['definitionId'] == null) {
+            throw new runtime.RequiredError(
+                'definitionId',
+                'Required parameter "definitionId" was null or undefined when calling editWorkflowMemoryChunk().'
+            );
+        }
+
+        if (requestParameters['chunkId'] == null) {
+            throw new runtime.RequiredError(
+                'chunkId',
+                'Required parameter "chunkId" was null or undefined when calling editWorkflowMemoryChunk().'
+            );
+        }
+
+        if (requestParameters['editMemoryChunkRequest'] == null) {
+            throw new runtime.RequiredError(
+                'editMemoryChunkRequest',
+                'Required parameter "editMemoryChunkRequest" was null or undefined when calling editWorkflowMemoryChunk().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/workflow-definitions/{definition_id}/memory/chunks/{chunk_id}`;
+        urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
+        urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+
+        return {
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: EditMemoryChunkRequestToJSON(requestParameters['editMemoryChunkRequest']),
+        };
+    }
+
+    /**
+     * Edit Workflow Memory Chunk Handler
+     */
+    async editWorkflowMemoryChunkRaw(requestParameters: EditWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MemoryChunkResponse>> {
+        const requestOptions = await this.editWorkflowMemoryChunkRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MemoryChunkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Edit Workflow Memory Chunk Handler
+     */
+    async editWorkflowMemoryChunk(requestParameters: EditWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MemoryChunkResponse> {
+        const response = await this.editWorkflowMemoryChunkRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for forgetWorkflowMemoryChunk without sending the request
+     */
+    async forgetWorkflowMemoryChunkRequestOpts(requestParameters: ForgetWorkflowMemoryChunkRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['definitionId'] == null) {
+            throw new runtime.RequiredError(
+                'definitionId',
+                'Required parameter "definitionId" was null or undefined when calling forgetWorkflowMemoryChunk().'
+            );
+        }
+
+        if (requestParameters['chunkId'] == null) {
+            throw new runtime.RequiredError(
+                'chunkId',
+                'Required parameter "chunkId" was null or undefined when calling forgetWorkflowMemoryChunk().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/workflow-definitions/{definition_id}/memory/chunks/{chunk_id}`;
+        urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
+        urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Forget Workflow Memory Chunk Handler
+     */
+    async forgetWorkflowMemoryChunkRaw(requestParameters: ForgetWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.forgetWorkflowMemoryChunkRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Forget Workflow Memory Chunk Handler
+     */
+    async forgetWorkflowMemoryChunk(requestParameters: ForgetWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.forgetWorkflowMemoryChunkRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getWorkflowMemoryChunk without sending the request
+     */
+    async getWorkflowMemoryChunkRequestOpts(requestParameters: GetWorkflowMemoryChunkRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['definitionId'] == null) {
+            throw new runtime.RequiredError(
+                'definitionId',
+                'Required parameter "definitionId" was null or undefined when calling getWorkflowMemoryChunk().'
+            );
+        }
+
+        if (requestParameters['chunkId'] == null) {
+            throw new runtime.RequiredError(
+                'chunkId',
+                'Required parameter "chunkId" was null or undefined when calling getWorkflowMemoryChunk().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/workflow-definitions/{definition_id}/memory/chunks/{chunk_id}`;
+        urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
+        urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get Workflow Memory Chunk Handler
+     */
+    async getWorkflowMemoryChunkRaw(requestParameters: GetWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MemoryChunkResponse>> {
+        const requestOptions = await this.getWorkflowMemoryChunkRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MemoryChunkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get Workflow Memory Chunk Handler
+     */
+    async getWorkflowMemoryChunk(requestParameters: GetWorkflowMemoryChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MemoryChunkResponse> {
+        const response = await this.getWorkflowMemoryChunkRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listWorkflowMemoryChunks without sending the request
+     */
+    async listWorkflowMemoryChunksRequestOpts(requestParameters: ListWorkflowMemoryChunksRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['definitionId'] == null) {
+            throw new runtime.RequiredError(
+                'definitionId',
+                'Required parameter "definitionId" was null or undefined when calling listWorkflowMemoryChunks().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/workflow-definitions/{definition_id}/memory`;
+        urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List Workflow Memory Chunks Handler
+     */
+    async listWorkflowMemoryChunksRaw(requestParameters: ListWorkflowMemoryChunksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListMemoryChunksResponse>> {
+        const requestOptions = await this.listWorkflowMemoryChunksRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListMemoryChunksResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List Workflow Memory Chunks Handler
+     */
+    async listWorkflowMemoryChunks(requestParameters: ListWorkflowMemoryChunksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListMemoryChunksResponse> {
+        const response = await this.listWorkflowMemoryChunksRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}