@epilot/automation-client 2.9.1 → 2.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/openapi.d.ts +71 -150
  2. package/dist/openapi.json +32 -98
  3. package/package.json +1 -1
package/dist/openapi.d.ts CHANGED
@@ -9,6 +9,14 @@ import type {
9
9
 
10
10
  declare namespace Components {
11
11
  namespace Schemas {
12
+ export interface ActionCondition {
13
+ id?: string;
14
+ /**
15
+ * Result of the condition evaluation
16
+ */
17
+ evaluationResult?: boolean;
18
+ conditions?: Condition[];
19
+ }
12
20
  /**
13
21
  * example:
14
22
  * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
@@ -25,7 +33,7 @@ declare namespace Components {
25
33
  types?: (("CreateMeterReading" | "UpdateMeterReading" | "DocDownloadedFromPortal" | "PortalUserResetPassword" | "PortalUserResetForgotPassword") | string)[];
26
34
  };
27
35
  }
28
- export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerWebhookAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | AutomationAction | ConditionAction;
36
+ export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerWebhookAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | AutomationAction;
29
37
  export type AnyActionConfig = /**
30
38
  * example:
31
39
  * {
@@ -225,7 +233,7 @@ declare namespace Components {
225
233
  * }
226
234
  * }
227
235
  */
228
- SendEmailActionConfig | /* Creates an order entity with prices from journey */ CartCheckoutActionConfig | AutomationActionConfig | ConditionActionConfig;
236
+ SendEmailActionConfig | /* Creates an order entity with prices from journey */ CartCheckoutActionConfig | AutomationActionConfig;
229
237
  export type AnyTrigger = FrontendSubmitTrigger | JourneySubmitTrigger | ApiSubmissionTrigger | /**
230
238
  * - If provides filter_config, executes an automation based on the filtered configuration when an entity event occurs.
231
239
  * - The conditions on a filter follows the event bridge patterns - `https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html`
@@ -509,6 +517,10 @@ declare namespace Components {
509
517
  [name: string]: any;
510
518
  };
511
519
  };
520
+ /**
521
+ * Condition Id to be checked before executing the action
522
+ */
523
+ condition_id?: string;
512
524
  execution_status?: ExecutionStatus;
513
525
  started_at?: string;
514
526
  updated_at?: string;
@@ -564,6 +576,10 @@ declare namespace Components {
564
576
  [name: string]: any;
565
577
  };
566
578
  };
579
+ /**
580
+ * Condition Id to be checked before executing the action
581
+ */
582
+ condition_id?: string;
567
583
  }
568
584
  export interface AutomationActionExecutionState {
569
585
  execution_status?: ExecutionStatus;
@@ -624,20 +640,8 @@ declare namespace Components {
624
640
  * 9ec3711b-db63-449c-b894-54d5bb622a8f
625
641
  */
626
642
  AutomationActionId;
643
+ conditions?: ActionCondition[];
627
644
  actions: AnyAction[];
628
- /**
629
- * The edges between actions which define the flow order
630
- */
631
- edges?: /**
632
- * example:
633
- * {
634
- * "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
635
- * "start": "3567cabc-587f-4ba2-8752-1f3da0100d1f",
636
- * "end": "4e29af6c-9824-461c-bcfb-505840a949ba",
637
- * "condition_output": true
638
- * }
639
- */
640
- Edge[];
641
645
  /**
642
646
  * Version of the flow
643
647
  * example:
@@ -682,23 +686,11 @@ declare namespace Components {
682
686
  * submission
683
687
  */
684
688
  entity_schema?: string;
689
+ conditions?: ActionCondition[];
685
690
  /**
686
691
  * The actions (nodes) of the automation flow
687
692
  */
688
693
  actions: AnyActionConfig[];
689
- /**
690
- * The edges between actions which define the flow order
691
- */
692
- edges?: /**
693
- * example:
694
- * {
695
- * "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
696
- * "start": "3567cabc-587f-4ba2-8752-1f3da0100d1f",
697
- * "end": "4e29af6c-9824-461c-bcfb-505840a949ba",
698
- * "condition_output": true
699
- * }
700
- */
701
- Edge[];
702
694
  /**
703
695
  * Number of automation executions that ran
704
696
  * example:
@@ -784,6 +776,10 @@ declare namespace Components {
784
776
  [name: string]: any;
785
777
  };
786
778
  };
779
+ /**
780
+ * Condition Id to be checked before executing the action
781
+ */
782
+ condition_id?: string;
787
783
  execution_status?: ExecutionStatus;
788
784
  started_at?: string;
789
785
  updated_at?: string;
@@ -840,6 +836,10 @@ declare namespace Components {
840
836
  [name: string]: any;
841
837
  };
842
838
  };
839
+ /**
840
+ * Condition Id to be checked before executing the action
841
+ */
842
+ condition_id?: string;
843
843
  }
844
844
  export interface CartCheckoutConfig {
845
845
  /**
@@ -877,106 +877,11 @@ declare namespace Components {
877
877
  target_unique?: string[];
878
878
  }
879
879
  export type Comparison = "equals" | "any_of" | "not_empty" | "is_empty";
880
- export interface ConditionAction {
881
- id?: /**
882
- * example:
883
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
884
- */
885
- AutomationActionId;
886
- flow_action_id?: /**
887
- * example:
888
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
889
- */
890
- AutomationActionId;
891
- name?: string;
892
- type?: "condition";
893
- config?: ConditionConfig;
894
- /**
895
- * Whether to stop execution in a failed state if this action fails
896
- */
897
- allow_failure?: boolean;
898
- /**
899
- * Flag indicating whether the action was created automatically or manually
900
- */
901
- created_automatically?: boolean;
902
- /**
903
- * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
904
- */
905
- is_bulk_action?: boolean;
906
- reason?: {
907
- /**
908
- * Why the action has to be skipped/failed
909
- * example:
910
- * There are no registered portal users for the given emails, hence skipping the action
911
- */
912
- message?: string;
913
- /**
914
- * Extra metadata about the skipping reason - such as a certain condition not met, etc.
915
- */
916
- payload?: {
917
- [name: string]: any;
918
- };
919
- };
920
- execution_status?: ExecutionStatus;
921
- started_at?: string;
922
- updated_at?: string;
923
- /**
924
- * example:
925
- * {}
926
- */
927
- outputs?: {
928
- [name: string]: any;
929
- };
930
- error_output?: ErrorOutput;
931
- retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
932
- actions?: AnyAction[];
933
- }
934
- export interface ConditionActionConfig {
935
- id?: /**
936
- * example:
937
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
938
- */
939
- AutomationActionId;
940
- flow_action_id?: /**
941
- * example:
942
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
943
- */
944
- AutomationActionId;
945
- name?: string;
946
- type?: "condition";
947
- config?: ConditionConfig;
948
- /**
949
- * Whether to stop execution in a failed state if this action fails
950
- */
951
- allow_failure?: boolean;
952
- /**
953
- * Flag indicating whether the action was created automatically or manually
954
- */
955
- created_automatically?: boolean;
956
- /**
957
- * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
958
- */
959
- is_bulk_action?: boolean;
960
- reason?: {
961
- /**
962
- * Why the action has to be skipped/failed
963
- * example:
964
- * There are no registered portal users for the given emails, hence skipping the action
965
- */
966
- message?: string;
967
- /**
968
- * Extra metadata about the skipping reason - such as a certain condition not met, etc.
969
- */
970
- payload?: {
971
- [name: string]: any;
972
- };
973
- };
974
- actions?: AnyActionConfig[];
975
- }
976
- export interface ConditionConfig {
880
+ export interface Condition {
977
881
  source?: {
978
- id?: string;
979
882
  type?: string;
883
+ id?: string;
884
+ schema?: string;
980
885
  attribute?: string;
981
886
  };
982
887
  operation?: "equals" | "not_equals" | "contains" | "not_contains" | "starts_with" | "ends_with" | "greater_than" | "less_than" | "greater_than_or_equals" | "less_than_or_equals" | "is_empty" | "is_not_empty";
@@ -1038,6 +943,10 @@ declare namespace Components {
1038
943
  [name: string]: any;
1039
944
  };
1040
945
  };
946
+ /**
947
+ * Condition Id to be checked before executing the action
948
+ */
949
+ condition_id?: string;
1041
950
  execution_status?: ExecutionStatus;
1042
951
  started_at?: string;
1043
952
  updated_at?: string;
@@ -1109,6 +1018,10 @@ declare namespace Components {
1109
1018
  [name: string]: any;
1110
1019
  };
1111
1020
  };
1021
+ /**
1022
+ * Condition Id to be checked before executing the action
1023
+ */
1024
+ condition_id?: string;
1112
1025
  }
