@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,1570 @@
1
+ import { JsonObject } from '@backstage/types';
2
+ import { Specification } from '@severlessworkflow/sdk-typescript';
3
+ import { JSONSchema7, JSONSchema7Definition } from 'json-schema';
4
+ import * as axios from 'axios';
5
+ import { RawAxiosRequestConfig, AxiosInstance, AxiosPromise } from 'axios';
6
+ import * as _backstage_plugin_permission_common from '@backstage/plugin-permission-common';
7
+
8
+ declare enum ProcessInstanceState {
9
+ Active = "ACTIVE",
10
+ Completed = "COMPLETED",
11
+ Aborted = "ABORTED",
12
+ Suspended = "SUSPENDED",
13
+ Error = "ERROR",
14
+ Pending = "PENDING"
15
+ }
16
+ type ProcessInstanceStateValues = Uppercase<keyof typeof ProcessInstanceState>;
17
+ declare enum MilestoneStatus {
18
+ Available = "AVAILABLE",
19
+ Active = "ACTIVE",
20
+ Completed = "COMPLETED"
21
+ }
22
+ interface NodeInstance {
23
+ __typename?: 'NodeInstance';
24
+ id: string;
25
+ name: string;
26
+ type: string;
27
+ enter: string;
28
+ exit?: string;
29
+ definitionId: string;
30
+ nodeId: string;
31
+ }
32
+ interface TriggerableNode {
33
+ id: number;
34
+ name: string;
35
+ type: string;
36
+ uniqueId: string;
37
+ nodeDefinitionId: string;
38
+ }
39
+ interface Milestone {
40
+ __typename?: 'Milestone';
41
+ id: string;
42
+ name: string;
43
+ status: MilestoneStatus;
44
+ }
45
+ interface ProcessInstanceError {
46
+ __typename?: 'ProcessInstanceError';
47
+ nodeDefinitionId: string;
48
+ message?: string;
49
+ }
50
+ type ProcessInstanceVariables = Record<string, unknown>;
51
+ interface ProcessInstance {
52
+ id: string;
53
+ processId: string;
54
+ processName?: string;
55
+ parentProcessInstanceId?: string;
56
+ rootProcessInstanceId?: string;
57
+ rootProcessId?: string;
58
+ roles?: string[];
59
+ state?: ProcessInstanceStateValues;
60
+ endpoint: string;
61
+ serviceUrl?: string;
62
+ nodes: NodeInstance[];
63
+ milestones?: Milestone[];
64
+ variables?: ProcessInstanceVariables | string;
65
+ /** Format: date-time */
66
+ start?: string;
67
+ /** Format: date-time */
68
+ end?: string;
69
+ parentProcessInstance?: ProcessInstance;
70
+ childProcessInstances?: ProcessInstance[];
71
+ error?: ProcessInstanceError;
72
+ addons?: string[];
73
+ businessKey?: string;
74
+ isSelected?: boolean;
75
+ errorMessage?: string;
76
+ isOpen?: boolean;
77
+ diagram?: string;
78
+ nodeDefinitions?: TriggerableNode[];
79
+ source?: string;
80
+ category?: WorkflowCategory;
81
+ description?: WorkflowDefinition['description'];
82
+ }
83
+ interface IntrospectionQuery {
84
+ __type: IntrospectionType | null;
85
+ }
86
+ interface IntrospectionType {
87
+ name: string;
88
+ kind: TypeKind;
89
+ description: string | null;
90
+ fields: IntrospectionField[] | null;
91
+ }
92
+ interface IntrospectionField {
93
+ name: string;
94
+ type: IntrospectionTypeRef;
95
+ }
96
+ interface IntrospectionTypeRef {
97
+ kind: TypeKind;
98
+ name: TypeName;
99
+ ofType: IntrospectionTypeRef | null;
100
+ }
101
+ declare enum TypeKind {
102
+ InputObject = "INPUT_OBJECT"
103
+ }
104
+ declare enum TypeName {
105
+ Id = "IdArgument",
106
+ String = "StringArgument",
107
+ StringArray = "StringArrayArgument",
108
+ Date = "DateArgument"
109
+ }
110
+
111
+ type Id<T> = {
112
+ [P in keyof T]: T[P];
113
+ };
114
+ type OmitDistributive<T, K extends PropertyKey> = T extends any ? T extends object ? Id<OmitRecursively<T, K>> : T : never;
115
+ type OmitRecursively<T, K extends PropertyKey> = Omit<{
116
+ [P in keyof T]: OmitDistributive<T[P], K>;
117
+ }, K>;
118
+ type WorkflowDefinition = OmitRecursively<Specification.Workflow, 'normalize'>;
119
+ type WorkflowListResult = {
120
+ items: WorkflowDefinition[];
121
+ totalCount: number;
122
+ offset: number;
123
+ limit: number;
124
+ };
125
+ type WorkflowOverviewListResult = {
126
+ items: WorkflowOverview[];
127
+ totalCount: number;
128
+ offset: number;
129
+ limit: number;
130
+ };
131
+ type WorkflowFormat = 'yaml' | 'json';
132
+ type WorkflowInputSchemaStep = {
133
+ schema: JsonObjectSchema;
134
+ title: string;
135
+ key: string;
136
+ data: JsonObject;
137
+ readonlyKeys: string[];
138
+ };
139
+ type JsonObjectSchema = Omit<JSONSchema7, 'properties'> & {
140
+ properties: {
141
+ [key: string]: JSONSchema7;
142
+ };
143
+ };
144
+ type ComposedSchema = Omit<JSONSchema7, 'properties'> & {
145
+ properties: {
146
+ [key: string]: Omit<JSONSchema7, 'properties'> & {
147
+ properties: {
148
+ [key: string]: JsonObjectSchema;
149
+ };
150
+ };
151
+ };
152
+ };
153
+ declare const isJsonObjectSchema: (schema: JSONSchema7 | JsonObjectSchema | JSONSchema7Definition) => schema is JsonObjectSchema;
154
+ declare const isComposedSchema: (schema: JSONSchema7 | ComposedSchema) => schema is ComposedSchema;
155
+ interface WorkflowExecutionResponse {
156
+ id: string;
157
+ }
158
+ declare enum WorkflowCategory {
159
+ ASSESSMENT = "assessment",
160
+ INFRASTRUCTURE = "infrastructure"
161
+ }
162
+ interface WorkflowOverview {
163
+ workflowId: string;
164
+ format: WorkflowFormat;
165
+ name?: string;
166
+ lastRunId?: string;
167
+ lastTriggeredMs?: number;
168
+ lastRunStatus?: ProcessInstanceStateValues;
169
+ category?: string;
170
+ avgDurationMs?: number;
171
+ description?: string;
172
+ }
173
+ interface WorkflowInfo {
174
+ id: string;
175
+ type?: string;
176
+ name?: string;
177
+ version?: string;
178
+ annotations?: string[];
179
+ description?: string;
180
+ inputSchema?: JSONSchema7;
181
+ endpoint?: string;
182
+ serviceUrl?: string;
183
+ roles?: string[];
184
+ source?: string;
185
+ metadata?: Map<string, string>;
186
+ nodes?: Node[];
187
+ }
188
+ interface Node {
189
+ id: string;
190
+ type?: string;
191
+ name?: string;
192
+ uniqueId?: string;
193
+ nodeDefinitionId?: string;
194
+ }
195
+ interface AssessedProcessInstance {
196
+ instance: ProcessInstance;
197
+ assessedBy?: ProcessInstance;
198
+ }
199
+
200
+ declare const openApiDocument: any;
201
+
202
+ /**
203
+ * Orchestrator plugin
204
+ * API to interact with orchestrator plugin
205
+ *
206
+ * The version of the OpenAPI document: 0.0.1
207
+ *
208
+ *
209
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
210
+ * https://openapi-generator.tech
211
+ * Do not edit the class manually.
212
+ */
213
+ interface ConfigurationParameters {
214
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
215
+ username?: string;
216
+ password?: string;
217
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
218
+ basePath?: string;
219
+ serverIndex?: number;
220
+ baseOptions?: any;
221
+ formDataCtor?: new () => any;
222
+ }
223
+ declare class Configuration {
224
+ /**
225
+ * parameter for apiKey security
226
+ * @param name security name
227
+ * @memberof Configuration
228
+ */
229
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
230
+ /**
231
+ * parameter for basic security
232
+ *
233
+ * @type {string}
234
+ * @memberof Configuration
235
+ */
236
+ username?: string;
237
+ /**
238
+ * parameter for basic security
239
+ *
240
+ * @type {string}
241
+ * @memberof Configuration
242
+ */
243
+ password?: string;
244
+ /**
245
+ * parameter for oauth2 security
246
+ * @param name security name
247
+ * @param scopes oauth2 scope
248
+ * @memberof Configuration
249
+ */
250
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
251
+ /**
252
+ * override base path
253
+ *
254
+ * @type {string}
255
+ * @memberof Configuration
256
+ */
257
+ basePath?: string;
258
+ /**
259
+ * override server index
260
+ *
261
+ * @type {number}
262
+ * @memberof Configuration
263
+ */
264
+ serverIndex?: number;
265
+ /**
266
+ * base options for axios calls
267
+ *
268
+ * @type {any}
269
+ * @memberof Configuration
270
+ */
271
+ baseOptions?: any;
272
+ /**
273
+ * The FormData constructor that will be used to create multipart form data
274
+ * requests. You can inject this here so that execution environments that
275
+ * do not support the FormData class can still run the generated client.
276
+ *
277
+ * @type {new () => FormData}
278
+ */
279
+ formDataCtor?: new () => any;
280
+ constructor(param?: ConfigurationParameters);
281
+ /**
282
+ * Check if the given MIME is a JSON MIME.
283
+ * JSON MIME examples:
284
+ * application/json
285
+ * application/json; charset=UTF8
286
+ * APPLICATION/JSON
287
+ * application/vnd.company+json
288
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
289
+ * @return True if the given MIME is JSON, false otherwise.
290
+ */
291
+ isJsonMime(mime: string): boolean;
292
+ }
293
+
294
+ /**
295
+ * Orchestrator plugin
296
+ * API to interact with orchestrator plugin
297
+ *
298
+ * The version of the OpenAPI document: 0.0.1
299
+ *
300
+ *
301
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
302
+ * https://openapi-generator.tech
303
+ * Do not edit the class manually.
304
+ */
305
+
306
+ /**
307
+ *
308
+ * @export
309
+ * @interface RequestArgs
310
+ */
311
+ interface RequestArgs {
312
+ url: string;
313
+ options: RawAxiosRequestConfig;
314
+ }
315
+ /**
316
+ *
317
+ * @export
318
+ * @class BaseAPI
319
+ */
320
+ declare class BaseAPI {
321
+ protected basePath: string;
322
+ protected axios: AxiosInstance;
323
+ protected configuration: Configuration | undefined;
324
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
325
+ }
326
+
327
+ /**
328
+ *
329
+ * @export
330
+ * @interface AssessedProcessInstanceDTO
331
+ */
332
+ interface AssessedProcessInstanceDTO {
333
+ /**
334
+ *
335
+ * @type {ProcessInstanceDTO}
336
+ * @memberof AssessedProcessInstanceDTO
337
+ */
338
+ 'instance': ProcessInstanceDTO;
339
+ /**
340
+ *
341
+ * @type {ProcessInstanceDTO}
342
+ * @memberof AssessedProcessInstanceDTO
343
+ */
344
+ 'assessedBy'?: ProcessInstanceDTO;
345
+ }
346
+ /**
347
+ * The ErrorResponse object represents a common structure for handling errors in API responses. It includes essential information about the error, such as the error message and additional optional details.
348
+ * @export
349
+ * @interface ErrorResponse
350
+ */
351
+ interface ErrorResponse {
352
+ /**
353
+ * A string providing a concise and human-readable description of the encountered error. This field is required in the ErrorResponse object.
354
+ * @type {string}
355
+ * @memberof ErrorResponse
356
+ */
357
+ 'message': string;
358
+ /**
359
+ * An optional field that can contain additional information or context about the error. It provides flexibility for including extra details based on specific error scenarios.
360
+ * @type {string}
361
+ * @memberof ErrorResponse
362
+ */
363
+ 'additionalInfo'?: string;
364
+ }
365
+ /**
366
+ *
367
+ * @export
368
+ * @interface ExecuteWorkflowRequestDTO
369
+ */
370
+ interface ExecuteWorkflowRequestDTO {
371
+ /**
372
+ *
373
+ * @type {object}
374
+ * @memberof ExecuteWorkflowRequestDTO
375
+ */
376
+ 'inputData': object;
377
+ }
378
+ /**
379
+ *
380
+ * @export
381
+ * @interface ExecuteWorkflowResponseDTO
382
+ */
383
+ interface ExecuteWorkflowResponseDTO {
384
+ /**
385
+ *
386
+ * @type {string}
387
+ * @memberof ExecuteWorkflowResponseDTO
388
+ */
389
+ 'id': string;
390
+ }
391
+ /**
392
+ *
393
+ * @export
394
+ * @interface FieldFilter
395
+ */
396
+ interface FieldFilter {
397
+ /**
398
+ *
399
+ * @type {string}
400
+ * @memberof FieldFilter
401
+ */
402
+ 'field': string;
403
+ /**
404
+ *
405
+ * @type {string}
406
+ * @memberof FieldFilter
407
+ */
408
+ 'operator': FieldFilterOperatorEnum;
409
+ /**
410
+ *
411
+ * @type {FieldFilterValue}
412
+ * @memberof FieldFilter
413
+ */
414
+ 'value': FieldFilterValue;
415
+ }
416
+ declare const FieldFilterOperatorEnum: {
417
+ readonly Eq: "EQ";
418
+ readonly Gt: "GT";
419
+ readonly Gte: "GTE";
420
+ readonly Lt: "LT";
421
+ readonly Lte: "LTE";
422
+ readonly In: "IN";
423
+ readonly IsNull: "IS_NULL";
424
+ readonly Contains: "CONTAINS";
425
+ readonly ContainsAll: "CONTAINS_ALL";
426
+ readonly ContainsAny: "CONTAINS_ANY";
427
+ readonly Like: "LIKE";
428
+ readonly Between: "BETWEEN";
429
+ };
430
+ type FieldFilterOperatorEnum = typeof FieldFilterOperatorEnum[keyof typeof FieldFilterOperatorEnum];
431
+ /**
432
+ * @type FieldFilterValue
433
+ * @export
434
+ */
435
+ type FieldFilterValue = any | boolean | number | string;
436
+ /**
437
+ * @type Filter
438
+ * @export
439
+ */
440
+ type Filter = FieldFilter | LogicalFilter;
441
+ /**
442
+ *
443
+ * @export
444
+ * @interface GetInstancesRequest
445
+ */
446
+ interface GetInstancesRequest {
447
+ /**
448
+ *
449
+ * @type {PaginationInfoDTO}
450
+ * @memberof GetInstancesRequest
451
+ */
452
+ 'paginationInfo'?: PaginationInfoDTO;
453
+ /**
454
+ *
455
+ * @type {SearchRequest}
456
+ * @memberof GetInstancesRequest
457
+ */
458
+ 'filters'?: SearchRequest;
459
+ }
460
+ /**
461
+ *
462
+ * @export
463
+ * @interface GetOverviewsRequestParams
464
+ */
465
+ interface GetOverviewsRequestParams {
466
+ /**
467
+ *
468
+ * @type {PaginationInfoDTO}
469
+ * @memberof GetOverviewsRequestParams
470
+ */
471
+ 'paginationInfo'?: PaginationInfoDTO;
472
+ /**
473
+ *
474
+ * @type {SearchRequest}
475
+ * @memberof GetOverviewsRequestParams
476
+ */
477
+ 'filters'?: SearchRequest;
478
+ }
479
+ /**
480
+ *
481
+ * @export
482
+ * @interface InputSchemaResponseDTO
483
+ */
484
+ interface InputSchemaResponseDTO {
485
+ /**
486
+ *
487
+ * @type {object}
488
+ * @memberof InputSchemaResponseDTO
489
+ */
490
+ 'inputSchema'?: object;
491
+ /**
492
+ *
493
+ * @type {object}
494
+ * @memberof InputSchemaResponseDTO
495
+ */
496
+ 'data'?: object;
497
+ }
498
+ /**
499
+ *
500
+ * @export
501
+ * @interface LogicalFilter
502
+ */
503
+ interface LogicalFilter {
504
+ /**
505
+ *
506
+ * @type {string}
507
+ * @memberof LogicalFilter
508
+ */
509
+ 'operator': LogicalFilterOperatorEnum;
510
+ /**
511
+ *
512
+ * @type {Array<Filter>}
513
+ * @memberof LogicalFilter
514
+ */
515
+ 'filters': Array<Filter>;
516
+ }
517
+ declare const LogicalFilterOperatorEnum: {
518
+ readonly And: "AND";
519
+ readonly Or: "OR";
520
+ readonly Not: "NOT";
521
+ };
522
+ type LogicalFilterOperatorEnum = typeof LogicalFilterOperatorEnum[keyof typeof LogicalFilterOperatorEnum];
523
+ /**
524
+ *
525
+ * @export
526
+ * @interface NodeInstanceDTO
527
+ */
528
+ interface NodeInstanceDTO {
529
+ /**
530
+ * Type name
531
+ * @type {string}
532
+ * @memberof NodeInstanceDTO
533
+ */
534
+ '__typename'?: string;
535
+ /**
536
+ * Node instance ID
537
+ * @type {string}
538
+ * @memberof NodeInstanceDTO
539
+ */
540
+ 'id': string;
541
+ /**
542
+ * Node name
543
+ * @type {string}
544
+ * @memberof NodeInstanceDTO
545
+ */
546
+ 'name'?: string;
547
+ /**
548
+ * Node type
549
+ * @type {string}
550
+ * @memberof NodeInstanceDTO
551
+ */
552
+ 'type'?: string;
553
+ /**
554
+ * Date when the node was entered
555
+ * @type {string}
556
+ * @memberof NodeInstanceDTO
557
+ */
558
+ 'enter'?: string;
559
+ /**
560
+ * Date when the node was exited (optional)
561
+ * @type {string}
562
+ * @memberof NodeInstanceDTO
563
+ */
564
+ 'exit'?: string;
565
+ /**
566
+ * Definition ID
567
+ * @type {string}
568
+ * @memberof NodeInstanceDTO
569
+ */
570
+ 'definitionId'?: string;
571
+ /**
572
+ * Node ID
573
+ * @type {string}
574
+ * @memberof NodeInstanceDTO
575
+ */
576
+ 'nodeId'?: string;
577
+ }
578
+ /**
579
+ *
580
+ * @export
581
+ * @interface PaginationInfoDTO
582
+ */
583
+ interface PaginationInfoDTO {
584
+ /**
585
+ *
586
+ * @type {number}
587
+ * @memberof PaginationInfoDTO
588
+ */
589
+ 'pageSize'?: number;
590
+ /**
591
+ *
592
+ * @type {number}
593
+ * @memberof PaginationInfoDTO
594
+ */
595
+ 'offset'?: number;
596
+ /**
597
+ *
598
+ * @type {number}
599
+ * @memberof PaginationInfoDTO
600
+ */
601
+ 'totalCount'?: number;
602
+ /**
603
+ *
604
+ * @type {string}
605
+ * @memberof PaginationInfoDTO
606
+ */
607
+ 'orderDirection'?: PaginationInfoDTOOrderDirectionEnum;
608
+ /**
609
+ *
610
+ * @type {string}
611
+ * @memberof PaginationInfoDTO
612
+ */
613
+ 'orderBy'?: string;
614
+ }
615
+ declare const PaginationInfoDTOOrderDirectionEnum: {
616
+ readonly Asc: "ASC";
617
+ readonly Desc: "DESC";
618
+ };
619
+ type PaginationInfoDTOOrderDirectionEnum = typeof PaginationInfoDTOOrderDirectionEnum[keyof typeof PaginationInfoDTOOrderDirectionEnum];
620
+ /**
621
+ *
622
+ * @export
623
+ * @interface ProcessInstanceDTO
624
+ */
625
+ interface ProcessInstanceDTO {
626
+ /**
627
+ *
628
+ * @type {string}
629
+ * @memberof ProcessInstanceDTO
630
+ */
631
+ 'id': string;
632
+ /**
633
+ *
634
+ * @type {string}
635
+ * @memberof ProcessInstanceDTO
636
+ */
637
+ 'processId': string;
638
+ /**
639
+ *
640
+ * @type {string}
641
+ * @memberof ProcessInstanceDTO
642
+ */
643
+ 'processName'?: string;
644
+ /**
645
+ *
646
+ * @type {ProcessInstanceStatusDTO}
647
+ * @memberof ProcessInstanceDTO
648
+ */
649
+ 'status'?: ProcessInstanceStatusDTO;
650
+ /**
651
+ *
652
+ * @type {string}
653
+ * @memberof ProcessInstanceDTO
654
+ */
655
+ 'endpoint'?: string;
656
+ /**
657
+ *
658
+ * @type {string}
659
+ * @memberof ProcessInstanceDTO
660
+ */
661
+ 'serviceUrl'?: string;
662
+ /**
663
+ *
664
+ * @type {string}
665
+ * @memberof ProcessInstanceDTO
666
+ */
667
+ 'start'?: string;
668
+ /**
669
+ *
670
+ * @type {string}
671
+ * @memberof ProcessInstanceDTO
672
+ */
673
+ 'end'?: string;
674
+ /**
675
+ *
676
+ * @type {string}
677
+ * @memberof ProcessInstanceDTO
678
+ */
679
+ 'duration'?: string;
680
+ /**
681
+ *
682
+ * @type {WorkflowCategoryDTO}
683
+ * @memberof ProcessInstanceDTO
684
+ */
685
+ 'category'?: WorkflowCategoryDTO;
686
+ /**
687
+ *
688
+ * @type {string}
689
+ * @memberof ProcessInstanceDTO
690
+ */
691
+ 'description'?: string;
692
+ /**
693
+ *
694
+ * @type {WorkflowDataDTO}
695
+ * @memberof ProcessInstanceDTO
696
+ */
697
+ 'workflowdata'?: WorkflowDataDTO;
698
+ /**
699
+ *
700
+ * @type {string}
701
+ * @memberof ProcessInstanceDTO
702
+ */
703
+ 'businessKey'?: string;
704
+ /**
705
+ *
706
+ * @type {Array<NodeInstanceDTO>}
707
+ * @memberof ProcessInstanceDTO
708
+ */
709
+ 'nodes': Array<NodeInstanceDTO>;
710
+ /**
711
+ *
712
+ * @type {ProcessInstanceErrorDTO}
713
+ * @memberof ProcessInstanceDTO
714
+ */
715
+ 'error'?: ProcessInstanceErrorDTO;
716
+ }
717
+ /**
718
+ *
719
+ * @export
720
+ * @interface ProcessInstanceErrorDTO
721
+ */
722
+ interface ProcessInstanceErrorDTO {
723
+ /**
724
+ * Type name
725
+ * @type {string}
726
+ * @memberof ProcessInstanceErrorDTO
727
+ */
728
+ '__typename'?: string;
729
+ /**
730
+ * Node definition ID
731
+ * @type {string}
732
+ * @memberof ProcessInstanceErrorDTO
733
+ */
734
+ 'nodeDefinitionId': string;
735
+ /**
736
+ * Error message (optional)
737
+ * @type {string}
738
+ * @memberof ProcessInstanceErrorDTO
739
+ */
740
+ 'message'?: string;
741
+ }
742
+ /**
743
+ *
744
+ * @export
745
+ * @interface ProcessInstanceListResultDTO
746
+ */
747
+ interface ProcessInstanceListResultDTO {
748
+ /**
749
+ *
750
+ * @type {Array<ProcessInstanceDTO>}
751
+ * @memberof ProcessInstanceListResultDTO
752
+ */
753
+ 'items'?: Array<ProcessInstanceDTO>;
754
+ /**
755
+ *
756
+ * @type {PaginationInfoDTO}
757
+ * @memberof ProcessInstanceListResultDTO
758
+ */
759
+ 'paginationInfo'?: PaginationInfoDTO;
760
+ }
761
+ /**
762
+ * Status of the workflow run
763
+ * @export
764
+ * @enum {string}
765
+ */
766
+ declare const ProcessInstanceStatusDTO: {
767
+ readonly Active: "Active";
768
+ readonly Error: "Error";
769
+ readonly Completed: "Completed";
770
+ readonly Aborted: "Aborted";
771
+ readonly Suspended: "Suspended";
772
+ readonly Pending: "Pending";
773
+ };
774
+ type ProcessInstanceStatusDTO = typeof ProcessInstanceStatusDTO[keyof typeof ProcessInstanceStatusDTO];
775
+ /**
776
+ *
777
+ * @export
778
+ * @interface SearchRequest
779
+ */
780
+ interface SearchRequest {
781
+ /**
782
+ *
783
+ * @type {Filter}
784
+ * @memberof SearchRequest
785
+ */
786
+ 'filters'?: Filter;
787
+ /**
788
+ *
789
+ * @type {PaginationInfoDTO}
790
+ * @memberof SearchRequest
791
+ */
792
+ 'paginationInfo'?: PaginationInfoDTO;
793
+ }
794
+ /**
795
+ * Category of the workflow
796
+ * @export
797
+ * @enum {string}
798
+ */
799
+ declare const WorkflowCategoryDTO: {
800
+ readonly Assessment: "assessment";
801
+ readonly Infrastructure: "infrastructure";
802
+ };
803
+ type WorkflowCategoryDTO = typeof WorkflowCategoryDTO[keyof typeof WorkflowCategoryDTO];
804
+ /**
805
+ *
806
+ * @export
807
+ * @interface WorkflowDTO
808
+ */
809
+ interface WorkflowDTO {
810
+ /**
811
+ * Workflow unique identifier
812
+ * @type {string}
813
+ * @memberof WorkflowDTO
814
+ */
815
+ 'id': string;
816
+ /**
817
+ * Workflow name
818
+ * @type {string}
819
+ * @memberof WorkflowDTO
820
+ */
821
+ 'name'?: string;
822
+ /**
823
+ *
824
+ * @type {WorkflowFormatDTO}
825
+ * @memberof WorkflowDTO
826
+ */
827
+ 'format': WorkflowFormatDTO;
828
+ /**
829
+ *
830
+ * @type {WorkflowCategoryDTO}
831
+ * @memberof WorkflowDTO
832
+ */
833
+ 'category': WorkflowCategoryDTO;
834
+ /**
835
+ * Description of the workflow
836
+ * @type {string}
837
+ * @memberof WorkflowDTO
838
+ */
839
+ 'description'?: string;
840
+ /**
841
+ *
842
+ * @type {Array<string>}
843
+ * @memberof WorkflowDTO
844
+ */
845
+ 'annotations'?: Array<string>;
846
+ }
847
+ /**
848
+ *
849
+ * @export
850
+ * @interface WorkflowDataDTO
851
+ */
852
+ interface WorkflowDataDTO {
853
+ /**
854
+ *
855
+ * @type {WorkflowResultDTO}
856
+ * @memberof WorkflowDataDTO
857
+ */
858
+ 'result'?: WorkflowResultDTO;
859
+ }
860
+ /**
861
+ * Format of the workflow definition
862
+ * @export
863
+ * @enum {string}
864
+ */
865
+ declare const WorkflowFormatDTO: {
866
+ readonly Yaml: "yaml";
867
+ readonly Json: "json";
868
+ };
869
+ type WorkflowFormatDTO = typeof WorkflowFormatDTO[keyof typeof WorkflowFormatDTO];
870
+ /**
871
+ *
872
+ * @export
873
+ * @interface WorkflowListResultDTO
874
+ */
875
+ interface WorkflowListResultDTO {
876
+ /**
877
+ *
878
+ * @type {Array<WorkflowDTO>}
879
+ * @memberof WorkflowListResultDTO
880
+ */
881
+ 'items': Array<WorkflowDTO>;
882
+ /**
883
+ *
884
+ * @type {PaginationInfoDTO}
885
+ * @memberof WorkflowListResultDTO
886
+ */
887
+ 'paginationInfo': PaginationInfoDTO;
888
+ }
889
+ /**
890
+ *
891
+ * @export
892
+ * @interface WorkflowOverviewDTO
893
+ */
894
+ interface WorkflowOverviewDTO {
895
+ /**
896
+ * Workflow unique identifier
897
+ * @type {string}
898
+ * @memberof WorkflowOverviewDTO
899
+ */
900
+ 'workflowId': string;
901
+ /**
902
+ * Workflow name
903
+ * @type {string}
904
+ * @memberof WorkflowOverviewDTO
905
+ */
906
+ 'name'?: string;
907
+ /**
908
+ *
909
+ * @type {WorkflowFormatDTO}
910
+ * @memberof WorkflowOverviewDTO
911
+ */
912
+ 'format': WorkflowFormatDTO;
913
+ /**
914
+ *
915
+ * @type {string}
916
+ * @memberof WorkflowOverviewDTO
917
+ */
918
+ 'lastRunId'?: string;
919
+ /**
920
+ *
921
+ * @type {number}
922
+ * @memberof WorkflowOverviewDTO
923
+ */
924
+ 'lastTriggeredMs'?: number;
925
+ /**
926
+ *
927
+ * @type {ProcessInstanceStatusDTO}
928
+ * @memberof WorkflowOverviewDTO
929
+ */
930
+ 'lastRunStatus'?: ProcessInstanceStatusDTO;
931
+ /**
932
+ *
933
+ * @type {WorkflowCategoryDTO}
934
+ * @memberof WorkflowOverviewDTO
935
+ */
936
+ 'category'?: WorkflowCategoryDTO;
937
+ /**
938
+ *
939
+ * @type {number}
940
+ * @memberof WorkflowOverviewDTO
941
+ */
942
+ 'avgDurationMs'?: number;
943
+ /**
944
+ *
945
+ * @type {string}
946
+ * @memberof WorkflowOverviewDTO
947
+ */
948
+ 'description'?: string;
949
+ }
950
+ /**
951
+ *
952
+ * @export
953
+ * @interface WorkflowOverviewListResultDTO
954
+ */
955
+ interface WorkflowOverviewListResultDTO {
956
+ /**
957
+ *
958
+ * @type {Array<WorkflowOverviewDTO>}
959
+ * @memberof WorkflowOverviewListResultDTO
960
+ */
961
+ 'overviews'?: Array<WorkflowOverviewDTO>;
962
+ /**
963
+ *
964
+ * @type {PaginationInfoDTO}
965
+ * @memberof WorkflowOverviewListResultDTO
966
+ */
967
+ 'paginationInfo'?: PaginationInfoDTO;
968
+ }
969
+ /**
970
+ *
971
+ * @export
972
+ * @interface WorkflowProgressDTO
973
+ */
974
+ interface WorkflowProgressDTO {
975
+ /**
976
+ * Type name
977
+ * @type {any}
978
+ * @memberof WorkflowProgressDTO
979
+ */
980
+ '__typename'?: any;
981
+ /**
982
+ * Node instance ID
983
+ * @type {any}
984
+ * @memberof WorkflowProgressDTO
985
+ */
986
+ 'id': any;
987
+ /**
988
+ * Node name
989
+ * @type {any}
990
+ * @memberof WorkflowProgressDTO
991
+ */
992
+ 'name'?: any;
993
+ /**
994
+ * Node type
995
+ * @type {any}
996
+ * @memberof WorkflowProgressDTO
997
+ */
998
+ 'type'?: any;
999
+ /**
1000
+ * Date when the node was entered
1001
+ * @type {any}
1002
+ * @memberof WorkflowProgressDTO
1003
+ */
1004
+ 'enter'?: any;
1005
+ /**
1006
+ * Date when the node was exited (optional)
1007
+ * @type {any}
1008
+ * @memberof WorkflowProgressDTO
1009
+ */
1010
+ 'exit'?: any;
1011
+ /**
1012
+ * Definition ID
1013
+ * @type {any}
1014
+ * @memberof WorkflowProgressDTO
1015
+ */
1016
+ 'definitionId'?: any;
1017
+ /**
1018
+ * Node ID
1019
+ * @type {any}
1020
+ * @memberof WorkflowProgressDTO
1021
+ */
1022
+ 'nodeId'?: any;
1023
+ /**
1024
+ *
1025
+ * @type {ProcessInstanceStatusDTO}
1026
+ * @memberof WorkflowProgressDTO
1027
+ */
1028
+ 'status'?: ProcessInstanceStatusDTO;
1029
+ /**
1030
+ *
1031
+ * @type {ProcessInstanceErrorDTO}
1032
+ * @memberof WorkflowProgressDTO
1033
+ */
1034
+ 'error'?: ProcessInstanceErrorDTO;
1035
+ }
1036
+ /**
1037
+ * Result of a workflow execution
1038
+ * @export
1039
+ * @interface WorkflowResultDTO
1040
+ */
1041
+ interface WorkflowResultDTO {
1042
+ /**
1043
+ * The state of workflow completion.
1044
+ * @type {string}
1045
+ * @memberof WorkflowResultDTO
1046
+ */
1047
+ 'completedWith'?: WorkflowResultDTOCompletedWithEnum;
1048
+ /**
1049
+ * High-level summary of the current status, free-form text, human readable.
1050
+ * @type {string}
1051
+ * @memberof WorkflowResultDTO
1052
+ */
1053
+ 'message'?: string;
1054
+ /**
1055
+ * List of workflows suggested to run next. Items at lower indexes are of higher priority.
1056
+ * @type {Array<WorkflowResultDTONextWorkflowsInner>}
1057
+ * @memberof WorkflowResultDTO
1058
+ */
1059
+ 'nextWorkflows'?: Array<WorkflowResultDTONextWorkflowsInner>;
1060
+ /**
1061
+ * Additional structured output of workflow processing. This can contain identifiers of created resources, links to resources, logs or other output.
1062
+ * @type {Array<WorkflowResultDTOOutputsInner>}
1063
+ * @memberof WorkflowResultDTO
1064
+ */
1065
+ 'outputs'?: Array<WorkflowResultDTOOutputsInner>;
1066
+ }
1067
+ declare const WorkflowResultDTOCompletedWithEnum: {
1068
+ readonly Error: "error";
1069
+ readonly Success: "success";
1070
+ };
1071
+ type WorkflowResultDTOCompletedWithEnum = typeof WorkflowResultDTOCompletedWithEnum[keyof typeof WorkflowResultDTOCompletedWithEnum];
1072
+ /**
1073
+ *
1074
+ * @export
1075
+ * @interface WorkflowResultDTONextWorkflowsInner
1076
+ */
1077
+ interface WorkflowResultDTONextWorkflowsInner {
1078
+ /**
1079
+ * Workflow identifier
1080
+ * @type {string}
1081
+ * @memberof WorkflowResultDTONextWorkflowsInner
1082
+ */
1083
+ 'id': string;
1084
+ /**
1085
+ * Human readable title describing the workflow.
1086
+ * @type {string}
1087
+ * @memberof WorkflowResultDTONextWorkflowsInner
1088
+ */
1089
+ 'name': string;
1090
+ }
1091
+ /**
1092
+ *
1093
+ * @export
1094
+ * @interface WorkflowResultDTOOutputsInner
1095
+ */
1096
+ interface WorkflowResultDTOOutputsInner {
1097
+ /**
1098
+ * Unique identifier of the option. Preferably human-readable.
1099
+ * @type {string}
1100
+ * @memberof WorkflowResultDTOOutputsInner
1101
+ */
1102
+ 'key': string;
1103
+ /**
1104
+ *
1105
+ * @type {WorkflowResultDTOOutputsInnerValue}
1106
+ * @memberof WorkflowResultDTOOutputsInner
1107
+ */
1108
+ 'value': WorkflowResultDTOOutputsInnerValue;
1109
+ /**
1110
+ * More detailed type of the \'value\' property. Defaults to \'text\'.
1111
+ * @type {string}
1112
+ * @memberof WorkflowResultDTOOutputsInner
1113
+ */
1114
+ 'format'?: WorkflowResultDTOOutputsInnerFormatEnum;
1115
+ }
1116
+ declare const WorkflowResultDTOOutputsInnerFormatEnum: {
1117
+ readonly Text: "text";
1118
+ readonly Number: "number";
1119
+ readonly Link: "link";
1120
+ };
1121
+ type WorkflowResultDTOOutputsInnerFormatEnum = typeof WorkflowResultDTOOutputsInnerFormatEnum[keyof typeof WorkflowResultDTOOutputsInnerFormatEnum];
1122
+ /**
1123
+ * Free form value of the option.
1124
+ * @export
1125
+ * @interface WorkflowResultDTOOutputsInnerValue
1126
+ */
1127
+ interface WorkflowResultDTOOutputsInnerValue {
1128
+ }
1129
+ /**
1130
+ *
1131
+ * @export
1132
+ * @interface WorkflowRunStatusDTO
1133
+ */
1134
+ interface WorkflowRunStatusDTO {
1135
+ /**
1136
+ *
1137
+ * @type {string}
1138
+ * @memberof WorkflowRunStatusDTO
1139
+ */
1140
+ 'key'?: string;
1141
+ /**
1142
+ *
1143
+ * @type {string}
1144
+ * @memberof WorkflowRunStatusDTO
1145
+ */
1146
+ 'value'?: string;
1147
+ }
1148
+ /**
1149
+ * DefaultApi - axios parameter creator
1150
+ * @export
1151
+ */
1152
+ declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
1153
+ /**
1154
+ * Aborts a workflow instance identified by the provided instanceId.
1155
+ * @summary Abort a workflow instance
1156
+ * @param {string} instanceId The identifier of the workflow instance to abort.
1157
+ * @param {*} [options] Override http request option.
1158
+ * @throws {RequiredError}
1159
+ */
1160
+ abortWorkflow: (instanceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1161
+ /**
1162
+ * Execute a workflow
1163
+ * @summary Execute a workflow
1164
+ * @param {string} workflowId ID of the workflow to execute
1165
+ * @param {ExecuteWorkflowRequestDTO} executeWorkflowRequestDTO
1166
+ * @param {*} [options] Override http request option.
1167
+ * @throws {RequiredError}
1168
+ */
1169
+ executeWorkflow: (workflowId: string, executeWorkflowRequestDTO: ExecuteWorkflowRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1170
+ /**
1171
+ * Get a workflow execution/run (instance)
1172
+ * @summary Get Workflow Instance by ID
1173
+ * @param {string} instanceId ID of the workflow instance
1174
+ * @param {boolean} [includeAssessment] Whether to include assessment
1175
+ * @param {*} [options] Override http request option.
1176
+ * @throws {RequiredError}
1177
+ */
1178
+ getInstanceById: (instanceId: string, includeAssessment?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1179
+ /**
1180
+ * Retrieve an array of workflow executions (instances)
1181
+ * @summary Get instances
1182
+ * @param {GetInstancesRequest} [getInstancesRequest] Parameters for retrieving instances
1183
+ * @param {*} [options] Override http request option.
1184
+ * @throws {RequiredError}
1185
+ */
1186
+ getInstances: (getInstancesRequest?: GetInstancesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1187
+ /**
1188
+ * Get the workflow input schema. It defines the input fields of the workflow
1189
+ * @param {string} workflowId ID of the workflow to fetch
1190
+ * @param {string} [instanceId] ID of instance
1191
+ * @param {*} [options] Override http request option.
1192
+ * @throws {RequiredError}
1193
+ */
1194
+ getWorkflowInputSchemaById: (workflowId: string, instanceId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1195
+ /**
1196
+ * Retrieve an array of workflow executions (instances) for the given workflow
1197
+ * @summary Get instances for a specific workflow
1198
+ * @param {string} workflowId ID of the workflow
1199
+ * @param {SearchRequest} [searchRequest] Parameters for retrieving workflow instances
1200
+ * @param {*} [options] Override http request option.
1201
+ * @throws {RequiredError}
1202
+ */
1203
+ getWorkflowInstances: (workflowId: string, searchRequest?: SearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1204
+ /**
1205
+ * Returns the key fields of the workflow including data on the last run instance
1206
+ * @param {string} workflowId Unique identifier of the workflow
1207
+ * @param {*} [options] Override http request option.
1208
+ * @throws {RequiredError}
1209
+ */
1210
+ getWorkflowOverviewById: (workflowId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1211
+ /**
1212
+ * Get the workflow\'s definition
1213
+ * @param {string} workflowId ID of the workflow to fetch
1214
+ * @param {*} [options] Override http request option.
1215
+ * @throws {RequiredError}
1216
+ */
1217
+ getWorkflowSourceById: (workflowId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1218
+ /**
1219
+ * Retrieve array with the status of all instances
1220
+ * @summary Get workflow status list
1221
+ * @param {*} [options] Override http request option.
1222
+ * @throws {RequiredError}
1223
+ */
1224
+ getWorkflowStatuses: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1225
+ /**
1226
+ * Returns the key fields of the workflow including data on the last run instance
1227
+ * @param {SearchRequest} [searchRequest] Pagination and filters
1228
+ * @param {*} [options] Override http request option.
1229
+ * @throws {RequiredError}
1230
+ */
1231
+ getWorkflowsOverview: (searchRequest?: SearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1232
+ /**
1233
+ * Retrigger an instance
1234
+ * @summary Retrigger an instance
1235
+ * @param {string} workflowId ID of the workflow
1236
+ * @param {string} instanceId ID of the instance to retrigger
1237
+ * @param {*} [options] Override http request option.
1238
+ * @throws {RequiredError}
1239
+ */
1240
+ retriggerInstance: (workflowId: string, instanceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1241
+ };
1242
+ /**
1243
+ * DefaultApi - functional programming interface
1244
+ * @export
1245
+ */
1246
+ declare const DefaultApiFp: (configuration?: Configuration) => {
1247
+ /**
1248
+ * Aborts a workflow instance identified by the provided instanceId.
1249
+ * @summary Abort a workflow instance
1250
+ * @param {string} instanceId The identifier of the workflow instance to abort.
1251
+ * @param {*} [options] Override http request option.
1252
+ * @throws {RequiredError}
1253
+ */
1254
+ abortWorkflow(instanceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
1255
+ /**
1256
+ * Execute a workflow
1257
+ * @summary Execute a workflow
1258
+ * @param {string} workflowId ID of the workflow to execute
1259
+ * @param {ExecuteWorkflowRequestDTO} executeWorkflowRequestDTO
1260
+ * @param {*} [options] Override http request option.
1261
+ * @throws {RequiredError}
1262
+ */
1263
+ executeWorkflow(workflowId: string, executeWorkflowRequestDTO: ExecuteWorkflowRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteWorkflowResponseDTO>>;
1264
+ /**
1265
+ * Get a workflow execution/run (instance)
1266
+ * @summary Get Workflow Instance by ID
1267
+ * @param {string} instanceId ID of the workflow instance
1268
+ * @param {boolean} [includeAssessment] Whether to include assessment
1269
+ * @param {*} [options] Override http request option.
1270
+ * @throws {RequiredError}
1271
+ */
1272
+ getInstanceById(instanceId: string, includeAssessment?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssessedProcessInstanceDTO>>;
1273
+ /**
1274
+ * Retrieve an array of workflow executions (instances)
1275
+ * @summary Get instances
1276
+ * @param {GetInstancesRequest} [getInstancesRequest] Parameters for retrieving instances
1277
+ * @param {*} [options] Override http request option.
1278
+ * @throws {RequiredError}
1279
+ */
1280
+ getInstances(getInstancesRequest?: GetInstancesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProcessInstanceListResultDTO>>;
1281
+ /**
1282
+ * Get the workflow input schema. It defines the input fields of the workflow
1283
+ * @param {string} workflowId ID of the workflow to fetch
1284
+ * @param {string} [instanceId] ID of instance
1285
+ * @param {*} [options] Override http request option.
1286
+ * @throws {RequiredError}
1287
+ */
1288
+ getWorkflowInputSchemaById(workflowId: string, instanceId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InputSchemaResponseDTO>>;
1289
+ /**
1290
+ * Retrieve an array of workflow executions (instances) for the given workflow
1291
+ * @summary Get instances for a specific workflow
1292
+ * @param {string} workflowId ID of the workflow
1293
+ * @param {SearchRequest} [searchRequest] Parameters for retrieving workflow instances
1294
+ * @param {*} [options] Override http request option.
1295
+ * @throws {RequiredError}
1296
+ */
1297
+ getWorkflowInstances(workflowId: string, searchRequest?: SearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProcessInstanceListResultDTO>>;
1298
+ /**
1299
+ * Returns the key fields of the workflow including data on the last run instance
1300
+ * @param {string} workflowId Unique identifier of the workflow
1301
+ * @param {*} [options] Override http request option.
1302
+ * @throws {RequiredError}
1303
+ */
1304
+ getWorkflowOverviewById(workflowId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowOverviewDTO>>;
1305
+ /**
1306
+ * Get the workflow\'s definition
1307
+ * @param {string} workflowId ID of the workflow to fetch
1308
+ * @param {*} [options] Override http request option.
1309
+ * @throws {RequiredError}
1310
+ */
1311
+ getWorkflowSourceById(workflowId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
1312
+ /**
1313
+ * Retrieve array with the status of all instances
1314
+ * @summary Get workflow status list
1315
+ * @param {*} [options] Override http request option.
1316
+ * @throws {RequiredError}
1317
+ */
1318
+ getWorkflowStatuses(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowRunStatusDTO>>>;
1319
+ /**
1320
+ * Returns the key fields of the workflow including data on the last run instance
1321
+ * @param {SearchRequest} [searchRequest] Pagination and filters
1322
+ * @param {*} [options] Override http request option.
1323
+ * @throws {RequiredError}
1324
+ */
1325
+ getWorkflowsOverview(searchRequest?: SearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowOverviewListResultDTO>>;
1326
+ /**
1327
+ * Retrigger an instance
1328
+ * @summary Retrigger an instance
1329
+ * @param {string} workflowId ID of the workflow
1330
+ * @param {string} instanceId ID of the instance to retrigger
1331
+ * @param {*} [options] Override http request option.
1332
+ * @throws {RequiredError}
1333
+ */
1334
+ retriggerInstance(workflowId: string, instanceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
1335
+ };
1336
+ /**
1337
+ * DefaultApi - factory interface
1338
+ * @export
1339
+ */
1340
+ declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1341
+ /**
1342
+ * Aborts a workflow instance identified by the provided instanceId.
1343
+ * @summary Abort a workflow instance
1344
+ * @param {string} instanceId The identifier of the workflow instance to abort.
1345
+ * @param {*} [options] Override http request option.
1346
+ * @throws {RequiredError}
1347
+ */
1348
+ abortWorkflow(instanceId: string, options?: any): AxiosPromise<string>;
1349
+ /**
1350
+ * Execute a workflow
1351
+ * @summary Execute a workflow
1352
+ * @param {string} workflowId ID of the workflow to execute
1353
+ * @param {ExecuteWorkflowRequestDTO} executeWorkflowRequestDTO
1354
+ * @param {*} [options] Override http request option.
1355
+ * @throws {RequiredError}
1356
+ */
1357
+ executeWorkflow(workflowId: string, executeWorkflowRequestDTO: ExecuteWorkflowRequestDTO, options?: any): AxiosPromise<ExecuteWorkflowResponseDTO>;
1358
+ /**
1359
+ * Get a workflow execution/run (instance)
1360
+ * @summary Get Workflow Instance by ID
1361
+ * @param {string} instanceId ID of the workflow instance
1362
+ * @param {boolean} [includeAssessment] Whether to include assessment
1363
+ * @param {*} [options] Override http request option.
1364
+ * @throws {RequiredError}
1365
+ */
1366
+ getInstanceById(instanceId: string, includeAssessment?: boolean, options?: any): AxiosPromise<AssessedProcessInstanceDTO>;
1367
+ /**
1368
+ * Retrieve an array of workflow executions (instances)
1369
+ * @summary Get instances
1370
+ * @param {GetInstancesRequest} [getInstancesRequest] Parameters for retrieving instances
1371
+ * @param {*} [options] Override http request option.
1372
+ * @throws {RequiredError}
1373
+ */
1374
+ getInstances(getInstancesRequest?: GetInstancesRequest, options?: any): AxiosPromise<ProcessInstanceListResultDTO>;
1375
+ /**
1376
+ * Get the workflow input schema. It defines the input fields of the workflow
1377
+ * @param {string} workflowId ID of the workflow to fetch
1378
+ * @param {string} [instanceId] ID of instance
1379
+ * @param {*} [options] Override http request option.
1380
+ * @throws {RequiredError}
1381
+ */
1382
+ getWorkflowInputSchemaById(workflowId: string, instanceId?: string, options?: any): AxiosPromise<InputSchemaResponseDTO>;
1383
+ /**
1384
+ * Retrieve an array of workflow executions (instances) for the given workflow
1385
+ * @summary Get instances for a specific workflow
1386
+ * @param {string} workflowId ID of the workflow
1387
+ * @param {SearchRequest} [searchRequest] Parameters for retrieving workflow instances
1388
+ * @param {*} [options] Override http request option.
1389
+ * @throws {RequiredError}
1390
+ */
1391
+ getWorkflowInstances(workflowId: string, searchRequest?: SearchRequest, options?: any): AxiosPromise<ProcessInstanceListResultDTO>;
1392
+ /**
1393
+ * Returns the key fields of the workflow including data on the last run instance
1394
+ * @param {string} workflowId Unique identifier of the workflow
1395
+ * @param {*} [options] Override http request option.
1396
+ * @throws {RequiredError}
1397
+ */
1398
+ getWorkflowOverviewById(workflowId: string, options?: any): AxiosPromise<WorkflowOverviewDTO>;
1399
+ /**
1400
+ * Get the workflow\'s definition
1401
+ * @param {string} workflowId ID of the workflow to fetch
1402
+ * @param {*} [options] Override http request option.
1403
+ * @throws {RequiredError}
1404
+ */
1405
+ getWorkflowSourceById(workflowId: string, options?: any): AxiosPromise<string>;
1406
+ /**
1407
+ * Retrieve array with the status of all instances
1408
+ * @summary Get workflow status list
1409
+ * @param {*} [options] Override http request option.
1410
+ * @throws {RequiredError}
1411
+ */
1412
+ getWorkflowStatuses(options?: any): AxiosPromise<Array<WorkflowRunStatusDTO>>;
1413
+ /**
1414
+ * Returns the key fields of the workflow including data on the last run instance
1415
+ * @param {SearchRequest} [searchRequest] Pagination and filters
1416
+ * @param {*} [options] Override http request option.
1417
+ * @throws {RequiredError}
1418
+ */
1419
+ getWorkflowsOverview(searchRequest?: SearchRequest, options?: any): AxiosPromise<WorkflowOverviewListResultDTO>;
1420
+ /**
1421
+ * Retrigger an instance
1422
+ * @summary Retrigger an instance
1423
+ * @param {string} workflowId ID of the workflow
1424
+ * @param {string} instanceId ID of the instance to retrigger
1425
+ * @param {*} [options] Override http request option.
1426
+ * @throws {RequiredError}
1427
+ */
1428
+ retriggerInstance(workflowId: string, instanceId: string, options?: any): AxiosPromise<object>;
1429
+ };
1430
+ /**
1431
+ * DefaultApi - object-oriented interface
1432
+ * @export
1433
+ * @class DefaultApi
1434
+ * @extends {BaseAPI}
1435
+ */
1436
+ declare class DefaultApi extends BaseAPI {
1437
+ /**
1438
+ * Aborts a workflow instance identified by the provided instanceId.
1439
+ * @summary Abort a workflow instance
1440
+ * @param {string} instanceId The identifier of the workflow instance to abort.
1441
+ * @param {*} [options] Override http request option.
1442
+ * @throws {RequiredError}
1443
+ * @memberof DefaultApi
1444
+ */
1445
+ abortWorkflow(instanceId: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<string, any>>;
1446
+ /**
1447
+ * Execute a workflow
1448
+ * @summary Execute a workflow
1449
+ * @param {string} workflowId ID of the workflow to execute
1450
+ * @param {ExecuteWorkflowRequestDTO} executeWorkflowRequestDTO
1451
+ * @param {*} [options] Override http request option.
1452
+ * @throws {RequiredError}
1453
+ * @memberof DefaultApi
1454
+ */
1455
+ executeWorkflow(workflowId: string, executeWorkflowRequestDTO: ExecuteWorkflowRequestDTO, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ExecuteWorkflowResponseDTO, any>>;
1456
+ /**
1457
+ * Get a workflow execution/run (instance)
1458
+ * @summary Get Workflow Instance by ID
1459
+ * @param {string} instanceId ID of the workflow instance
1460
+ * @param {boolean} [includeAssessment] Whether to include assessment
1461
+ * @param {*} [options] Override http request option.
1462
+ * @throws {RequiredError}
1463
+ * @memberof DefaultApi
1464
+ */
1465
+ getInstanceById(instanceId: string, includeAssessment?: boolean, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<AssessedProcessInstanceDTO, any>>;
1466
+ /**
1467
+ * Retrieve an array of workflow executions (instances)
1468
+ * @summary Get instances
1469
+ * @param {GetInstancesRequest} [getInstancesRequest] Parameters for retrieving instances
1470
+ * @param {*} [options] Override http request option.
1471
+ * @throws {RequiredError}
1472
+ * @memberof DefaultApi
1473
+ */
1474
+ getInstances(getInstancesRequest?: GetInstancesRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ProcessInstanceListResultDTO, any>>;
1475
+ /**
1476
+ * Get the workflow input schema. It defines the input fields of the workflow
1477
+ * @param {string} workflowId ID of the workflow to fetch
1478
+ * @param {string} [instanceId] ID of instance
1479
+ * @param {*} [options] Override http request option.
1480
+ * @throws {RequiredError}
1481
+ * @memberof DefaultApi
1482
+ */
1483
+ getWorkflowInputSchemaById(workflowId: string, instanceId?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<InputSchemaResponseDTO, any>>;
1484
+ /**
1485
+ * Retrieve an array of workflow executions (instances) for the given workflow
1486
+ * @summary Get instances for a specific workflow
1487
+ * @param {string} workflowId ID of the workflow
1488
+ * @param {SearchRequest} [searchRequest] Parameters for retrieving workflow instances
1489
+ * @param {*} [options] Override http request option.
1490
+ * @throws {RequiredError}
1491
+ * @memberof DefaultApi
1492
+ */
1493
+ getWorkflowInstances(workflowId: string, searchRequest?: SearchRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ProcessInstanceListResultDTO, any>>;
1494
+ /**
1495
+ * Returns the key fields of the workflow including data on the last run instance
1496
+ * @param {string} workflowId Unique identifier of the workflow
1497
+ * @param {*} [options] Override http request option.
1498
+ * @throws {RequiredError}
1499
+ * @memberof DefaultApi
1500
+ */
1501
+ getWorkflowOverviewById(workflowId: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<WorkflowOverviewDTO, any>>;
1502
+ /**
1503
+ * Get the workflow\'s definition
1504
+ * @param {string} workflowId ID of the workflow to fetch
1505
+ * @param {*} [options] Override http request option.
1506
+ * @throws {RequiredError}
1507
+ * @memberof DefaultApi
1508
+ */
1509
+ getWorkflowSourceById(workflowId: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<string, any>>;
1510
+ /**
1511
+ * Retrieve array with the status of all instances
1512
+ * @summary Get workflow status list
1513
+ * @param {*} [options] Override http request option.
1514
+ * @throws {RequiredError}
1515
+ * @memberof DefaultApi
1516
+ */
1517
+ getWorkflowStatuses(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<WorkflowRunStatusDTO[], any>>;
1518
+ /**
1519
+ * Returns the key fields of the workflow including data on the last run instance
1520
+ * @param {SearchRequest} [searchRequest] Pagination and filters
1521
+ * @param {*} [options] Override http request option.
1522
+ * @throws {RequiredError}
1523
+ * @memberof DefaultApi
1524
+ */
1525
+ getWorkflowsOverview(searchRequest?: SearchRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<WorkflowOverviewListResultDTO, any>>;
1526
+ /**
1527
+ * Retrigger an instance
1528
+ * @summary Retrigger an instance
1529
+ * @param {string} workflowId ID of the workflow
1530
+ * @param {string} instanceId ID of the instance to retrigger
1531
+ * @param {*} [options] Override http request option.
1532
+ * @throws {RequiredError}
1533
+ * @memberof DefaultApi
1534
+ */
1535
+ retriggerInstance(workflowId: string, instanceId: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<object, any>>;
1536
+ }
1537
+
1538
+ declare const DEFAULT_SONATAFLOW_CONTAINER_IMAGE = "docker.io/apache/incubator-kie-sonataflow-devmode:latest";
1539
+ declare const DEFAULT_SONATAFLOW_PERSISTENCE_PATH = "/home/kogito/persistence";
1540
+ declare const DEFAULT_SONATAFLOW_BASE_URL = "http://localhost";
1541
+ declare const DEFAULT_WORKFLOWS_PATH = "workflows";
1542
+ declare const ASSESSMENT_WORKFLOW_TYPE = "workflow-type/assessment";
1543
+ declare const INFRASTRUCTURE_WORKFLOW_TYPE = "workflow-type/infrastructure";
1544
+
1545
+ declare function fromWorkflowSource(content: string): WorkflowDefinition;
1546
+ declare function toWorkflowString(definition: WorkflowDefinition, format: WorkflowFormat): string;
1547
+ declare function toWorkflowJson(definition: WorkflowDefinition): string;
1548
+ declare function toWorkflowYaml(definition: WorkflowDefinition): string;
1549
+ declare function extractWorkflowFormatFromUri(uri: string): WorkflowFormat;
1550
+ declare function getWorkflowCategory(definition: WorkflowDefinition | undefined): WorkflowCategory;
1551
+ declare function parseWorkflowVariables(variables?: object): object | undefined;
1552
+ declare function extractWorkflowFormat(source: string): WorkflowFormat;
1553
+
1554
+ declare const QUERY_PARAM_BUSINESS_KEY: "businessKey";
1555
+ declare const QUERY_PARAM_INSTANCE_ID: "instanceId";
1556
+ declare const QUERY_PARAM_INCLUDE_ASSESSMENT: "includeAssessment";
1557
+ declare const QUERY_PARAM_ASSESSMENT_INSTANCE_ID: "assessmentInstanceId";
1558
+
1559
+ type Capitalized<S extends string> = Capitalize<Lowercase<S>>;
1560
+ declare const capitalize: <S extends string>(text: S) => Capitalize<Lowercase<S>>;
1561
+ declare const ellipsis: <S extends string>(text: S, prefixLength?: number) => string;
1562
+
1563
+ declare const orchestratorWorkflowInstancesReadPermission: _backstage_plugin_permission_common.BasicPermission;
1564
+ declare const orchestratorWorkflowInstanceReadPermission: _backstage_plugin_permission_common.BasicPermission;
1565
+ declare const orchestratorWorkflowReadPermission: _backstage_plugin_permission_common.BasicPermission;
1566
+ declare const orchestratorWorkflowExecutePermission: _backstage_plugin_permission_common.BasicPermission;
1567
+ declare const orchestratorWorkflowInstanceAbortPermission: _backstage_plugin_permission_common.BasicPermission;
1568
+ declare const orchestratorPermissions: _backstage_plugin_permission_common.BasicPermission[];
1569
+
1570
+ export { ASSESSMENT_WORKFLOW_TYPE, type AssessedProcessInstance, type AssessedProcessInstanceDTO, type Capitalized, type ComposedSchema, Configuration, type ConfigurationParameters, DEFAULT_SONATAFLOW_BASE_URL, DEFAULT_SONATAFLOW_CONTAINER_IMAGE, DEFAULT_SONATAFLOW_PERSISTENCE_PATH, DEFAULT_WORKFLOWS_PATH, DefaultApi, DefaultApiAxiosParamCreator, DefaultApiFactory, DefaultApiFp, type ErrorResponse, type ExecuteWorkflowRequestDTO, type ExecuteWorkflowResponseDTO, type FieldFilter, FieldFilterOperatorEnum, type FieldFilterValue, type Filter, type GetInstancesRequest, type GetOverviewsRequestParams, INFRASTRUCTURE_WORKFLOW_TYPE, type InputSchemaResponseDTO, type IntrospectionField, type IntrospectionQuery, type IntrospectionType, type IntrospectionTypeRef, type JsonObjectSchema, type LogicalFilter, LogicalFilterOperatorEnum, type Milestone, MilestoneStatus, type Node, type NodeInstance, type NodeInstanceDTO, type OmitRecursively, type PaginationInfoDTO, PaginationInfoDTOOrderDirectionEnum, type ProcessInstance, type ProcessInstanceDTO, type ProcessInstanceError, type ProcessInstanceErrorDTO, type ProcessInstanceListResultDTO, ProcessInstanceState, type ProcessInstanceStateValues, ProcessInstanceStatusDTO, type ProcessInstanceVariables, QUERY_PARAM_ASSESSMENT_INSTANCE_ID, QUERY_PARAM_BUSINESS_KEY, QUERY_PARAM_INCLUDE_ASSESSMENT, QUERY_PARAM_INSTANCE_ID, type SearchRequest, type TriggerableNode, TypeKind, TypeName, WorkflowCategory, WorkflowCategoryDTO, type WorkflowDTO, type WorkflowDataDTO, type WorkflowDefinition, type WorkflowExecutionResponse, type WorkflowFormat, WorkflowFormatDTO, type WorkflowInfo, type WorkflowInputSchemaStep, type WorkflowListResult, type WorkflowListResultDTO, type WorkflowOverview, type WorkflowOverviewDTO, type WorkflowOverviewListResult, type WorkflowOverviewListResultDTO, type WorkflowProgressDTO, type WorkflowResultDTO, WorkflowResultDTOCompletedWithEnum, type WorkflowResultDTONextWorkflowsInner, type WorkflowResultDTOOutputsInner, WorkflowResultDTOOutputsInnerFormatEnum, type WorkflowResultDTOOutputsInnerValue, type WorkflowRunStatusDTO, capitalize, ellipsis, extractWorkflowFormat, extractWorkflowFormatFromUri, fromWorkflowSource, getWorkflowCategory, isComposedSchema, isJsonObjectSchema, openApiDocument, orchestratorPermissions, orchestratorWorkflowExecutePermission, orchestratorWorkflowInstanceAbortPermission, orchestratorWorkflowInstanceReadPermission, orchestratorWorkflowInstancesReadPermission, orchestratorWorkflowReadPermission, parseWorkflowVariables, toWorkflowJson, toWorkflowString, toWorkflowYaml };