@kommerz/ts-client 1.184.0 → 1.186.0

package/dist/apis/TagsApi.d.ts

@@ -9,34 +9,74 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { GetAllEntitiesForTag200Response, GetAllTags200Response, KommerzPageable, TagDto } from '../models/index';
+import { type GetAllEntitiesForTag200Response } from '../models/GetAllEntitiesForTag200Response';
+import { type GetAllTags200Response } from '../models/GetAllTags200Response';
+import { type KommerzPageable } from '../models/KommerzPageable';
+import { type TagDto } from '../models/TagDto';
 export interface CreateTagRequest {
+    /**
+     *
+     */
     tagDto: TagDto;
 }
 export interface DeleteTagRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface GetAllEntitiesForTagRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     * 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 GetAllTagsRequest {
+    /**
+     * 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 GetTagRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface UpdateTagRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     tagDto: TagDto;
+    /**
+     * whether to force update the entity
+     */
     force?: boolean;
 }
 /**
  *
  */
 export declare class TagsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createTag without sending the request
+     */
+    createTagRequestOpts(requestParameters: CreateTagRequest): Promise<runtime.RequestOpts>;
     /**
      * Create new a new tag
      */
@@ -45,6 +85,10 @@ export declare class TagsApi extends runtime.BaseAPI {
      * Create new a new tag
      */
     createTag(requestParameters: CreateTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagDto>;
+    /**
+     * Creates request options for deleteTag without sending the request
+     */
+    deleteTagRequestOpts(requestParameters: DeleteTagRequest): Promise<runtime.RequestOpts>;
     /**
      * delete single tag
      */
@@ -53,6 +97,10 @@ export declare class TagsApi extends runtime.BaseAPI {
      * delete single tag
      */
     deleteTag(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getAllEntitiesForTag without sending the request
+     */
+    getAllEntitiesForTagRequestOpts(requestParameters: GetAllEntitiesForTagRequest): Promise<runtime.RequestOpts>;
     /**
      * get all entities of a tag
      */
@@ -61,6 +109,10 @@ export declare class TagsApi extends runtime.BaseAPI {
      * get all entities of a tag
      */
     getAllEntitiesForTag(requestParameters: GetAllEntitiesForTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllEntitiesForTag200Response>;
+    /**
+     * Creates request options for getAllTags without sending the request
+     */
+    getAllTagsRequestOpts(requestParameters: GetAllTagsRequest): Promise<runtime.RequestOpts>;
     /**
      * get all tags
      */
@@ -69,6 +121,10 @@ export declare class TagsApi extends runtime.BaseAPI {
      * get all tags
      */
     getAllTags(requestParameters: GetAllTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllTags200Response>;
+    /**
+     * Creates request options for getTag without sending the request
+     */
+    getTagRequestOpts(requestParameters: GetTagRequest): Promise<runtime.RequestOpts>;
     /**
      * read one tag
      */
@@ -77,6 +133,10 @@ export declare class TagsApi extends runtime.BaseAPI {
      * read one tag
      */
     getTag(requestParameters: GetTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagDto>;
+    /**
+     * Creates request options for updateTag without sending the request
+     */
+    updateTagRequestOpts(requestParameters: UpdateTagRequest): Promise<runtime.RequestOpts>;
     /**
      * Update a tag
      */

package/dist/apis/TagsApi.js

@@ -65,7 +65,9 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TagsApi = void 0;
 var runtime = require("../runtime");
-var index_1 = require("../models/index");
+var GetAllEntitiesForTag200Response_1 = require("../models/GetAllEntitiesForTag200Response");
+var GetAllTags200Response_1 = require("../models/GetAllTags200Response");
+var TagDto_1 = require("../models/TagDto");
 /**
  *
  */
@@ -74,32 +76,45 @@ var TagsApi = /** @class */ (function (_super) {
     function TagsApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Creates request options for createTag without sending the request
+     */
+    TagsApi.prototype.createTagRequestOpts = function (requestParameters) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, urlPath;
+            return __generator(this, function (_a) {
+                if (requestParameters['tagDto'] == null) {
+                    throw new runtime.RequiredError('tagDto', 'Required parameter "tagDto" was null or undefined when calling createTag().');
+                }
+                queryParameters = {};
+                headerParameters = {};
+                headerParameters['Content-Type'] = 'application/json';
+                urlPath = "/ui/tags/v1/tags";
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'POST',
+                        headers: headerParameters,
+                        query: queryParameters,
+                        body: (0, TagDto_1.TagDtoToJSON)(requestParameters['tagDto']),
+                    }];
+            });
+        });
+    };
     /**
      * Create new a new tag
      */
     TagsApi.prototype.createTagRaw = 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['tagDto'] == null) {
-                            throw new runtime.RequiredError('tagDto', 'Required parameter "tagDto" was null or undefined when calling createTag().');
-                        }
-                        queryParameters = {};
-                        headerParameters = {};
-                        headerParameters['Content-Type'] = 'application/json';
-                        urlPath = "/ui/tags/v1/tags";
-                        return [4 /*yield*/, this.request({
-                                path: urlPath,
-                                method: 'POST',
-                                headers: headerParameters,
-                                query: queryParameters,
-                                body: (0, index_1.TagDtoToJSON)(requestParameters['tagDto']),
-                            }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.createTagRequestOpts(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.TagDtoFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, TagDto_1.TagDtoFromJSON)(jsonValue); })];
                 }
             });
         });
