@frankieone/workflow-api 1.0.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.
@@ -0,0 +1,2358 @@
1
+ import { AxiosInstance } from 'axios';
2
+ import { AxiosPromise } from 'axios';
3
+ import { AxiosResponse } from 'axios';
4
+ import { RawAxiosRequestConfig } from 'axios';
5
+
6
+ /**
7
+ * Configuration for an agent task that sends requests to LLM providers (OpenAI, Claude, FrankieOne).
8
+ */
9
+ export declare interface AgentTaskConfig {
10
+ 'type': BaseTaskConfigType;
11
+ /**
12
+ * The LLM provider to use
13
+ */
14
+ 'agentType': AgentTaskConfigAgentTypeEnum;
15
+ /**
16
+ * The prompt to send to the agent. Supports template syntax.
17
+ */
18
+ 'prompt'?: string;
19
+ /**
20
+ * System prompt/instructions for the agent
21
+ */
22
+ 'systemPrompt'?: string;
23
+ /**
24
+ * The model to use (e.g., gpt-4, claude-3-opus)
25
+ */
26
+ 'model'?: string;
27
+ /**
28
+ * Temperature for response randomness (0-2, lower is more deterministic)
29
+ */
30
+ 'temperature'?: number;
31
+ /**
32
+ * Maximum tokens in response
33
+ */
34
+ 'maxTokens'?: number;
35
+ /**
36
+ * Path in workflow state to store the response
37
+ */
38
+ 'outputPath'?: string;
39
+ /**
40
+ * Reference to OpenAI API key (environment variable or secret name)
41
+ */
42
+ 'apiKeyRef'?: string;
43
+ /**
44
+ * Reference to Anthropic API key (environment variable or secret name)
45
+ */
46
+ 'anthropicApiKeyRef'?: string;
47
+ /**
48
+ * FrankieOne Agent ID for internal agent service
49
+ */
50
+ 'agentId'?: string;
51
+ }
52
+
53
+ export declare const AgentTaskConfigAgentTypeEnum: {
54
+ readonly Openai: "OPENAI";
55
+ readonly Claude: "CLAUDE";
56
+ readonly Frankieone: "FRANKIEONE";
57
+ };
58
+
59
+ export declare type AgentTaskConfigAgentTypeEnum = typeof AgentTaskConfigAgentTypeEnum[keyof typeof AgentTaskConfigAgentTypeEnum];
60
+
61
+ /**
62
+ * Workflow Engine API
63
+ * API for creating and managing workflow definitions and executions
64
+ *
65
+ * The version of the OpenAPI document: 2.0.0
66
+ *
67
+ *
68
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
69
+ * https://openapi-generator.tech
70
+ * Do not edit the class manually.
71
+ */
72
+ declare interface AWSv4Configuration {
73
+ options?: {
74
+ region?: string;
75
+ service?: string;
76
+ };
77
+ credentials?: {
78
+ accessKeyId?: string;
79
+ secretAccessKey?: string;
80
+ sessionToken?: string;
81
+ };
82
+ }
83
+
84
+ declare class BaseAPI {
85
+ protected basePath: string;
86
+ protected axios: AxiosInstance;
87
+ protected configuration: Configuration | undefined;
88
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
89
+ }
90
+
91
+ /**
92
+ * Base configuration for a task
93
+ */
94
+ export declare interface BaseTaskConfig {
95
+ 'type': BaseTaskConfigType;
96
+ }
97
+
98
+ /**
99
+ * Type of task: - HTTP - sends an HTTP request and stores the response - BRANCH - branching node, conditionally execute a set of tasks - LOOP - execute a set of tasks multiple times based on a source field - LOG - log a message - WAIT - wait for a condition to be met - SET_STATE - set values in the workflow state - STEP - run a custom step - PARALLEL - execute a set of tasks in parallel - RUN_WORKFLOW - execute a workflow - NOTIFICATION - send notifications via email or Slack - AGENT - send requests to LLM providers (OpenAI, Claude, FrankieOne) - SUBFLOW - execute another workflow definition as a subflow - FORM - pause workflow to collect user input via a form
100
+ */
101
+ export declare const BaseTaskConfigType: {
102
+ readonly Http: "HTTP";
103
+ readonly Branch: "BRANCH";
104
+ readonly Loop: "LOOP";
105
+ readonly Log: "LOG";
106
+ readonly Wait: "WAIT";
107
+ readonly SetState: "SET_STATE";
108
+ readonly Step: "STEP";
109
+ readonly Parallel: "PARALLEL";
110
+ readonly RunWorkflow: "RUN_WORKFLOW";
111
+ readonly Notification: "NOTIFICATION";
112
+ readonly Agent: "AGENT";
113
+ readonly Subflow: "SUBFLOW";
114
+ readonly Form: "FORM";
115
+ };
116
+
117
+ export declare type BaseTaskConfigType = typeof BaseTaskConfigType[keyof typeof BaseTaskConfigType];
118
+
119
+ /**
120
+ * A branch on a branching node, contains the configuration about what is the name of the branch, the expression to evaluate for whether this branch is executed and the tasks associated with the branch, if the branch is evaluated as true then list of tasks will be used executed. field will be used to determine the next task to execute.
121
+ */
122
+ export declare interface BranchTaskBranch {
123
+ /**
124
+ * The name of the branch.
125
+ */
126
+ 'name': string;
127
+ 'expression'?: BranchTaskExpression;
128
+ /**
129
+ * List of tasks associated with the branch
130
+ */
131
+ 'tasks': Array<Task>;
132
+ }
133
+
134
+ export declare interface BranchTaskConfig {
135
+ 'type': BaseTaskConfigType;
136
+ /**
137
+ * A map of branch names to their corresponding expression objects.
138
+ */
139
+ 'branches': Array<BranchTaskBranch>;
140
+ /**
141
+ * The default next task ID if no branches match.
142
+ */
143
+ 'defaultBranch': string;
144
+ }
145
+
146
+ /**
147
+ * @type BranchTaskExpression
148
+ */
149
+ export declare type BranchTaskExpression = {
150
+ type: 'COMPLEX';
151
+ } & BranchTaskExpressionComplex | {
152
+ type: 'SIMPLE';
153
+ } & BranchTaskExpressionSimple;
154
+
155
+ export declare interface BranchTaskExpressionBase {
156
+ 'type': BranchTaskExpressionBaseType;
157
+ }
158
+
159
+ /**
160
+ * The type of the branch task expression. - `SIMPLE`: A simple comparison expression. - `COMPLEX`: A complex expression using AND and OR.
161
+ */
162
+ export declare const BranchTaskExpressionBaseType: {
163
+ readonly Simple: "SIMPLE";
164
+ readonly Complex: "COMPLEX";
165
+ };
166
+
167
+ export declare type BranchTaskExpressionBaseType = typeof BranchTaskExpressionBaseType[keyof typeof BranchTaskExpressionBaseType];
168
+
169
+ export declare interface BranchTaskExpressionComplex {
170
+ 'type': BranchTaskExpressionBaseType;
171
+ 'and'?: Array<BranchTaskExpression>;
172
+ 'or'?: Array<BranchTaskExpression>;
173
+ }
174
+
175
+ export declare interface BranchTaskExpressionSimple {
176
+ 'type': BranchTaskExpressionBaseType;
177
+ /**
178
+ * The path to the value in the state to use in the comparison.
179
+ */
180
+ 'sourcePath': string;
181
+ /**
182
+ * The comparison operator. - `EQ` - path value is equal to the expression value - `NEQ` - path value is not equal to the expression value - `GT` - path value is greater than the expression value - `GTE` - path value is greater than or equal to the expression value - `LT` - path value is less than the expression value - `LTE` - path value is less than or equal to the expression value - `EXISTS` - check if the path value exists - `NOT_EXISTS` - check if the path value does not exist
183
+ */
184
+ 'operator': BranchTaskExpressionSimpleOperatorEnum;
185
+ /**
186
+ * The value to compare against. Can be a string, number, or boolean or an array of strings, numbers, or booleans.
187
+ */
188
+ 'value': any;
189
+ }
190
+
191
+ export declare const BranchTaskExpressionSimpleOperatorEnum: {
192
+ readonly Eq: "EQ";
193
+ readonly Neq: "NEQ";
194
+ readonly Gt: "GT";
195
+ readonly Gte: "GTE";
196
+ readonly Lt: "LT";
197
+ readonly Lte: "LTE";
198
+ readonly Exists: "EXISTS";
199
+ readonly NotExists: "NOT_EXISTS";
200
+ };
201
+
202
+ export declare type BranchTaskExpressionSimpleOperatorEnum = typeof BranchTaskExpressionSimpleOperatorEnum[keyof typeof BranchTaskExpressionSimpleOperatorEnum];
203
+
204
+ export declare class Configuration {
205
+ /**
206
+ * parameter for apiKey security
207
+ * @param name security name
208
+ */
209
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
210
+ /**
211
+ * parameter for basic security
212
+ */
213
+ username?: string;
214
+ /**
215
+ * parameter for basic security
216
+ */
217
+ password?: string;
218
+ /**
219
+ * parameter for oauth2 security
220
+ * @param name security name
221
+ * @param scopes oauth2 scope
222
+ */
223
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
224
+ /**
225
+ * parameter for aws4 signature security
226
+ * @param {Object} AWS4Signature - AWS4 Signature security
227
+ * @param {string} options.region - aws region
228
+ * @param {string} options.service - name of the service.
229
+ * @param {string} credentials.accessKeyId - aws access key id
230
+ * @param {string} credentials.secretAccessKey - aws access key
231
+ * @param {string} credentials.sessionToken - aws session token
232
+ * @memberof Configuration
233
+ */
234
+ awsv4?: AWSv4Configuration;
235
+ /**
236
+ * override base path
237
+ */
238
+ basePath?: string;
239
+ /**
240
+ * override server index
241
+ */
242
+ serverIndex?: number;
243
+ /**
244
+ * base options for axios calls
245
+ */
246
+ baseOptions?: any;
247
+ /**
248
+ * The FormData constructor that will be used to create multipart form data
249
+ * requests. You can inject this here so that execution environments that
250
+ * do not support the FormData class can still run the generated client.
251
+ *
252
+ * @type {new () => FormData}
253
+ */
254
+ formDataCtor?: new () => any;
255
+ constructor(param?: ConfigurationParameters);
256
+ /**
257
+ * Check if the given MIME is a JSON MIME.
258
+ * JSON MIME examples:
259
+ * application/json
260
+ * application/json; charset=UTF8
261
+ * APPLICATION/JSON
262
+ * application/vnd.company+json
263
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
264
+ * @return True if the given MIME is JSON, false otherwise.
265
+ */
266
+ isJsonMime(mime: string): boolean;
267
+ }
268
+
269
+ export declare interface ConfigurationParameters {
270
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
271
+ username?: string;
272
+ password?: string;
273
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
274
+ awsv4?: AWSv4Configuration;
275
+ basePath?: string;
276
+ serverIndex?: number;
277
+ baseOptions?: any;
278
+ formDataCtor?: new () => any;
279
+ }
280
+
281
+ export declare interface DefinitionSummariesResponse {
282
+ 'tags': Array<string>;
283
+ 'owners': Array<string>;
284
+ 'workflowDefinitions': Array<WorkflowDefinitionSummary>;
285
+ 'meta'?: Meta;
286
+ }
287
+
288
+ /**
289
+ * Configuration for how task errors should be handled
290
+ */
291
+ export declare interface ErrorHandlingConfig {
292
+ /**
293
+ * Determines if task errors should be ignored, the task will be marked as ERROR if this is false, and the workflow will be marked as FAILED if this is true
294
+ */
295
+ 'ignoreErrors'?: boolean;
296
+ /**
297
+ * Optional state to use if the task fails (only used if ignoreErrors is true)
298
+ */
299
+ 'fallbackState'?: object;
300
+ 'retryConfig'?: RetryConfig;
301
+ }
302
+
303
+ export declare interface ErrorResponse {
304
+ /**
305
+ * Error message
306
+ */
307
+ 'error': string;
308
+ /**
309
+ * Additional error details
310
+ */
311
+ 'details'?: object;
312
+ }
313
+
314
+ /**
315
+ * @type FormField
316
+ */
317
+ export declare type FormField = {
318
+ type: 'ADDRESS';
319
+ } & FormFieldAddress | {
320
+ type: 'CHECKBOX';
321
+ } & FormFieldCheckbox | {
322
+ type: 'CHECKLIST';
323
+ } & FormFieldChecklist | {
324
+ type: 'CONSENT';
325
+ } & FormFieldConsent | {
326
+ type: 'COUNTRY';
327
+ } & FormFieldCountry | {
328
+ type: 'DATE';
329
+ } & FormFieldDate | {
330
+ type: 'EMAIL';
331
+ } & FormFieldEmail | {
332
+ type: 'FILE';
333
+ } & FormFieldFile | {
334
+ type: 'HEADER';
335
+ } & FormFieldHeader | {
336
+ type: 'IMAGE';
337
+ } & FormFieldImage | {
338
+ type: 'NUMBER';
339
+ } & FormFieldNumber | {
340
+ type: 'PHONE';
341
+ } & FormFieldPhone | {
342
+ type: 'SELECT';
343
+ } & FormFieldSelect | {
344
+ type: 'TEXT';
345
+ } & FormFieldText | {
346
+ type: 'TEXTAREA';
347
+ } & FormFieldTextarea | {
348
+ type: 'TEXTBLOCK';
349
+ } & FormFieldTextblock;
350
+
351
+ export declare interface FormFieldAddress {
352
+ /**
353
+ * Unique identifier for the field, used as the key in form data
354
+ */
355
+ 'id': string;
356
+ 'type': FormFieldType;
357
+ /**
358
+ * Reference to the field in the form data
359
+ */
360
+ 'reference'?: string;
361
+ /**
362
+ * Displayed label for the field
363
+ */
364
+ 'label': string;
365
+ /**
366
+ * Placeholder text for the field
367
+ */
368
+ 'placeholder'?: string;
369
+ /**
370
+ * Whether the field is required
371
+ */
372
+ 'required'?: boolean;
373
+ /**
374
+ * Default value for the field. Supports template syntax.
375
+ */
376
+ 'defaultValue'?: string;
377
+ 'validation'?: FormFieldBaseValidation;
378
+ }
379
+
380
+ export declare interface FormFieldBase {
381
+ /**
382
+ * Unique identifier for the field, used as the key in form data
383
+ */
384
+ 'id': string;
385
+ 'type': FormFieldType;
386
+ /**
387
+ * Reference to the field in the form data
388
+ */
389
+ 'reference'?: string;
390
+ /**
391
+ * Displayed label for the field
392
+ */
393
+ 'label': string;
394
+ /**
395
+ * Placeholder text for the field
396
+ */
397
+ 'placeholder'?: string;
398
+ /**
399
+ * Whether the field is required
400
+ */
401
+ 'required'?: boolean;
402
+ /**
403
+ * Default value for the field. Supports template syntax.
404
+ */
405
+ 'defaultValue'?: string;
406
+ 'validation'?: FormFieldBaseValidation;
407
+ }
408
+
409
+ /**
410
+ * Validation rules for the field
411
+ */
412
+ export declare interface FormFieldBaseValidation {
413
+ 'minLength'?: number;
414
+ 'maxLength'?: number;
415
+ /**
416
+ * Regex pattern for validation
417
+ */
418
+ 'pattern'?: string;
419
+ 'min'?: number;
420
+ 'max'?: number;
421
+ }
422
+
423
+ export declare interface FormFieldCheckbox {
424
+ /**
425
+ * Unique identifier for the field, used as the key in form data
426
+ */
427
+ 'id': string;
428
+ 'type': FormFieldType;
429
+ /**
430
+ * Reference to the field in the form data
431
+ */
432
+ 'reference'?: string;
433
+ /**
434
+ * Displayed label for the field
435
+ */
436
+ 'label': string;
437
+ /**
438
+ * Placeholder text for the field
439
+ */
440
+ 'placeholder'?: string;
441
+ /**
442
+ * Whether the field is required
443
+ */
444
+ 'required'?: boolean;
445
+ /**
446
+ * Default value for the field. Supports template syntax.
447
+ */
448
+ 'defaultValue'?: string;
449
+ 'validation'?: FormFieldBaseValidation;
450
+ }
451
+
452
+ export declare interface FormFieldChecklist {
453
+ /**
454
+ * Unique identifier for the field, used as the key in form data
455
+ */
456
+ 'id': string;
457
+ 'type': FormFieldType;
458
+ /**
459
+ * Reference to the field in the form data
460
+ */
461
+ 'reference'?: string;
462
+ /**
463
+ * Displayed label for the field
464
+ */
465
+ 'label': string;
466
+ /**
467
+ * Placeholder text for the field
468
+ */
469
+ 'placeholder'?: string;
470
+ /**
471
+ * Whether the field is required
472
+ */
473
+ 'required'?: boolean;
474
+ /**
475
+ * Default value for the field. Supports template syntax.
476
+ */
477
+ 'defaultValue'?: string;
478
+ 'validation'?: FormFieldBaseValidation;
479
+ 'description'?: string;
480
+ /**
481
+ * Items for checklist fields
482
+ */
483
+ 'items'?: Array<FormFieldChecklistAllOfItems>;
484
+ }
485
+
486
+ export declare interface FormFieldChecklistAllOfItems {
487
+ 'description'?: string;
488
+ 'icon'?: string;
489
+ }
490
+
491
+ export declare interface FormFieldConsent {
492
+ /**
493
+ * Unique identifier for the field, used as the key in form data
494
+ */
495
+ 'id': string;
496
+ 'type': FormFieldType;
497
+ /**
498
+ * Reference to the field in the form data
499
+ */
500
+ 'reference'?: string;
501
+ /**
502
+ * Displayed label for the field
503
+ */
504
+ 'label': string;
505
+ /**
506
+ * Placeholder text for the field
507
+ */
508
+ 'placeholder'?: string;
509
+ /**
510
+ * Whether the field is required
511
+ */
512
+ 'required'?: boolean;
513
+ /**
514
+ * Default value for the field. Supports template syntax.
515
+ */
516
+ 'defaultValue'?: string;
517
+ 'validation'?: FormFieldBaseValidation;
518
+ /**
519
+ * Header text for the consent section
520
+ */
521
+ 'header'?: string;
522
+ /**
523
+ * Terms text for the consent
524
+ */
525
+ 'content'?: string;
526
+ 'consents'?: Array<FormFieldConsentAllOfConsents>;
527
+ }
528
+
529
+ export declare interface FormFieldConsentAllOfConsents {
530
+ /**
531
+ * The name to store when the consent is given
532
+ */
533
+ 'name'?: string;
534
+ /**
535
+ * Whether this consent is required
536
+ */
537
+ 'required'?: boolean;
538
+ /**
539
+ * The value to store when the consent is given
540
+ */
541
+ 'value'?: string;
542
+ }
543
+
544
+ export declare interface FormFieldCountry {
545
+ /**
546
+ * Unique identifier for the field, used as the key in form data
547
+ */
548
+ 'id': string;
549
+ 'type': FormFieldType;
550
+ /**
551
+ * Reference to the field in the form data
552
+ */
553
+ 'reference'?: string;
554
+ /**
555
+ * Displayed label for the field
556
+ */
557
+ 'label': string;
558
+ /**
559
+ * Placeholder text for the field
560
+ */
561
+ 'placeholder'?: string;
562
+ /**
563
+ * Whether the field is required
564
+ */
565
+ 'required'?: boolean;
566
+ /**
567
+ * Default value for the field. Supports template syntax.
568
+ */
569
+ 'defaultValue'?: string;
570
+ 'validation'?: FormFieldBaseValidation;
571
+ }
572
+
573
+ export declare interface FormFieldDate {
574
+ /**
575
+ * Unique identifier for the field, used as the key in form data
576
+ */
577
+ 'id': string;
578
+ 'type': FormFieldType;
579
+ /**
580
+ * Reference to the field in the form data
581
+ */
582
+ 'reference'?: string;
583
+ /**
584
+ * Displayed label for the field
585
+ */
586
+ 'label': string;
587
+ /**
588
+ * Placeholder text for the field
589
+ */
590
+ 'placeholder'?: string;
591
+ /**
592
+ * Whether the field is required
593
+ */
594
+ 'required'?: boolean;
595
+ /**
596
+ * Default value for the field. Supports template syntax.
597
+ */
598
+ 'defaultValue'?: string;
599
+ 'validation'?: FormFieldBaseValidation;
600
+ }
601
+
602
+ export declare interface FormFieldEmail {
603
+ /**
604
+ * Unique identifier for the field, used as the key in form data
605
+ */
606
+ 'id': string;
607
+ 'type': FormFieldType;
608
+ /**
609
+ * Reference to the field in the form data
610
+ */
611
+ 'reference'?: string;
612
+ /**
613
+ * Displayed label for the field
614
+ */
615
+ 'label': string;
616
+ /**
617
+ * Placeholder text for the field
618
+ */
619
+ 'placeholder'?: string;
620
+ /**
621
+ * Whether the field is required
622
+ */
623
+ 'required'?: boolean;
624
+ /**
625
+ * Default value for the field. Supports template syntax.
626
+ */
627
+ 'defaultValue'?: string;
628
+ 'validation'?: FormFieldBaseValidation;
629
+ }
630
+
631
+ export declare interface FormFieldFile {
632
+ /**
633
+ * Unique identifier for the field, used as the key in form data
634
+ */
635
+ 'id': string;
636
+ 'type': FormFieldType;
637
+ /**
638
+ * Reference to the field in the form data
639
+ */
640
+ 'reference'?: string;
641
+ /**
642
+ * Displayed label for the field
643
+ */
644
+ 'label': string;
645
+ /**
646
+ * Placeholder text for the field
647
+ */
648
+ 'placeholder'?: string;
649
+ /**
650
+ * Whether the field is required
651
+ */
652
+ 'required'?: boolean;
653
+ /**
654
+ * Default value for the field. Supports template syntax.
655
+ */
656
+ 'defaultValue'?: string;
657
+ 'validation'?: FormFieldBaseValidation;
658
+ }
659
+
660
+ export declare interface FormFieldHeader {
661
+ /**
662
+ * Unique identifier for the field, used as the key in form data
663
+ */
664
+ 'id': string;
665
+ 'type': FormFieldType;
666
+ /**
667
+ * Reference to the field in the form data
668
+ */
669
+ 'reference'?: string;
670
+ /**
671
+ * Displayed label for the field
672
+ */
673
+ 'label': string;
674
+ /**
675
+ * Placeholder text for the field
676
+ */
677
+ 'placeholder'?: string;
678
+ /**
679
+ * Whether the field is required
680
+ */
681
+ 'required'?: boolean;
682
+ /**
683
+ * Default value for the field. Supports template syntax.
684
+ */
685
+ 'defaultValue'?: string;
686
+ 'validation'?: FormFieldBaseValidation;
687
+ /**
688
+ * Header level (1-6)
689
+ */
690
+ 'level'?: number;
691
+ }
692
+
693
+ export declare interface FormFieldImage {
694
+ /**
695
+ * Unique identifier for the field, used as the key in form data
696
+ */
697
+ 'id': string;
698
+ 'type': FormFieldType;
699
+ /**
700
+ * Reference to the field in the form data
701
+ */
702
+ 'reference'?: string;
703
+ /**
704
+ * Displayed label for the field
705
+ */
706
+ 'label': string;
707
+ /**
708
+ * Placeholder text for the field
709
+ */
710
+ 'placeholder'?: string;
711
+ /**
712
+ * Whether the field is required
713
+ */
714
+ 'required'?: boolean;
715
+ /**
716
+ * Default value for the field. Supports template syntax.
717
+ */
718
+ 'defaultValue'?: string;
719
+ 'validation'?: FormFieldBaseValidation;
720
+ /**
721
+ * Image source URL or path
722
+ */
723
+ 'src'?: string;
724
+ /**
725
+ * Alternative text for the image
726
+ */
727
+ 'alt'?: string;
728
+ /**
729
+ * Image width (CSS value)
730
+ */
731
+ 'width'?: string;
732
+ /**
733
+ * Image height (CSS value)
734
+ */
735
+ 'height'?: string;
736
+ }
737
+
738
+ export declare interface FormFieldNumber {
739
+ /**
740
+ * Unique identifier for the field, used as the key in form data
741
+ */
742
+ 'id': string;
743
+ 'type': FormFieldType;
744
+ /**
745
+ * Reference to the field in the form data
746
+ */
747
+ 'reference'?: string;
748
+ /**
749
+ * Displayed label for the field
750
+ */
751
+ 'label': string;
752
+ /**
753
+ * Placeholder text for the field
754
+ */
755
+ 'placeholder'?: string;
756
+ /**
757
+ * Whether the field is required
758
+ */
759
+ 'required'?: boolean;
760
+ /**
761
+ * Default value for the field. Supports template syntax.
762
+ */
763
+ 'defaultValue'?: string;
764
+ 'validation'?: FormFieldBaseValidation;
765
+ }
766
+
767
+ export declare interface FormFieldPhone {
768
+ /**
769
+ * Unique identifier for the field, used as the key in form data
770
+ */
771
+ 'id': string;
772
+ 'type': FormFieldType;
773
+ /**
774
+ * Reference to the field in the form data
775
+ */
776
+ 'reference'?: string;
777
+ /**
778
+ * Displayed label for the field
779
+ */
780
+ 'label': string;
781
+ /**
782
+ * Placeholder text for the field
783
+ */
784
+ 'placeholder'?: string;
785
+ /**
786
+ * Whether the field is required
787
+ */
788
+ 'required'?: boolean;
789
+ /**
790
+ * Default value for the field. Supports template syntax.
791
+ */
792
+ 'defaultValue'?: string;
793
+ 'validation'?: FormFieldBaseValidation;
794
+ }
795
+
796
+ export declare interface FormFieldSelect {
797
+ /**
798
+ * Unique identifier for the field, used as the key in form data
799
+ */
800
+ 'id': string;
801
+ 'type': FormFieldType;
802
+ /**
803
+ * Reference to the field in the form data
804
+ */
805
+ 'reference'?: string;
806
+ /**
807
+ * Displayed label for the field
808
+ */
809
+ 'label': string;
810
+ /**
811
+ * Placeholder text for the field
812
+ */
813
+ 'placeholder'?: string;
814
+ /**
815
+ * Whether the field is required
816
+ */
817
+ 'required'?: boolean;
818
+ /**
819
+ * Default value for the field. Supports template syntax.
820
+ */
821
+ 'defaultValue'?: string;
822
+ 'validation'?: FormFieldBaseValidation;
823
+ /**
824
+ * Options for select fields
825
+ */
826
+ 'options'?: Array<FormFieldSelectAllOfOptions>;
827
+ }
828
+
829
+ export declare interface FormFieldSelectAllOfOptions {
830
+ 'value'?: string;
831
+ 'label'?: string;
832
+ }
833
+
834
+ export declare interface FormFieldText {
835
+ /**
836
+ * Unique identifier for the field, used as the key in form data
837
+ */
838
+ 'id': string;
839
+ 'type': FormFieldType;
840
+ /**
841
+ * Reference to the field in the form data
842
+ */
843
+ 'reference'?: string;
844
+ /**
845
+ * Displayed label for the field
846
+ */
847
+ 'label': string;
848
+ /**
849
+ * Placeholder text for the field
850
+ */
851
+ 'placeholder'?: string;
852
+ /**
853
+ * Whether the field is required
854
+ */
855
+ 'required'?: boolean;
856
+ /**
857
+ * Default value for the field. Supports template syntax.
858
+ */
859
+ 'defaultValue'?: string;
860
+ 'validation'?: FormFieldBaseValidation;
861
+ }
862
+
863
+ export declare interface FormFieldTextarea {
864
+ /**
865
+ * Unique identifier for the field, used as the key in form data
866
+ */
867
+ 'id': string;
868
+ 'type': FormFieldType;
869
+ /**
870
+ * Reference to the field in the form data
871
+ */
872
+ 'reference'?: string;
873
+ /**
874
+ * Displayed label for the field
875
+ */
876
+ 'label': string;
877
+ /**
878
+ * Placeholder text for the field
879
+ */
880
+ 'placeholder'?: string;
881
+ /**
882
+ * Whether the field is required
883
+ */
884
+ 'required'?: boolean;
885
+ /**
886
+ * Default value for the field. Supports template syntax.
887
+ */
888
+ 'defaultValue'?: string;
889
+ 'validation'?: FormFieldBaseValidation;
890
+ }
891
+
892
+ export declare interface FormFieldTextblock {
893
+ /**
894
+ * Unique identifier for the field, used as the key in form data
895
+ */
896
+ 'id': string;
897
+ 'type': FormFieldType;
898
+ /**
899
+ * Reference to the field in the form data
900
+ */
901
+ 'reference'?: string;
902
+ /**
903
+ * Displayed label for the field
904
+ */
905
+ 'label': string;
906
+ /**
907
+ * Placeholder text for the field
908
+ */
909
+ 'placeholder'?: string;
910
+ /**
911
+ * Whether the field is required
912
+ */
913
+ 'required'?: boolean;
914
+ /**
915
+ * Default value for the field. Supports template syntax.
916
+ */
917
+ 'defaultValue'?: string;
918
+ 'validation'?: FormFieldBaseValidation;
919
+ /**
920
+ * Text alignment
921
+ */
922
+ 'alignment'?: FormFieldTextblockAlignmentEnum;
923
+ /**
924
+ * Text content to display
925
+ */
926
+ 'content'?: string;
927
+ }
928
+
929
+ export declare const FormFieldTextblockAlignmentEnum: {
930
+ readonly Left: "left";
931
+ readonly Center: "center";
932
+ readonly Right: "right";
933
+ };
934
+
935
+ export declare type FormFieldTextblockAlignmentEnum = typeof FormFieldTextblockAlignmentEnum[keyof typeof FormFieldTextblockAlignmentEnum];
936
+
937
+ /**
938
+ * The type of form field
939
+ */
940
+ export declare const FormFieldType: {
941
+ readonly Text: "TEXT";
942
+ readonly Email: "EMAIL";
943
+ readonly Phone: "PHONE";
944
+ readonly Number: "NUMBER";
945
+ readonly Date: "DATE";
946
+ readonly Select: "SELECT";
947
+ readonly Checkbox: "CHECKBOX";
948
+ readonly Textarea: "TEXTAREA";
949
+ readonly File: "FILE";
950
+ readonly Country: "COUNTRY";
951
+ readonly Address: "ADDRESS";
952
+ readonly Checklist: "CHECKLIST";
953
+ readonly Header: "HEADER";
954
+ readonly Textblock: "TEXTBLOCK";
955
+ readonly Image: "IMAGE";
956
+ readonly Consent: "CONSENT";
957
+ };
958
+
959
+ export declare type FormFieldType = typeof FormFieldType[keyof typeof FormFieldType];
960
+
961
+ /**
962
+ * Configuration for a form task that pauses workflow execution to collect user input via a form. The workflow resumes when the form is submitted.
963
+ */
964
+ export declare interface FormTaskConfig {
965
+ 'type': BaseTaskConfigType;
966
+ 'formType': FormType;
967
+ /**
968
+ * Form title displayed to the user. Supports template syntax.
969
+ */
970
+ 'title'?: string;
971
+ /**
972
+ * Form description or instructions. Supports template syntax.
973
+ */
974
+ 'description'?: string;
975
+ /**
976
+ * Text for the submit button
977
+ */
978
+ 'buttonText'?: string;
979
+ /**
980
+ * List of form fields to display
981
+ */
982
+ 'fields'?: Array<FormField>;
983
+ /**
984
+ * Path in workflow state to store the form submission data
985
+ */
986
+ 'outputPath'?: string;
987
+ /**
988
+ * Maximum time in seconds to wait for form submission before timing out
989
+ */
990
+ 'timeoutSeconds'?: number;
991
+ /**
992
+ * Unique key to identify this form wait, used for resuming the workflow
993
+ */
994
+ 'waitKey'?: string;
995
+ }
996
+
997
+ /**
998
+ * The type of form to display
999
+ */
1000
+ export declare const FormType: {
1001
+ readonly Welcome: "WELCOME";
1002
+ readonly Consent: "CONSENT";
1003
+ readonly PersonalInfo: "PERSONAL_INFO";
1004
+ readonly Address: "ADDRESS";
1005
+ readonly DocumentUpload: "DOCUMENT_UPLOAD";
1006
+ readonly Review: "REVIEW";
1007
+ readonly Custom: "CUSTOM";
1008
+ };
1009
+
1010
+ export declare type FormType = typeof FormType[keyof typeof FormType];
1011
+
1012
+ export declare interface HttpTaskConfig {
1013
+ 'type': BaseTaskConfigType;
1014
+ /**
1015
+ * URL to send the HTTP request to
1016
+ */
1017
+ 'url': string;
1018
+ 'method': HttpTaskConfigMethod;
1019
+ /**
1020
+ * HTTP headers to include in the request
1021
+ */
1022
+ 'headers'?: {
1023
+ [key: string]: string;
1024
+ };
1025
+ /**
1026
+ * HTTP request body
1027
+ */
1028
+ 'body'?: string;
1029
+ /**
1030
+ * Path to value in state to use as request body
1031
+ */
1032
+ 'bodyFromState'?: string;
1033
+ /**
1034
+ * Timeout for the HTTP request in seconds
1035
+ */
1036
+ 'timeoutSeconds'?: number;
1037
+ /**
1038
+ * Mapping of response fields to state paths
1039
+ */
1040
+ 'responseMapping'?: {
1041
+ [key: string]: string;
1042
+ };
1043
+ /**
1044
+ * Mapping of error fields to state paths
1045
+ */
1046
+ 'errorMapping'?: {
1047
+ [key: string]: string;
1048
+ };
1049
+ }
1050
+
1051
+ /**
1052
+ * HTTP method to use for the request
1053
+ */
1054
+ export declare const HttpTaskConfigMethod: {
1055
+ readonly Get: "GET";
1056
+ readonly Post: "POST";
1057
+ readonly Put: "PUT";
1058
+ readonly Delete: "DELETE";
1059
+ readonly Patch: "PATCH";
1060
+ readonly Head: "HEAD";
1061
+ readonly Options: "OPTIONS";
1062
+ };
1063
+
1064
+ export declare type HttpTaskConfigMethod = typeof HttpTaskConfigMethod[keyof typeof HttpTaskConfigMethod];
1065
+
1066
+ export declare const ListWorkflowExecutionsStatusEnum: {
1067
+ readonly Pending: "PENDING";
1068
+ readonly Running: "RUNNING";
1069
+ readonly Completed: "COMPLETED";
1070
+ readonly Failed: "FAILED";
1071
+ readonly Paused: "PAUSED";
1072
+ readonly Cancelled: "CANCELLED";
1073
+ };
1074
+
1075
+ export declare type ListWorkflowExecutionsStatusEnum = typeof ListWorkflowExecutionsStatusEnum[keyof typeof ListWorkflowExecutionsStatusEnum];
1076
+
1077
+ export declare interface LogTaskConfig {
1078
+ 'type': BaseTaskConfigType;
1079
+ /**
1080
+ * Template string for the log message
1081
+ */
1082
+ 'template': string;
1083
+ 'level': LogTaskConfigLevel;
1084
+ /**
1085
+ * Optional prefix for the log message
1086
+ */
1087
+ 'prefix'?: string;
1088
+ /**
1089
+ * Whether to store the log in the workflow state
1090
+ */
1091
+ 'storeInState'?: boolean;
1092
+ }
1093
+
1094
+ /**
1095
+ * Log level (INFO, WARN, ERROR, DEBUG)
1096
+ */
1097
+ export declare const LogTaskConfigLevel: {
1098
+ readonly Info: "INFO";
1099
+ readonly Warn: "WARN";
1100
+ readonly Error: "ERROR";
1101
+ readonly Debug: "DEBUG";
1102
+ };
1103
+
1104
+ export declare type LogTaskConfigLevel = typeof LogTaskConfigLevel[keyof typeof LogTaskConfigLevel];
1105
+
1106
+ export declare interface LoopTaskConfig {
1107
+ 'type': BaseTaskConfigType;
1108
+ /**
1109
+ * Path to the list value in the state to iterate over
1110
+ */
1111
+ 'sourcePath': string;
1112
+ /**
1113
+ * Name of the variable to store the current item in the state
1114
+ */
1115
+ 'itemVariable': string;
1116
+ /**
1117
+ * Name of the variable to store the current index in the state
1118
+ */
1119
+ 'indexVariable'?: string;
1120
+ /**
1121
+ * List of tasks to execute for each item in the list
1122
+ */
1123
+ 'tasks': Array<Task>;
1124
+ /**
1125
+ * Path in the state where the results of all iterations will be stored
1126
+ */
1127
+ 'resultPath'?: string;
1128
+ }
1129
+
1130
+ export declare interface Meta {
1131
+ /**
1132
+ * Current page number (1-based)
1133
+ */
1134
+ 'page'?: number;
1135
+ /**
1136
+ * Number of items per page
1137
+ */
1138
+ 'pageSize'?: number;
1139
+ /**
1140
+ * Total number of items matching the filters
1141
+ */
1142
+ 'totalCount'?: number;
1143
+ /**
1144
+ * Total number of pages available
1145
+ */
1146
+ 'totalPages'?: number;
1147
+ }
1148
+
1149
+ export declare interface NewWorkflowDefinition {
1150
+ /**
1151
+ * Whether the workflow is a template
1152
+ */
1153
+ 'isTemplate'?: boolean;
1154
+ /**
1155
+ * Whether the workflow is a draft
1156
+ */
1157
+ 'isDraft'?: boolean;
1158
+ /**
1159
+ * Human-readable name for the workflow
1160
+ */
1161
+ 'name': string;
1162
+ /**
1163
+ * Owner of the workflow
1164
+ */
1165
+ 'owner'?: string;
1166
+ /**
1167
+ * Optional detailed description of the workflow
1168
+ */
1169
+ 'description'?: string;
1170
+ /**
1171
+ * Schema for the initial state of the workflow
1172
+ */
1173
+ 'initialState'?: object;
1174
+ 'defaultErrorHandling'?: ErrorHandlingConfig;
1175
+ /**
1176
+ * Map of tasks where the key is the task ID
1177
+ */
1178
+ 'tasks'?: Array<Task>;
1179
+ /**
1180
+ * Tags associated with the workflow
1181
+ */
1182
+ 'tags'?: Array<string>;
1183
+ /**
1184
+ * Workflow-level variables that can be referenced in task configurations using template syntax, these would be validated into the initial state on workflow execution
1185
+ */
1186
+ 'variables'?: Array<WorkflowDefinitionVariable>;
1187
+ }
1188
+
1189
+ /**
1190
+ * Configuration for a notification task that sends notifications via email or Slack.
1191
+ */
1192
+ export declare interface NotificationTaskConfig {
1193
+ 'type': BaseTaskConfigType;
1194
+ /**
1195
+ * The notification channel to use
1196
+ */
1197
+ 'notificationType': NotificationTaskConfigNotificationTypeEnum;
1198
+ /**
1199
+ * Email recipients (for EMAIL type)
1200
+ */
1201
+ 'recipients'?: Array<string>;
1202
+ /**
1203
+ * Email subject line (for EMAIL type). Supports template syntax.
1204
+ */
1205
+ 'subject'?: string;
1206
+ /**
1207
+ * Email body content (for EMAIL type). Supports template syntax.
1208
+ */
1209
+ 'body'?: string;
1210
+ /**
1211
+ * Email body format (for EMAIL type)
1212
+ */
1213
+ 'bodyType'?: NotificationTaskConfigBodyTypeEnum;
1214
+ /**
1215
+ * CC recipients (for EMAIL type)
1216
+ */
1217
+ 'cc'?: Array<string>;
1218
+ /**
1219
+ * BCC recipients (for EMAIL type)
1220
+ */
1221
+ 'bcc'?: Array<string>;
1222
+ /**
1223
+ * Slack webhook URL (for SLACK type). Supports template syntax for secrets.
1224
+ */
1225
+ 'webhookUrl'?: string;
1226
+ /**
1227
+ * Slack channel override (for SLACK type)
1228
+ */
1229
+ 'channel'?: string;
1230
+ /**
1231
+ * Slack message content (for SLACK type). Supports template syntax.
1232
+ */
1233
+ 'message'?: string;
1234
+ /**
1235
+ * Slack bot username override (for SLACK type)
1236
+ */
1237
+ 'username'?: string;
1238
+ /**
1239
+ * Slack bot icon emoji (for SLACK type)
1240
+ */
1241
+ 'iconEmoji'?: string;
1242
+ }
1243
+
1244
+ export declare const NotificationTaskConfigBodyTypeEnum: {
1245
+ readonly Text: "text";
1246
+ readonly Html: "html";
1247
+ };
1248
+
1249
+ export declare type NotificationTaskConfigBodyTypeEnum = typeof NotificationTaskConfigBodyTypeEnum[keyof typeof NotificationTaskConfigBodyTypeEnum];
1250
+
1251
+ export declare const NotificationTaskConfigNotificationTypeEnum: {
1252
+ readonly Email: "EMAIL";
1253
+ readonly Slack: "SLACK";
1254
+ };
1255
+
1256
+ export declare type NotificationTaskConfigNotificationTypeEnum = typeof NotificationTaskConfigNotificationTypeEnum[keyof typeof NotificationTaskConfigNotificationTypeEnum];
1257
+
1258
+ export declare interface ParallelTaskConfig {
1259
+ 'type': BaseTaskConfigType;
1260
+ /**
1261
+ * A group of tasks that should be executed in parallel
1262
+ */
1263
+ 'groups': Array<ParallelTaskGroup>;
1264
+ }
1265
+
1266
+ /**
1267
+ * A group of tasks that should be executed in parallel, each group contains potentially one or more tasks that would be executed in sequence. But each group is executed in parallel.
1268
+ */
1269
+ export declare interface ParallelTaskGroup {
1270
+ /**
1271
+ * The name of the group.
1272
+ */
1273
+ 'name': string;
1274
+ /**
1275
+ * List of tasks associated with the branch
1276
+ */
1277
+ 'tasks': Array<Task>;
1278
+ }
1279
+
1280
+ declare interface RequestArgs {
1281
+ url: string;
1282
+ options: RawAxiosRequestConfig;
1283
+ }
1284
+
1285
+ export declare interface ResumeWorkflowExecution {
1286
+ /**
1287
+ * Additional state for the workflow execution to append to the existing state
1288
+ */
1289
+ 'additionalState'?: object;
1290
+ }
1291
+
1292
+ /**
1293
+ * Configuration for task retry behavior
1294
+ */
1295
+ export declare interface RetryConfig {
1296
+ /**
1297
+ * Maximum number of retry attempts
1298
+ */
1299
+ 'maxAttempts'?: number;
1300
+ /**
1301
+ * Delay in milliseconds between retry attempts
1302
+ */
1303
+ 'delayMs'?: number;
1304
+ /**
1305
+ * Backoff factor for exponential backoff
1306
+ */
1307
+ 'backoffFactor'?: number;
1308
+ }
1309
+
1310
+ export declare interface RunWorkflowTaskConfig {
1311
+ 'type': BaseTaskConfigType;
1312
+ /**
1313
+ * Type of entity (supports templating)
1314
+ */
1315
+ 'entityType': RunWorkflowTaskConfigEntityTypeEnum;
1316
+ /**
1317
+ * Entity ID to execute workflow against (supports templating)
1318
+ */
1319
+ 'entityId': string;
1320
+ /**
1321
+ * Service profile name (supports templating, typically from state)
1322
+ */
1323
+ 'serviceName': string;
1324
+ /**
1325
+ * Name of the workflow to execute (supports templating)
1326
+ */
1327
+ 'workflowName': string;
1328
+ /**
1329
+ * Request timeout in seconds
1330
+ */
1331
+ 'timeoutSeconds'?: number;
1332
+ /**
1333
+ * If true, only the entityId and workflowExecutionId are returned, otherwise the full result is returned
1334
+ */
1335
+ 'returnIdsOnly'?: boolean;
1336
+ }
1337
+
1338
+ export declare const RunWorkflowTaskConfigEntityTypeEnum: {
1339
+ readonly Individuals: "individuals";
1340
+ readonly Organizations: "organizations";
1341
+ };
1342
+
1343
+ export declare type RunWorkflowTaskConfigEntityTypeEnum = typeof RunWorkflowTaskConfigEntityTypeEnum[keyof typeof RunWorkflowTaskConfigEntityTypeEnum];
1344
+
1345
+ export declare interface SetStateTaskConfig {
1346
+ 'type': BaseTaskConfigType;
1347
+ /**
1348
+ * Key-value pairs to set in the workflow state
1349
+ */
1350
+ 'state': {
1351
+ [key: string]: any;
1352
+ };
1353
+ }
1354
+
1355
+ export declare interface StepTaskConfig {
1356
+ 'type': BaseTaskConfigType;
1357
+ /**
1358
+ * The name of the step.
1359
+ */
1360
+ 'name': string;
1361
+ /**
1362
+ * Additional parameters for the step.
1363
+ */
1364
+ 'parameters'?: {
1365
+ [key: string]: any;
1366
+ };
1367
+ }
1368
+
1369
+ /**
1370
+ * Configuration for a subflow task that executes another workflow definition as part of the parent workflow. The subflow inherits the parent workflow\'s state.
1371
+ */
1372
+ export declare interface SubflowTaskConfig {
1373
+ 'type': BaseTaskConfigType;
1374
+ /**
1375
+ * The ID of the workflow definition to execute as a subflow
1376
+ */
1377
+ 'workflowDefinitionId': string;
1378
+ /**
1379
+ * The specific version of the workflow to use (locked at design time)
1380
+ */
1381
+ 'workflowVersion': number;
1382
+ /**
1383
+ * Display name of the referenced workflow (for UI purposes only)
1384
+ */
1385
+ 'workflowName'?: string;
1386
+ /**
1387
+ * Whether the subflow should inherit the parent workflow\'s state
1388
+ */
1389
+ 'inheritState'?: boolean;
1390
+ /**
1391
+ * Optional mapping of parent state keys to subflow state keys
1392
+ */
1393
+ 'stateMapping'?: {
1394
+ [key: string]: string;
1395
+ };
1396
+ /**
1397
+ * Optional mapping of subflow output keys to parent state keys
1398
+ */
1399
+ 'outputMapping'?: {
1400
+ [key: string]: string;
1401
+ };
1402
+ /**
1403
+ * Maximum time in seconds to wait for subflow completion
1404
+ */
1405
+ 'timeoutSeconds'?: number;
1406
+ }
1407
+
1408
+ export declare interface Task {
1409
+ /**
1410
+ * The ID of the task.
1411
+ */
1412
+ 'id': string;
1413
+ /**
1414
+ * The name of the task.
1415
+ */
1416
+ 'name': string;
1417
+ /**
1418
+ * Human-readable description of the task
1419
+ */
1420
+ 'description'?: string;
1421
+ 'errorHandling'?: ErrorHandlingConfig;
1422
+ 'configuration': TaskConfig;
1423
+ }
1424
+
1425
+ /**
1426
+ * @type TaskConfig
1427
+ */
1428
+ export declare type TaskConfig = {
1429
+ type: 'AGENT';
1430
+ } & AgentTaskConfig | {
1431
+ type: 'BRANCH';
1432
+ } & BranchTaskConfig | {
1433
+ type: 'FORM';
1434
+ } & FormTaskConfig | {
1435
+ type: 'HTTP';
1436
+ } & HttpTaskConfig | {
1437
+ type: 'LOG';
1438
+ } & LogTaskConfig | {
1439
+ type: 'LOOP';
1440
+ } & LoopTaskConfig | {
1441
+ type: 'NOTIFICATION';
1442
+ } & NotificationTaskConfig | {
1443
+ type: 'PARALLEL';
1444
+ } & ParallelTaskConfig | {
1445
+ type: 'RUN_WORKFLOW';
1446
+ } & RunWorkflowTaskConfig | {
1447
+ type: 'SET_STATE';
1448
+ } & SetStateTaskConfig | {
1449
+ type: 'STEP';
1450
+ } & StepTaskConfig | {
1451
+ type: 'SUBFLOW';
1452
+ } & SubflowTaskConfig | {
1453
+ type: 'WAIT';
1454
+ } & WaitTaskConfig;
1455
+
1456
+ export declare interface TaskExecutionDetails {
1457
+ /**
1458
+ * ID of the task
1459
+ */
1460
+ 'taskId': string;
1461
+ /**
1462
+ * Owner of the task
1463
+ */
1464
+ 'owner'?: string;
1465
+ 'status': TaskExecutionDetailsStatus;
1466
+ /**
1467
+ * Timestamp when the task execution started
1468
+ */
1469
+ 'startTime'?: string;
1470
+ /**
1471
+ * Timestamp when the task execution ended (if completed, failed, or skipped)
1472
+ */
1473
+ 'endTime'?: string;
1474
+ /**
1475
+ * Error message if the task execution failed
1476
+ */
1477
+ 'error'?: string;
1478
+ /**
1479
+ * Result of the task execution
1480
+ */
1481
+ 'result'?: object;
1482
+ }
1483
+
1484
+ /**
1485
+ * Status of a task execution
1486
+ */
1487
+ export declare const TaskExecutionDetailsStatus: {
1488
+ readonly Pending: "PENDING";
1489
+ readonly Running: "RUNNING";
1490
+ readonly Completed: "COMPLETED";
1491
+ readonly Failed: "FAILED";
1492
+ readonly Paused: "PAUSED";
1493
+ readonly Skipped: "SKIPPED";
1494
+ };
1495
+
1496
+ export declare type TaskExecutionDetailsStatus = typeof TaskExecutionDetailsStatus[keyof typeof TaskExecutionDetailsStatus];
1497
+
1498
+ /**
1499
+ * Configuration for a wait task, this task will wait for a specified amount of time before resuming the workflow or until a specific time is reached.
1500
+ */
1501
+ export declare interface WaitTaskConfig {
1502
+ 'type': BaseTaskConfigType;
1503
+ /**
1504
+ * ISO-8601 timestamp when the task should automatically resume
1505
+ */
1506
+ 'resumeTime'?: string;
1507
+ /**
1508
+ * Duration string (e.g., \"24h\", \"30m\") to wait before resuming
1509
+ */
1510
+ 'resumeAfter'?: string;
1511
+ /**
1512
+ * Optional custom key to use for storing wait status in state
1513
+ */
1514
+ 'waitKey'?: string;
1515
+ /**
1516
+ * Optional reason for waiting, for documentation purposes
1517
+ */
1518
+ 'reason': string;
1519
+ /**
1520
+ * Number of seconds to wait before resuming (alternative to resumeAfter)
1521
+ */
1522
+ 'waitSeconds'?: number;
1523
+ }
1524
+
1525
+ export declare interface WorkflowDefinition {
1526
+ /**
1527
+ * Unique identifier for the workflow
1528
+ */
1529
+ 'id': string;
1530
+ /**
1531
+ * Human-readable name for the workflow
1532
+ */
1533
+ 'name': string;
1534
+ /**
1535
+ * Owner of the workflow
1536
+ */
1537
+ 'owner'?: string;
1538
+ /**
1539
+ * Workflow-level variables that can be referenced in task configurations using template syntax, these would be validated into the initial state on workflow execution
1540
+ */
1541
+ 'variables'?: Array<WorkflowDefinitionVariable>;
1542
+ /**
1543
+ * Whether the workflow is a template
1544
+ */
1545
+ 'isTemplate'?: boolean;
1546
+ /**
1547
+ * Tags associated with the workflow
1548
+ */
1549
+ 'tags'?: Array<string>;
1550
+ /**
1551
+ * Optional detailed description of the workflow
1552
+ */
1553
+ 'description'?: string;
1554
+ /**
1555
+ * List of available versions for this workflow definition
1556
+ */
1557
+ 'versions': Array<number>;
1558
+ /**
1559
+ * The version number of this workflow definition
1560
+ */
1561
+ 'version': number;
1562
+ /**
1563
+ * Version Identifier to refer to
1564
+ */
1565
+ 'versionId'?: string;
1566
+ /**
1567
+ * Timestamp when the workflow definition was first created
1568
+ */
1569
+ 'createdAt': string;
1570
+ /**
1571
+ * Timestamp when the workflow definition was last updated
1572
+ */
1573
+ 'updatedAt': string;
1574
+ /**
1575
+ * User who created the workflow definition
1576
+ */
1577
+ 'createdBy'?: string;
1578
+ /**
1579
+ * User who last updated the workflow definition
1580
+ */
1581
+ 'updatedBy'?: string;
1582
+ 'defaultErrorHandling'?: ErrorHandlingConfig;
1583
+ /**
1584
+ * Whether the workflow definition is a draft
1585
+ */
1586
+ 'isDraft'?: boolean;
1587
+ /**
1588
+ * Initial state for the workflow execution
1589
+ */
1590
+ 'initialState'?: object;
1591
+ /**
1592
+ * Map of tasks where the key is the task ID
1593
+ */
1594
+ 'tasks': Array<Task>;
1595
+ }
1596
+
1597
+ export declare interface WorkflowDefinitionResponse {
1598
+ 'workflowDefinition': WorkflowDefinition;
1599
+ }
1600
+
1601
+ /**
1602
+ * WorkflowDefinitionsApi - object-oriented interface
1603
+ */
1604
+ export declare class WorkflowDefinitionsApi extends BaseAPI {
1605
+ /**
1606
+ * Creates a new workflow definition with tasks and their dependencies
1607
+ * @summary Create a new workflow definition
1608
+ * @param {NewWorkflowDefinition} newWorkflowDefinition Workflow definition to create
1609
+ * @param {*} [options] Override http request option.
1610
+ * @throws {RequiredError}
1611
+ */
1612
+ createWorkflowDefinition(newWorkflowDefinition: NewWorkflowDefinition, options?: RawAxiosRequestConfig): Promise<AxiosResponse<WorkflowDefinitionResponse, any, {}>>;
1613
+ /**
1614
+ * Deletes a workflow definition by its ID
1615
+ * @summary Delete a workflow definition
1616
+ * @param {string} workflowDefinitionId ID of the workflow definition
1617
+ * @param {string} [xFrankieRequestID] Request ID
1618
+ * @param {*} [options] Override http request option.
1619
+ * @throws {RequiredError}
1620
+ */
1621
+ deleteWorkflowDefinition(workflowDefinitionId: string, xFrankieRequestID?: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<void, any, {}>>;
1622
+ /**
1623
+ * Returns a workflow definition by its ID
1624
+ * @summary Get a workflow definition by ID
1625
+ * @param {string} workflowDefinitionId ID of the workflow definition
1626
+ * @param {string} [xFrankieRequestID] Request ID
1627
+ * @param {number} [version] Version of the workflow definition to retrieve. If not provided, the latest version will be returned.
1628
+ * @param {*} [options] Override http request option.
1629
+ * @throws {RequiredError}
1630
+ */
1631
+ getWorkflowDefinition(workflowDefinitionId: string, xFrankieRequestID?: string, version?: number, options?: RawAxiosRequestConfig): Promise<AxiosResponse<WorkflowDefinitionResponse, any, {}>>;
1632
+ /**
1633
+ * Returns a list of all workflow definitions
1634
+ * @summary List all workflow definitions
1635
+ * @param {string} [xFrankieRequestID] Request ID
1636
+ * @param {boolean} [isTemplate] Include template workflow definitions in the response
1637
+ * @param {string} [owner] Filter workflow definitions by owner
1638
+ * @param {number} [page] Page number to retrieve (1-based)
1639
+ * @param {number} [limit] Number of items per page (page size)
1640
+ * @param {boolean} [isDraft] Include draft workflow definitions in the response
1641
+ * @param {*} [options] Override http request option.
1642
+ * @throws {RequiredError}
1643
+ */
1644
+ listWorkflowDefinitions(xFrankieRequestID?: string, isTemplate?: boolean, owner?: string, page?: number, limit?: number, isDraft?: boolean, options?: RawAxiosRequestConfig): Promise<AxiosResponse<DefinitionSummariesResponse, any, {}>>;
1645
+ /**
1646
+ * Updates an existing workflow definition
1647
+ * @summary Update a workflow definition
1648
+ * @param {string} workflowDefinitionId ID of the workflow definition
1649
+ * @param {WorkflowDefinition} workflowDefinition
1650
+ * @param {string} [xFrankieRequestID] Request ID
1651
+ * @param {*} [options] Override http request option.
1652
+ * @throws {RequiredError}
1653
+ */
1654
+ updateWorkflowDefinition(workflowDefinitionId: string, workflowDefinition: WorkflowDefinition, xFrankieRequestID?: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<WorkflowDefinitionResponse, any, {}>>;
1655
+ }
1656
+
1657
+ /**
1658
+ * WorkflowDefinitionsApi - axios parameter creator
1659
+ */
1660
+ export declare const WorkflowDefinitionsApiAxiosParamCreator: (configuration?: Configuration) => {
1661
+ /**
1662
+ * Creates a new workflow definition with tasks and their dependencies
1663
+ * @summary Create a new workflow definition
1664
+ * @param {NewWorkflowDefinition} newWorkflowDefinition Workflow definition to create
1665
+ * @param {*} [options] Override http request option.
1666
+ * @throws {RequiredError}
1667
+ */
1668
+ createWorkflowDefinition: (newWorkflowDefinition: NewWorkflowDefinition, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1669
+ /**
1670
+ * Deletes a workflow definition by its ID
1671
+ * @summary Delete a workflow definition
1672
+ * @param {string} workflowDefinitionId ID of the workflow definition
1673
+ * @param {string} [xFrankieRequestID] Request ID
1674
+ * @param {*} [options] Override http request option.
1675
+ * @throws {RequiredError}
1676
+ */
1677
+ deleteWorkflowDefinition: (workflowDefinitionId: string, xFrankieRequestID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1678
+ /**
1679
+ * Returns a workflow definition by its ID
1680
+ * @summary Get a workflow definition by ID
1681
+ * @param {string} workflowDefinitionId ID of the workflow definition
1682
+ * @param {string} [xFrankieRequestID] Request ID
1683
+ * @param {number} [version] Version of the workflow definition to retrieve. If not provided, the latest version will be returned.
1684
+ * @param {*} [options] Override http request option.
1685
+ * @throws {RequiredError}
1686
+ */
1687
+ getWorkflowDefinition: (workflowDefinitionId: string, xFrankieRequestID?: string, version?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1688
+ /**
1689
+ * Returns a list of all workflow definitions
1690
+ * @summary List all workflow definitions
1691
+ * @param {string} [xFrankieRequestID] Request ID
1692
+ * @param {boolean} [isTemplate] Include template workflow definitions in the response
1693
+ * @param {string} [owner] Filter workflow definitions by owner
1694
+ * @param {number} [page] Page number to retrieve (1-based)
1695
+ * @param {number} [limit] Number of items per page (page size)
1696
+ * @param {boolean} [isDraft] Include draft workflow definitions in the response
1697
+ * @param {*} [options] Override http request option.
1698
+ * @throws {RequiredError}
1699
+ */
1700
+ listWorkflowDefinitions: (xFrankieRequestID?: string, isTemplate?: boolean, owner?: string, page?: number, limit?: number, isDraft?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1701
+ /**
1702
+ * Updates an existing workflow definition
1703
+ * @summary Update a workflow definition
1704
+ * @param {string} workflowDefinitionId ID of the workflow definition
1705
+ * @param {WorkflowDefinition} workflowDefinition
1706
+ * @param {string} [xFrankieRequestID] Request ID
1707
+ * @param {*} [options] Override http request option.
1708
+ * @throws {RequiredError}
1709
+ */
1710
+ updateWorkflowDefinition: (workflowDefinitionId: string, workflowDefinition: WorkflowDefinition, xFrankieRequestID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1711
+ };
1712
+
1713
+ /**
1714
+ * WorkflowDefinitionsApi - factory interface
1715
+ */
1716
+ export declare const WorkflowDefinitionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1717
+ /**
1718
+ * Creates a new workflow definition with tasks and their dependencies
1719
+ * @summary Create a new workflow definition
1720
+ * @param {NewWorkflowDefinition} newWorkflowDefinition Workflow definition to create
1721
+ * @param {*} [options] Override http request option.
1722
+ * @throws {RequiredError}
1723
+ */
1724
+ createWorkflowDefinition(newWorkflowDefinition: NewWorkflowDefinition, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowDefinitionResponse>;
1725
+ /**
1726
+ * Deletes a workflow definition by its ID
1727
+ * @summary Delete a workflow definition
1728
+ * @param {string} workflowDefinitionId ID of the workflow definition
1729
+ * @param {string} [xFrankieRequestID] Request ID
1730
+ * @param {*} [options] Override http request option.
1731
+ * @throws {RequiredError}
1732
+ */
1733
+ deleteWorkflowDefinition(workflowDefinitionId: string, xFrankieRequestID?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1734
+ /**
1735
+ * Returns a workflow definition by its ID
1736
+ * @summary Get a workflow definition by ID
1737
+ * @param {string} workflowDefinitionId ID of the workflow definition
1738
+ * @param {string} [xFrankieRequestID] Request ID
1739
+ * @param {number} [version] Version of the workflow definition to retrieve. If not provided, the latest version will be returned.
1740
+ * @param {*} [options] Override http request option.
1741
+ * @throws {RequiredError}
1742
+ */
1743
+ getWorkflowDefinition(workflowDefinitionId: string, xFrankieRequestID?: string, version?: number, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowDefinitionResponse>;
1744
+ /**
1745
+ * Returns a list of all workflow definitions
1746
+ * @summary List all workflow definitions
1747
+ * @param {string} [xFrankieRequestID] Request ID
1748
+ * @param {boolean} [isTemplate] Include template workflow definitions in the response
1749
+ * @param {string} [owner] Filter workflow definitions by owner
1750
+ * @param {number} [page] Page number to retrieve (1-based)
1751
+ * @param {number} [limit] Number of items per page (page size)
1752
+ * @param {boolean} [isDraft] Include draft workflow definitions in the response
1753
+ * @param {*} [options] Override http request option.
1754
+ * @throws {RequiredError}
1755
+ */
1756
+ listWorkflowDefinitions(xFrankieRequestID?: string, isTemplate?: boolean, owner?: string, page?: number, limit?: number, isDraft?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DefinitionSummariesResponse>;
1757
+ /**
1758
+ * Updates an existing workflow definition
1759
+ * @summary Update a workflow definition
1760
+ * @param {string} workflowDefinitionId ID of the workflow definition
1761
+ * @param {WorkflowDefinition} workflowDefinition
1762
+ * @param {string} [xFrankieRequestID] Request ID
1763
+ * @param {*} [options] Override http request option.
1764
+ * @throws {RequiredError}
1765
+ */
1766
+ updateWorkflowDefinition(workflowDefinitionId: string, workflowDefinition: WorkflowDefinition, xFrankieRequestID?: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowDefinitionResponse>;
1767
+ };
1768
+
1769
+ /**
1770
+ * WorkflowDefinitionsApi - functional programming interface
1771
+ */
1772
+ export declare const WorkflowDefinitionsApiFp: (configuration?: Configuration) => {
1773
+ /**
1774
+ * Creates a new workflow definition with tasks and their dependencies
1775
+ * @summary Create a new workflow definition
1776
+ * @param {NewWorkflowDefinition} newWorkflowDefinition Workflow definition to create
1777
+ * @param {*} [options] Override http request option.
1778
+ * @throws {RequiredError}
1779
+ */
1780
+ createWorkflowDefinition(newWorkflowDefinition: NewWorkflowDefinition, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowDefinitionResponse>>;
1781
+ /**
1782
+ * Deletes a workflow definition by its ID
1783
+ * @summary Delete a workflow definition
1784
+ * @param {string} workflowDefinitionId ID of the workflow definition
1785
+ * @param {string} [xFrankieRequestID] Request ID
1786
+ * @param {*} [options] Override http request option.
1787
+ * @throws {RequiredError}
1788
+ */
1789
+ deleteWorkflowDefinition(workflowDefinitionId: string, xFrankieRequestID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1790
+ /**
1791
+ * Returns a workflow definition by its ID
1792
+ * @summary Get a workflow definition by ID
1793
+ * @param {string} workflowDefinitionId ID of the workflow definition
1794
+ * @param {string} [xFrankieRequestID] Request ID
1795
+ * @param {number} [version] Version of the workflow definition to retrieve. If not provided, the latest version will be returned.
1796
+ * @param {*} [options] Override http request option.
1797
+ * @throws {RequiredError}
1798
+ */
1799
+ getWorkflowDefinition(workflowDefinitionId: string, xFrankieRequestID?: string, version?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowDefinitionResponse>>;
1800
+ /**
1801
+ * Returns a list of all workflow definitions
1802
+ * @summary List all workflow definitions
1803
+ * @param {string} [xFrankieRequestID] Request ID
1804
+ * @param {boolean} [isTemplate] Include template workflow definitions in the response
1805
+ * @param {string} [owner] Filter workflow definitions by owner
1806
+ * @param {number} [page] Page number to retrieve (1-based)
1807
+ * @param {number} [limit] Number of items per page (page size)
1808
+ * @param {boolean} [isDraft] Include draft workflow definitions in the response
1809
+ * @param {*} [options] Override http request option.
1810
+ * @throws {RequiredError}
1811
+ */
1812
+ listWorkflowDefinitions(xFrankieRequestID?: string, isTemplate?: boolean, owner?: string, page?: number, limit?: number, isDraft?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DefinitionSummariesResponse>>;
1813
+ /**
1814
+ * Updates an existing workflow definition
1815
+ * @summary Update a workflow definition
1816
+ * @param {string} workflowDefinitionId ID of the workflow definition
1817
+ * @param {WorkflowDefinition} workflowDefinition
1818
+ * @param {string} [xFrankieRequestID] Request ID
1819
+ * @param {*} [options] Override http request option.
1820
+ * @throws {RequiredError}
1821
+ */
1822
+ updateWorkflowDefinition(workflowDefinitionId: string, workflowDefinition: WorkflowDefinition, xFrankieRequestID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowDefinitionResponse>>;
1823
+ };
1824
+
1825
+ export declare interface WorkflowDefinitionSummary {
1826
+ /**
1827
+ * Unique identifier for the workflow
1828
+ */
1829
+ 'id': string;
1830
+ /**
1831
+ * Human-readable name for the workflow
1832
+ */
1833
+ 'name': string;
1834
+ /**
1835
+ * Owner of the workflow
1836
+ */
1837
+ 'owner'?: string;
1838
+ /**
1839
+ * Workflow-level variables that can be referenced in task configurations using template syntax, these would be validated into the initial state on workflow execution
1840
+ */
1841
+ 'variables'?: Array<WorkflowDefinitionVariable>;
1842
+ /**
1843
+ * Whether the workflow is a template
1844
+ */
1845
+ 'isTemplate'?: boolean;
1846
+ /**
1847
+ * Tags associated with the workflow
1848
+ */
1849
+ 'tags'?: Array<string>;
1850
+ /**
1851
+ * Optional detailed description of the workflow
1852
+ */
1853
+ 'description'?: string;
1854
+ /**
1855
+ * List of available versions for this workflow definition
1856
+ */
1857
+ 'versions': Array<number>;
1858
+ /**
1859
+ * The version number of this workflow definition
1860
+ */
1861
+ 'version': number;
1862
+ /**
1863
+ * Version Identifier to refer to
1864
+ */
1865
+ 'versionId'?: string;
1866
+ /**
1867
+ * Timestamp when the workflow definition was first created
1868
+ */
1869
+ 'createdAt': string;
1870
+ /**
1871
+ * Timestamp when the workflow definition was last updated
1872
+ */
1873
+ 'updatedAt': string;
1874
+ /**
1875
+ * User who created the workflow definition
1876
+ */
1877
+ 'createdBy'?: string;
1878
+ /**
1879
+ * User who last updated the workflow definition
1880
+ */
1881
+ 'updatedBy'?: string;
1882
+ }
1883
+
1884
+ export declare interface WorkflowDefinitionVariable {
1885
+ /**
1886
+ * Name of the variable
1887
+ */
1888
+ 'name': string;
1889
+ /**
1890
+ * Example value of the variable
1891
+ */
1892
+ 'example'?: string;
1893
+ /**
1894
+ * Default value of the variable if not provided
1895
+ */
1896
+ 'default'?: string;
1897
+ /**
1898
+ * Type of the variable
1899
+ */
1900
+ 'type': WorkflowDefinitionVariableTypeEnum;
1901
+ /**
1902
+ * Description of the variable
1903
+ */
1904
+ 'description'?: string;
1905
+ }
1906
+
1907
+ export declare const WorkflowDefinitionVariableTypeEnum: {
1908
+ readonly String: "STRING";
1909
+ readonly Number: "NUMBER";
1910
+ readonly Boolean: "BOOLEAN";
1911
+ readonly Object: "OBJECT";
1912
+ readonly Array: "ARRAY";
1913
+ };
1914
+
1915
+ export declare type WorkflowDefinitionVariableTypeEnum = typeof WorkflowDefinitionVariableTypeEnum[keyof typeof WorkflowDefinitionVariableTypeEnum];
1916
+
1917
+ export declare interface WorkflowExecutionDetails {
1918
+ /**
1919
+ * Unique identifier for the workflow execution
1920
+ */
1921
+ 'id': string;
1922
+ /**
1923
+ * ID of the workflow definition being executed
1924
+ */
1925
+ 'workflowDefinitionId': string;
1926
+ /**
1927
+ * Owner of the workflow execution
1928
+ */
1929
+ 'owner': string;
1930
+ /**
1931
+ * Version of the workflow definition
1932
+ */
1933
+ 'workflowVersion': number;
1934
+ /**
1935
+ * Current status of the workflow execution
1936
+ */
1937
+ 'status': WorkflowExecutionDetailsStatusEnum;
1938
+ /**
1939
+ * Tags associated with the workflow execution
1940
+ */
1941
+ 'tags'?: Array<string>;
1942
+ /**
1943
+ * Timestamp when the workflow execution started
1944
+ */
1945
+ 'startTime': string;
1946
+ /**
1947
+ * Timestamp when the workflow execution ended (if completed or failed)
1948
+ */
1949
+ 'endTime'?: string;
1950
+ /**
1951
+ * Current state of the workflow execution
1952
+ */
1953
+ 'state': object;
1954
+ /**
1955
+ * Error message if the workflow execution failed
1956
+ */
1957
+ 'error'?: string;
1958
+ /**
1959
+ * ID of the currently executing task (if status is RUNNING)
1960
+ */
1961
+ 'currentTaskId'?: string;
1962
+ /**
1963
+ * ID of the task that caused the workflow to pause (if status is PAUSED)
1964
+ */
1965
+ 'pausedTaskId'?: string;
1966
+ /**
1967
+ * Map of task executions where the key is the task ID
1968
+ */
1969
+ 'taskExecutions'?: {
1970
+ [key: string]: TaskExecutionDetails;
1971
+ };
1972
+ /**
1973
+ * List of logs for the workflow execution
1974
+ */
1975
+ 'logs'?: Array<WorkflowExecutionLog>;
1976
+ }
1977
+
1978
+ export declare const WorkflowExecutionDetailsStatusEnum: {
1979
+ readonly Pending: "PENDING";
1980
+ readonly Running: "RUNNING";
1981
+ readonly Completed: "COMPLETED";
1982
+ readonly Failed: "FAILED";
1983
+ readonly Paused: "PAUSED";
1984
+ readonly Cancelled: "CANCELLED";
1985
+ };
1986
+
1987
+ export declare type WorkflowExecutionDetailsStatusEnum = typeof WorkflowExecutionDetailsStatusEnum[keyof typeof WorkflowExecutionDetailsStatusEnum];
1988
+
1989
+ export declare interface WorkflowExecutionLog {
1990
+ /**
1991
+ * Unique identifier for the log
1992
+ */
1993
+ 'id': string;
1994
+ /**
1995
+ * ID of the workflow definition
1996
+ */
1997
+ 'workflowDefinitionId': string;
1998
+ /**
1999
+ * ID of the workflow execution
2000
+ */
2001
+ 'workflowExecutionId': string;
2002
+ /**
2003
+ * Log level
2004
+ */
2005
+ 'level': string;
2006
+ /**
2007
+ * Log message
2008
+ */
2009
+ 'message': string;
2010
+ /**
2011
+ * Timestamp when the log was created
2012
+ */
2013
+ 'createdAt': string;
2014
+ /**
2015
+ * Source of the log
2016
+ */
2017
+ 'source': string;
2018
+ }
2019
+
2020
+ export declare interface WorkflowExecutionRequest {
2021
+ /**
2022
+ * ID of the workflow definition to execute
2023
+ */
2024
+ 'workflowDefinitionId': string;
2025
+ /**
2026
+ * Version of the workflow definition to execute. If not provided, the latest version will be used.
2027
+ */
2028
+ 'version'?: number;
2029
+ /**
2030
+ * Owner of the workflow execution
2031
+ */
2032
+ 'owner'?: string;
2033
+ /**
2034
+ * Initial state for the workflow execution
2035
+ */
2036
+ 'initialState': object;
2037
+ /**
2038
+ * Optional custom execution ID
2039
+ */
2040
+ 'executionId'?: string;
2041
+ }
2042
+
2043
+ export declare interface WorkflowExecutionResponse {
2044
+ 'workflowExecution': WorkflowExecutionDetails;
2045
+ }
2046
+
2047
+ /**
2048
+ * WorkflowExecutionsApi - object-oriented interface
2049
+ */
2050
+ export declare class WorkflowExecutionsApi extends BaseAPI {
2051
+ /**
2052
+ * Cancels a running or paused workflow execution
2053
+ * @summary Cancel a workflow execution
2054
+ * @param {string} executionId ID of the workflow execution
2055
+ * @param {string} [xFrankieRequestID] Request ID
2056
+ * @param {*} [options] Override http request option.
2057
+ * @throws {RequiredError}
2058
+ */
2059
+ cancelWorkflowExecution(executionId: string, xFrankieRequestID?: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<WorkflowExecutionResponse, any, {}>>;
2060
+ /**
2061
+ * Starts execution of a workflow definition
2062
+ * @summary Create a new workflow execution
2063
+ * @param {WorkflowExecutionRequest} workflowExecutionRequest
2064
+ * @param {boolean} [xAsyncExecution] Set to true to execute the workflow asynchronously
2065
+ * @param {string} [xFrankieRequestID] Request ID
2066
+ * @param {string} [xFrankieCustomerID] FrankieOne Customer Identifier
2067
+ * @param {string} [xFrankieCustomerChildID] FrankieOne Customer Child Identifier
2068
+ * @param {string} [xFrankieChannel] Channel that the request is coming from
2069
+ * @param {*} [options] Override http request option.
2070
+ * @throws {RequiredError}
2071
+ */
2072
+ createWorkflowExecution(workflowExecutionRequest: WorkflowExecutionRequest, xAsyncExecution?: boolean, xFrankieRequestID?: string, xFrankieCustomerID?: string, xFrankieCustomerChildID?: string, xFrankieChannel?: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<WorkflowExecutionResponse, any, {}>>;
2073
+ /**
2074
+ * Returns a workflow execution by its ID
2075
+ * @summary Get a workflow execution by ID
2076
+ * @param {string} executionId ID of the workflow execution
2077
+ * @param {string} [xFrankieRequestID] Request ID
2078
+ * @param {*} [options] Override http request option.
2079
+ * @throws {RequiredError}
2080
+ */
2081
+ getWorkflowExecution(executionId: string, xFrankieRequestID?: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<WorkflowExecutionResponse, any, {}>>;
2082
+ /**
2083
+ * Returns a paginated list of workflow executions. Pagination is applied by default.
2084
+ * @summary List workflow executions
2085
+ * @param {string} [xFrankieRequestID] Request ID
2086
+ * @param {string} [workflowDefinitionId] Filter by workflow definition ID
2087
+ * @param {string} [owner] Filter by workflow definition owner
2088
+ * @param {ListWorkflowExecutionsStatusEnum} [status] Filter by execution status
2089
+ * @param {number} [page] Page number to retrieve (1-based)
2090
+ * @param {number} [limit] Number of items per page (page size)
2091
+ * @param {string} [startTimeBefore] Filter by execution start time before a specific date and time
2092
+ * @param {string} [startTimeAfter] Filter by execution start time after a specific date and time
2093
+ * @param {*} [options] Override http request option.
2094
+ * @throws {RequiredError}
2095
+ */
2096
+ listWorkflowExecutions(xFrankieRequestID?: string, workflowDefinitionId?: string, owner?: string, status?: ListWorkflowExecutionsStatusEnum, page?: number, limit?: number, startTimeBefore?: string, startTimeAfter?: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<WorkflowExecutionSummariesResponse, any, {}>>;
2097
+ /**
2098
+ * Resumes a workflow execution that was paused
2099
+ * @summary Resume a paused workflow execution
2100
+ * @param {string} executionId ID of the workflow execution
2101
+ * @param {ResumeWorkflowExecution} resumeWorkflowExecution Resume data for the workflow execution
2102
+ * @param {string} [xFrankieRequestID] Request ID
2103
+ * @param {string} [xFrankieCustomerID] FrankieOne Customer Identifier
2104
+ * @param {string} [xFrankieCustomerChildID] FrankieOne Customer Child Identifier
2105
+ * @param {string} [xFrankieChannel] Channel that the request is coming from
2106
+ * @param {*} [options] Override http request option.
2107
+ * @throws {RequiredError}
2108
+ */
2109
+ resumeWorkflowExecution(executionId: string, resumeWorkflowExecution: ResumeWorkflowExecution, xFrankieRequestID?: string, xFrankieCustomerID?: string, xFrankieCustomerChildID?: string, xFrankieChannel?: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<WorkflowExecutionResponse, any, {}>>;
2110
+ }
2111
+
2112
+ /**
2113
+ * WorkflowExecutionsApi - axios parameter creator
2114
+ */
2115
+ export declare const WorkflowExecutionsApiAxiosParamCreator: (configuration?: Configuration) => {
2116
+ /**
2117
+ * Cancels a running or paused workflow execution
2118
+ * @summary Cancel a workflow execution
2119
+ * @param {string} executionId ID of the workflow execution
2120
+ * @param {string} [xFrankieRequestID] Request ID
2121
+ * @param {*} [options] Override http request option.
2122
+ * @throws {RequiredError}
2123
+ */
2124
+ cancelWorkflowExecution: (executionId: string, xFrankieRequestID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2125
+ /**
2126
+ * Starts execution of a workflow definition
2127
+ * @summary Create a new workflow execution
2128
+ * @param {WorkflowExecutionRequest} workflowExecutionRequest
2129
+ * @param {boolean} [xAsyncExecution] Set to true to execute the workflow asynchronously
2130
+ * @param {string} [xFrankieRequestID] Request ID
2131
+ * @param {string} [xFrankieCustomerID] FrankieOne Customer Identifier
2132
+ * @param {string} [xFrankieCustomerChildID] FrankieOne Customer Child Identifier
2133
+ * @param {string} [xFrankieChannel] Channel that the request is coming from
2134
+ * @param {*} [options] Override http request option.
2135
+ * @throws {RequiredError}
2136
+ */
2137
+ createWorkflowExecution: (workflowExecutionRequest: WorkflowExecutionRequest, xAsyncExecution?: boolean, xFrankieRequestID?: string, xFrankieCustomerID?: string, xFrankieCustomerChildID?: string, xFrankieChannel?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2138
+ /**
2139
+ * Returns a workflow execution by its ID
2140
+ * @summary Get a workflow execution by ID
2141
+ * @param {string} executionId ID of the workflow execution
2142
+ * @param {string} [xFrankieRequestID] Request ID
2143
+ * @param {*} [options] Override http request option.
2144
+ * @throws {RequiredError}
2145
+ */
2146
+ getWorkflowExecution: (executionId: string, xFrankieRequestID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2147
+ /**
2148
+ * Returns a paginated list of workflow executions. Pagination is applied by default.
2149
+ * @summary List workflow executions
2150
+ * @param {string} [xFrankieRequestID] Request ID
2151
+ * @param {string} [workflowDefinitionId] Filter by workflow definition ID
2152
+ * @param {string} [owner] Filter by workflow definition owner
2153
+ * @param {ListWorkflowExecutionsStatusEnum} [status] Filter by execution status
2154
+ * @param {number} [page] Page number to retrieve (1-based)
2155
+ * @param {number} [limit] Number of items per page (page size)
2156
+ * @param {string} [startTimeBefore] Filter by execution start time before a specific date and time
2157
+ * @param {string} [startTimeAfter] Filter by execution start time after a specific date and time
2158
+ * @param {*} [options] Override http request option.
2159
+ * @throws {RequiredError}
2160
+ */
2161
+ listWorkflowExecutions: (xFrankieRequestID?: string, workflowDefinitionId?: string, owner?: string, status?: ListWorkflowExecutionsStatusEnum, page?: number, limit?: number, startTimeBefore?: string, startTimeAfter?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2162
+ /**
2163
+ * Resumes a workflow execution that was paused
2164
+ * @summary Resume a paused workflow execution
2165
+ * @param {string} executionId ID of the workflow execution
2166
+ * @param {ResumeWorkflowExecution} resumeWorkflowExecution Resume data for the workflow execution
2167
+ * @param {string} [xFrankieRequestID] Request ID
2168
+ * @param {string} [xFrankieCustomerID] FrankieOne Customer Identifier
2169
+ * @param {string} [xFrankieCustomerChildID] FrankieOne Customer Child Identifier
2170
+ * @param {string} [xFrankieChannel] Channel that the request is coming from
2171
+ * @param {*} [options] Override http request option.
2172
+ * @throws {RequiredError}
2173
+ */
2174
+ resumeWorkflowExecution: (executionId: string, resumeWorkflowExecution: ResumeWorkflowExecution, xFrankieRequestID?: string, xFrankieCustomerID?: string, xFrankieCustomerChildID?: string, xFrankieChannel?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2175
+ };
2176
+
2177
+ /**
2178
+ * WorkflowExecutionsApi - factory interface
2179
+ */
2180
+ export declare const WorkflowExecutionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2181
+ /**
2182
+ * Cancels a running or paused workflow execution
2183
+ * @summary Cancel a workflow execution
2184
+ * @param {string} executionId ID of the workflow execution
2185
+ * @param {string} [xFrankieRequestID] Request ID
2186
+ * @param {*} [options] Override http request option.
2187
+ * @throws {RequiredError}
2188
+ */
2189
+ cancelWorkflowExecution(executionId: string, xFrankieRequestID?: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowExecutionResponse>;
2190
+ /**
2191
+ * Starts execution of a workflow definition
2192
+ * @summary Create a new workflow execution
2193
+ * @param {WorkflowExecutionRequest} workflowExecutionRequest
2194
+ * @param {boolean} [xAsyncExecution] Set to true to execute the workflow asynchronously
2195
+ * @param {string} [xFrankieRequestID] Request ID
2196
+ * @param {string} [xFrankieCustomerID] FrankieOne Customer Identifier
2197
+ * @param {string} [xFrankieCustomerChildID] FrankieOne Customer Child Identifier
2198
+ * @param {string} [xFrankieChannel] Channel that the request is coming from
2199
+ * @param {*} [options] Override http request option.
2200
+ * @throws {RequiredError}
2201
+ */
2202
+ createWorkflowExecution(workflowExecutionRequest: WorkflowExecutionRequest, xAsyncExecution?: boolean, xFrankieRequestID?: string, xFrankieCustomerID?: string, xFrankieCustomerChildID?: string, xFrankieChannel?: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowExecutionResponse>;
2203
+ /**
2204
+ * Returns a workflow execution by its ID
2205
+ * @summary Get a workflow execution by ID
2206
+ * @param {string} executionId ID of the workflow execution
2207
+ * @param {string} [xFrankieRequestID] Request ID
2208
+ * @param {*} [options] Override http request option.
2209
+ * @throws {RequiredError}
2210
+ */
2211
+ getWorkflowExecution(executionId: string, xFrankieRequestID?: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowExecutionResponse>;
2212
+ /**
2213
+ * Returns a paginated list of workflow executions. Pagination is applied by default.
2214
+ * @summary List workflow executions
2215
+ * @param {string} [xFrankieRequestID] Request ID
2216
+ * @param {string} [workflowDefinitionId] Filter by workflow definition ID
2217
+ * @param {string} [owner] Filter by workflow definition owner
2218
+ * @param {ListWorkflowExecutionsStatusEnum} [status] Filter by execution status
2219
+ * @param {number} [page] Page number to retrieve (1-based)
2220
+ * @param {number} [limit] Number of items per page (page size)
2221
+ * @param {string} [startTimeBefore] Filter by execution start time before a specific date and time
2222
+ * @param {string} [startTimeAfter] Filter by execution start time after a specific date and time
2223
+ * @param {*} [options] Override http request option.
2224
+ * @throws {RequiredError}
2225
+ */
2226
+ listWorkflowExecutions(xFrankieRequestID?: string, workflowDefinitionId?: string, owner?: string, status?: ListWorkflowExecutionsStatusEnum, page?: number, limit?: number, startTimeBefore?: string, startTimeAfter?: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowExecutionSummariesResponse>;
2227
+ /**
2228
+ * Resumes a workflow execution that was paused
2229
+ * @summary Resume a paused workflow execution
2230
+ * @param {string} executionId ID of the workflow execution
2231
+ * @param {ResumeWorkflowExecution} resumeWorkflowExecution Resume data for the workflow execution
2232
+ * @param {string} [xFrankieRequestID] Request ID
2233
+ * @param {string} [xFrankieCustomerID] FrankieOne Customer Identifier
2234
+ * @param {string} [xFrankieCustomerChildID] FrankieOne Customer Child Identifier
2235
+ * @param {string} [xFrankieChannel] Channel that the request is coming from
2236
+ * @param {*} [options] Override http request option.
2237
+ * @throws {RequiredError}
2238
+ */
2239
+ resumeWorkflowExecution(executionId: string, resumeWorkflowExecution: ResumeWorkflowExecution, xFrankieRequestID?: string, xFrankieCustomerID?: string, xFrankieCustomerChildID?: string, xFrankieChannel?: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowExecutionResponse>;
2240
+ };
2241
+
2242
+ /**
2243
+ * WorkflowExecutionsApi - functional programming interface
2244
+ */
2245
+ export declare const WorkflowExecutionsApiFp: (configuration?: Configuration) => {
2246
+ /**
2247
+ * Cancels a running or paused workflow execution
2248
+ * @summary Cancel a workflow execution
2249
+ * @param {string} executionId ID of the workflow execution
2250
+ * @param {string} [xFrankieRequestID] Request ID
2251
+ * @param {*} [options] Override http request option.
2252
+ * @throws {RequiredError}
2253
+ */
2254
+ cancelWorkflowExecution(executionId: string, xFrankieRequestID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowExecutionResponse>>;
2255
+ /**
2256
+ * Starts execution of a workflow definition
2257
+ * @summary Create a new workflow execution
2258
+ * @param {WorkflowExecutionRequest} workflowExecutionRequest
2259
+ * @param {boolean} [xAsyncExecution] Set to true to execute the workflow asynchronously
2260
+ * @param {string} [xFrankieRequestID] Request ID
2261
+ * @param {string} [xFrankieCustomerID] FrankieOne Customer Identifier
2262
+ * @param {string} [xFrankieCustomerChildID] FrankieOne Customer Child Identifier
2263
+ * @param {string} [xFrankieChannel] Channel that the request is coming from
2264
+ * @param {*} [options] Override http request option.
2265
+ * @throws {RequiredError}
2266
+ */
2267
+ createWorkflowExecution(workflowExecutionRequest: WorkflowExecutionRequest, xAsyncExecution?: boolean, xFrankieRequestID?: string, xFrankieCustomerID?: string, xFrankieCustomerChildID?: string, xFrankieChannel?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowExecutionResponse>>;
2268
+ /**
2269
+ * Returns a workflow execution by its ID
2270
+ * @summary Get a workflow execution by ID
2271
+ * @param {string} executionId ID of the workflow execution
2272
+ * @param {string} [xFrankieRequestID] Request ID
2273
+ * @param {*} [options] Override http request option.
2274
+ * @throws {RequiredError}
2275
+ */
2276
+ getWorkflowExecution(executionId: string, xFrankieRequestID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowExecutionResponse>>;
2277
+ /**
2278
+ * Returns a paginated list of workflow executions. Pagination is applied by default.
2279
+ * @summary List workflow executions
2280
+ * @param {string} [xFrankieRequestID] Request ID
2281
+ * @param {string} [workflowDefinitionId] Filter by workflow definition ID
2282
+ * @param {string} [owner] Filter by workflow definition owner
2283
+ * @param {ListWorkflowExecutionsStatusEnum} [status] Filter by execution status
2284
+ * @param {number} [page] Page number to retrieve (1-based)
2285
+ * @param {number} [limit] Number of items per page (page size)
2286
+ * @param {string} [startTimeBefore] Filter by execution start time before a specific date and time
2287
+ * @param {string} [startTimeAfter] Filter by execution start time after a specific date and time
2288
+ * @param {*} [options] Override http request option.
2289
+ * @throws {RequiredError}
2290
+ */
2291
+ listWorkflowExecutions(xFrankieRequestID?: string, workflowDefinitionId?: string, owner?: string, status?: ListWorkflowExecutionsStatusEnum, page?: number, limit?: number, startTimeBefore?: string, startTimeAfter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowExecutionSummariesResponse>>;
2292
+ /**
2293
+ * Resumes a workflow execution that was paused
2294
+ * @summary Resume a paused workflow execution
2295
+ * @param {string} executionId ID of the workflow execution
2296
+ * @param {ResumeWorkflowExecution} resumeWorkflowExecution Resume data for the workflow execution
2297
+ * @param {string} [xFrankieRequestID] Request ID
2298
+ * @param {string} [xFrankieCustomerID] FrankieOne Customer Identifier
2299
+ * @param {string} [xFrankieCustomerChildID] FrankieOne Customer Child Identifier
2300
+ * @param {string} [xFrankieChannel] Channel that the request is coming from
2301
+ * @param {*} [options] Override http request option.
2302
+ * @throws {RequiredError}
2303
+ */
2304
+ resumeWorkflowExecution(executionId: string, resumeWorkflowExecution: ResumeWorkflowExecution, xFrankieRequestID?: string, xFrankieCustomerID?: string, xFrankieCustomerChildID?: string, xFrankieChannel?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowExecutionResponse>>;
2305
+ };
2306
+
2307
+ export declare interface WorkflowExecutionSummariesResponse {
2308
+ 'workflowExecutions': Array<WorkflowExecutionSummary>;
2309
+ 'meta': Meta;
2310
+ }
2311
+
2312
+ export declare interface WorkflowExecutionSummary {
2313
+ /**
2314
+ * Unique identifier for the workflow execution
2315
+ */
2316
+ 'id': string;
2317
+ /**
2318
+ * ID of the workflow definition being executed
2319
+ */
2320
+ 'workflowDefinitionId': string;
2321
+ /**
2322
+ * Version of the workflow definition
2323
+ */
2324
+ 'workflowVersion': number;
2325
+ /**
2326
+ * Current status of the workflow execution
2327
+ */
2328
+ 'status': WorkflowExecutionSummaryStatusEnum;
2329
+ /**
2330
+ * Owner of the workflow execution
2331
+ */
2332
+ 'owner': string;
2333
+ /**
2334
+ * Timestamp when the workflow execution started
2335
+ */
2336
+ 'startTime': string;
2337
+ /**
2338
+ * Timestamp when the workflow execution ended (if completed or failed)
2339
+ */
2340
+ 'endTime'?: string;
2341
+ /**
2342
+ * ID of the currently executing task (if status is RUNNING)
2343
+ */
2344
+ 'currentTaskId'?: string;
2345
+ }
2346
+
2347
+ export declare const WorkflowExecutionSummaryStatusEnum: {
2348
+ readonly Pending: "PENDING";
2349
+ readonly Running: "RUNNING";
2350
+ readonly Completed: "COMPLETED";
2351
+ readonly Failed: "FAILED";
2352
+ readonly Paused: "PAUSED";
2353
+ readonly Cancelled: "CANCELLED";
2354
+ };
2355
+
2356
+ export declare type WorkflowExecutionSummaryStatusEnum = typeof WorkflowExecutionSummaryStatusEnum[keyof typeof WorkflowExecutionSummaryStatusEnum];
2357
+
2358
+ export { }