@knowledge-stack/ksapi 1.66.2 → 1.67.0

package/dist/esm/apis/DocumentVersionsApi.js

@@ -0,0 +1,411 @@
+/* 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 { ClearVersionContentsResponseFromJSON, DocumentVersionActionResponseFromJSON, DocumentVersionMetadataUpdateToJSON, DocumentVersionResponseFromJSON, PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminatorFromJSON, PaginatedResponseDocumentVersionResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class DocumentVersionsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for clearDocumentVersionContents without sending the request
+     */
+    clearDocumentVersionContentsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['versionId'] == null) {
+                throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling clearDocumentVersionContents().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/document_versions/{version_id}/contents`;
+            urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    clearDocumentVersionContentsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.clearDocumentVersionContentsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ClearVersionContentsResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
+     * Clear Document Version Contents Handler
+     */
+    clearDocumentVersionContents(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.clearDocumentVersionContentsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for createDocumentVersion without sending the request
+     */
+    createDocumentVersionRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling createDocumentVersion().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/documents/{document_id}/versions`;
+            urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
+     * Create Document Version Handler
+     */
+    createDocumentVersionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createDocumentVersionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DocumentVersionResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
+     * Create Document Version Handler
+     */
+    createDocumentVersion(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createDocumentVersionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteDocumentVersion without sending the request
+     */
+    deleteDocumentVersionRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['versionId'] == null) {
+                throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling deleteDocumentVersion().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/document_versions/{version_id}`;
+            urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Delete a document version by its ID.  Cannot delete the active version of a document.
+     * Delete Document Version Handler
+     */
+    deleteDocumentVersionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteDocumentVersionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Delete a document version by its ID.  Cannot delete the active version of a document.
+     * Delete Document Version Handler
+     */
+    deleteDocumentVersion(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteDocumentVersionRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for documentVersionAction without sending the request
+     */
+    documentVersionActionRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['versionId'] == null) {
+                throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling documentVersionAction().');
+            }
+            if (requestParameters['action'] == null) {
+                throw new runtime.RequiredError('action', 'Required parameter "action" was null or undefined when calling documentVersionAction().');
+            }
+            const queryParameters = {};
+            if (requestParameters['action'] != null) {
+                queryParameters['action'] = requestParameters['action'];
+            }
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/document_versions/{version_id}`;
+            urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Perform an action on a document version.  Supported actions: - `reembed`: Re-embed all chunks for this version into Qdrant.
+     * Document Version Action Handler
+     */
+    documentVersionActionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.documentVersionActionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DocumentVersionActionResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Perform an action on a document version.  Supported actions: - `reembed`: Re-embed all chunks for this version into Qdrant.
+     * Document Version Action Handler
+     */
+    documentVersionAction(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.documentVersionActionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getDocumentVersion without sending the request
+     */
+    getDocumentVersionRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['versionId'] == null) {
+                throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling getDocumentVersion().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/document_versions/{version_id}`;
+            urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get a document version by its ID.
+     * Get Document Version Handler
+     */
+    getDocumentVersionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getDocumentVersionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DocumentVersionResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get a document version by its ID.
+     * Get Document Version Handler
+     */
+    getDocumentVersion(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDocumentVersionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getDocumentVersionContents without sending the request
+     */
+    getDocumentVersionContentsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['versionId'] == null) {
+                throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling getDocumentVersionContents().');
+            }
+            const queryParameters = {};
+            if (requestParameters['sectionId'] != null) {
+                queryParameters['section_id'] = requestParameters['sectionId'];
+            }
+            if (requestParameters['contentType'] != null) {
+                queryParameters['content_type'] = requestParameters['contentType'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['offset'] != null) {
+                queryParameters['offset'] = requestParameters['offset'];
+            }
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/document_versions/{version_id}/contents`;
+            urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").  Use `content_type` to return only one type (e.g. `content_type=CHUNK` for chunk-only pagination where offset/limit apply only to chunks).
+     * Get Document Version Contents Handler
+     */
+    getDocumentVersionContentsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getDocumentVersionContentsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminatorFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").  Use `content_type` to return only one type (e.g. `content_type=CHUNK` for chunk-only pagination where offset/limit apply only to chunks).
+     * Get Document Version Contents Handler
+     */
+    getDocumentVersionContents(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDocumentVersionContentsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listDocumentVersions without sending the request
+     */
+    listDocumentVersionsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling listDocumentVersions().');
+            }
+            const queryParameters = {};
+            if (requestParameters['documentId'] != null) {
+                queryParameters['document_id'] = requestParameters['documentId'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['offset'] != null) {
+                queryParameters['offset'] = requestParameters['offset'];
+            }
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/document_versions`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
+     * List Document Versions Handler
+     */
+    listDocumentVersionsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listDocumentVersionsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseDocumentVersionResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
+     * List Document Versions Handler
+     */
+    listDocumentVersions(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listDocumentVersionsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for updateDocumentVersionMetadata without sending the request
+     */
+    updateDocumentVersionMetadataRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['versionId'] == null) {
+                throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling updateDocumentVersionMetadata().');
+            }
+            if (requestParameters['documentVersionMetadataUpdate'] == null) {
+                throw new runtime.RequiredError('documentVersionMetadataUpdate', 'Required parameter "documentVersionMetadataUpdate" was null or undefined when calling updateDocumentVersionMetadata().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/document_versions/{version_id}/metadata`;
+            urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: DocumentVersionMetadataUpdateToJSON(requestParameters['documentVersionMetadataUpdate']),
+            };
+        });
+    }
+    /**
+     * Merge metadata fields into an existing document version\'s metadata.  Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
+     * Update Document Version Metadata Handler
+     */
+    updateDocumentVersionMetadataRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateDocumentVersionMetadataRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DocumentVersionResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Merge metadata fields into an existing document version\'s metadata.  Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
+     * Update Document Version Metadata Handler
+     */
+    updateDocumentVersionMetadata(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateDocumentVersionMetadataRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}