@knowledge-stack/ksapi 1.23.4 → 1.24.0

package/src/apis/DocumentsApi.ts

@@ -85,6 +85,15 @@ 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
@@ -102,6 +111,15 @@ export interface DocumentsApiInterface {
      */
     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
@@ -119,6 +137,16 @@ export interface DocumentsApiInterface {
      */
     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
@@ -137,6 +165,17 @@ export interface DocumentsApiInterface {
      */
     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
@@ -156,6 +195,19 @@ export interface DocumentsApiInterface {
      */
     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
@@ -177,6 +229,16 @@ export interface DocumentsApiInterface {
      */
     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
@@ -203,10 +265,9 @@ export interface DocumentsApiInterface {
 export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterface {
 
     /**
-     * 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
+     * Creates request options for createDocument without sending the request
      */
-    async createDocumentRaw(requestParameters: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>> {
+    async createDocumentRequestOpts(requestParameters: CreateDocumentOperationRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['createDocumentRequest'] == null) {
             throw new runtime.RequiredError(
                 'createDocumentRequest',
@@ -223,13 +284,22 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
 
         let urlPath = `/v1/documents`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: CreateDocumentRequestToJSON(requestParameters['createDocumentRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * 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
+     */
+    async createDocumentRaw(requestParameters: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>> {
+        const requestOptions = await this.createDocumentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResponseFromJSON(jsonValue));
     }
@@ -244,10 +314,9 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
     }
 
     /**
-     * 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
+     * Creates request options for deleteDocument without sending the request
      */
-    async deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['documentId'] == null) {
             throw new runtime.RequiredError(
                 'documentId',
@@ -263,12 +332,21 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
         let urlPath = `/v1/documents/{document_id}`;
         urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'DELETE',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * 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
+     */
+    async deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteDocumentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
@@ -282,10 +360,9 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
     }
 
     /**
-     * Get a document by its document ID.
-     * Get Document Handler
+     * Creates request options for getDocument without sending the request
      */
-    async getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>> {
+    async getDocumentRequestOpts(requestParameters: GetDocumentRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['documentId'] == null) {
             throw new runtime.RequiredError(
                 'documentId',
@@ -305,12 +382,21 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
         let urlPath = `/v1/documents/{document_id}`;
         urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get a document by its document ID.
+     * Get Document Handler
+     */
+    async getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>> {
+        const requestOptions = await this.getDocumentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResponseFromJSON(jsonValue));
     }
@@ -325,10 +411,9 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
     }
 
     /**
-     * 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
+     * Creates request options for ingestDocument without sending the request
      */
-    async ingestDocumentRaw(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>> {
+    async ingestDocumentRequestOpts(requestParameters: IngestDocumentRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['file'] == null) {
             throw new runtime.RequiredError(
                 'file',
@@ -378,13 +463,22 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
 
         let urlPath = `/v1/documents/ingest`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: formParams,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * 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
+     */
+    async ingestDocumentRaw(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>> {
+        const requestOptions = await this.ingestDocumentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => IngestDocumentResponseFromJSON(jsonValue));
     }
@@ -399,10 +493,9 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
     }
 
     /**
-     * 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
+     * Creates request options for listDocuments without sending the request
      */
-    async listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>> {
+    async listDocumentsRequestOpts(requestParameters: ListDocumentsRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         if (requestParameters['parentPathPartId'] != null) {
@@ -430,12 +523,21 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
 
         let urlPath = `/v1/documents`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * 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
+     */
+    async listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>> {
+        const requestOptions = await this.listDocumentsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseDocumentResponseFromJSON(jsonValue));
     }
@@ -450,10 +552,9 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
     }
 
     /**
-     * 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
+     * Creates request options for updateDocument without sending the request
      */
-    async updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>> {
+    async updateDocumentRequestOpts(requestParameters: UpdateDocumentOperationRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['documentId'] == null) {
             throw new runtime.RequiredError(
                 'documentId',
@@ -478,13 +579,22 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
         let urlPath = `/v1/documents/{document_id}`;
         urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'PATCH',
             headers: headerParameters,
             query: queryParameters,
             body: UpdateDocumentRequestToJSON(requestParameters['updateDocumentRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * 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
+     */
+    async updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>> {
+        const requestOptions = await this.updateDocumentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResponseFromJSON(jsonValue));
     }