@kommerz/ts-client 1.184.1 → 1.187.0

package/dist/apis/FileUploadsApi.js

@@ -65,7 +65,10 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileUploadsApi = void 0;
 var runtime = require("../runtime");
-var index_1 = require("../models/index");
+var FileDetailsDto_1 = require("../models/FileDetailsDto");
+var FileUploadDto_1 = require("../models/FileUploadDto");
+var FileUploadManifestDto_1 = require("../models/FileUploadManifestDto");
+var FileUploadPartDto_1 = require("../models/FileUploadPartDto");
 /**
  *
  */
@@ -74,37 +77,50 @@ var FileUploadsApi = /** @class */ (function (_super) {
     function FileUploadsApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Creates request options for createFileFromUpload without sending the request
+     */
+    FileUploadsApi.prototype.createFileFromUploadRequestOpts = function (requestParameters) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, urlPath;
+            return __generator(this, function (_a) {
+                if (requestParameters['id'] == null) {
+                    throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling createFileFromUpload().');
+                }
+                if (requestParameters['fileUploadManifestDto'] == null) {
+                    throw new runtime.RequiredError('fileUploadManifestDto', 'Required parameter "fileUploadManifestDto" was null or undefined when calling createFileFromUpload().');
+                }
+                queryParameters = {};
+                headerParameters = {};
+                headerParameters['Content-Type'] = 'application/json';
+                urlPath = "/ui/files/v1/uploads/{id}/manifest";
+                urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'POST',
+                        headers: headerParameters,
+                        query: queryParameters,
+                        body: (0, FileUploadManifestDto_1.FileUploadManifestDtoToJSON)(requestParameters['fileUploadManifestDto']),
+                    }];
+            });
+        });
+    };
     /**
      * uses the manifest to create the final file
      * create file from manifest
      */
     FileUploadsApi.prototype.createFileFromUploadRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, urlPath, response;
+            var requestOptions, response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0:
-                        if (requestParameters['id'] == null) {
-                            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling createFileFromUpload().');
-                        }
-                        if (requestParameters['fileUploadManifestDto'] == null) {
-                            throw new runtime.RequiredError('fileUploadManifestDto', 'Required parameter "fileUploadManifestDto" was null or undefined when calling createFileFromUpload().');
-                        }
-                        queryParameters = {};
-                        headerParameters = {};
-                        headerParameters['Content-Type'] = 'application/json';
-                        urlPath = "/ui/files/v1/uploads/{id}/manifest";
-                        urlPath = urlPath.replace("{".concat("id", "}"), encodeURIComponent(String(requestParameters['id'])));
-                        return [4 /*yield*/, this.request({
-                                path: urlPath,
-                                method: 'POST',
-                                headers: headerParameters,
-                                query: queryParameters,
-                                body: (0, index_1.FileUploadManifestDtoToJSON)(requestParameters['fileUploadManifestDto']),
-                            }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.createFileFromUploadRequestOpts(requestParameters)];
                     case 1:
+                        requestOptions = _a.sent();
+                        return [4 /*yield*/, this.request(requestOptions, initOverrides)];
+                    case 2:
                         response = _a.sent();
-                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.FileDetailsDtoFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, FileDetailsDto_1.FileDetailsDtoFromJSON)(jsonValue); })];
                 }
             });
         });
@@ -127,32 +143,45 @@ var FileUploadsApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Creates request options for createFileUpload without sending the request
+     */
+    FileUploadsApi.prototype.createFileUploadRequestOpts = function (requestParameters) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, urlPath;
+            return __generator(this, function (_a) {
+                if (requestParameters['fileUploadDto'] == null) {
+                    throw new runtime.RequiredError('fileUploadDto', 'Required parameter "fileUploadDto" was null or undefined when calling createFileUpload().');
+                }
+                queryParameters = {};
+                headerParameters = {};
+                headerParameters['Content-Type'] = 'application/json';
+                urlPath = "/ui/files/v1/uploads";
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'POST',
+                        headers: headerParameters,
+                        query: queryParameters,
+                        body: (0, FileUploadDto_1.FileUploadDtoToJSON)(requestParameters['fileUploadDto']),
+                    }];
+            });
+        });
+    };
     /**
      * create new file upload for large files (>= 5MiB). For smaller files use \"uploadFile\" method directly.
      */
     FileUploadsApi.prototype.createFileUploadRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, urlPath, response;
