@epilot/automation-client 1.9.6 → 2.0.0
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.
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +289 -180
- package/dist/openapi.json +244 -156
- package/package.json +2 -3
- package/LICENSE +0 -21
package/dist/openapi.d.ts
CHANGED
|
@@ -11,70 +11,22 @@ declare namespace Components {
|
|
|
11
11
|
namespace Schemas {
|
|
12
12
|
/**
|
|
13
13
|
* example:
|
|
14
|
-
*
|
|
15
|
-
* "target": {
|
|
16
|
-
* "schema": "contact",
|
|
17
|
-
* "tag": "primary",
|
|
18
|
-
* "key": "address",
|
|
19
|
-
* "value_json": "{\"_tags\": [\"billing\"],\"city\":\"steps[0][Adresse][city]\",\"country\":\"steps[0][Adresse][countryCode]\",\"postal_code\":\"steps[0][Adresse][zipCode]\",\"street\":\"steps[0][Adresse][streetName]\",\"street_number\":\"steps[0][Adresse][houseNumber]\",\"additional_info\":\"steps[0][Adresse][addressExtention]\"}",
|
|
20
|
-
* "target_unique": [
|
|
21
|
-
* "country",
|
|
22
|
-
* "city",
|
|
23
|
-
* "postal_code",
|
|
24
|
-
* "street",
|
|
25
|
-
* "street_number"
|
|
26
|
-
* ]
|
|
27
|
-
* },
|
|
28
|
-
* "reference": {
|
|
29
|
-
* "schema": "opportunity",
|
|
30
|
-
* "key": "billing_address"
|
|
31
|
-
* }
|
|
32
|
-
* }
|
|
14
|
+
* e3d3ebac-baab-4395-abf4-50b5bf1f8b74
|
|
33
15
|
*/
|
|
34
|
-
export
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
*/
|
|
39
|
-
schema: string;
|
|
40
|
-
/**
|
|
41
|
-
* find target entity based on entity tag
|
|
42
|
-
*/
|
|
43
|
-
tag?: string;
|
|
44
|
-
/**
|
|
45
|
-
* find target entity based on relation tag on main entity relation
|
|
46
|
-
*/
|
|
47
|
-
relation_tag?: string;
|
|
48
|
-
/**
|
|
49
|
-
* target field for where to store this address.
|
|
50
|
-
*/
|
|
51
|
-
key: string;
|
|
52
|
-
/**
|
|
53
|
-
* stringified JSON for how to map address data
|
|
54
|
-
*/
|
|
55
|
-
value_json: string;
|
|
56
|
-
/**
|
|
57
|
-
* Array of keys which should be used when checking for uniqueness. Eg: [country, city, postal_code]
|
|
58
|
-
*
|
|
59
|
-
*/
|
|
60
|
-
target_unique?: string[];
|
|
61
|
-
};
|
|
62
|
-
reference: {
|
|
63
|
-
/**
|
|
64
|
-
* Schema of the entity where the reference will be stored.
|
|
65
|
-
*/
|
|
66
|
-
schema: string;
|
|
67
|
-
/**
|
|
68
|
-
* Field location to store the reference.
|
|
69
|
-
*/
|
|
70
|
-
key: string;
|
|
16
|
+
export type ActivityId = string;
|
|
17
|
+
export interface ActivityTrigger {
|
|
18
|
+
type: "activity";
|
|
19
|
+
configuration: {
|
|
71
20
|
/**
|
|
72
|
-
*
|
|
21
|
+
* example:
|
|
22
|
+
* submission
|
|
73
23
|
*/
|
|
74
|
-
|
|
24
|
+
schema?: string;
|
|
25
|
+
types?: ("CreateMeterReading" | "UpdateMeterReading" | "MessageActivity" | "EntityCreated" | "EntityUpdated" | "EntityDeleted" | "SyncActivity")[];
|
|
75
26
|
};
|
|
76
27
|
}
|
|
77
|
-
export type AnyAction =
|
|
28
|
+
export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerWebhookAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | AutomationAction;
|
|
29
|
+
export type AnyActionConfig = /**
|
|
78
30
|
* example:
|
|
79
31
|
* {
|
|
80
32
|
* "id": "2520gja-2sgmsaga-0asg-822jgal",
|
|
@@ -194,7 +146,7 @@ declare namespace Components {
|
|
|
194
146
|
* }
|
|
195
147
|
* }
|
|
196
148
|
*/
|
|
197
|
-
|
|
149
|
+
MapEntityActionConfig | /**
|
|
198
150
|
* example:
|
|
199
151
|
* {
|
|
200
152
|
* "id": "08g988-ojt2jtaga-292h-8978gsaga",
|
|
@@ -228,7 +180,7 @@ declare namespace Components {
|
|
|
228
180
|
* }
|
|
229
181
|
* }
|
|
230
182
|
*/
|
|
231
|
-
|
|
183
|
+
TriggerWorkflowActionConfig | /**
|
|
232
184
|
* example:
|
|
233
185
|
* {
|
|
234
186
|
* "id": "2520gja-2sgmsaga-0asg-822jgal",
|
|
@@ -243,7 +195,7 @@ declare namespace Components {
|
|
|
243
195
|
* }
|
|
244
196
|
* }
|
|
245
197
|
*/
|
|
246
|
-
|
|
198
|
+
TriggerWebhookActionConfig | /**
|
|
247
199
|
* example:
|
|
248
200
|
* {
|
|
249
201
|
* "id": "08g988-ojt2jtaga-292h-8978gsaga",
|
|
@@ -261,7 +213,7 @@ declare namespace Components {
|
|
|
261
213
|
* }
|
|
262
214
|
* }
|
|
263
215
|
*/
|
|
264
|
-
|
|
216
|
+
CreateDocumentActionConfig | /**
|
|
265
217
|
* example:
|
|
266
218
|
* {
|
|
267
219
|
* "id": "25jga0-gkasl26-0asg-908sgaj2",
|
|
@@ -273,8 +225,8 @@ declare namespace Components {
|
|
|
273
225
|
* }
|
|
274
226
|
* }
|
|
275
227
|
*/
|
|
276
|
-
|
|
277
|
-
export type AnyTrigger = FrontendSubmitTrigger | JourneySubmitTrigger | ApiSubmissionTrigger | EntityOperationTrigger | EntityManualTrigger | ReceivedEmailTrigger;
|
|
228
|
+
SendEmailActionConfig | /* Creates an order entity with prices from journey */ CartCheckoutActionConfig | AutomationActionConfig;
|
|
229
|
+
export type AnyTrigger = FrontendSubmitTrigger | JourneySubmitTrigger | ApiSubmissionTrigger | EntityOperationTrigger | ActivityTrigger | EntityManualTrigger | ReceivedEmailTrigger;
|
|
278
230
|
export interface ApiSubmissionTrigger {
|
|
279
231
|
type: "api_submission";
|
|
280
232
|
configuration: {
|
|
@@ -348,9 +300,46 @@ declare namespace Components {
|
|
|
348
300
|
config?: {
|
|
349
301
|
[name: string]: any;
|
|
350
302
|
};
|
|
303
|
+
/**
|
|
304
|
+
* Whether to stop execution in a failed state if this action fails
|
|
305
|
+
*/
|
|
306
|
+
allow_failure?: boolean;
|
|
307
|
+
/**
|
|
308
|
+
* Flag indicating whether the action was created automatically or manually
|
|
309
|
+
*/
|
|
310
|
+
created_automatically?: boolean;
|
|
351
311
|
execution_status?: ExecutionStatus;
|
|
352
312
|
started_at?: string;
|
|
353
313
|
updated_at?: string;
|
|
314
|
+
/**
|
|
315
|
+
* example:
|
|
316
|
+
* {}
|
|
317
|
+
*/
|
|
318
|
+
outputs?: {
|
|
319
|
+
[name: string]: any;
|
|
320
|
+
};
|
|
321
|
+
error_output?: ErrorOutput;
|
|
322
|
+
/**
|
|
323
|
+
* different behaviors for retrying failed execution actions.
|
|
324
|
+
*/
|
|
325
|
+
retry_strategy?: "RETRY_AND_RESUME" | "RETRY_AND_STOP";
|
|
326
|
+
}
|
|
327
|
+
export interface AutomationActionConfig {
|
|
328
|
+
id?: /**
|
|
329
|
+
* example:
|
|
330
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
331
|
+
*/
|
|
332
|
+
AutomationActionId;
|
|
333
|
+
flow_action_id?: /**
|
|
334
|
+
* example:
|
|
335
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
336
|
+
*/
|
|
337
|
+
AutomationActionId;
|
|
338
|
+
name?: string;
|
|
339
|
+
type?: string;
|
|
340
|
+
config?: {
|
|
341
|
+
[name: string]: any;
|
|
342
|
+
};
|
|
354
343
|
/**
|
|
355
344
|
* Whether to stop execution in a failed state if this action fails
|
|
356
345
|
*/
|
|
@@ -359,6 +348,11 @@ declare namespace Components {
|
|
|
359
348
|
* Flag indicating whether the action was created automatically or manually
|
|
360
349
|
*/
|
|
361
350
|
created_automatically?: boolean;
|
|
351
|
+
}
|
|
352
|
+
export interface AutomationActionExecutionState {
|
|
353
|
+
execution_status?: ExecutionStatus;
|
|
354
|
+
started_at?: string;
|
|
355
|
+
updated_at?: string;
|
|
362
356
|
/**
|
|
363
357
|
* example:
|
|
364
358
|
* {}
|
|
@@ -367,6 +361,10 @@ declare namespace Components {
|
|
|
367
361
|
[name: string]: any;
|
|
368
362
|
};
|
|
369
363
|
error_output?: ErrorOutput;
|
|
364
|
+
/**
|
|
365
|
+
* different behaviors for retrying failed execution actions.
|
|
366
|
+
*/
|
|
367
|
+
retry_strategy?: "RETRY_AND_RESUME" | "RETRY_AND_STOP";
|
|
370
368
|
}
|
|
371
369
|
/**
|
|
372
370
|
* example:
|
|
@@ -385,6 +383,11 @@ declare namespace Components {
|
|
|
385
383
|
* e3d3ebac-baab-4395-abf4-50b5bf1f8b74
|
|
386
384
|
*/
|
|
387
385
|
EntityId;
|
|
386
|
+
activity_id?: /**
|
|
387
|
+
* example:
|
|
388
|
+
* e3d3ebac-baab-4395-abf4-50b5bf1f8b74
|
|
389
|
+
*/
|
|
390
|
+
ActivityId;
|
|
388
391
|
entity_snapshot?: EntityItemSnapshot;
|
|
389
392
|
org_id: /**
|
|
390
393
|
* example:
|
|
@@ -446,7 +449,7 @@ declare namespace Components {
|
|
|
446
449
|
* submission
|
|
447
450
|
*/
|
|
448
451
|
entity_schema?: string;
|
|
449
|
-
actions:
|
|
452
|
+
actions: AnyActionConfig[];
|
|
450
453
|
/**
|
|
451
454
|
* Number of automation executions that ran
|
|
452
455
|
* example:
|
|
@@ -490,9 +493,6 @@ declare namespace Components {
|
|
|
490
493
|
name?: string;
|
|
491
494
|
type?: "cart-checkout";
|
|
492
495
|
config?: CartCheckoutConfig;
|
|
493
|
-
execution_status?: ExecutionStatus;
|
|
494
|
-
started_at?: string;
|
|
495
|
-
updated_at?: string;
|
|
496
496
|
/**
|
|
497
497
|
* Whether to stop execution in a failed state if this action fails
|
|
498
498
|
*/
|
|
@@ -501,6 +501,9 @@ declare namespace Components {
|
|
|
501
501
|
* Flag indicating whether the action was created automatically or manually
|
|
502
502
|
*/
|
|
503
503
|
created_automatically?: boolean;
|
|
504
|
+
execution_status?: ExecutionStatus;
|
|
505
|
+
started_at?: string;
|
|
506
|
+
updated_at?: string;
|
|
504
507
|
/**
|
|
505
508
|
* example:
|
|
506
509
|
* {}
|
|
@@ -509,6 +512,36 @@ declare namespace Components {
|
|
|
509
512
|
[name: string]: any;
|
|
510
513
|
};
|
|
511
514
|
error_output?: ErrorOutput;
|
|
515
|
+
/**
|
|
516
|
+
* different behaviors for retrying failed execution actions.
|
|
517
|
+
*/
|
|
518
|
+
retry_strategy?: "RETRY_AND_RESUME" | "RETRY_AND_STOP";
|
|
519
|
+
}
|
|
520
|
+
/**
|
|
521
|
+
* Creates an order entity with prices from journey
|
|
522
|
+
*/
|
|
523
|
+
export interface CartCheckoutActionConfig {
|
|
524
|
+
id?: /**
|
|
525
|
+
* example:
|
|
526
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
527
|
+
*/
|
|
528
|
+
AutomationActionId;
|
|
529
|
+
flow_action_id?: /**
|
|
530
|
+
* example:
|
|
531
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
532
|
+
*/
|
|
533
|
+
AutomationActionId;
|
|
534
|
+
name?: string;
|
|
535
|
+
type?: "cart-checkout";
|
|
536
|
+
config?: CartCheckoutConfig;
|
|
537
|
+
/**
|
|
538
|
+
* Whether to stop execution in a failed state if this action fails
|
|
539
|
+
*/
|
|
540
|
+
allow_failure?: boolean;
|
|
541
|
+
/**
|
|
542
|
+
* Flag indicating whether the action was created automatically or manually
|
|
543
|
+
*/
|
|
544
|
+
created_automatically?: boolean;
|
|
512
545
|
}
|
|
513
546
|
export interface CartCheckoutConfig {
|
|
514
547
|
/**
|
|
@@ -562,6 +595,44 @@ declare namespace Components {
|
|
|
562
595
|
*/
|
|
563
596
|
source: string;
|
|
564
597
|
}
|
|
598
|
+
export interface CreateDocumentAction {
|
|
599
|
+
id?: /**
|
|
600
|
+
* example:
|
|
601
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
602
|
+
*/
|
|
603
|
+
AutomationActionId;
|
|
604
|
+
flow_action_id?: /**
|
|
605
|
+
* example:
|
|
606
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
607
|
+
*/
|
|
608
|
+
AutomationActionId;
|
|
609
|
+
name?: string;
|
|
610
|
+
type?: "create-document";
|
|
611
|
+
config?: CreateDocumentConfig;
|
|
612
|
+
/**
|
|
613
|
+
* Whether to stop execution in a failed state if this action fails
|
|
614
|
+
*/
|
|
615
|
+
allow_failure?: boolean;
|
|
616
|
+
/**
|
|
617
|
+
* Flag indicating whether the action was created automatically or manually
|
|
618
|
+
*/
|
|
619
|
+
created_automatically?: boolean;
|
|
620
|
+
execution_status?: ExecutionStatus;
|
|
621
|
+
started_at?: string;
|
|
622
|
+
updated_at?: string;
|
|
623
|
+
/**
|
|
624
|
+
* example:
|
|
625
|
+
* {}
|
|
626
|
+
*/
|
|
627
|
+
outputs?: {
|
|
628
|
+
[name: string]: any;
|
|
629
|
+
};
|
|
630
|
+
error_output?: ErrorOutput;
|
|
631
|
+
/**
|
|
632
|
+
* different behaviors for retrying failed execution actions.
|
|
633
|
+
*/
|
|
634
|
+
retry_strategy?: "RETRY_AND_RESUME" | "RETRY_AND_STOP";
|
|
635
|
+
}
|
|
565
636
|
/**
|
|
566
637
|
* example:
|
|
567
638
|
* {
|
|
@@ -580,7 +651,7 @@ declare namespace Components {
|
|
|
580
651
|
* }
|
|
581
652
|
* }
|
|
582
653
|
*/
|
|
583
|
-
export interface
|
|
654
|
+
export interface CreateDocumentActionConfig {
|
|
584
655
|
id?: /**
|
|
585
656
|
* example:
|
|
586
657
|
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
@@ -594,9 +665,6 @@ declare namespace Components {
|
|
|
594
665
|
name?: string;
|
|
595
666
|
type?: "create-document";
|
|
596
667
|
config?: CreateDocumentConfig;
|
|
597
|
-
execution_status?: ExecutionStatus;
|
|
598
|
-
started_at?: string;
|
|
599
|
-
updated_at?: string;
|
|
600
668
|
/**
|
|
601
669
|
* Whether to stop execution in a failed state if this action fails
|
|
602
670
|
*/
|
|
@@ -605,14 +673,6 @@ declare namespace Components {
|
|
|
605
673
|
* Flag indicating whether the action was created automatically or manually
|
|
606
674
|
*/
|
|
607
675
|
created_automatically?: boolean;
|
|
608
|
-
/**
|
|
609
|
-
* example:
|
|
610
|
-
* {}
|
|
611
|
-
*/
|
|
612
|
-
outputs?: {
|
|
613
|
-
[name: string]: any;
|
|
614
|
-
};
|
|
615
|
-
error_output?: ErrorOutput;
|
|
616
676
|
}
|
|
617
677
|
export interface CreateDocumentConfig {
|
|
618
678
|
template_id?: string;
|
|
@@ -665,7 +725,27 @@ declare namespace Components {
|
|
|
665
725
|
error_reason: string;
|
|
666
726
|
}
|
|
667
727
|
export type ExecutionStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled";
|
|
668
|
-
export interface
|
|
728
|
+
export interface FrontendSubmitTrigger {
|
|
729
|
+
type: "frontend_submission";
|
|
730
|
+
configuration: {
|
|
731
|
+
/**
|
|
732
|
+
* example:
|
|
733
|
+
* 99
|
|
734
|
+
*/
|
|
735
|
+
source_id?: string;
|
|
736
|
+
};
|
|
737
|
+
}
|
|
738
|
+
export interface GetExecutionsResp {
|
|
739
|
+
total: number;
|
|
740
|
+
results: AutomationExecution[];
|
|
741
|
+
}
|
|
742
|
+
export interface JourneySubmitTrigger {
|
|
743
|
+
type: "journey_submission";
|
|
744
|
+
configuration: {
|
|
745
|
+
source_id: string; // uuid
|
|
746
|
+
};
|
|
747
|
+
}
|
|
748
|
+
export interface MapEntityAction {
|
|
669
749
|
id?: /**
|
|
670
750
|
* example:
|
|
671
751
|
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
@@ -677,11 +757,8 @@ declare namespace Components {
|
|
|
677
757
|
*/
|
|
678
758
|
AutomationActionId;
|
|
679
759
|
name?: string;
|
|
680
|
-
type?: "
|
|
681
|
-
config
|
|
682
|
-
execution_status?: ExecutionStatus;
|
|
683
|
-
started_at?: string;
|
|
684
|
-
updated_at?: string;
|
|
760
|
+
type?: "map-entity";
|
|
761
|
+
config?: MapEntityConfig;
|
|
685
762
|
/**
|
|
686
763
|
* Whether to stop execution in a failed state if this action fails
|
|
687
764
|
*/
|
|
@@ -690,6 +767,9 @@ declare namespace Components {
|
|
|
690
767
|
* Flag indicating whether the action was created automatically or manually
|
|
691
768
|
*/
|
|
692
769
|
created_automatically?: boolean;
|
|
770
|
+
execution_status?: ExecutionStatus;
|
|
771
|
+
started_at?: string;
|
|
772
|
+
updated_at?: string;
|
|
693
773
|
/**
|
|
694
774
|
* example:
|
|
695
775
|
* {}
|
|
@@ -698,51 +778,10 @@ declare namespace Components {
|
|
|
698
778
|
[name: string]: any;
|
|
699
779
|
};
|
|
700
780
|
error_output?: ErrorOutput;
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
mappings: /**
|
|
704
|
-
* example:
|
|
705
|
-
* {
|
|
706
|
-
* "target": {
|
|
707
|
-
* "schema": "contact",
|
|
708
|
-
* "tag": "primary",
|
|
709
|
-
* "key": "address",
|
|
710
|
-
* "value_json": "{\"_tags\": [\"billing\"],\"city\":\"steps[0][Adresse][city]\",\"country\":\"steps[0][Adresse][countryCode]\",\"postal_code\":\"steps[0][Adresse][zipCode]\",\"street\":\"steps[0][Adresse][streetName]\",\"street_number\":\"steps[0][Adresse][houseNumber]\",\"additional_info\":\"steps[0][Adresse][addressExtention]\"}",
|
|
711
|
-
* "target_unique": [
|
|
712
|
-
* "country",
|
|
713
|
-
* "city",
|
|
714
|
-
* "postal_code",
|
|
715
|
-
* "street",
|
|
716
|
-
* "street_number"
|
|
717
|
-
* ]
|
|
718
|
-
* },
|
|
719
|
-
* "reference": {
|
|
720
|
-
* "schema": "opportunity",
|
|
721
|
-
* "key": "billing_address"
|
|
722
|
-
* }
|
|
723
|
-
* }
|
|
781
|
+
/**
|
|
782
|
+
* different behaviors for retrying failed execution actions.
|
|
724
783
|
*/
|
|
725
|
-
|
|
726
|
-
}
|
|
727
|
-
export interface FrontendSubmitTrigger {
|
|
728
|
-
type: "frontend_submission";
|
|
729
|
-
configuration: {
|
|
730
|
-
/**
|
|
731
|
-
* example:
|
|
732
|
-
* 99
|
|
733
|
-
*/
|
|
734
|
-
source_id?: string;
|
|
735
|
-
};
|
|
736
|
-
}
|
|
737
|
-
export interface GetExecutionsResp {
|
|
738
|
-
total: number;
|
|
739
|
-
results: AutomationExecution[];
|
|
740
|
-
}
|
|
741
|
-
export interface JourneySubmitTrigger {
|
|
742
|
-
type: "journey_submission";
|
|
743
|
-
configuration: {
|
|
744
|
-
source_id: string; // uuid
|
|
745
|
-
};
|
|
784
|
+
retry_strategy?: "RETRY_AND_RESUME" | "RETRY_AND_STOP";
|
|
746
785
|
}
|
|
747
786
|
/**
|
|
748
787
|
* example:
|
|
@@ -864,7 +903,7 @@ declare namespace Components {
|
|
|
864
903
|
* }
|
|
865
904
|
* }
|
|
866
905
|
*/
|
|
867
|
-
export interface
|
|
906
|
+
export interface MapEntityActionConfig {
|
|
868
907
|
id?: /**
|
|
869
908
|
* example:
|
|
870
909
|
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
@@ -877,10 +916,7 @@ declare namespace Components {
|
|
|
877
916
|
AutomationActionId;
|
|
878
917
|
name?: string;
|
|
879
918
|
type?: "map-entity";
|
|
880
|
-
config?:
|
|
881
|
-
execution_status?: ExecutionStatus;
|
|
882
|
-
started_at?: string;
|
|
883
|
-
updated_at?: string;
|
|
919
|
+
config?: MapEntityConfig;
|
|
884
920
|
/**
|
|
885
921
|
* Whether to stop execution in a failed state if this action fails
|
|
886
922
|
*/
|
|
@@ -889,16 +925,8 @@ declare namespace Components {
|
|
|
889
925
|
* Flag indicating whether the action was created automatically or manually
|
|
890
926
|
*/
|
|
891
927
|
created_automatically?: boolean;
|
|
892
|
-
/**
|
|
893
|
-
* example:
|
|
894
|
-
* {}
|
|
895
|
-
*/
|
|
896
|
-
outputs?: {
|
|
897
|
-
[name: string]: any;
|
|
898
|
-
};
|
|
899
|
-
error_output?: ErrorOutput;
|
|
900
928
|
}
|
|
901
|
-
export interface
|
|
929
|
+
export interface MapEntityConfig {
|
|
902
930
|
mapping_config?: MappingConfigRef;
|
|
903
931
|
/**
|
|
904
932
|
* Schema of target entity
|
|
@@ -1069,6 +1097,44 @@ declare namespace Components {
|
|
|
1069
1097
|
total: number;
|
|
1070
1098
|
results: AutomationFlow[];
|
|
1071
1099
|
}
|
|
1100
|
+
export interface SendEmailAction {
|
|
1101
|
+
id?: /**
|
|
1102
|
+
* example:
|
|
1103
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
1104
|
+
*/
|
|
1105
|
+
AutomationActionId;
|
|
1106
|
+
flow_action_id?: /**
|
|
1107
|
+
* example:
|
|
1108
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
1109
|
+
*/
|
|
1110
|
+
AutomationActionId;
|
|
1111
|
+
name?: string;
|
|
1112
|
+
type?: "send-email";
|
|
1113
|
+
config?: SendEmailConfig;
|
|
1114
|
+
/**
|
|
1115
|
+
* Whether to stop execution in a failed state if this action fails
|
|
1116
|
+
*/
|
|
1117
|
+
allow_failure?: boolean;
|
|
1118
|
+
/**
|
|
1119
|
+
* Flag indicating whether the action was created automatically or manually
|
|
1120
|
+
*/
|
|
1121
|
+
created_automatically?: boolean;
|
|
1122
|
+
execution_status?: ExecutionStatus;
|
|
1123
|
+
started_at?: string;
|
|
1124
|
+
updated_at?: string;
|
|
1125
|
+
/**
|
|
1126
|
+
* example:
|
|
1127
|
+
* {}
|
|
1128
|
+
*/
|
|
1129
|
+
outputs?: {
|
|
1130
|
+
[name: string]: any;
|
|
1131
|
+
};
|
|
1132
|
+
error_output?: ErrorOutput;
|
|
1133
|
+
/**
|
|
1134
|
+
* different behaviors for retrying failed execution actions.
|
|
1135
|
+
*/
|
|
1136
|
+
retry_strategy?: "RETRY_AND_RESUME" | "RETRY_AND_STOP";
|
|
1137
|
+
}
|
|
1072
1138
|
/**
|
|
1073
1139
|
* example:
|
|
1074
1140
|
* {
|
|
@@ -1081,7 +1147,7 @@ declare namespace Components {
|
|
|
1081
1147
|
* }
|
|
1082
1148
|
* }
|
|
1083
1149
|
*/
|
|
1084
|
-
export interface
|
|
1150
|
+
export interface SendEmailActionConfig {
|
|
1085
1151
|
id?: /**
|
|
1086
1152
|
* example:
|
|
1087
1153
|
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
@@ -1094,10 +1160,7 @@ declare namespace Components {
|
|
|
1094
1160
|
AutomationActionId;
|
|
1095
1161
|
name?: string;
|
|
1096
1162
|
type?: "send-email";
|
|
1097
|
-
config?:
|
|
1098
|
-
execution_status?: ExecutionStatus;
|
|
1099
|
-
started_at?: string;
|
|
1100
|
-
updated_at?: string;
|
|
1163
|
+
config?: SendEmailConfig;
|
|
1101
1164
|
/**
|
|
1102
1165
|
* Whether to stop execution in a failed state if this action fails
|
|
1103
1166
|
*/
|
|
@@ -1106,16 +1169,8 @@ declare namespace Components {
|
|
|
1106
1169
|
* Flag indicating whether the action was created automatically or manually
|
|
1107
1170
|
*/
|
|
1108
1171
|
created_automatically?: boolean;
|
|
1109
|
-
/**
|
|
1110
|
-
* example:
|
|
1111
|
-
* {}
|
|
1112
|
-
*/
|
|
1113
|
-
outputs?: {
|
|
1114
|
-
[name: string]: any;
|
|
1115
|
-
};
|
|
1116
|
-
error_output?: ErrorOutput;
|
|
1117
1172
|
}
|
|
1118
|
-
export interface
|
|
1173
|
+
export interface SendEmailConfig {
|
|
1119
1174
|
email_template_id?: string;
|
|
1120
1175
|
language_code?: "de" | "en";
|
|
1121
1176
|
/**
|
|
@@ -1208,6 +1263,44 @@ declare namespace Components {
|
|
|
1208
1263
|
comparison: Comparison;
|
|
1209
1264
|
value?: string | number | string[] | number[];
|
|
1210
1265
|
}
|
|
1266
|
+
export interface TriggerWebhookAction {
|
|
1267
|
+
id?: /**
|
|
1268
|
+
* example:
|
|
1269
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
1270
|
+
*/
|
|
1271
|
+
AutomationActionId;
|
|
1272
|
+
flow_action_id?: /**
|
|
1273
|
+
* example:
|
|
1274
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
1275
|
+
*/
|
|
1276
|
+
AutomationActionId;
|
|
1277
|
+
name?: string;
|
|
1278
|
+
type?: "trigger-webhook";
|
|
1279
|
+
config?: TriggerWebhookConfig;
|
|
1280
|
+
/**
|
|
1281
|
+
* Whether to stop execution in a failed state if this action fails
|
|
1282
|
+
*/
|
|
1283
|
+
allow_failure?: boolean;
|
|
1284
|
+
/**
|
|
1285
|
+
* Flag indicating whether the action was created automatically or manually
|
|
1286
|
+
*/
|
|
1287
|
+
created_automatically?: boolean;
|
|
1288
|
+
execution_status?: ExecutionStatus;
|
|
1289
|
+
started_at?: string;
|
|
1290
|
+
updated_at?: string;
|
|
1291
|
+
/**
|
|
1292
|
+
* example:
|
|
1293
|
+
* {}
|
|
1294
|
+
*/
|
|
1295
|
+
outputs?: {
|
|
1296
|
+
[name: string]: any;
|
|
1297
|
+
};
|
|
1298
|
+
error_output?: ErrorOutput;
|
|
1299
|
+
/**
|
|
1300
|
+
* different behaviors for retrying failed execution actions.
|
|
1301
|
+
*/
|
|
1302
|
+
retry_strategy?: "RETRY_AND_RESUME" | "RETRY_AND_STOP";
|
|
1303
|
+
}
|
|
1211
1304
|
/**
|
|
1212
1305
|
* example:
|
|
1213
1306
|
* {
|
|
@@ -1223,7 +1316,7 @@ declare namespace Components {
|
|
|
1223
1316
|
* }
|
|
1224
1317
|
* }
|
|
1225
1318
|
*/
|
|
1226
|
-
export interface
|
|
1319
|
+
export interface TriggerWebhookActionConfig {
|
|
1227
1320
|
id?: /**
|
|
1228
1321
|
* example:
|
|
1229
1322
|
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
@@ -1236,10 +1329,34 @@ declare namespace Components {
|
|
|
1236
1329
|
AutomationActionId;
|
|
1237
1330
|
name?: string;
|
|
1238
1331
|
type?: "trigger-webhook";
|
|
1239
|
-
config?:
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
|
|
1332
|
+
config?: TriggerWebhookConfig;
|
|
1333
|
+
/**
|
|
1334
|
+
* Whether to stop execution in a failed state if this action fails
|
|
1335
|
+
*/
|
|
1336
|
+
allow_failure?: boolean;
|
|
1337
|
+
/**
|
|
1338
|
+
* Flag indicating whether the action was created automatically or manually
|
|
1339
|
+
*/
|
|
1340
|
+
created_automatically?: boolean;
|
|
1341
|
+
}
|
|
1342
|
+
export interface TriggerWebhookConfig {
|
|
1343
|
+
entity_sources?: string[];
|
|
1344
|
+
target_webhook_id?: string;
|
|
1345
|
+
}
|
|
1346
|
+
export interface TriggerWorkflowAction {
|
|
1347
|
+
id?: /**
|
|
1348
|
+
* example:
|
|
1349
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
1350
|
+
*/
|
|
1351
|
+
AutomationActionId;
|
|
1352
|
+
flow_action_id?: /**
|
|
1353
|
+
* example:
|
|
1354
|
+
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
1355
|
+
*/
|
|
1356
|
+
AutomationActionId;
|
|
1357
|
+
name?: string;
|
|
1358
|
+
type?: "trigger-workflow";
|
|
1359
|
+
config?: TriggerWorkflowConfig;
|
|
1243
1360
|
/**
|
|
1244
1361
|
* Whether to stop execution in a failed state if this action fails
|
|
1245
1362
|
*/
|
|
@@ -1248,6 +1365,9 @@ declare namespace Components {
|
|
|
1248
1365
|
* Flag indicating whether the action was created automatically or manually
|
|
1249
1366
|
*/
|
|
1250
1367
|
created_automatically?: boolean;
|
|
1368
|
+
execution_status?: ExecutionStatus;
|
|
1369
|
+
started_at?: string;
|
|
1370
|
+
updated_at?: string;
|
|
1251
1371
|
/**
|
|
1252
1372
|
* example:
|
|
1253
1373
|
* {}
|
|
@@ -1256,10 +1376,10 @@ declare namespace Components {
|
|
|
1256
1376
|
[name: string]: any;
|
|
1257
1377
|
};
|
|
1258
1378
|
error_output?: ErrorOutput;
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1379
|
+
/**
|
|
1380
|
+
* different behaviors for retrying failed execution actions.
|
|
1381
|
+
*/
|
|
1382
|
+
retry_strategy?: "RETRY_AND_RESUME" | "RETRY_AND_STOP";
|
|
1263
1383
|
}
|
|
1264
1384
|
/**
|
|
1265
1385
|
* example:
|
|
@@ -1295,7 +1415,7 @@ declare namespace Components {
|
|
|
1295
1415
|
* }
|
|
1296
1416
|
* }
|
|
1297
1417
|
*/
|
|
1298
|
-
export interface
|
|
1418
|
+
export interface TriggerWorkflowActionConfig {
|
|
1299
1419
|
id?: /**
|
|
1300
1420
|
* example:
|
|
1301
1421
|
* 9ec3711b-db63-449c-b894-54d5bb622a8f
|
|
@@ -1309,9 +1429,6 @@ declare namespace Components {
|
|
|
1309
1429
|
name?: string;
|
|
1310
1430
|
type?: "trigger-workflow";
|
|
1311
1431
|
config?: TriggerWorkflowConfig;
|
|
1312
|
-
execution_status?: ExecutionStatus;
|
|
1313
|
-
started_at?: string;
|
|
1314
|
-
updated_at?: string;
|
|
1315
1432
|
/**
|
|
1316
1433
|
* Whether to stop execution in a failed state if this action fails
|
|
1317
1434
|
*/
|
|
@@ -1320,14 +1437,6 @@ declare namespace Components {
|
|
|
1320
1437
|
* Flag indicating whether the action was created automatically or manually
|
|
1321
1438
|
*/
|
|
1322
1439
|
created_automatically?: boolean;
|
|
1323
|
-
/**
|
|
1324
|
-
* example:
|
|
1325
|
-
* {}
|
|
1326
|
-
*/
|
|
1327
|
-
outputs?: {
|
|
1328
|
-
[name: string]: any;
|
|
1329
|
-
};
|
|
1330
|
-
error_output?: ErrorOutput;
|
|
1331
1440
|
}
|
|
1332
1441
|
/**
|
|
1333
1442
|
* example:
|