@red-hat-developer-hub/backstage-plugin-orchestrator-common 1.24.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/CHANGELOG.md +228 -0
  2. package/README.md +5 -0
  3. package/config.d.ts +81 -0
  4. package/dist/QueryParams.cjs.js +12 -0
  5. package/dist/QueryParams.cjs.js.map +1 -0
  6. package/dist/QueryParams.esm.js +7 -0
  7. package/dist/QueryParams.esm.js.map +1 -0
  8. package/dist/constants.cjs.js +16 -0
  9. package/dist/constants.cjs.js.map +1 -0
  10. package/dist/constants.esm.js +9 -0
  11. package/dist/constants.esm.js.map +1 -0
  12. package/dist/generated/api/definition.cjs.js +7 -0
  13. package/dist/generated/api/definition.cjs.js.map +1 -0
  14. package/dist/generated/api/definition.esm.js +5 -0
  15. package/dist/generated/api/definition.esm.js.map +1 -0
  16. package/dist/generated/client/api.cjs.js +761 -0
  17. package/dist/generated/client/api.cjs.js.map +1 -0
  18. package/dist/generated/client/api.esm.js +744 -0
  19. package/dist/generated/client/api.esm.js.map +1 -0
  20. package/dist/generated/client/base.cjs.js +34 -0
  21. package/dist/generated/client/base.cjs.js.map +1 -0
  22. package/dist/generated/client/base.esm.js +25 -0
  23. package/dist/generated/client/base.esm.js.map +1 -0
  24. package/dist/generated/client/common.cjs.js +55 -0
  25. package/dist/generated/client/common.cjs.js.map +1 -0
  26. package/dist/generated/client/common.esm.js +48 -0
  27. package/dist/generated/client/common.esm.js.map +1 -0
  28. package/dist/generated/client/configuration.cjs.js +87 -0
  29. package/dist/generated/client/configuration.cjs.js.map +1 -0
  30. package/dist/generated/client/configuration.esm.js +85 -0
  31. package/dist/generated/client/configuration.esm.js.map +1 -0
  32. package/dist/index.cjs.js +63 -0
  33. package/dist/index.cjs.js.map +1 -0
  34. package/dist/index.d.ts +1570 -0
  35. package/dist/index.esm.js +11 -0
  36. package/dist/index.esm.js.map +1 -0
  37. package/dist/models.cjs.js +34 -0
  38. package/dist/models.cjs.js.map +1 -0
  39. package/dist/models.esm.js +29 -0
  40. package/dist/models.esm.js.map +1 -0
  41. package/dist/permissions.cjs.js +45 -0
  42. package/dist/permissions.cjs.js.map +1 -0
  43. package/dist/permissions.esm.js +38 -0
  44. package/dist/permissions.esm.js.map +1 -0
  45. package/dist/types.cjs.js +18 -0
  46. package/dist/types.cjs.js.map +1 -0
  47. package/dist/types.esm.js +14 -0
  48. package/dist/types.esm.js.map +1 -0
  49. package/dist/utils/StringUtils.cjs.js +8 -0
  50. package/dist/utils/StringUtils.cjs.js.map +1 -0
  51. package/dist/utils/StringUtils.esm.js +5 -0
  52. package/dist/utils/StringUtils.esm.js.map +1 -0
  53. package/dist/workflow.cjs.js +96 -0
  54. package/dist/workflow.cjs.js.map +1 -0
  55. package/dist/workflow.esm.js +87 -0
  56. package/dist/workflow.esm.js.map +1 -0
  57. package/package.json +85 -0
