@knowledge-stack/ksapi 1.23.5 → 1.25.0

package/dist/esm/apis/DocumentVersionsApi.js

@@ -21,16 +21,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { ClearVersionContentsResponseFromJSON, DocumentVersionMetadataUpdateToJSON, DocumentVersionResponseFromJSON, PaginatedResponseDocumentContentPathPartFromJSON, PaginatedResponseDocumentVersionResponseFromJSON, } from '../models/index';
+import { ClearVersionContentsResponseFromJSON, DocumentVersionMetadataUpdateToJSON, DocumentVersionResponseFromJSON, PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminatorFromJSON, PaginatedResponseDocumentVersionResponseFromJSON, } from '../models/index';
 /**
  *
  */
 export class DocumentVersionsApi extends runtime.BaseAPI {
     /**
-     * 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
+     * Creates request options for clearDocumentVersionContents without sending the request
      */
-    clearDocumentVersionContentsRaw(requestParameters, initOverrides) {
+    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().');
@@ -39,12 +38,22 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/document_versions/{version_id}/contents`;
             urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'DELETE',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * 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));
         });
     }
@@ -59,10 +68,9 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
-     * Create Document Version Handler
+     * Creates request options for createDocumentVersion without sending the request
      */
-    createDocumentVersionRaw(requestParameters, initOverrides) {
+    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().');
@@ -71,12 +79,22 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/documents/{document_id}/versions`;
             urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * 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));
         });
     }
@@ -91,10 +109,9 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Delete a document version by its ID.  Cannot delete the active version of a document.
-     * Delete Document Version Handler
+     * Creates request options for deleteDocumentVersion without sending the request
      */
-    deleteDocumentVersionRaw(requestParameters, initOverrides) {
+    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().');
@@ -103,12 +120,22 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/document_versions/{version_id}`;
             urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'DELETE',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * 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);
         });
     }
@@ -122,10 +149,9 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get a document version by its ID.
-     * Get Document Version Handler
+     * Creates request options for getDocumentVersion without sending the request
      */
-    getDocumentVersionRaw(requestParameters, initOverrides) {
+    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().');
@@ -134,12 +160,22 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/document_versions/{version_id}`;
             urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * 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));
         });
     }
@@ -154,10 +190,9 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * List all sections and chunks for a document version in depth-first logical order.  Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
-     * Get Document Version Contents Handler
+     * Creates request options for getDocumentVersionContents without sending the request
      */
-    getDocumentVersionContentsRaw(requestParameters, initOverrides) {
+    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().');
@@ -175,17 +210,27 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/document_versions/{version_id}/contents`;
             urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseDocumentContentPathPartFromJSON(jsonValue));
+            };
         });
     }
     /**
-     * List all sections and chunks for a document version in depth-first logical order.  Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
+     * 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\").
+     * 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\").
      * Get Document Version Contents Handler
      */
     getDocumentVersionContents(requestParameters, initOverrides) {
@@ -195,10 +240,9 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
-     * List Document Versions Handler
+     * Creates request options for listDocumentVersions without sending the request
      */
-    listDocumentVersionsRaw(requestParameters, initOverrides) {
+    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().');
@@ -215,12 +259,22 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
             }
             const headerParameters = {};
             let urlPath = `/v1/document_versions`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * 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));
         });
     }
@@ -235,10 +289,9 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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
+     * Creates request options for updateDocumentVersionMetadata without sending the request
      */
-    updateDocumentVersionMetadataRaw(requestParameters, initOverrides) {
+    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().');
@@ -251,13 +304,23 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/v1/document_versions/{version_id}/metadata`;
             urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'PATCH',
                 headers: headerParameters,
                 query: queryParameters,
                 body: DocumentVersionMetadataUpdateToJSON(requestParameters['documentVersionMetadataUpdate']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * 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));
         });
     }

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