1113
1026
  export interface CreateDocumentConfig {
1114
1027
  template_id?: string;
@@ -1117,30 +1030,6 @@ declare namespace Components {
1117
1030
  export type DiffAdded = FilterConditionOnEvent;
1118
1031
  export type DiffDeleted = FilterConditionOnEvent;
1119
1032
  export type DiffUpdated = FilterConditionOnEvent;
1120
- /**
1121
- * example:
1122
- * {
1123
- * "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
1124
- * "start": "3567cabc-587f-4ba2-8752-1f3da0100d1f",
1125
- * "end": "4e29af6c-9824-461c-bcfb-505840a949ba",
1126
- * "condition_output": true
1127
- * }
1128
- */
1129
- export interface Edge {
1130
- id: string;
1131
- /**
1132
- * The action id from which the edge starts
1133
- */
1134
- start: string;
1135
- /**
1136
- * The action id to which the edge ends
1137
- */
1138
- end: string;
1139
- /**
1140
- * The condition output of the edge (binary)
1141
- */
1142
- condition_output?: boolean;
1143
- }
1144
1033
  /**
1145
1034
  * example:
1146
1035
  * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
@@ -1456,6 +1345,10 @@ declare namespace Components {
1456
1345
  [name: string]: any;
1457
1346
  };
1458
1347
  };
1348
+ /**
1349
+ * Condition Id to be checked before executing the action
1350
+ */
1351
+ condition_id?: string;
1459
1352
  execution_status?: ExecutionStatus;
1460
1353
  started_at?: string;
1461
1354
  updated_at?: string;
@@ -1629,6 +1522,10 @@ declare namespace Components {
1629
1522
  [name: string]: any;
1630
1523
  };
1631
1524
  };
1525
+ /**
1526
+ * Condition Id to be checked before executing the action
1527
+ */
1528
+ condition_id?: string;
1632
1529
  }