@@ -0,0 +1,744 @@
1
+ import globalAxios from 'axios';
2
+ import { assertParamExists, DUMMY_BASE_URL, setSearchParams, toPathString, serializeDataIfNeeded, createRequestFunction } from './common.esm.js';
3
+ import { operationServerMap, BaseAPI, BASE_PATH } from './base.esm.js';
4
+
5
+ const FieldFilterOperatorEnum = {
6
+ Eq: "EQ",
7
+ Gt: "GT",
8
+ Gte: "GTE",
9
+ Lt: "LT",
10
+ Lte: "LTE",
11
+ In: "IN",
12
+ IsNull: "IS_NULL",
13
+ Contains: "CONTAINS",
14
+ ContainsAll: "CONTAINS_ALL",
15
+ ContainsAny: "CONTAINS_ANY",
16
+ Like: "LIKE",
17
+ Between: "BETWEEN"
18
+ };
19
+ const LogicalFilterOperatorEnum = {
20
+ And: "AND",
21
+ Or: "OR",
22
+ Not: "NOT"
23
+ };
24
+ const PaginationInfoDTOOrderDirectionEnum = {
25
+ Asc: "ASC",
26
+ Desc: "DESC"
27
+ };
28
+ const ProcessInstanceStatusDTO = {
29
+ Active: "Active",
30
+ Error: "Error",
31
+ Completed: "Completed",
32
+ Aborted: "Aborted",
33
+ Suspended: "Suspended",
34
+ Pending: "Pending"
35
+ };
36
+ const WorkflowCategoryDTO = {
37
+ Assessment: "assessment",
38
+ Infrastructure: "infrastructure"
39
+ };
40
+ const WorkflowFormatDTO = {
41
+ Yaml: "yaml",
42
+ Json: "json"
43
+ };
44
+ const WorkflowResultDTOCompletedWithEnum = {
45
+ Error: "error",
46
+ Success: "success"
47
+ };
48
+ const WorkflowResultDTOOutputsInnerFormatEnum = {
49
+ Text: "text",
50
+ Number: "number",
51
+ Link: "link"
52
+ };
53
+ const DefaultApiAxiosParamCreator = function(configuration) {
54
+ return {
55
+ /**
56
+ * Aborts a workflow instance identified by the provided instanceId.
57
+ * @summary Abort a workflow instance
58
+ * @param {string} instanceId The identifier of the workflow instance to abort.
59
+ * @param {*} [options] Override http request option.
60
+ * @throws {RequiredError}
61
+ */
62
+ abortWorkflow: async (instanceId, options = {}) => {
63
+ assertParamExists("abortWorkflow", "instanceId", instanceId);
64
+ const localVarPath = `/v2/workflows/instances/{instanceId}/abort`.replace(`{${"instanceId"}}`, encodeURIComponent(String(instanceId)));
65
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
66
+ let baseOptions;
67
+ if (configuration) {
68
+ baseOptions = configuration.baseOptions;
69
+ }
70
+ const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
71
+ const localVarHeaderParameter = {};
72
+ const localVarQueryParameter = {};
73
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
74
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
75
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
76
+ return {
77
+ url: toPathString(localVarUrlObj),
78
+ options: localVarRequestOptions
79
+ };
80
+ },
81
+ /**
82
+ * Execute a workflow
83
+ * @summary Execute a workflow
84
+ * @param {string} workflowId ID of the workflow to execute
85
+ * @param {ExecuteWorkflowRequestDTO} executeWorkflowRequestDTO
86
+ * @param {*} [options] Override http request option.
87
+ * @throws {RequiredError}
88
+ */
89
+ executeWorkflow: async (workflowId, executeWorkflowRequestDTO, options = {}) => {
90
+ assertParamExists("executeWorkflow", "workflowId", workflowId);
91
+ assertParamExists("executeWorkflow", "executeWorkflowRequestDTO", executeWorkflowRequestDTO);
92
+ const localVarPath = `/v2/workflows/{workflowId}/execute`.replace(`{${"workflowId"}}`, encodeURIComponent(String(workflowId)));
93
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
94
+ let baseOptions;
95
+ if (configuration) {
96
+ baseOptions = configuration.baseOptions;
97
+ }
98
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
99
+ const localVarHeaderParameter = {};
100
+ const localVarQueryParameter = {};
101
+ localVarHeaderParameter["Content-Type"] = "application/json";
102
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
103
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
104
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
105
+ localVarRequestOptions.data = serializeDataIfNeeded(executeWorkflowRequestDTO, localVarRequestOptions, configuration);
106
+ return {
107
+ url: toPathString(localVarUrlObj),
108
+ options: localVarRequestOptions
109
+ };
110
+ },
111
+ /**
112
+ * Get a workflow execution/run (instance)
113
+ * @summary Get Workflow Instance by ID
114
+ * @param {string} instanceId ID of the workflow instance
115
+ * @param {boolean} [includeAssessment] Whether to include assessment
116
+ * @param {*} [options] Override http request option.
117
+ * @throws {RequiredError}
118
+ */
119
+ getInstanceById: async (instanceId, includeAssessment, options = {}) => {
120
+ assertParamExists("getInstanceById", "instanceId", instanceId);
121
+ const localVarPath = `/v2/workflows/instances/{instanceId}`.replace(`{${"instanceId"}}`, encodeURIComponent(String(instanceId)));
122
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
123
+ let baseOptions;
124
+ if (configuration) {
125
+ baseOptions = configuration.baseOptions;
126
+ }
127
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
128
+ const localVarHeaderParameter = {};
129
+ const localVarQueryParameter = {};
130
+ if (includeAssessment !== void 0) {
131
+ localVarQueryParameter["includeAssessment"] = includeAssessment;
132
+ }
133
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
134
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
135
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
136
+ return {
137
+ url: toPathString(localVarUrlObj),
138
+ options: localVarRequestOptions
139
+ };
140
+ },
141
+ /**
142
+ * Retrieve an array of workflow executions (instances)
143
+ * @summary Get instances
144
+ * @param {GetInstancesRequest} [getInstancesRequest] Parameters for retrieving instances
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ getInstances: async (getInstancesRequest, options = {}) => {
149
+ const localVarPath = `/v2/workflows/instances`;
150
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
151
+ let baseOptions;
152
+ if (configuration) {
153
+ baseOptions = configuration.baseOptions;
154
+ }
155
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
156
+ const localVarHeaderParameter = {};
157
+ const localVarQueryParameter = {};
158
+ localVarHeaderParameter["Content-Type"] = "application/json";
159
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
160
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
161
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
162
+ localVarRequestOptions.data = serializeDataIfNeeded(getInstancesRequest, localVarRequestOptions, configuration);
163
+ return {
164
+ url: toPathString(localVarUrlObj),
165
+ options: localVarRequestOptions
166
+ };
167
+ },
168
+ /**
169
+ * Get the workflow input schema. It defines the input fields of the workflow
170
+ * @param {string} workflowId ID of the workflow to fetch
171
+ * @param {string} [instanceId] ID of instance
172
+ * @param {*} [options] Override http request option.
173
+ * @throws {RequiredError}
174
+ */
175
+ getWorkflowInputSchemaById: async (workflowId, instanceId, options = {}) => {
176
+ assertParamExists("getWorkflowInputSchemaById", "workflowId", workflowId);
177
+ const localVarPath = `/v2/workflows/{workflowId}/inputSchema`.replace(`{${"workflowId"}}`, encodeURIComponent(String(workflowId)));
178
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
179
+ let baseOptions;
180
+ if (configuration) {
181
+ baseOptions = configuration.baseOptions;
182
+ }
183
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
184
+ const localVarHeaderParameter = {};
185
+ const localVarQueryParameter = {};
186
+ if (instanceId !== void 0) {
187
+ localVarQueryParameter["instanceId"] = instanceId;
188
+ }
189
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
190
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
191
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
192
+ return {
193
+ url: toPathString(localVarUrlObj),
194
+ options: localVarRequestOptions
195
+ };
196
+ },
197
+ /**
198
+ * Retrieve an array of workflow executions (instances) for the given workflow
199
+ * @summary Get instances for a specific workflow
200
+ * @param {string} workflowId ID of the workflow
201
+ * @param {SearchRequest} [searchRequest] Parameters for retrieving workflow instances
202
+ * @param {*} [options] Override http request option.
203
+ * @throws {RequiredError}
204
+ */
205
+ getWorkflowInstances: async (workflowId, searchRequest, options = {}) => {
206
+ assertParamExists("getWorkflowInstances", "workflowId", workflowId);
207
+ const localVarPath = `/v2/workflows/{workflowId}/instances`.replace(`{${"workflowId"}}`, encodeURIComponent(String(workflowId)));
208
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
209
+ let baseOptions;
210
+ if (configuration) {
211
+ baseOptions = configuration.baseOptions;
212
+ }
213
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
214
+ const localVarHeaderParameter = {};
215
+ const localVarQueryParameter = {};
216
+ localVarHeaderParameter["Content-Type"] = "application/json";
217
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
218
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
219
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
220
+ localVarRequestOptions.data = serializeDataIfNeeded(searchRequest, localVarRequestOptions, configuration);
221
+ return {
222
+ url: toPathString(localVarUrlObj),
223
+ options: localVarRequestOptions
224
+ };
225
+ },
226
+ /**
227
+ * Returns the key fields of the workflow including data on the last run instance
228
+ * @param {string} workflowId Unique identifier of the workflow
229
+ * @param {*} [options] Override http request option.
230
+ * @throws {RequiredError}
231
+ */
232
+ getWorkflowOverviewById: async (workflowId, options = {}) => {
233
+ assertParamExists("getWorkflowOverviewById", "workflowId", workflowId);
234
+ const localVarPath = `/v2/workflows/{workflowId}/overview`.replace(`{${"workflowId"}}`, encodeURIComponent(String(workflowId)));
235
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
236
+ let baseOptions;
237
+ if (configuration) {
238
+ baseOptions = configuration.baseOptions;
239
+ }
240
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
241
+ const localVarHeaderParameter = {};
242
+ const localVarQueryParameter = {};
243
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
244
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
245
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
246
+ return {
247
+ url: toPathString(localVarUrlObj),
248
+ options: localVarRequestOptions
249
+ };
250
+ },
251
+ /**
252
+ * Get the workflow\'s definition
253
+ * @param {string} workflowId ID of the workflow to fetch
254
+ * @param {*} [options] Override http request option.
255
+ * @throws {RequiredError}
256
+ */
257
+ getWorkflowSourceById: async (workflowId, options = {}) => {
258
+ assertParamExists("getWorkflowSourceById", "workflowId", workflowId);
259
+ const localVarPath = `/v2/workflows/{workflowId}/source`.replace(`{${"workflowId"}}`, encodeURIComponent(String(workflowId)));
260
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
261
+ let baseOptions;
262
+ if (configuration) {
263
+ baseOptions = configuration.baseOptions;
264
+ }
265
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
266
+ const localVarHeaderParameter = {};
267
+ const localVarQueryParameter = {};
268
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
269
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
270
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
271
+ return {
272
+ url: toPathString(localVarUrlObj),
273
+ options: localVarRequestOptions
274
+ };
275
+ },
276
+ /**
277
+ * Retrieve array with the status of all instances
278
+ * @summary Get workflow status list
279
+ * @param {*} [options] Override http request option.
280
+ * @throws {RequiredError}
281
+ */
282
+ getWorkflowStatuses: async (options = {}) => {
283
+ const localVarPath = `/v2/workflows/instances/statuses`;
284
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
285
+ let baseOptions;
286
+ if (configuration) {
287
+ baseOptions = configuration.baseOptions;
288
+ }
289
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
290
+ const localVarHeaderParameter = {};
291
+ const localVarQueryParameter = {};
292
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
293
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
294
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
295
+ return {
296
+ url: toPathString(localVarUrlObj),
297
+ options: localVarRequestOptions
298
+ };
299
+ },
300
+ /**
301
+ * Returns the key fields of the workflow including data on the last run instance
302
+ * @param {SearchRequest} [searchRequest] Pagination and filters
303
+ * @param {*} [options] Override http request option.
304
+ * @throws {RequiredError}
305
+ */
306
+ getWorkflowsOverview: async (searchRequest, options = {}) => {
307
+ const localVarPath = `/v2/workflows/overview`;
308
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
309
+ let baseOptions;
310
+ if (configuration) {
311
+ baseOptions = configuration.baseOptions;
312
+ }
313
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
314
+ const localVarHeaderParameter = {};
315
+ const localVarQueryParameter = {};
316
+ localVarHeaderParameter["Content-Type"] = "application/json";
317
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
318
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
319
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
320
+ localVarRequestOptions.data = serializeDataIfNeeded(searchRequest, localVarRequestOptions, configuration);
321
+ return {
322
+ url: toPathString(localVarUrlObj),
323
+ options: localVarRequestOptions
324
+ };
325
+ },
326
+ /**
327
+ * Retrigger an instance
328
+ * @summary Retrigger an instance
329
+ * @param {string} workflowId ID of the workflow
330
+ * @param {string} instanceId ID of the instance to retrigger
331
+ * @param {*} [options] Override http request option.
332
+ * @throws {RequiredError}
333
+ */
334
+ retriggerInstance: async (workflowId, instanceId, options = {}) => {
335
+ assertParamExists("retriggerInstance", "workflowId", workflowId);
336
+ assertParamExists("retriggerInstance", "instanceId", instanceId);
337
+ const localVarPath = `/v2/workflows/{workflowId}/{instanceId}/retrigger`.replace(`{${"workflowId"}}`, encodeURIComponent(String(workflowId))).replace(`{${"instanceId"}}`, encodeURIComponent(String(instanceId)));
338
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
339
+ let baseOptions;
340
+ if (configuration) {
341
+ baseOptions = configuration.baseOptions;
342
+ }
343
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
344
+ const localVarHeaderParameter = {};
345
+ const localVarQueryParameter = {};
346
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
347
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
348
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
349
+ return {
350
+ url: toPathString(localVarUrlObj),
351
+ options: localVarRequestOptions
352
+ };
353
+ }
354
+ };
355
+ };
356
+ const DefaultApiFp = function(configuration) {
357
+ const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration);
358
+ return {
359
+ /**
360
+ * Aborts a workflow instance identified by the provided instanceId.
361
+ * @summary Abort a workflow instance
362
+ * @param {string} instanceId The identifier of the workflow instance to abort.
363
+ * @param {*} [options] Override http request option.
364
+ * @throws {RequiredError}
365
+ */
366
+ async abortWorkflow(instanceId, options) {
367
+ const localVarAxiosArgs = await localVarAxiosParamCreator.abortWorkflow(instanceId, options);
368
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
369
+ const localVarOperationServerBasePath = operationServerMap["DefaultApi.abortWorkflow"]?.[localVarOperationServerIndex]?.url;
370
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
371
+ },
372
+ /**
373
+ * Execute a workflow
374
+ * @summary Execute a workflow
375
+ * @param {string} workflowId ID of the workflow to execute
376
+ * @param {ExecuteWorkflowRequestDTO} executeWorkflowRequestDTO
377
+ * @param {*} [options] Override http request option.
378
+ * @throws {RequiredError}
379
+ */
380
+ async executeWorkflow(workflowId, executeWorkflowRequestDTO, options) {
381
+ const localVarAxiosArgs = await localVarAxiosParamCreator.executeWorkflow(workflowId, executeWorkflowRequestDTO, options);
382
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
383
+ const localVarOperationServerBasePath = operationServerMap["DefaultApi.executeWorkflow"]?.[localVarOperationServerIndex]?.url;
384
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
385
+ },
386
+ /**
387
+ * Get a workflow execution/run (instance)
388
+ * @summary Get Workflow Instance by ID
389
+ * @param {string} instanceId ID of the workflow instance
390
+ * @param {boolean} [includeAssessment] Whether to include assessment
391
+ * @param {*} [options] Override http request option.
392
+ * @throws {RequiredError}
393
+ */
394
+ async getInstanceById(instanceId, includeAssessment, options) {
395
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getInstanceById(instanceId, includeAssessment, options);
396
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
397
+ const localVarOperationServerBasePath = operationServerMap["DefaultApi.getInstanceById"]?.[localVarOperationServerIndex]?.url;
398
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
399
+ },
400
+ /**
401
+ * Retrieve an array of workflow executions (instances)
402
+ * @summary Get instances
403
+ * @param {GetInstancesRequest} [getInstancesRequest] Parameters for retrieving instances
404
+ * @param {*} [options] Override http request option.
405
+ * @throws {RequiredError}
406
+ */
407
+ async getInstances(getInstancesRequest, options) {
408
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getInstances(getInstancesRequest, options);
409
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
410
+ const localVarOperationServerBasePath = operationServerMap["DefaultApi.getInstances"]?.[localVarOperationServerIndex]?.url;
411
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
412
+ },
413
+ /**
414
+ * Get the workflow input schema. It defines the input fields of the workflow
415
+ * @param {string} workflowId ID of the workflow to fetch
416
+ * @param {string} [instanceId] ID of instance
417
+ * @param {*} [options] Override http request option.
418
+ * @throws {RequiredError}
419
+ */
420
+ async getWorkflowInputSchemaById(workflowId, instanceId, options) {
421
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowInputSchemaById(workflowId, instanceId, options);
422
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
423
+ const localVarOperationServerBasePath = operationServerMap["DefaultApi.getWorkflowInputSchemaById"]?.[localVarOperationServerIndex]?.url;
424
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
425
+ },
426
+ /**
427
+ * Retrieve an array of workflow executions (instances) for the given workflow
428
+ * @summary Get instances for a specific workflow
429
+ * @param {string} workflowId ID of the workflow
430
+ * @param {SearchRequest} [searchRequest] Parameters for retrieving workflow instances
431
+ * @param {*} [options] Override http request option.
432
+ * @throws {RequiredError}
433
+ */
434
+ async getWorkflowInstances(workflowId, searchRequest, options) {
435
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowInstances(workflowId, searchRequest, options);
436
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
437
+ const localVarOperationServerBasePath = operationServerMap["DefaultApi.getWorkflowInstances"]?.[localVarOperationServerIndex]?.url;
438
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
439
+ },
440
+ /**
441
+ * Returns the key fields of the workflow including data on the last run instance
442
+ * @param {string} workflowId Unique identifier of the workflow
443
+ * @param {*} [options] Override http request option.
444
+ * @throws {RequiredError}
445
+ */
446
+ async getWorkflowOverviewById(workflowId, options) {
447
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowOverviewById(workflowId, options);
448
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
449
+ const localVarOperationServerBasePath = operationServerMap["DefaultApi.getWorkflowOverviewById"]?.[localVarOperationServerIndex]?.url;
450
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
451
+ },
452
+ /**
453
+ * Get the workflow\'s definition
454
+ * @param {string} workflowId ID of the workflow to fetch
455
+ * @param {*} [options] Override http request option.
456
+ * @throws {RequiredError}
457
+ */
458
+ async getWorkflowSourceById(workflowId, options) {
459
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowSourceById(workflowId, options);
460
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
461
+ const localVarOperationServerBasePath = operationServerMap["DefaultApi.getWorkflowSourceById"]?.[localVarOperationServerIndex]?.url;
462
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
463
+ },
464
+ /**
465
+ * Retrieve array with the status of all instances
466
+ * @summary Get workflow status list
467
+ * @param {*} [options] Override http request option.
468
+ * @throws {RequiredError}
469
+ */
470
+ async getWorkflowStatuses(options) {
471
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowStatuses(options);
472
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
473
+ const localVarOperationServerBasePath = operationServerMap["DefaultApi.getWorkflowStatuses"]?.[localVarOperationServerIndex]?.url;
474
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
475
+ },
476
+ /**
477
+ * Returns the key fields of the workflow including data on the last run instance
478
+ * @param {SearchRequest} [searchRequest] Pagination and filters
479
+ * @param {*} [options] Override http request option.
480
+ * @throws {RequiredError}
481
+ */
482
+ async getWorkflowsOverview(searchRequest, options) {
483
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowsOverview(searchRequest, options);
484
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
485
+ const localVarOperationServerBasePath = operationServerMap["DefaultApi.getWorkflowsOverview"]?.[localVarOperationServerIndex]?.url;
486
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
487
+ },
488
+ /**
489
+ * Retrigger an instance
490
+ * @summary Retrigger an instance
491
+ * @param {string} workflowId ID of the workflow
492
+ * @param {string} instanceId ID of the instance to retrigger
493
+ * @param {*} [options] Override http request option.
494
+ * @throws {RequiredError}
495
+ */
496
+ async retriggerInstance(workflowId, instanceId, options) {
497
+ const localVarAxiosArgs = await localVarAxiosParamCreator.retriggerInstance(workflowId, instanceId, options);
498
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
499
+ const localVarOperationServerBasePath = operationServerMap["DefaultApi.retriggerInstance"]?.[localVarOperationServerIndex]?.url;
500
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
501
+ }
502
+ };
503
+ };
504
+ const DefaultApiFactory = function(configuration, basePath, axios) {
505
+ const localVarFp = DefaultApiFp(configuration);
506
+ return {
507
+ /**
508
+ * Aborts a workflow instance identified by the provided instanceId.
509
+ * @summary Abort a workflow instance
510
+ * @param {string} instanceId The identifier of the workflow instance to abort.
511
+ * @param {*} [options] Override http request option.
512
+ * @throws {RequiredError}
513
+ */
514
+ abortWorkflow(instanceId, options) {
515
+ return localVarFp.abortWorkflow(instanceId, options).then((request) => request(axios, basePath));
516
+ },
517
+ /**
518
+ * Execute a workflow
519
+ * @summary Execute a workflow
520
+ * @param {string} workflowId ID of the workflow to execute
521
+ * @param {ExecuteWorkflowRequestDTO} executeWorkflowRequestDTO
522
+ * @param {*} [options] Override http request option.
523
+ * @throws {RequiredError}
524
+ */
525
+ executeWorkflow(workflowId, executeWorkflowRequestDTO, options) {
526
+ return localVarFp.executeWorkflow(workflowId, executeWorkflowRequestDTO, options).then((request) => request(axios, basePath));
527
+ },
528
+ /**
529
+ * Get a workflow execution/run (instance)
530
+ * @summary Get Workflow Instance by ID
531
+ * @param {string} instanceId ID of the workflow instance
532
+ * @param {boolean} [includeAssessment] Whether to include assessment
533
+ * @param {*} [options] Override http request option.
534
+ * @throws {RequiredError}
535
+ */
536
+ getInstanceById(instanceId, includeAssessment, options) {
537
+ return localVarFp.getInstanceById(instanceId, includeAssessment, options).then((request) => request(axios, basePath));
538
+ },
539
+ /**
540
+ * Retrieve an array of workflow executions (instances)
541
+ * @summary Get instances
542
+ * @param {GetInstancesRequest} [getInstancesRequest] Parameters for retrieving instances
543
+ * @param {*} [options] Override http request option.
544
+ * @throws {RequiredError}
545
+ */
546
+ getInstances(getInstancesRequest, options) {
547
+ return localVarFp.getInstances(getInstancesRequest, options).then((request) => request(axios, basePath));
548
+ },
549
+ /**
550
+ * Get the workflow input schema. It defines the input fields of the workflow
551
+ * @param {string} workflowId ID of the workflow to fetch
552
+ * @param {string} [instanceId] ID of instance
553
+ * @param {*} [options] Override http request option.
554
+ * @throws {RequiredError}
555
+ */
556
+ getWorkflowInputSchemaById(workflowId, instanceId, options) {
557
+ return localVarFp.getWorkflowInputSchemaById(workflowId, instanceId, options).then((request) => request(axios, basePath));
558
+ },
559
+ /**
560
+ * Retrieve an array of workflow executions (instances) for the given workflow
561
+ * @summary Get instances for a specific workflow
562
+ * @param {string} workflowId ID of the workflow
563
+ * @param {SearchRequest} [searchRequest] Parameters for retrieving workflow instances
564
+ * @param {*} [options] Override http request option.
565
+ * @throws {RequiredError}
566
+ */
567
+ getWorkflowInstances(workflowId, searchRequest, options) {
568
+ return localVarFp.getWorkflowInstances(workflowId, searchRequest, options).then((request) => request(axios, basePath));
569
+ },
570
+ /**
571
+ * Returns the key fields of the workflow including data on the last run instance
572
+ * @param {string} workflowId Unique identifier of the workflow
573
+ * @param {*} [options] Override http request option.
574
+ * @throws {RequiredError}
575
+ */
576
+ getWorkflowOverviewById(workflowId, options) {
577
+ return localVarFp.getWorkflowOverviewById(workflowId, options).then((request) => request(axios, basePath));
578
+ },
579
+ /**
580
+ * Get the workflow\'s definition
581
+ * @param {string} workflowId ID of the workflow to fetch
582
+ * @param {*} [options] Override http request option.
583
+ * @throws {RequiredError}
584
+ */
585
+ getWorkflowSourceById(workflowId, options) {
586
+ return localVarFp.getWorkflowSourceById(workflowId, options).then((request) => request(axios, basePath));
587
+ },
588
+ /**
589
+ * Retrieve array with the status of all instances
590
+ * @summary Get workflow status list
591
+ * @param {*} [options] Override http request option.
592
+ * @throws {RequiredError}
593
+ */
594
+ getWorkflowStatuses(options) {
595
+ return localVarFp.getWorkflowStatuses(options).then((request) => request(axios, basePath));
596
+ },
597
+ /**
598
+ * Returns the key fields of the workflow including data on the last run instance
599
+ * @param {SearchRequest} [searchRequest] Pagination and filters
600
+ * @param {*} [options] Override http request option.
601
+ * @throws {RequiredError}
602
+ */
603
+ getWorkflowsOverview(searchRequest, options) {
604
+ return localVarFp.getWorkflowsOverview(searchRequest, options).then((request) => request(axios, basePath));
605
+ },
606
+ /**
607
+ * Retrigger an instance
608
+ * @summary Retrigger an instance
609
+ * @param {string} workflowId ID of the workflow
610
+ * @param {string} instanceId ID of the instance to retrigger
611
+ * @param {*} [options] Override http request option.
612
+ * @throws {RequiredError}
613
+ */
614
+ retriggerInstance(workflowId, instanceId, options) {
615
+ return localVarFp.retriggerInstance(workflowId, instanceId, options).then((request) => request(axios, basePath));
616
+ }
617
+ };
618
+ };
619
+ class DefaultApi extends BaseAPI {
620
+ /**
621
+ * Aborts a workflow instance identified by the provided instanceId.
622
+ * @summary Abort a workflow instance
623
+ * @param {string} instanceId The identifier of the workflow instance to abort.
624
+ * @param {*} [options] Override http request option.
625
+ * @throws {RequiredError}
626
+ * @memberof DefaultApi
627
+ */
628
+ abortWorkflow(instanceId, options) {
629
+ return DefaultApiFp(this.configuration).abortWorkflow(instanceId, options).then((request) => request(this.axios, this.basePath));
630
+ }
631
+ /**
632
+ * Execute a workflow
633
+ * @summary Execute a workflow
634
+ * @param {string} workflowId ID of the workflow to execute
635
+ * @param {ExecuteWorkflowRequestDTO} executeWorkflowRequestDTO
636
+ * @param {*} [options] Override http request option.
637
+ * @throws {RequiredError}
638
+ * @memberof DefaultApi
639
+ */
640
+ executeWorkflow(workflowId, executeWorkflowRequestDTO, options) {
641
+ return DefaultApiFp(this.configuration).executeWorkflow(workflowId, executeWorkflowRequestDTO, options).then((request) => request(this.axios, this.basePath));
642
+ }
643
+ /**
644
+ * Get a workflow execution/run (instance)
645
+ * @summary Get Workflow Instance by ID
646
+ * @param {string} instanceId ID of the workflow instance
647
+ * @param {boolean} [includeAssessment] Whether to include assessment
648
+ * @param {*} [options] Override http request option.
649
+ * @throws {RequiredError}
650
+ * @memberof DefaultApi
651
+ */
652
+ getInstanceById(instanceId, includeAssessment, options) {
653
+ return DefaultApiFp(this.configuration).getInstanceById(instanceId, includeAssessment, options).then((request) => request(this.axios, this.basePath));
654
+ }
655
+ /**
656
+ * Retrieve an array of workflow executions (instances)
657
+ * @summary Get instances
658
+ * @param {GetInstancesRequest} [getInstancesRequest] Parameters for retrieving instances
659
+ * @param {*} [options] Override http request option.
660
+ * @throws {RequiredError}
661
+ * @memberof DefaultApi
662
+ */
663
+ getInstances(getInstancesRequest, options) {
664
+ return DefaultApiFp(this.configuration).getInstances(getInstancesRequest, options).then((request) => request(this.axios, this.basePath));
665
+ }
666
+ /**
667
+ * Get the workflow input schema. It defines the input fields of the workflow
668
+ * @param {string} workflowId ID of the workflow to fetch
669
+ * @param {string} [instanceId] ID of instance
670
+ * @param {*} [options] Override http request option.
671
+ * @throws {RequiredError}
672
+ * @memberof DefaultApi
673
+ */
674
+ getWorkflowInputSchemaById(workflowId, instanceId, options) {
675
+ return DefaultApiFp(this.configuration).getWorkflowInputSchemaById(workflowId, instanceId, options).then((request) => request(this.axios, this.basePath));
676
+ }
677
+ /**
678
+ * Retrieve an array of workflow executions (instances) for the given workflow
679
+ * @summary Get instances for a specific workflow
680
+ * @param {string} workflowId ID of the workflow
681
+ * @param {SearchRequest} [searchRequest] Parameters for retrieving workflow instances
682
+ * @param {*} [options] Override http request option.
683
+ * @throws {RequiredError}
684
+ * @memberof DefaultApi
685
+ */
686
+ getWorkflowInstances(workflowId, searchRequest, options) {
687
+ return DefaultApiFp(this.configuration).getWorkflowInstances(workflowId, searchRequest, options).then((request) => request(this.axios, this.basePath));
688
+ }
689
+ /**
690
+ * Returns the key fields of the workflow including data on the last run instance
691
+ * @param {string} workflowId Unique identifier of the workflow
692
+ * @param {*} [options] Override http request option.
693
+ * @throws {RequiredError}
694
+ * @memberof DefaultApi
695
+ */
696
+ getWorkflowOverviewById(workflowId, options) {
697
+ return DefaultApiFp(this.configuration).getWorkflowOverviewById(workflowId, options).then((request) => request(this.axios, this.basePath));
698
+ }
699
+ /**
700
+ * Get the workflow\'s definition
701
+ * @param {string} workflowId ID of the workflow to fetch
702
+ * @param {*} [options] Override http request option.
703
+ * @throws {RequiredError}
704
+ * @memberof DefaultApi
705
+ */
706
+ getWorkflowSourceById(workflowId, options) {
707
+ return DefaultApiFp(this.configuration).getWorkflowSourceById(workflowId, options).then((request) => request(this.axios, this.basePath));
708
+ }
709
+ /**
710
+ * Retrieve array with the status of all instances
711
+ * @summary Get workflow status list
712
+ * @param {*} [options] Override http request option.
713
+ * @throws {RequiredError}
714
+ * @memberof DefaultApi
715
+ */
716
+ getWorkflowStatuses(options) {
717
+ return DefaultApiFp(this.configuration).getWorkflowStatuses(options).then((request) => request(this.axios, this.basePath));
718
+ }
719
+ /**
720
+ * Returns the key fields of the workflow including data on the last run instance
721
+ * @param {SearchRequest} [searchRequest] Pagination and filters
722
+ * @param {*} [options] Override http request option.
723
+ * @throws {RequiredError}
724
+ * @memberof DefaultApi
725
+ */
726
+ getWorkflowsOverview(searchRequest, options) {
727
+ return DefaultApiFp(this.configuration).getWorkflowsOverview(searchRequest, options).then((request) => request(this.axios, this.basePath));
728
+ }
729
+ /**
730
+ * Retrigger an instance
731
+ * @summary Retrigger an instance
732
+ * @param {string} workflowId ID of the workflow
733
+ * @param {string} instanceId ID of the instance to retrigger
734
+ * @param {*} [options] Override http request option.
735
+ * @throws {RequiredError}
736
+ * @memberof DefaultApi
737
+ */
738
+ retriggerInstance(workflowId, instanceId, options) {
739
+ return DefaultApiFp(this.configuration).retriggerInstance(workflowId, instanceId, options).then((request) => request(this.axios, this.basePath));
740
+ }
741
+ }
742
+
743
+ export { DefaultApi, DefaultApiAxiosParamCreator, DefaultApiFactory, DefaultApiFp, FieldFilterOperatorEnum, LogicalFilterOperatorEnum, PaginationInfoDTOOrderDirectionEnum, ProcessInstanceStatusDTO, WorkflowCategoryDTO, WorkflowFormatDTO, WorkflowResultDTOCompletedWithEnum, WorkflowResultDTOOutputsInnerFormatEnum };
744
+ //# sourceMappingURL=api.esm.js.map