@knowledge-stack/ksapi 1.23.5 → 1.24.0

package/src/apis/DocumentVersionsApi.ts

@@ -19,7 +19,7 @@ import type {
   DocumentVersionMetadataUpdate,
   DocumentVersionResponse,
   HTTPValidationError,
-  PaginatedResponseDocumentContentPathPart,
+  PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator,
   PaginatedResponseDocumentVersionResponse,
 } from '../models/index';
 import {
@@ -31,8 +31,8 @@ import {
     DocumentVersionResponseToJSON,
     HTTPValidationErrorFromJSON,
     HTTPValidationErrorToJSON,
-    PaginatedResponseDocumentContentPathPartFromJSON,
-    PaginatedResponseDocumentContentPathPartToJSON,
+    PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminatorFromJSON,
+    PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminatorToJSON,
     PaginatedResponseDocumentVersionResponseFromJSON,
     PaginatedResponseDocumentVersionResponseToJSON,
 } from '../models/index';
@@ -85,6 +85,15 @@ export interface UpdateDocumentVersionMetadataRequest {
  * @interface DocumentVersionsApiInterface
  */
 export interface DocumentVersionsApiInterface {
+    /**
+     * Creates request options for clearDocumentVersionContents without sending the request
+     * @param {string} versionId DocumentVersion ID
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    clearDocumentVersionContentsRequestOpts(requestParameters: ClearDocumentVersionContentsRequest): Promise<runtime.RequestOpts>;
+
     /**
      * 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.
      * @summary Clear Document Version Contents Handler
@@ -102,6 +111,15 @@ export interface DocumentVersionsApiInterface {
      */
     clearDocumentVersionContents(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClearVersionContentsResponse>;
 
+    /**
+     * Creates request options for createDocumentVersion without sending the request
+     * @param {string} documentId Document ID
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    createDocumentVersionRequestOpts(requestParameters: CreateDocumentVersionRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
      * @summary Create Document Version Handler
@@ -119,6 +137,15 @@ export interface DocumentVersionsApiInterface {
      */
     createDocumentVersion(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
 
+    /**
+     * Creates request options for deleteDocumentVersion without sending the request
+     * @param {string} versionId DocumentVersion ID
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    deleteDocumentVersionRequestOpts(requestParameters: DeleteDocumentVersionRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Delete a document version by its ID.  Cannot delete the active version of a document.
      * @summary Delete Document Version Handler
@@ -136,6 +163,15 @@ export interface DocumentVersionsApiInterface {
      */
     deleteDocumentVersion(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
+    /**
+     * Creates request options for getDocumentVersion without sending the request
+     * @param {string} versionId DocumentVersion ID
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    getDocumentVersionRequestOpts(requestParameters: GetDocumentVersionRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Get a document version by its ID.
      * @summary Get Document Version Handler
@@ -154,7 +190,19 @@ export interface DocumentVersionsApiInterface {
     getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
 
     /**
-     * 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.
+     * Creates request options for getDocumentVersionContents without sending the request
+     * @param {string} versionId DocumentVersion ID
+     * @param {string} [sectionId] Optional section ID to scope traversal to a subtree
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    getDocumentVersionContentsRequestOpts(requestParameters: GetDocumentVersionContentsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 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\").
      * @summary Get Document Version Contents Handler
      * @param {string} versionId DocumentVersion ID
      * @param {string} [sectionId] Optional section ID to scope traversal to a subtree
@@ -165,13 +213,24 @@ export interface DocumentVersionsApiInterface {
      * @throws {RequiredError}
      * @memberof DocumentVersionsApiInterface
      */
-    getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentContentPathPart>>;
+    getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator>>;
 
     /**
-     * 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
      */
-    getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentContentPathPart>;
+    getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator>;
+
+    /**
+     * Creates request options for listDocumentVersions without sending the request
+     * @param {string} documentId Document ID to list versions for
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    listDocumentVersionsRequestOpts(requestParameters: ListDocumentVersionsRequest): Promise<runtime.RequestOpts>;
 
     /**
      * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
@@ -192,6 +251,16 @@ export interface DocumentVersionsApiInterface {
      */
     listDocumentVersions(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentVersionResponse>;
 
+    /**
+     * Creates request options for updateDocumentVersionMetadata without sending the request
+     * @param {string} versionId DocumentVersion ID
+     * @param {DocumentVersionMetadataUpdate} documentVersionMetadataUpdate 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    updateDocumentVersionMetadataRequestOpts(requestParameters: UpdateDocumentVersionMetadataRequest): Promise<runtime.RequestOpts>;
+
     /**
      * 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.
      * @summary Update Document Version Metadata Handler
@@ -218,10 +287,9 @@ export interface DocumentVersionsApiInterface {
 export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVersionsApiInterface {
 
     /**
-     * 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
      */
-    async clearDocumentVersionContentsRaw(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClearVersionContentsResponse>> {
+    async clearDocumentVersionContentsRequestOpts(requestParameters: ClearDocumentVersionContentsRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['versionId'] == null) {
             throw new runtime.RequiredError(
                 'versionId',
@@ -237,12 +305,21 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
         let urlPath = `/v1/document_versions/{version_id}/contents`;
         urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
 
-        const response = await 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
+     */
+    async clearDocumentVersionContentsRaw(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClearVersionContentsResponse>> {
+        const requestOptions = await this.clearDocumentVersionContentsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => ClearVersionContentsResponseFromJSON(jsonValue));
     }
@@ -257,10 +334,9 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
     }
 
     /**
-     * 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
      */
-    async createDocumentVersionRaw(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>> {
+    async createDocumentVersionRequestOpts(requestParameters: CreateDocumentVersionRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['documentId'] == null) {
             throw new runtime.RequiredError(
                 'documentId',
@@ -276,12 +352,21 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
         let urlPath = `/v1/documents/{document_id}/versions`;
         urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
 
-        const response = await 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
+     */
+    async createDocumentVersionRaw(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>> {
+        const requestOptions = await this.createDocumentVersionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => DocumentVersionResponseFromJSON(jsonValue));
     }
@@ -296,10 +381,9 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
     }
 
     /**
-     * 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
      */
-    async deleteDocumentVersionRaw(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async deleteDocumentVersionRequestOpts(requestParameters: DeleteDocumentVersionRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['versionId'] == null) {
             throw new runtime.RequiredError(
                 'versionId',
@@ -315,12 +399,21 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
         let urlPath = `/v1/document_versions/{version_id}`;
         urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
 
-        const response = await 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
+     */
+    async deleteDocumentVersionRaw(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteDocumentVersionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
@@ -334,10 +427,9 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
     }
 
     /**
-     * Get a document version by its ID.
-     * Get Document Version Handler
+     * Creates request options for getDocumentVersion without sending the request
      */
-    async getDocumentVersionRaw(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>> {
+    async getDocumentVersionRequestOpts(requestParameters: GetDocumentVersionRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['versionId'] == null) {
             throw new runtime.RequiredError(
                 'versionId',
@@ -353,12 +445,21 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
         let urlPath = `/v1/document_versions/{version_id}`;
         urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get a document version by its ID.
+     * Get Document Version Handler
+     */
+    async getDocumentVersionRaw(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>> {
+        const requestOptions = await this.getDocumentVersionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => DocumentVersionResponseFromJSON(jsonValue));
     }
@@ -373,10 +474,9 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
     }
 
     /**
-     * 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
      */
-    async getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentContentPathPart>> {
+    async getDocumentVersionContentsRequestOpts(requestParameters: GetDocumentVersionContentsRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['versionId'] == null) {
             throw new runtime.RequiredError(
                 'versionId',
@@ -404,30 +504,38 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
         let urlPath = `/v1/document_versions/{version_id}/contents`;
         urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
 
-        const response = await 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 discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").
+     * Get Document Version Contents Handler
+     */
+    async getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator>> {
+        const requestOptions = await this.getDocumentVersionContentsRequestOpts(requestParameters);
+        const response = await 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 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
      */
-    async getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentContentPathPart> {
+    async getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator> {
         const response = await this.getDocumentVersionContentsRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
-     * 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
      */
-    async listDocumentVersionsRaw(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentVersionResponse>> {
+    async listDocumentVersionsRequestOpts(requestParameters: ListDocumentVersionsRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['documentId'] == null) {
             throw new runtime.RequiredError(
                 'documentId',
@@ -454,12 +562,21 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
 
         let urlPath = `/v1/document_versions`;
 
-        const response = await 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
+     */
+    async listDocumentVersionsRaw(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentVersionResponse>> {
+        const requestOptions = await this.listDocumentVersionsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseDocumentVersionResponseFromJSON(jsonValue));
     }
@@ -474,10 +591,9 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
     }
 
     /**
-     * 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
      */
-    async updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>> {
+    async updateDocumentVersionMetadataRequestOpts(requestParameters: UpdateDocumentVersionMetadataRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['versionId'] == null) {
             throw new runtime.RequiredError(
                 'versionId',
@@ -502,13 +618,22 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
         let urlPath = `/v1/document_versions/{version_id}/metadata`;
         urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
 
-        const response = await 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
+     */
+    async updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>> {
+        const requestOptions = await this.updateDocumentVersionMetadataRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => DocumentVersionResponseFromJSON(jsonValue));
     }