@@ -121,29 +136,42 @@ var TagsApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Creates request options for deleteTag without sending the request
+     */
+    TagsApi.prototype.deleteTagRequestOpts = 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 deleteTag().');
+                }
+                queryParameters = {};
+                headerParameters = {};
+                urlPath = "/ui/tags/v1/tags/{id}";
+                urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'DELETE',
+                        headers: headerParameters,
+                        query: queryParameters,
+                    }];
+            });
+        });
+    };
     /**
      * delete single tag
      */
     TagsApi.prototype.deleteTagRaw = 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 deleteTag().');
-                        }
-                        queryParameters = {};
-                        headerParameters = {};
-                        urlPath = "/ui/tags/v1/tags/{id}";
-                        urlPath = urlPath.replace("{".concat("id", "}"), encodeURIComponent(String(requestParameters['id'])));
-                        return [4 /*yield*/, this.request({
-                                path: urlPath,
-                                method: 'DELETE',
-                                headers: headerParameters,
-                                query: queryParameters,
-                            }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.deleteTagRequestOpts(requestParameters)];
                     case 1:
+                        requestOptions = _a.sent();
+                        return [4 /*yield*/, this.request(requestOptions, initOverrides)];
+                    case 2:
                         response = _a.sent();
                         return [2 /*return*/, new runtime.VoidApiResponse(response)];
                 }
@@ -165,40 +193,53 @@ var TagsApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Creates request options for getAllEntitiesForTag without sending the request
+     */
+    TagsApi.prototype.getAllEntitiesForTagRequestOpts = 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 getAllEntitiesForTag().');
+                }
+                if (requestParameters['pageable'] == null) {
+                    throw new runtime.RequiredError('pageable', 'Required parameter "pageable" was null or undefined when calling getAllEntitiesForTag().');
+                }
+                queryParameters = {};
+                if (requestParameters['pageable'] != null) {
+                    queryParameters['pageable'] = requestParameters['pageable'];
+                }
+                if (requestParameters['filter'] != null) {
+                    queryParameters['filter'] = requestParameters['filter'];
+                }
+                headerParameters = {};
+                urlPath = "/ui/tags/v1/tags/{id}/entities";
+                urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'GET',
+                        headers: headerParameters,
+                        query: queryParameters,
+                    }];
+            });
+        });
+    };
     /**
      * get all entities of a tag
      */
     TagsApi.prototype.getAllEntitiesForTagRaw = 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 getAllEntitiesForTag().');
-                        }
-                        if (requestParameters['pageable'] == null) {
-                            throw new runtime.RequiredError('pageable', 'Required parameter "pageable" was null or undefined when calling getAllEntitiesForTag().');
-                        }
-                        queryParameters = {};
-                        if (requestParameters['pageable'] != null) {
-                            queryParameters['pageable'] = requestParameters['pageable'];
-                        }
-                        if (requestParameters['filter'] != null) {
-                            queryParameters['filter'] = requestParameters['filter'];
-                        }
-                        headerParameters = {};
-                        urlPath = "/ui/tags/v1/tags/{id}/entities";
-                        urlPath = urlPath.replace("{".concat("id", "}"), encodeURIComponent(String(requestParameters['id'])));
-                        return [4 /*yield*/, this.request({
-                                path: urlPath,
-                                method: 'GET',
-                                headers: headerParameters,
-                                query: queryParameters,
-                            }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.getAllEntitiesForTagRequestOpts(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.GetAllEntitiesForTag200ResponseFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, GetAllEntitiesForTag200Response_1.GetAllEntitiesForTag200ResponseFromJSON)(jsonValue); })];
                 }
             });
         });