1633
1530
  export interface MapEntityConfig {
1634
1531
  mapping_config?: MappingConfigRef;
@@ -1855,6 +1752,10 @@ declare namespace Components {
1855
1752
  [name: string]: any;
1856
1753
  };
1857
1754
  };
1755
+ /**
1756
+ * Condition Id to be checked before executing the action
1757
+ */
1758
+ condition_id?: string;
1858
1759
  execution_status?: ExecutionStatus;
1859
1760
  started_at?: string;
1860
1761
  updated_at?: string;
@@ -1920,6 +1821,10 @@ declare namespace Components {
1920
1821
  [name: string]: any;
1921
1822
  };
1922
1823
  };
1824
+ /**
1825
+ * Condition Id to be checked before executing the action
1826
+ */
1827
+ condition_id?: string;
1923
1828
  }
1924
1829
  export interface SendEmailConfig {
1925
1830
  email_template_id?: string;
@@ -2116,6 +2021,10 @@ declare namespace Components {
2116
2021
  [name: string]: any;
2117
2022
  };
2118
2023
  };
2024
+ /**
2025
+ * Condition Id to be checked before executing the action
2026
+ */
2027
+ condition_id?: string;
2119
2028
  execution_status?: ExecutionStatus;
2120
2029
  started_at?: string;