@@ -50,6 +50,14 @@ export interface UpdateDocumentOperationRequest {
  * @interface DocumentsApiInterface
  */
 export interface DocumentsApiInterface {
+    /**
+     * Creates request options for createDocument without sending the request
+     * @param {CreateDocumentRequest} createDocumentRequest
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    createDocumentRequestOpts(requestParameters: CreateDocumentOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Create a new document with initial v0 version.  The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
      * @summary Create Document Handler
@@ -65,6 +73,14 @@ export interface DocumentsApiInterface {
      * Create Document Handler
      */
     createDocument(requestParameters: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
+    /**
+     * Creates request options for deleteDocument without sending the request
+     * @param {string} documentId
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts>;
     /**
      * Delete a document and all its contents.  WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
      * @summary Delete Document Handler
@@ -80,6 +96,15 @@ export interface DocumentsApiInterface {
      * Delete Document Handler
      */
     deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getDocument without sending the request
+     * @param {string} documentId
+     * @param {boolean} [withTags] Include tags in the response (default: false)
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    getDocumentRequestOpts(requestParameters: GetDocumentRequest): Promise<runtime.RequestOpts>;
     /**
      * Get a document by its document ID.
      * @summary Get Document Handler
@@ -96,6 +121,16 @@ export interface DocumentsApiInterface {
      * Get Document Handler
      */
     getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
+    /**
+     * Creates request options for ingestDocument without sending the request
+     * @param {Blob} file
+     * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
+     * @param {string} [ksUat]
+     * @param {string} [name] Document name (defaults to filename)
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    ingestDocumentRequestOpts(requestParameters: IngestDocumentRequest): Promise<runtime.RequestOpts>;
     /**
      * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.  Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
      * @summary Ingest Document Handler
@@ -113,6 +148,18 @@ export interface DocumentsApiInterface {
      * Ingest Document Handler
      */
     ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
+    /**
+     * Creates request options for listDocuments without sending the request
+     * @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
+     * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
+     * @param {boolean} [withTags] Include tags in the response (default: false)
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    listDocumentsRequestOpts(requestParameters: ListDocumentsRequest): Promise<runtime.RequestOpts>;
     /**
      * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
      * @summary List Documents Handler
@@ -132,6 +179,15 @@ export interface DocumentsApiInterface {
      * List Documents Handler
      */
     listDocuments(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
+    /**
+     * Creates request options for updateDocument without sending the request
+     * @param {string} documentId
+     * @param {UpdateDocumentRequest} updateDocumentRequest
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    updateDocumentRequestOpts(requestParameters: UpdateDocumentOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Update a document (rename, move, and/or change active version).  To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
      * @summary Update Document Handler
@@ -153,6 +209,10 @@ export interface DocumentsApiInterface {
  *
  */
 export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterface {
+    /**
+     * Creates request options for createDocument without sending the request
+     */
+    createDocumentRequestOpts(requestParameters: CreateDocumentOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Create a new document with initial v0 version.  The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
      * Create Document Handler
@@ -163,6 +223,10 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
      * Create Document Handler
      */
     createDocument(requestParameters: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
+    /**
+     * Creates request options for deleteDocument without sending the request
+     */
+    deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts>;
     /**
      * Delete a document and all its contents.  WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
      * Delete Document Handler
@@ -173,6 +237,10 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
      * Delete Document Handler
      */
     deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getDocument without sending the request
+     */
+    getDocumentRequestOpts(requestParameters: GetDocumentRequest): Promise<runtime.RequestOpts>;
     /**
      * Get a document by its document ID.
      * Get Document Handler
@@ -183,6 +251,10 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
      * Get Document Handler
      */
     getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
+    /**
+     * Creates request options for ingestDocument without sending the request
+     */
+    ingestDocumentRequestOpts(requestParameters: IngestDocumentRequest): Promise<runtime.RequestOpts>;
     /**
      * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.  Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
      * Ingest Document Handler
@@ -193,6 +265,10 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
      * Ingest Document Handler
      */
     ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
+    /**
+     * Creates request options for listDocuments without sending the request
+     */
+    listDocumentsRequestOpts(requestParameters: ListDocumentsRequest): Promise<runtime.RequestOpts>;
     /**
      * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
      * List Documents Handler
@@ -203,6 +279,10 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
      * List Documents Handler
      */
     listDocuments(requestParameters?: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
+    /**
+     * Creates request options for updateDocument without sending the request
+     */
+    updateDocumentRequestOpts(requestParameters: UpdateDocumentOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Update a document (rename, move, and/or change active version).  To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
      * Update Document Handler