+            var requestOptions, response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0:
-                        if (requestParameters['fileUploadDto'] == null) {
-                            throw new runtime.RequiredError('fileUploadDto', 'Required parameter "fileUploadDto" was null or undefined when calling createFileUpload().');
-                        }
-                        queryParameters = {};
-                        headerParameters = {};
-                        headerParameters['Content-Type'] = 'application/json';
-                        urlPath = "/ui/files/v1/uploads";
-                        return [4 /*yield*/, this.request({
-                                path: urlPath,
-                                method: 'POST',
-                                headers: headerParameters,
-                                query: queryParameters,
-                                body: (0, index_1.FileUploadDtoToJSON)(requestParameters['fileUploadDto']),
-                            }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.createFileUploadRequestOpts(requestParameters)];
                     case 1:
+                        requestOptions = _a.sent();
+                        return [4 /*yield*/, this.request(requestOptions, initOverrides)];
+                    case 2:
                         response = _a.sent();
-                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.FileUploadDtoFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, FileUploadDto_1.FileUploadDtoFromJSON)(jsonValue); })];
                 }
             });
         });
@@ -174,57 +203,70 @@ var FileUploadsApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Creates request options for uploadFilePart without sending the request
+     */
+    FileUploadsApi.prototype.uploadFilePartRequestOpts = function (requestParameters) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, consumes, canConsumeForm, formParams, useForm, urlPath;
+            return __generator(this, function (_a) {
+                if (requestParameters['id'] == null) {
+                    throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling uploadFilePart().');
+                }
+                if (requestParameters['partNumber'] == null) {
+                    throw new runtime.RequiredError('partNumber', 'Required parameter "partNumber" was null or undefined when calling uploadFilePart().');
+                }
+                if (requestParameters['file'] == null) {
+                    throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling uploadFilePart().');
+                }
+                queryParameters = {};
+                headerParameters = {};
+                consumes = [
+                    { contentType: 'multipart/form-data' },
+                ];
+                canConsumeForm = runtime.canConsumeForm(consumes);
+                useForm = false;
+                // use FormData to transmit files using content-type "multipart/form-data"
+                useForm = canConsumeForm;
+                if (useForm) {
+                    formParams = new FormData();
+                }
+                else {
+                    formParams = new URLSearchParams();
+                }
+                if (requestParameters['partNumber'] != null) {
+                    formParams.append('partNumber', requestParameters['partNumber']);
+                }
+                if (requestParameters['file'] != null) {
+                    formParams.append('file', requestParameters['file']);
+                }
+                urlPath = "/ui/files/v1/uploads/{id}/parts";
+                urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'POST',
+                        headers: headerParameters,
+                        query: queryParameters,
+                        body: formParams,
+                    }];
+            });
+        });
+    };
     /**
      * upload part of file
      */
     FileUploadsApi.prototype.uploadFilePartRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, consumes, canConsumeForm, formParams, useForm, urlPath, response;
+            var requestOptions, response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0:
-                        if (requestParameters['id'] == null) {
-                            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling uploadFilePart().');
-                        }
-                        if (requestParameters['partNumber'] == null) {
-                            throw new runtime.RequiredError('partNumber', 'Required parameter "partNumber" was null or undefined when calling uploadFilePart().');
-                        }
-                        if (requestParameters['file'] == null) {
-                            throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling uploadFilePart().');
-                        }
-                        queryParameters = {};
-                        headerParameters = {};
-                        consumes = [
-                            { contentType: 'multipart/form-data' },
-                        ];
-                        canConsumeForm = runtime.canConsumeForm(consumes);
-                        useForm = false;
-                        // use FormData to transmit files using content-type "multipart/form-data"
-                        useForm = canConsumeForm;
-                        if (useForm) {
-                            formParams = new FormData();
-                        }
-                        else {
-                            formParams = new URLSearchParams();
-                        }
-                        if (requestParameters['partNumber'] != null) {
-                            formParams.append('partNumber', requestParameters['partNumber']);
-                        }
-                        if (requestParameters['file'] != null) {
-                            formParams.append('file', requestParameters['file']);
-                        }
-                        urlPath = "/ui/files/v1/uploads/{id}/parts";
-                        urlPath = urlPath.replace("{".concat("id", "}"), encodeURIComponent(String(requestParameters['id'])));
-                        return [4 /*yield*/, this.request({
-                                path: urlPath,
-                                method: 'POST',
-                                headers: headerParameters,
-                                query: queryParameters,
-                                body: formParams,
-                            }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.uploadFilePartRequestOpts(requestParameters)];
                     case 1:
+                        requestOptions = _a.sent();
+                        return [4 /*yield*/, this.request(requestOptions, initOverrides)];
+                    case 2:
                         response = _a.sent();
-                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.FileUploadPartDtoFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, FileUploadPartDto_1.FileUploadPartDtoFromJSON)(jsonValue); })];
                 }
             });
         });

