@kommerz/ts-client 1.184.1 → 1.186.0

package/dist/apis/WorkflowProcessesApi.js

@@ -65,7 +65,8 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkflowProcessesApi = void 0;
 var runtime = require("../runtime");
-var index_1 = require("../models/index");
+var GetAllWorkflowProcesses200Response_1 = require("../models/GetAllWorkflowProcesses200Response");
+var WorkflowProcessDto_1 = require("../models/WorkflowProcessDto");
 /**
  *
  */
@@ -74,31 +75,44 @@ var WorkflowProcessesApi = /** @class */ (function (_super) {
     function WorkflowProcessesApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Creates request options for deleteWorkflowProcess without sending the request
+     */
+    WorkflowProcessesApi.prototype.deleteWorkflowProcessRequestOpts = 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 deleteWorkflowProcess().');
+                }
+                queryParameters = {};
+                headerParameters = {};
+                urlPath = "/ui/workflow/v1/workflow-processes/{id}";
+                urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'DELETE',
+                        headers: headerParameters,
+                        query: queryParameters,
+                    }];
+            });
+        });
+    };
     /**
      * delete a workflow execution
      */
     WorkflowProcessesApi.prototype.deleteWorkflowProcessRaw = 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 deleteWorkflowProcess().');
-                        }
-                        queryParameters = {};
-                        headerParameters = {};
-                        urlPath = "/ui/workflow/v1/workflow-processes/{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.deleteWorkflowProcessRequestOpts(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.WorkflowProcessDtoFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, WorkflowProcessDto_1.WorkflowProcessDtoFromJSON)(jsonValue); })];
                 }
             });
         });
@@ -120,36 +134,49 @@ var WorkflowProcessesApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Creates request options for getAllWorkflowProcesses without sending the request
+     */
+    WorkflowProcessesApi.prototype.getAllWorkflowProcessesRequestOpts = 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 getAllWorkflowProcesses().');
+                }
+                queryParameters = {};
+                if (requestParameters['pageable'] != null) {
+                    queryParameters['pageable'] = requestParameters['pageable'];
+                }
+                if (requestParameters['filter'] != null) {
+                    queryParameters['filter'] = requestParameters['filter'];
+                }
+                headerParameters = {};
+                urlPath = "/ui/workflow/v1/workflow-processes";
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'GET',
+                        headers: headerParameters,
+                        query: queryParameters,
+                    }];
+            });
+        });
+    };
     /**
      * get all workflow processes
      */
     WorkflowProcessesApi.prototype.getAllWorkflowProcessesRaw = 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 getAllWorkflowProcesses().');
-                        }
-                        queryParameters = {};
-                        if (requestParameters['pageable'] != null) {
-                            queryParameters['pageable'] = requestParameters['pageable'];
-                        }
-                        if (requestParameters['filter'] != null) {
-                            queryParameters['filter'] = requestParameters['filter'];
-                        }
-                        headerParameters = {};
-                        urlPath = "/ui/workflow/v1/workflow-processes";
-                        return [4 /*yield*/, this.request({
-                                path: urlPath,
-                                method: 'GET',
-                                headers: headerParameters,
-                                query: queryParameters,
-                            }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.getAllWorkflowProcessesRequestOpts(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.GetAllWorkflowProcesses200ResponseFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, GetAllWorkflowProcesses200Response_1.GetAllWorkflowProcesses200ResponseFromJSON)(jsonValue); })];
                 }
             });
         });
@@ -171,31 +198,44 @@ var WorkflowProcessesApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Creates request options for getWorkflowProcess without sending the request
+     */
+    WorkflowProcessesApi.prototype.getWorkflowProcessRequestOpts = 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 getWorkflowProcess().');
+                }
+                queryParameters = {};
+                headerParameters = {};
+                urlPath = "/ui/workflow/v1/workflow-processes/{id}";
+                urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'GET',
+                        headers: headerParameters,
+                        query: queryParameters,
+                    }];
+            });
+        });
+    };
     /**
      * read one workflow process
      */
     WorkflowProcessesApi.prototype.getWorkflowProcessRaw = 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 getWorkflowProcess().');
-                        }
-                        queryParameters = {};
-                        headerParameters = {};
-                        urlPath = "/ui/workflow/v1/workflow-processes/{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.getWorkflowProcessRequestOpts(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.WorkflowProcessDtoFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, WorkflowProcessDto_1.WorkflowProcessDtoFromJSON)(jsonValue); })];
                 }
             });
         });