2121
2030
  updated_at?: string;
@@ -2184,6 +2093,10 @@ declare namespace Components {
2184
2093
  [name: string]: any;
2185
2094
  };
2186
2095
  };
2096
+ /**
2097
+ * Condition Id to be checked before executing the action
2098
+ */
2099
+ condition_id?: string;
2187
2100
  }
2188
2101
  export interface TriggerWebhookConfig {
2189
2102
  entity_sources?: string[];
@@ -2233,6 +2146,10 @@ declare namespace Components {
2233
2146
  [name: string]: any;
2234
2147
  };
2235
2148
  };
2149
+ /**
2150
+ * Condition Id to be checked before executing the action
2151
+ */
2152
+ condition_id?: string;
2236
2153
  execution_status?: ExecutionStatus;
2237
2154
  started_at?: string;
2238
2155
  updated_at?: string;
@@ -2320,6 +2237,10 @@ declare namespace Components {
2320
2237
  [name: string]: any;
2321
2238
  };
2322
2239
  };
2240
+ /**
2241
+ * Condition Id to be checked before executing the action
2242
+ */
2243
+ condition_id?: string;
2323
2244
  }
2324
2245
  /**
2325
2246
  * example:
package/dist/openapi.json CHANGED
@@ -455,6 +455,12 @@
455
455
  "type": "string",
456
456
  "example": "submission"
457
457
  },
458
+ "conditions": {
459
+ "type": "array",
460
+ "items": {
461
+ "$ref": "#/components/schemas/ActionCondition"
462
+ }
463
+ },
458
464
  "actions": {
459
465
  "type": "array",
460
466
  "description": "The actions (nodes) of the automation flow",
@@ -463,13 +469,6 @@
463
469
  },
464
470
  "readOnly": true
465
471
  },
466
- "edges": {
467
- "type": "array",
468
- "description": "The edges between actions which define the flow order",
469
- "items": {
470
- "$ref": "#/components/schemas/Edge"
471
- }
472
- },
473
472
  "runs": {
474
473
  "type": "number",
475
474
  "example": 7,
@@ -519,37 +518,6 @@
519
518
  "actions"
520
519
  ]
521
520
  },
522
- "Edge": {
523
- "type": "object",
524
- "properties": {
525
- "id": {
526
- "type": "string"
527
- },
528
- "start": {
529
- "type": "string",
530
- "description": "The action id from which the edge starts"
531
- },
532
- "end": {
533
- "type": "string",
534
- "description": "The action id to which the edge ends"
535
- },
536
- "condition_output": {
537
- "type": "boolean",
538
- "description": "The condition output of the edge (binary)"
539
- }
540
- },
541
- "required": [
542
- "id",
543
- "start",
544
- "end"
545
- ],
546
- "example": {
547
- "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
548
- "start": "3567cabc-587f-4ba2-8752-1f3da0100d1f",
549
- "end": "4e29af6c-9824-461c-bcfb-505840a949ba",
550
- "condition_output": true
551
- }
552
- },
553
521
  "SearchAutomationsResp": {
554
522
  "type": "object",
555
523
  "properties": {
@@ -615,9 +583,6 @@
615
583
  },
616
584
  {
617
585
  "$ref": "#/components/schemas/AutomationAction"
618
- },
619
- {
620
- "$ref": "#/components/schemas/ConditionAction"
621
586
  }
622
587
  ]
623
588
  },
@@ -643,9 +608,6 @@
643
608
  },
644
609
  {
645
610
  "$ref": "#/components/schemas/AutomationActionConfig"
646
- },
647
- {
648
- "$ref": "#/components/schemas/ConditionActionConfig"
649
611
  }
650
612
  ]
651
613
  },
@@ -694,6 +656,10 @@
694
656
  "description": "Extra metadata about the skipping reason - such as a certain condition not met, etc."
695
657
  }
696
658
  }
659
+ },
660
+ "condition_id": {
661
+ "type": "string",
662
+ "description": "Condition Id to be checked before executing the action"
697
663
  }
698
664
  }
699
665
  },
@@ -1802,16 +1768,19 @@
1802
1768
  }
1803
1769
  }
1804
1770
  },
1805
- "ConditionConfig": {
1771
+ "Condition": {
1806
1772
  "type": "object",
1807
1773
  "properties": {
1808
1774
  "source": {
1809
1775
  "type": "object",
1810
1776
  "properties": {
1777
+ "type": {
1778
+ "type": "string"
1779
+ },
1811
1780
  "id": {
1812
1781
  "type": "string"
1813
1782
  },
1814
- "type": {
1783
+ "schema": {
1815
1784
  "type": "string"
1816
1785
  },
1817
1786
  "attribute": {
@@ -1844,57 +1813,23 @@
1844
1813
  }
1845
1814
  }
1846
1815
  },
1847
- "ConditionAction": {
1848
- "allOf": [
1849
- {
1850
- "$ref": "#/components/schemas/AutomationAction"
1816
+ "ActionCondition": {
1817
+ "type": "object",
1818
+ "properties": {
1819
+ "id": {
1820
+ "type": "string"
1851
1821
  },
1852
- {
1853
- "type": "object",
1854
- "properties": {
1855
- "type": {
1856
- "enum": [
1857
- "condition"
1858
- ]
1859
- },
1860
- "actions": {
1861
- "type": "array",
1862
- "items": {
1863
- "$ref": "#/components/schemas/AnyAction"
1864
- }
1865
- },
1866
- "config": {
1867
- "$ref": "#/components/schemas/ConditionConfig"
1868
- }
1869
- }
1870
- }
1871
- ]
1872
- },
1873
- "ConditionActionConfig": {
1874
- "allOf": [
1875
- {
1876
- "$ref": "#/components/schemas/AutomationActionConfig"
1822
+ "evaluationResult": {
1823
+ "type": "boolean",
1824
+ "description": "Result of the condition evaluation"
1877
1825
  },
1878
- {
1879
- "type": "object",
1880
- "properties": {
1881
- "type": {
1882
- "enum": [
1883
- "condition"
1884
- ]
1885
- },
1886
- "actions": {
1887
- "type": "array",
1888
- "items": {
1889
- "$ref": "#/components/schemas/AnyActionConfig"
1890
- }
1891
- },
1892
- "config": {
1893
- "$ref": "#/components/schemas/ConditionConfig"
1894
- }
1826
+ "conditions": {
1827
+ "type": "array",
1828
+ "items": {
1829
+ "$ref": "#/components/schemas/Condition"
1895
1830
  }
1896
1831
  }
1897
- ]
1832
+ }
1898
1833
  },
1899
1834
  "AutomationExecutionId": {
1900
1835
  "type": "string",
@@ -1939,17 +1874,16 @@
1939
1874
  "current_action_id": {
1940
1875
  "$ref": "#/components/schemas/AutomationActionId"
1941
1876
  },
1942
- "actions": {
1877
+ "conditions": {
1943
1878
  "type": "array",
1944
1879
  "items": {
1945
- "$ref": "#/components/schemas/AnyAction"
1880
+ "$ref": "#/components/schemas/ActionCondition"
1946
1881
  }
1947
1882
  },
1948
- "edges": {
1883
+ "actions": {
1949
1884
  "type": "array",
1950
- "description": "The edges between actions which define the flow order",
1951
1885
  "items": {
1952
- "$ref": "#/components/schemas/Edge"
1886
+ "$ref": "#/components/schemas/AnyAction"
1953
1887
  }
1954
1888
  },
1955
1889
  "version": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/automation-client",
3
- "version": "2.9.1",
3
+ "version": "2.9.2",
4
4
  "description": "Client library for epilot automation API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",