package/dist/apis/FilesApi.d.ts

@@ -9,41 +9,89 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { FileDetailsDto, FileDownloadDisposition, FileUploadDto, KommerzPageable, ListFiles200Response } from '../models/index';
+import { type FileDetailsDto } from '../models/FileDetailsDto';
+import { type FileDownloadDisposition } from '../models/FileDownloadDisposition';
+import { type FileUploadDto } from '../models/FileUploadDto';
+import { type KommerzPageable } from '../models/KommerzPageable';
+import { type ListFiles200Response } from '../models/ListFiles200Response';
 export interface DownloadFileRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     accessToken: string;
+    /**
+     * timestamp in seconds when the token expires
+     */
     expires: number;
+    /**
+     *
+     */
     disposition?: FileDownloadDisposition;
 }
 export interface GetFileRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface ListFilesRequest {
+    /**
+     * Pageable query parameters
+     */
     pageable: KommerzPageable;
+    /**
+     * Filter query parameters. Operators: sim, nsim, eq, neq, leq, less, geq, gtr). Values have to be url-encoded.
+     */
     filter?: Array<string>;
 }
 export interface UpdateFileRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     fileDetailsDto: FileDetailsDto;
+    /**
+     * whether to force update the entity
+     */
     force?: boolean;
 }
 export interface UploadFileRequest {
+    /**
+     *
+     */
     file: Blob;
+    /**
+     *
+     */
     details?: FileUploadDto;
 }
 /**
  *
  */
 export declare class FilesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for downloadFile without sending the request
+     */
+    downloadFileRequestOpts(requestParameters: DownloadFileRequest): Promise<runtime.RequestOpts>;
     /**
      * download file
      */
-    downloadFileRaw(requestParameters: DownloadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    downloadFileRaw(requestParameters: DownloadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<runtime.HttpFile>>;
     /**
      * download file
      */
-    downloadFile(requestParameters: DownloadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    downloadFile(requestParameters: DownloadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.HttpFile>;
+    /**
+     * Creates request options for getFile without sending the request
+     */
+    getFileRequestOpts(requestParameters: GetFileRequest): Promise<runtime.RequestOpts>;
     /**
      * read file details
      */
@@ -52,6 +100,10 @@ export declare class FilesApi extends runtime.BaseAPI {
      * read file details
      */
     getFile(requestParameters: GetFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileDetailsDto>;
+    /**
+     * Creates request options for listFiles without sending the request
+     */
+    listFilesRequestOpts(requestParameters: ListFilesRequest): Promise<runtime.RequestOpts>;
     /**
      * list files
      */
@@ -60,6 +112,10 @@ export declare class FilesApi extends runtime.BaseAPI {
      * list files
      */
     listFiles(requestParameters: ListFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListFiles200Response>;
+    /**
+     * Creates request options for updateFile without sending the request
+     */
+    updateFileRequestOpts(requestParameters: UpdateFileRequest): Promise<runtime.RequestOpts>;
     /**
      * update a file
      */
@@ -68,6 +124,10 @@ export declare class FilesApi extends runtime.BaseAPI {
      * update a file
      */
     updateFile(requestParameters: UpdateFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileDetailsDto>;
+    /**
+     * Creates request options for uploadFile without sending the request
+     */
+    uploadFileRequestOpts(requestParameters: UploadFileRequest): Promise<runtime.RequestOpts>;
     /**
      * Uploads a small file ( <= 5MiB). For larger files file-uploads must be used.
      * upload single file