@@ -217,31 +257,44 @@ var WorkflowProcessesApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Creates request options for pauseWorkflowProcess without sending the request
+     */
+    WorkflowProcessesApi.prototype.pauseWorkflowProcessRequestOpts = 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 pauseWorkflowProcess().');
+                }
+                queryParameters = {};
+                headerParameters = {};
+                urlPath = "/ui/workflow/v1/workflow-processes/{id}/pause";
+                urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'POST',
+                        headers: headerParameters,
+                        query: queryParameters,
+                    }];
+            });
+        });
+    };
     /**
      * Pause a workflow process
      */
     WorkflowProcessesApi.prototype.pauseWorkflowProcessRaw = 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 pauseWorkflowProcess().');
-                        }
-                        queryParameters = {};
-                        headerParameters = {};
-                        urlPath = "/ui/workflow/v1/workflow-processes/{id}/pause";
-                        urlPath = urlPath.replace("{".concat("id", "}"), encodeURIComponent(String(requestParameters['id'])));
-                        return [4 /*yield*/, this.request({
-                                path: urlPath,
-                                method: 'POST',
-                                headers: headerParameters,
-                                query: queryParameters,
-                            }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.pauseWorkflowProcessRequestOpts(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.WorkflowProcessDtoFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, WorkflowProcessDto_1.WorkflowProcessDtoFromJSON)(jsonValue); })];
                 }
             });
         });
@@ -263,31 +316,44 @@ var WorkflowProcessesApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Creates request options for resumeWorkflowProcess without sending the request
+     */
+    WorkflowProcessesApi.prototype.resumeWorkflowProcessRequestOpts = 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 resumeWorkflowProcess().');
+                }
+                queryParameters = {};
+                headerParameters = {};
+                urlPath = "/ui/workflow/v1/workflow-processes/{id}/resume";
+                urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'POST',
+                        headers: headerParameters,
+                        query: queryParameters,
+                    }];
+            });
+        });
+    };
     /**
      * Resume a stopped workflow process
      */
     WorkflowProcessesApi.prototype.resumeWorkflowProcessRaw = 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 resumeWorkflowProcess().');
-                        }
-                        queryParameters = {};
-                        headerParameters = {};
-                        urlPath = "/ui/workflow/v1/workflow-processes/{id}/resume";
-                        urlPath = urlPath.replace("{".concat("id", "}"), encodeURIComponent(String(requestParameters['id'])));
-                        return [4 /*yield*/, this.request({
-                                path: urlPath,
-                                method: 'POST',
-                                headers: headerParameters,
-                                query: queryParameters,
-                            }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.resumeWorkflowProcessRequestOpts(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.WorkflowProcessDtoFromJSON)(jsonValue); })];
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, WorkflowProcessDto_1.WorkflowProcessDtoFromJSON)(jsonValue); })];
                 }
             });
         });

package/dist/apis/WorkflowsApi.d.ts

@@ -9,49 +9,106 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { DeployWorkflowRequest, GetAllWorkflows200Response, KommerzPageable, RunWorkflowRequest, ValidationErrors, WorkflowDto } from '../models/index';
+import { type DeployWorkflowRequest } from '../models/DeployWorkflowRequest';
+import { type GetAllWorkflows200Response } from '../models/GetAllWorkflows200Response';
+import { type KommerzPageable } from '../models/KommerzPageable';
+import { type RunWorkflowRequest } from '../models/RunWorkflowRequest';
+import { type ValidationErrors } from '../models/ValidationErrors';
+import { type WorkflowDto } from '../models/WorkflowDto';
 export interface CreateWorkflowRequest {
+    /**
+     *
+     */
     workflowDto: WorkflowDto;
 }
 export interface DeleteWorkflowRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface DeployWorkflowOperationRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     deployWorkflowRequest: DeployWorkflowRequest;
 }
 export interface GetAllWorkflowsRequest {
+    /**
+     * 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 GetWorkflowRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface ResumeWorkflowRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface RunWorkflowOperationRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     runWorkflowRequest: RunWorkflowRequest;
 }
 export interface StopWorkflowRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface UndeployWorkflowRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 export interface UpdateWorkflowRequest {
+    /**
+     * id of entity
+     */
     id: string;
+    /**
+     *
+     */
     workflowDto: WorkflowDto;
+    /**
+     * whether to force update the entity
+     */
     force?: boolean;
 }
 export interface ValidateWorkflowRequest {
+    /**
+     * id of entity
+     */
     id: string;
 }
 /**
  *
  */
 export declare class WorkflowsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createWorkflow without sending the request
+     */
+    createWorkflowRequestOpts(requestParameters: CreateWorkflowRequest): Promise<runtime.RequestOpts>;
     /**
      * Create a new workflow
      */
