@coraxai/api-client 2.313.0

package/src/apis/KnowledgeCollectionsApi.ts

@@ -0,0 +1,684 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Corax API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v2.313.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 {
+  Collection,
+  CollectionCreate,
+  CollectionUpdate,
+  DocumentEmbeddingResponse,
+  HTTPValidationError,
+  PagedResponseModelCollection,
+  PagedResponseModelDocument,
+} from '../models/index';
+import {
+    CollectionFromJSON,
+    CollectionToJSON,
+    CollectionCreateFromJSON,
+    CollectionCreateToJSON,
+    CollectionUpdateFromJSON,
+    CollectionUpdateToJSON,
+    DocumentEmbeddingResponseFromJSON,
+    DocumentEmbeddingResponseToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    PagedResponseModelCollectionFromJSON,
+    PagedResponseModelCollectionToJSON,
+    PagedResponseModelDocumentFromJSON,
+    PagedResponseModelDocumentToJSON,
+} from '../models/index';
+
+export interface CreateCollectionAsyncV1CollectionsPostRequest {
+    collectionCreate: CollectionCreate;
+}
+
+export interface DeleteCollectionV1CollectionsCollectionIdDeleteRequest {
+    collectionId: string;
+}
+
+export interface DeleteDocumentV1CollectionsCollectionIdDocumentsDocumentIdDeleteRequest {
+    collectionId: string;
+    documentId: string;
+}
+
+export interface DownloadDocumentTextV1CollectionsCollectionIdDocumentsDocumentIdTextGetRequest {
+    collectionId: string;
+    documentId: string;
+}
+
+export interface DownloadDocumentV1CollectionsCollectionIdDocumentsDocumentIdDownloadGetRequest {
+    collectionId: string;
+    documentId: string;
+}
+
+export interface EmbedDocumentsToCollectionAsyncV1CollectionsCollectionIdEmbedPostRequest {
+    collectionId: string;
+    files: Array<string>;
+}
+
+export interface ReadCollectionAsyncV1CollectionsCollectionIdGetRequest {
+    collectionId: string;
+}
+
+export interface ReadCollectionDocumentsAsyncV1CollectionsCollectionIdDocumentsGetRequest {
+    collectionId: string;
+    page?: number;
+    size?: number;
+    sort?: string;
+    filter?: string | null;
+}
+
+export interface ReadCollectionsAsyncV1CollectionsGetRequest {
+    page?: number;
+    size?: number;
+    sort?: string;
+    filter?: string | null;
+}
+
+export interface UpdateCollectionAsyncV1CollectionsCollectionIdPutRequest {
+    collectionId: string;
+    collectionUpdate: CollectionUpdate;
+}
+
+/**
+ * 
+ */
+export class KnowledgeCollectionsApi extends runtime.BaseAPI {
+
+    /**
+     * Create Collection Async
+     */
+    async createCollectionAsyncV1CollectionsPostRaw(requestParameters: CreateCollectionAsyncV1CollectionsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Collection>> {
+        if (requestParameters['collectionCreate'] == null) {
+            throw new runtime.RequiredError(
+                'collectionCreate',
+                'Required parameter "collectionCreate" was null or undefined when calling createCollectionAsyncV1CollectionsPost().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // APIKeyHeader authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("HTTPBearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/collections`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CollectionCreateToJSON(requestParameters['collectionCreate']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CollectionFromJSON(jsonValue));
+    }
+
+    /**
+     * Create Collection Async
+     */
+    async createCollectionAsyncV1CollectionsPost(requestParameters: CreateCollectionAsyncV1CollectionsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Collection> {
+        const response = await this.createCollectionAsyncV1CollectionsPostRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Delete Collection
+     */
+    async deleteCollectionV1CollectionsCollectionIdDeleteRaw(requestParameters: DeleteCollectionV1CollectionsCollectionIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['collectionId'] == null) {
+            throw new runtime.RequiredError(
+                'collectionId',
+                'Required parameter "collectionId" was null or undefined when calling deleteCollectionV1CollectionsCollectionIdDelete().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // APIKeyHeader authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("HTTPBearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/collections/{collection_id}`;
+        urlPath = urlPath.replace(`{${"collection_id"}}`, encodeURIComponent(String(requestParameters['collectionId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete Collection
+     */
+    async deleteCollectionV1CollectionsCollectionIdDelete(requestParameters: DeleteCollectionV1CollectionsCollectionIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteCollectionV1CollectionsCollectionIdDeleteRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Delete Document
+     */
+    async deleteDocumentV1CollectionsCollectionIdDocumentsDocumentIdDeleteRaw(requestParameters: DeleteDocumentV1CollectionsCollectionIdDocumentsDocumentIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['collectionId'] == null) {
+            throw new runtime.RequiredError(
+                'collectionId',
+                'Required parameter "collectionId" was null or undefined when calling deleteDocumentV1CollectionsCollectionIdDocumentsDocumentIdDelete().'
+            );
+        }
+
+        if (requestParameters['documentId'] == null) {
+            throw new runtime.RequiredError(
+                'documentId',
+                'Required parameter "documentId" was null or undefined when calling deleteDocumentV1CollectionsCollectionIdDocumentsDocumentIdDelete().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // APIKeyHeader authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("HTTPBearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/collections/{collection_id}/documents/{document_id}`;
+        urlPath = urlPath.replace(`{${"collection_id"}}`, encodeURIComponent(String(requestParameters['collectionId'])));
+        urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete Document
+     */
+    async deleteDocumentV1CollectionsCollectionIdDocumentsDocumentIdDelete(requestParameters: DeleteDocumentV1CollectionsCollectionIdDocumentsDocumentIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteDocumentV1CollectionsCollectionIdDocumentsDocumentIdDeleteRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Download the extracted text (Markdown) for a document from object storage.
+     * Download extracted document text (Markdown)
+     */
+    async downloadDocumentTextV1CollectionsCollectionIdDocumentsDocumentIdTextGetRaw(requestParameters: DownloadDocumentTextV1CollectionsCollectionIdDocumentsDocumentIdTextGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>> {
+        if (requestParameters['collectionId'] == null) {
+            throw new runtime.RequiredError(
+                'collectionId',
+                'Required parameter "collectionId" was null or undefined when calling downloadDocumentTextV1CollectionsCollectionIdDocumentsDocumentIdTextGet().'
+            );
+        }
+
+        if (requestParameters['documentId'] == null) {
+            throw new runtime.RequiredError(
+                'documentId',
+                'Required parameter "documentId" was null or undefined when calling downloadDocumentTextV1CollectionsCollectionIdDocumentsDocumentIdTextGet().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // APIKeyHeader authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("HTTPBearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/collections/{collection_id}/documents/{document_id}/text`;
+        urlPath = urlPath.replace(`{${"collection_id"}}`, encodeURIComponent(String(requestParameters['collectionId'])));
+        urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse<any>(response);
+        } else {
+            return new runtime.TextApiResponse(response) as any;
+        }
+    }
+
+    /**
+     * Download the extracted text (Markdown) for a document from object storage.
+     * Download extracted document text (Markdown)
+     */
+    async downloadDocumentTextV1CollectionsCollectionIdDocumentsDocumentIdTextGet(requestParameters: DownloadDocumentTextV1CollectionsCollectionIdDocumentsDocumentIdTextGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any> {
+        const response = await this.downloadDocumentTextV1CollectionsCollectionIdDocumentsDocumentIdTextGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Download the original uploaded file from object storage.
+     * Download original document
+     */
+    async downloadDocumentV1CollectionsCollectionIdDocumentsDocumentIdDownloadGetRaw(requestParameters: DownloadDocumentV1CollectionsCollectionIdDocumentsDocumentIdDownloadGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+        if (requestParameters['collectionId'] == null) {
+            throw new runtime.RequiredError(
+                'collectionId',
+                'Required parameter "collectionId" was null or undefined when calling downloadDocumentV1CollectionsCollectionIdDocumentsDocumentIdDownloadGet().'
+            );
+        }
+
+        if (requestParameters['documentId'] == null) {
+            throw new runtime.RequiredError(
+                'documentId',
+                'Required parameter "documentId" was null or undefined when calling downloadDocumentV1CollectionsCollectionIdDocumentsDocumentIdDownloadGet().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // APIKeyHeader authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("HTTPBearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/collections/{collection_id}/documents/{document_id}/download`;
+        urlPath = urlPath.replace(`{${"collection_id"}}`, encodeURIComponent(String(requestParameters['collectionId'])));
+        urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.BlobApiResponse(response);
+    }
+
+    /**
+     * Download the original uploaded file from object storage.
+     * Download original document
+     */
+    async downloadDocumentV1CollectionsCollectionIdDocumentsDocumentIdDownloadGet(requestParameters: DownloadDocumentV1CollectionsCollectionIdDocumentsDocumentIdDownloadGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
+        const response = await this.downloadDocumentV1CollectionsCollectionIdDocumentsDocumentIdDownloadGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Embed multiple documents to a specific collection asynchronously with HATEOAS links.  Args:     request (Request): The FastAPI request object for building HATEOAS links.     collection_id (uuid.UUID): The ID of the collection to embed documents to.     files (List[UploadFile]): A list of files to be embedded.     service (AsyncCollectionService): The collection service.     user (User): The current authenticated user.  Returns:     DocumentEmbeddingResponse: A response with HATEOAS links and embedding status.  Raises:     HTTPException: If the collection is not found or if there\'s an error during embedding.
+     * Embed Documents To Collection Async
+     */
+    async embedDocumentsToCollectionAsyncV1CollectionsCollectionIdEmbedPostRaw(requestParameters: EmbedDocumentsToCollectionAsyncV1CollectionsCollectionIdEmbedPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentEmbeddingResponse>> {
+        if (requestParameters['collectionId'] == null) {
+            throw new runtime.RequiredError(
+                'collectionId',
+                'Required parameter "collectionId" was null or undefined when calling embedDocumentsToCollectionAsyncV1CollectionsCollectionIdEmbedPost().'
+            );
+        }
+
+        if (requestParameters['files'] == null) {
+            throw new runtime.RequiredError(
+                'files',
+                'Required parameter "files" was null or undefined when calling embedDocumentsToCollectionAsyncV1CollectionsCollectionIdEmbedPost().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // APIKeyHeader authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("HTTPBearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['files'] != null) {
+            formParams.append('files', requestParameters['files']!.join(runtime.COLLECTION_FORMATS["csv"]));
+        }
+
+
+        let urlPath = `/v1/collections/{collection_id}/embed`;
+        urlPath = urlPath.replace(`{${"collection_id"}}`, encodeURIComponent(String(requestParameters['collectionId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DocumentEmbeddingResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Embed multiple documents to a specific collection asynchronously with HATEOAS links.  Args:     request (Request): The FastAPI request object for building HATEOAS links.     collection_id (uuid.UUID): The ID of the collection to embed documents to.     files (List[UploadFile]): A list of files to be embedded.     service (AsyncCollectionService): The collection service.     user (User): The current authenticated user.  Returns:     DocumentEmbeddingResponse: A response with HATEOAS links and embedding status.  Raises:     HTTPException: If the collection is not found or if there\'s an error during embedding.
+     * Embed Documents To Collection Async
+     */
+    async embedDocumentsToCollectionAsyncV1CollectionsCollectionIdEmbedPost(requestParameters: EmbedDocumentsToCollectionAsyncV1CollectionsCollectionIdEmbedPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentEmbeddingResponse> {
+        const response = await this.embedDocumentsToCollectionAsyncV1CollectionsCollectionIdEmbedPostRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Read Collection Async
+     */
+    async readCollectionAsyncV1CollectionsCollectionIdGetRaw(requestParameters: ReadCollectionAsyncV1CollectionsCollectionIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Collection>> {
+        if (requestParameters['collectionId'] == null) {
+            throw new runtime.RequiredError(
+                'collectionId',
+                'Required parameter "collectionId" was null or undefined when calling readCollectionAsyncV1CollectionsCollectionIdGet().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // APIKeyHeader authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("HTTPBearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/collections/{collection_id}`;
+        urlPath = urlPath.replace(`{${"collection_id"}}`, encodeURIComponent(String(requestParameters['collectionId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CollectionFromJSON(jsonValue));
+    }
+
+    /**
+     * Read Collection Async
+     */
+    async readCollectionAsyncV1CollectionsCollectionIdGet(requestParameters: ReadCollectionAsyncV1CollectionsCollectionIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Collection> {
+        const response = await this.readCollectionAsyncV1CollectionsCollectionIdGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Read Collection Documents Async
+     */
+    async readCollectionDocumentsAsyncV1CollectionsCollectionIdDocumentsGetRaw(requestParameters: ReadCollectionDocumentsAsyncV1CollectionsCollectionIdDocumentsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedResponseModelDocument>> {
+        if (requestParameters['collectionId'] == null) {
+            throw new runtime.RequiredError(
+                'collectionId',
+                'Required parameter "collectionId" was null or undefined when calling readCollectionDocumentsAsyncV1CollectionsCollectionIdDocumentsGet().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['size'] != null) {
+            queryParameters['size'] = requestParameters['size'];
+        }
+
+        if (requestParameters['sort'] != null) {
+            queryParameters['sort'] = requestParameters['sort'];
+        }
+
+        if (requestParameters['filter'] != null) {
+            queryParameters['filter'] = requestParameters['filter'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // APIKeyHeader authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("HTTPBearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/collections/{collection_id}/documents`;
+        urlPath = urlPath.replace(`{${"collection_id"}}`, encodeURIComponent(String(requestParameters['collectionId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PagedResponseModelDocumentFromJSON(jsonValue));
+    }
+
+    /**
+     * Read Collection Documents Async
+     */
+    async readCollectionDocumentsAsyncV1CollectionsCollectionIdDocumentsGet(requestParameters: ReadCollectionDocumentsAsyncV1CollectionsCollectionIdDocumentsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedResponseModelDocument> {
+        const response = await this.readCollectionDocumentsAsyncV1CollectionsCollectionIdDocumentsGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Read Collections Async
+     */
+    async readCollectionsAsyncV1CollectionsGetRaw(requestParameters: ReadCollectionsAsyncV1CollectionsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PagedResponseModelCollection>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['size'] != null) {
+            queryParameters['size'] = requestParameters['size'];
+        }
+
+        if (requestParameters['sort'] != null) {
+            queryParameters['sort'] = requestParameters['sort'];
+        }
+
+        if (requestParameters['filter'] != null) {
+            queryParameters['filter'] = requestParameters['filter'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // APIKeyHeader authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("HTTPBearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/collections`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PagedResponseModelCollectionFromJSON(jsonValue));
+    }
+
+    /**
+     * Read Collections Async
+     */
+    async readCollectionsAsyncV1CollectionsGet(requestParameters: ReadCollectionsAsyncV1CollectionsGetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedResponseModelCollection> {
+        const response = await this.readCollectionsAsyncV1CollectionsGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update Collection Async
+     */
+    async updateCollectionAsyncV1CollectionsCollectionIdPutRaw(requestParameters: UpdateCollectionAsyncV1CollectionsCollectionIdPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Collection>> {
+        if (requestParameters['collectionId'] == null) {
+            throw new runtime.RequiredError(
+                'collectionId',
+                'Required parameter "collectionId" was null or undefined when calling updateCollectionAsyncV1CollectionsCollectionIdPut().'
+            );
+        }
+
+        if (requestParameters['collectionUpdate'] == null) {
+            throw new runtime.RequiredError(
+                'collectionUpdate',
+                'Required parameter "collectionUpdate" was null or undefined when calling updateCollectionAsyncV1CollectionsCollectionIdPut().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // APIKeyHeader authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("HTTPBearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/collections/{collection_id}`;
+        urlPath = urlPath.replace(`{${"collection_id"}}`, encodeURIComponent(String(requestParameters['collectionId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CollectionUpdateToJSON(requestParameters['collectionUpdate']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CollectionFromJSON(jsonValue));
+    }
+
+    /**
+     * Update Collection Async
+     */
+    async updateCollectionAsyncV1CollectionsCollectionIdPut(requestParameters: UpdateCollectionAsyncV1CollectionsCollectionIdPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Collection> {
+        const response = await this.updateCollectionAsyncV1CollectionsCollectionIdPutRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}