@@ -220,36 +261,49 @@ var TagsApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Creates request options for getAllTags without sending the request
+     */
+    TagsApi.prototype.getAllTagsRequestOpts = function (requestParameters) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, urlPath;
+            return __generator(this, function (_a) {
+                if (requestParameters['pageable'] == null) {
+                    throw new runtime.RequiredError('pageable', 'Required parameter "pageable" was null or undefined when calling getAllTags().');
+                }
+                queryParameters = {};
+                if (requestParameters['pageable'] != null) {
+                    queryParameters['pageable'] = requestParameters['pageable'];
+                }
+                if (requestParameters['filter'] != null) {
+                    queryParameters['filter'] = requestParameters['filter'];
+                }
+                headerParameters = {};
+                urlPath = "/ui/tags/v1/tags";
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'GET',
+                        headers: headerParameters,
+                        query: queryParameters,
+                    }];
+            });
+        });
+    };
     /**
      * get all tags
      */
     TagsApi.prototype.getAllTagsRaw = 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['pageable'] == null) {
-                            throw new runtime.RequiredError('pageable', 'Required parameter "pageable" was null or undefined when calling getAllTags().');
-                        }
-                        queryParameters = {};
-                        if (requestParameters['pageable'] != null) {
-                            queryParameters['pageable'] = requestParameters['pageable'];
-                        }
-                        if (requestParameters['filter'] != null) {
-                            queryParameters['filter'] = requestParameters['filter'];
-                        }
-                        headerParameters = {};
-                        urlPath = "/ui/tags/v1/tags";
-                        return [4 /*yield*/, this.request({
-                                path: urlPath,
-                                method: 'GET',
-                                headers: headerParameters,
-                                query: queryParameters,
-                            }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.getAllTagsRequestOpts(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.GetAllTags200ResponseFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, GetAllTags200Response_1.GetAllTags200ResponseFromJSON)(jsonValue); })];
                 }
             });
         });
@@ -271,31 +325,44 @@ var TagsApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Creates request options for getTag without sending the request
+     */
+    TagsApi.prototype.getTagRequestOpts = 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 getTag().');
+                }
+                queryParameters = {};
+                headerParameters = {};
+                urlPath = "/ui/tags/v1/tags/{id}";
+                urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'GET',
+                        headers: headerParameters,
+                        query: queryParameters,
+                    }];
+            });
+        });
+    };
     /**
      * read one tag
      */
     TagsApi.prototype.getTagRaw = 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 getTag().');
-                        }
-                        queryParameters = {};
-                        headerParameters = {};
-                        urlPath = "/ui/tags/v1/tags/{id}";
-                        urlPath = urlPath.replace("{".concat("id", "}"), encodeURIComponent(String(requestParameters['id'])));
-                        return [4 /*yield*/, this.request({
-                                path: urlPath,
-                                method: 'GET',
-                                headers: headerParameters,
-                                query: queryParameters,
-                            }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.getTagRequestOpts(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.TagDtoFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, TagDto_1.TagDtoFromJSON)(jsonValue); })];
                 }
             });
         });
@@ -317,39 +384,52 @@ var TagsApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Creates request options for updateTag without sending the request
+     */
+    TagsApi.prototype.updateTagRequestOpts = 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 updateTag().');
+                }
+                if (requestParameters['tagDto'] == null) {
+                    throw new runtime.RequiredError('tagDto', 'Required parameter "tagDto" was null or undefined when calling updateTag().');
+                }
+                queryParameters = {};
+                if (requestParameters['force'] != null) {
+                    queryParameters['force'] = requestParameters['force'];
+                }
+                headerParameters = {};
+                headerParameters['Content-Type'] = 'application/json';
+                urlPath = "/ui/tags/v1/tags/{id}";
+                urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'PUT',
+                        headers: headerParameters,
+                        query: queryParameters,
+                        body: (0, TagDto_1.TagDtoToJSON)(requestParameters['tagDto']),
+                    }];
+            });
+        });
+    };
     /**
      * Update a tag
      */
     TagsApi.prototype.updateTagRaw = 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 updateTag().');
-                        }
-                        if (requestParameters['tagDto'] == null) {
-                            throw new runtime.RequiredError('tagDto', 'Required parameter "tagDto" was null or undefined when calling updateTag().');
-                        }
-                        queryParameters = {};
-                        if (requestParameters['force'] != null) {
-                            queryParameters['force'] = requestParameters['force'];
-                        }
-                        headerParameters = {};
-                        headerParameters['Content-Type'] = 'application/json';
-                        urlPath = "/ui/tags/v1/tags/{id}";
-                        urlPath = urlPath.replace("{".concat("id", "}"), encodeURIComponent(String(requestParameters['id'])));
-                        return [4 /*yield*/, this.request({
-                                path: urlPath,
-                                method: 'PUT',
-                                headers: headerParameters,
-                                query: queryParameters,
-                                body: (0, index_1.TagDtoToJSON)(requestParameters['tagDto']),
-                            }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.updateTagRequestOpts(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.TagDtoFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, TagDto_1.TagDtoFromJSON)(jsonValue); })];
                 }
             });
         });