@@ -60,6 +117,10 @@ export declare class WorkflowsApi extends runtime.BaseAPI {
      * Create a new workflow
      */
     createWorkflow(requestParameters: CreateWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDto>;
+    /**
+     * Creates request options for deleteWorkflow without sending the request
+     */
+    deleteWorkflowRequestOpts(requestParameters: DeleteWorkflowRequest): Promise<runtime.RequestOpts>;
     /**
      * Stop deployment and all processes, delete workflow and all processes
      * delete single workflow
@@ -70,6 +131,10 @@ export declare class WorkflowsApi extends runtime.BaseAPI {
      * delete single workflow
      */
     deleteWorkflow(requestParameters: DeleteWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for deployWorkflow without sending the request
+     */
+    deployWorkflowRequestOpts(requestParameters: DeployWorkflowOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Deploy a workflow
      */
@@ -78,6 +143,10 @@ export declare class WorkflowsApi extends runtime.BaseAPI {
      * Deploy a workflow
      */
     deployWorkflow(requestParameters: DeployWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDto>;
+    /**
+     * Creates request options for getAllWorkflows without sending the request
+     */
+    getAllWorkflowsRequestOpts(requestParameters: GetAllWorkflowsRequest): Promise<runtime.RequestOpts>;
     /**
      * get all workflows
      */
@@ -86,6 +155,10 @@ export declare class WorkflowsApi extends runtime.BaseAPI {
      * get all workflows
      */
     getAllWorkflows(requestParameters: GetAllWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllWorkflows200Response>;
+    /**
+     * Creates request options for getWorkflow without sending the request
+     */
+    getWorkflowRequestOpts(requestParameters: GetWorkflowRequest): Promise<runtime.RequestOpts>;
     /**
      * read one workflow
      */
@@ -94,6 +167,10 @@ export declare class WorkflowsApi extends runtime.BaseAPI {
      * read one workflow
      */
     getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDto>;
+    /**
+     * Creates request options for resumeWorkflow without sending the request
+     */
+    resumeWorkflowRequestOpts(requestParameters: ResumeWorkflowRequest): Promise<runtime.RequestOpts>;
     /**
      * Resume a stopped workflow
      */
@@ -102,6 +179,10 @@ export declare class WorkflowsApi extends runtime.BaseAPI {
      * Resume a stopped workflow
      */
     resumeWorkflow(requestParameters: ResumeWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDto>;
+    /**
+     * Creates request options for runWorkflow without sending the request
+     */
+    runWorkflowRequestOpts(requestParameters: RunWorkflowOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Create a new process
      * Run a deployment with parameters
@@ -112,6 +193,10 @@ export declare class WorkflowsApi extends runtime.BaseAPI {
      * Run a deployment with parameters
      */
     runWorkflow(requestParameters: RunWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDto>;
+    /**
+     * Creates request options for stopWorkflow without sending the request
+     */
+    stopWorkflowRequestOpts(requestParameters: StopWorkflowRequest): Promise<runtime.RequestOpts>;
     /**
      * Stop a deployment; running processes will continue to run
      */
@@ -120,6 +205,10 @@ export declare class WorkflowsApi extends runtime.BaseAPI {
      * Stop a deployment; running processes will continue to run
      */
     stopWorkflow(requestParameters: StopWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDto>;
+    /**
+     * Creates request options for undeployWorkflow without sending the request
+     */
+    undeployWorkflowRequestOpts(requestParameters: UndeployWorkflowRequest): Promise<runtime.RequestOpts>;
     /**
      * Stop and undeploy a deployment; running processes will be stopped
      */
@@ -128,6 +217,10 @@ export declare class WorkflowsApi extends runtime.BaseAPI {
      * Stop and undeploy a deployment; running processes will be stopped
      */
     undeployWorkflow(requestParameters: UndeployWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDto>;
+    /**
+     * Creates request options for updateWorkflow without sending the request
+     */
+    updateWorkflowRequestOpts(requestParameters: UpdateWorkflowRequest): Promise<runtime.RequestOpts>;
     /**
      * Update a workflow
      */
@@ -136,6 +229,10 @@ export declare class WorkflowsApi extends runtime.BaseAPI {
      * Update a workflow
      */
     updateWorkflow(requestParameters: UpdateWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDto>;
+    /**
+     * Creates request options for validateWorkflow without sending the request
+     */
+    validateWorkflowRequestOpts(requestParameters: ValidateWorkflowRequest): Promise<runtime.RequestOpts>;
     /**
      * Validate a workflow
      */