@knowledge-stack/ksapi 1.83.0 → 1.85.0

package/dist/apis/WorkflowMemoryApi.js

@@ -0,0 +1,299 @@
+"use strict";
+/* 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowMemoryApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class WorkflowMemoryApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for appendWorkflowMemoryChunk without sending the request
+     */
+    appendWorkflowMemoryChunkRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 = {};
+            const headerParameters = {};
+            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: (0, index_1.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
+     */
+    appendWorkflowMemoryChunkRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.appendWorkflowMemoryChunkRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.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
+     */
+    appendWorkflowMemoryChunk(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.appendWorkflowMemoryChunkRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for editWorkflowMemoryChunk without sending the request
+     */
+    editWorkflowMemoryChunkRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 = {};
+            const headerParameters = {};
+            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: (0, index_1.EditMemoryChunkRequestToJSON)(requestParameters['editMemoryChunkRequest']),
+            };
+        });
+    }
+    /**
+     * Edit Workflow Memory Chunk Handler
+     */
+    editWorkflowMemoryChunkRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.editWorkflowMemoryChunkRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MemoryChunkResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Edit Workflow Memory Chunk Handler
+     */
+    editWorkflowMemoryChunk(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.editWorkflowMemoryChunkRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for forgetWorkflowMemoryChunk without sending the request
+     */
+    forgetWorkflowMemoryChunkRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 = {};
+            const headerParameters = {};
+            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
+     */
+    forgetWorkflowMemoryChunkRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.forgetWorkflowMemoryChunkRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Forget Workflow Memory Chunk Handler
+     */
+    forgetWorkflowMemoryChunk(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.forgetWorkflowMemoryChunkRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getWorkflowMemoryChunk without sending the request
+     */
+    getWorkflowMemoryChunkRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 = {};
+            const headerParameters = {};
+            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
+     */
+    getWorkflowMemoryChunkRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getWorkflowMemoryChunkRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MemoryChunkResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get Workflow Memory Chunk Handler
+     */
+    getWorkflowMemoryChunk(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getWorkflowMemoryChunkRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listWorkflowMemoryChunks without sending the request
+     */
+    listWorkflowMemoryChunksRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['definitionId'] == null) {
+                throw new runtime.RequiredError('definitionId', 'Required parameter "definitionId" was null or undefined when calling listWorkflowMemoryChunks().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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
+     */
+    listWorkflowMemoryChunksRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listWorkflowMemoryChunksRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListMemoryChunksResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List Workflow Memory Chunks Handler
+     */
+    listWorkflowMemoryChunks(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listWorkflowMemoryChunksRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.WorkflowMemoryApi = WorkflowMemoryApi;

package/dist/apis/index.d.ts

@@ -4,6 +4,7 @@ export * from './AuthApi';
 export * from './ChunkLineagesApi';
 export * from './ChunksApi';
 export * from './DefaultApi';
+export * from './DocumentCheckoutApi';
 export * from './DocumentVersionsApi';
 export * from './DocumentsApi';
 export * from './FeaturesApi';
@@ -22,5 +23,6 @@ export * from './ThreadsApi';
 export * from './UserPermissionsApi';
 export * from './UsersApi';
 export * from './WorkflowDefinitionsApi';
+export * from './WorkflowMemoryApi';
 export * from './WorkflowRunsApi';
 export * from './WorkflowsApi';

package/dist/apis/index.js

@@ -22,6 +22,7 @@ __exportStar(require("./AuthApi"), exports);
 __exportStar(require("./ChunkLineagesApi"), exports);
 __exportStar(require("./ChunksApi"), exports);
 __exportStar(require("./DefaultApi"), exports);
+__exportStar(require("./DocumentCheckoutApi"), exports);
 __exportStar(require("./DocumentVersionsApi"), exports);
 __exportStar(require("./DocumentsApi"), exports);
 __exportStar(require("./FeaturesApi"), exports);
@@ -40,5 +41,6 @@ __exportStar(require("./ThreadsApi"), exports);
 __exportStar(require("./UserPermissionsApi"), exports);
 __exportStar(require("./UsersApi"), exports);
 __exportStar(require("./WorkflowDefinitionsApi"), exports);
+__exportStar(require("./WorkflowMemoryApi"), exports);
 __exportStar(require("./WorkflowRunsApi"), exports);
 __exportStar(require("./WorkflowsApi"), exports);

package/dist/esm/apis/DocumentCheckoutApi.d.ts

@@ -0,0 +1,158 @@
+/**
+ * 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 { DocumentCheckoutResponse } from '../models/index';
+export interface AcquireDocumentCheckoutRequest {
+    pathPartId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface GetDocumentCheckoutRequest {
+    pathPartId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface ReleaseDocumentCheckoutRequest {
+    pathPartId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+/**
+ * DocumentCheckoutApi - interface
+ *
+ * @export
+ * @interface DocumentCheckoutApiInterface
+ */
+export interface DocumentCheckoutApiInterface {
+    /**
+     * Creates request options for acquireDocumentCheckout without sending the request
+     * @param {string} pathPartId Document\'s PathPart ID
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    acquireDocumentCheckoutRequestOpts(requestParameters: AcquireDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * @summary Acquire Document Checkout Handler
+     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    acquireDocumentCheckoutRaw(requestParameters: AcquireDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentCheckoutResponse>>;
+    /**
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire Document Checkout Handler
+     */
+    acquireDocumentCheckout(requestParameters: AcquireDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCheckoutResponse>;
+    /**
+     * Creates request options for getDocumentCheckout without sending the request
+     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    getDocumentCheckoutRequestOpts(requestParameters: GetDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
+     * @summary Get Document Checkout Handler
+     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    getDocumentCheckoutRaw(requestParameters: GetDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentCheckoutResponse>>;
+    /**
+     * Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
+     * Get Document Checkout Handler
+     */
+    getDocumentCheckout(requestParameters: GetDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCheckoutResponse>;
+    /**
+     * Creates request options for releaseDocumentCheckout without sending the request
+     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    releaseDocumentCheckoutRequestOpts(requestParameters: ReleaseDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
+     * @summary Release Document Checkout Handler
+     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    releaseDocumentCheckoutRaw(requestParameters: ReleaseDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
+     * Release Document Checkout Handler
+     */
+    releaseDocumentCheckout(requestParameters: ReleaseDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class DocumentCheckoutApi extends runtime.BaseAPI implements DocumentCheckoutApiInterface {
+    /**
+     * Creates request options for acquireDocumentCheckout without sending the request
+     */
+    acquireDocumentCheckoutRequestOpts(requestParameters: AcquireDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire Document Checkout Handler
+     */
+    acquireDocumentCheckoutRaw(requestParameters: AcquireDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentCheckoutResponse>>;
+    /**
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire Document Checkout Handler
+     */
+    acquireDocumentCheckout(requestParameters: AcquireDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCheckoutResponse>;
+    /**
+     * Creates request options for getDocumentCheckout without sending the request
+     */
+    getDocumentCheckoutRequestOpts(requestParameters: GetDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
+     * Get Document Checkout Handler
+     */
+    getDocumentCheckoutRaw(requestParameters: GetDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentCheckoutResponse>>;
+    /**
+     * Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
+     * Get Document Checkout Handler
+     */
+    getDocumentCheckout(requestParameters: GetDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCheckoutResponse>;
+    /**
+     * Creates request options for releaseDocumentCheckout without sending the request
+     */
+    releaseDocumentCheckoutRequestOpts(requestParameters: ReleaseDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
+     * Release Document Checkout Handler
+     */
+    releaseDocumentCheckoutRaw(requestParameters: ReleaseDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
+     * Release Document Checkout Handler
+     */
+    releaseDocumentCheckout(requestParameters: ReleaseDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}

package/dist/esm/apis/DocumentCheckoutApi.js

@@ -0,0 +1,160 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { DocumentCheckoutResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class DocumentCheckoutApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for acquireDocumentCheckout without sending the request
+     */
+    acquireDocumentCheckoutRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['pathPartId'] == null) {
+                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling acquireDocumentCheckout().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/documents/{path_part_id}/checkout`;
+            urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire Document Checkout Handler
+     */
+    acquireDocumentCheckoutRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.acquireDocumentCheckoutRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DocumentCheckoutResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire Document Checkout Handler
+     */
+    acquireDocumentCheckout(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.acquireDocumentCheckoutRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getDocumentCheckout without sending the request
+     */
+    getDocumentCheckoutRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['pathPartId'] == null) {
+                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling getDocumentCheckout().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/documents/{path_part_id}/checkout`;
+            urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
+     * Get Document Checkout Handler
+     */
+    getDocumentCheckoutRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getDocumentCheckoutRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DocumentCheckoutResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
+     * Get Document Checkout Handler
+     */
+    getDocumentCheckout(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDocumentCheckoutRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for releaseDocumentCheckout without sending the request
+     */
+    releaseDocumentCheckoutRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['pathPartId'] == null) {
+                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling releaseDocumentCheckout().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/documents/{path_part_id}/checkout`;
+            urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
+     * Release Document Checkout Handler
+     */
+    releaseDocumentCheckoutRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.releaseDocumentCheckoutRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
+     * Release Document Checkout Handler
+     */
+    releaseDocumentCheckout(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.releaseDocumentCheckoutRaw(requestParameters, initOverrides);
+        });
+    }
+}