@epilot/automation-client 2.8.8 → 2.9.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/openapi.d.ts CHANGED
@@ -344,7 +344,7 @@ declare namespace Components {
344
344
  */
345
345
  EntityOperationTrigger | ActivityTrigger | EntityManualTrigger | ReceivedEmailTrigger;
346
346
  export interface AnythingButCondition {
347
- "anything-but"?: (string | number)[];
347
+ "anything-but"?: string[];
348
348
  }
349
349
  export interface ApiCallerContext {
350
350
  [name: string]: any;
@@ -492,7 +492,7 @@ declare namespace Components {
492
492
  */
493
493
  created_automatically?: boolean;
494
494
  /**
495
- * Flag indicating whether the same action can be run multiple times in a single execution
495
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
496
496
  */
497
497
  is_bulk_action?: boolean;
498
498
  reason?: {
@@ -547,7 +547,7 @@ declare namespace Components {
547
547
  */
548
548
  created_automatically?: boolean;
549
549
  /**
550
- * Flag indicating whether the same action can be run multiple times in a single execution
550
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
551
551
  */
552
552
  is_bulk_action?: boolean;
553
553
  reason?: {
@@ -625,6 +625,25 @@ declare namespace Components {
625
625
  */
626
626
  AutomationActionId;
627
627
  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
+ /**
642
+ * Version of the flow
643
+ * example:
644
+ * 2
645
+ */
646
+ version?: number;
628
647
  trigger_event?: TriggerEventManual | TriggerEventEntityActivity | TriggerEventEntityOperation;
629
648
  }
630
649
  /**
@@ -748,7 +767,7 @@ declare namespace Components {
748
767
  */
749
768
  created_automatically?: boolean;
750
769
  /**
751
- * Flag indicating whether the same action can be run multiple times in a single execution
770
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
752
771
  */
753
772
  is_bulk_action?: boolean;
754
773
  reason?: {
@@ -804,7 +823,7 @@ declare namespace Components {
804
823
  */
805
824
  created_automatically?: boolean;
806
825
  /**
807
- * Flag indicating whether the same action can be run multiple times in a single execution
826
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
808
827
  */
809
828
  is_bulk_action?: boolean;
810
829
  reason?: {
@@ -881,7 +900,7 @@ declare namespace Components {
881
900
  */
882
901
  created_automatically?: boolean;
883
902
  /**
884
- * Flag indicating whether the same action can be run multiple times in a single execution
903
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
885
904
  */
886
905
  is_bulk_action?: boolean;
887
906
  reason?: {
@@ -903,7 +922,7 @@ declare namespace Components {
903
922
  source?: {
904
923
  id?: string;
905
924
  type?: string;
906
- attributes?: string;
925
+ attribute?: string;
907
926
  };
908
927
  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";
909
928
  values?: string[];
@@ -947,7 +966,7 @@ declare namespace Components {
947
966
  */
948
967
  created_automatically?: boolean;
949
968
  /**
950
- * Flag indicating whether the same action can be run multiple times in a single execution
969
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
951
970
  */
952
971
  is_bulk_action?: boolean;
953
972
  reason?: {
@@ -1018,7 +1037,7 @@ declare namespace Components {
1018
1037
  */
1019
1038
  created_automatically?: boolean;
1020
1039
  /**
1021
- * Flag indicating whether the same action can be run multiple times in a single execution
1040
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
1022
1041
  */
1023
1042
  is_bulk_action?: boolean;
1024
1043
  reason?: {
@@ -1320,7 +1339,7 @@ declare namespace Components {
1320
1339
  exists?: boolean;
1321
1340
  }
1322
1341
  export type FilterConditionOnEvent = OrCondition | {
1323
- [name: string]: (string | number | boolean | EqualsIgnoreCaseCondition | AnythingButCondition | NumericCondition | ExistsCondition | PrefixCondition | SuffixCondition | WildcardCondition)[];
1342
+ [name: string]: (string | EqualsIgnoreCaseCondition | AnythingButCondition | NumericCondition | ExistsCondition | PrefixCondition | SuffixCondition | WildcardCondition)[];
1324
1343
  };
1325
1344
  export interface FrontendSubmitTrigger {
1326
1345
  type: "frontend_submission";
@@ -1365,7 +1384,7 @@ declare namespace Components {
1365
1384
  */
1366
1385
  created_automatically?: boolean;
1367
1386
  /**
1368
- * Flag indicating whether the same action can be run multiple times in a single execution
1387
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
1369
1388
  */
1370
1389
  is_bulk_action?: boolean;
1371
1390
  reason?: {
@@ -1538,7 +1557,7 @@ declare namespace Components {
1538
1557
  */
1539
1558
  created_automatically?: boolean;
1540
1559
  /**
1541
- * Flag indicating whether the same action can be run multiple times in a single execution
1560
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
1542
1561
  */
1543
1562
  is_bulk_action?: boolean;
1544
1563
  reason?: {
@@ -1764,7 +1783,7 @@ declare namespace Components {
1764
1783
  */
1765
1784
  created_automatically?: boolean;
1766
1785
  /**
1767
- * Flag indicating whether the same action can be run multiple times in a single execution
1786
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
1768
1787
  */
1769
1788
  is_bulk_action?: boolean;
1770
1789
  reason?: {
@@ -1829,7 +1848,7 @@ declare namespace Components {
1829
1848
  */
1830
1849
  created_automatically?: boolean;
1831
1850
  /**
1832
- * Flag indicating whether the same action can be run multiple times in a single execution
1851
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
1833
1852
  */
1834
1853
  is_bulk_action?: boolean;
1835
1854
  reason?: {
@@ -1854,9 +1873,12 @@ declare namespace Components {
1854
1873
  * Send an email exclusively to the portal user if they are registered on the portal.
1855
1874
  */
1856
1875
  notify_portal_user_only?: boolean;
1876
+ /**
1877
+ * When true, it lets to send only the email by skip creating the thread & message entities.
1878
+ */
1879
+ skip_creating_entities?: boolean;
1857
1880
  /**
1858
1881
  * Include extra file attachments in sent email.
1859
- *
1860
1882
  * Attachments in email template will be sent regardless of this configuration.
1861
1883
  *
1862
1884
  */
@@ -2022,7 +2044,7 @@ declare namespace Components {
2022
2044
  */
2023
2045
  created_automatically?: boolean;
2024
2046
  /**
2025
- * Flag indicating whether the same action can be run multiple times in a single execution
2047
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
2026
2048
  */
2027
2049
  is_bulk_action?: boolean;
2028
2050
  reason?: {
@@ -2090,7 +2112,7 @@ declare namespace Components {
2090
2112
  */
2091
2113
  created_automatically?: boolean;
2092
2114
  /**
2093
- * Flag indicating whether the same action can be run multiple times in a single execution
2115
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
2094
2116
  */
2095
2117
  is_bulk_action?: boolean;
2096
2118
  reason?: {
@@ -2139,7 +2161,7 @@ declare namespace Components {
2139
2161
  */
2140
2162
  created_automatically?: boolean;
2141
2163
  /**
2142
- * Flag indicating whether the same action can be run multiple times in a single execution
2164
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
2143
2165
  */
2144
2166
  is_bulk_action?: boolean;
2145
2167
  reason?: {
@@ -2226,7 +2248,7 @@ declare namespace Components {
2226
2248
  */
2227
2249
  created_automatically?: boolean;
2228
2250
  /**
2229
- * Flag indicating whether the same action can be run multiple times in a single execution
2251
+ * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
2230
2252
  */
2231
2253
  is_bulk_action?: boolean;
2232
2254
  reason?: {
package/dist/openapi.json CHANGED
@@ -674,7 +674,7 @@
674
674
  "type": "boolean"
675
675
  },
676
676
  "is_bulk_action": {
677
- "description": "Flag indicating whether the same action can be run multiple times in a single execution",
677
+ "description": "Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity",
678
678
  "type": "boolean"
679
679
  },
680
680
  "reason": {
@@ -1433,9 +1433,14 @@
1433
1433
  "description": "Send an email exclusively to the portal user if they are registered on the portal.",
1434
1434
  "default": false
1435
1435
  },
1436
+ "skip_creating_entities": {
1437
+ "type": "boolean",
1438
+ "description": "When true, it lets to send only the email by skip creating the thread & message entities.",
1439
+ "default": false
1440
+ },
1436
1441
  "attachments": {
1437
1442
  "type": "array",
1438
- "description": "Include extra file attachments in sent email.\n\nAttachments in email template will be sent regardless of this configuration.\n",
1443
+ "description": "Include extra file attachments in sent email.\nAttachments in email template will be sent regardless of this configuration.\n",
1439
1444
  "items": {
1440
1445
  "type": "object",
1441
1446
  "properties": {
@@ -1806,7 +1811,7 @@
1806
1811
  "type": {
1807
1812
  "type": "string"
1808
1813
  },
1809
- "attributes": {
1814
+ "attribute": {
1810
1815
  "type": "string"
1811
1816
  }
1812
1817
  }
@@ -1905,6 +1910,18 @@
1905
1910
  "$ref": "#/components/schemas/AnyAction"
1906
1911
  }
1907
1912
  },
1913
+ "edges": {
1914
+ "type": "array",
1915
+ "description": "The edges between actions which define the flow order",
1916
+ "items": {
1917
+ "$ref": "#/components/schemas/Edge"
1918
+ }
1919
+ },
1920
+ "version": {
1921
+ "type": "number",
1922
+ "description": "Version of the flow",
1923
+ "example": 2
1924
+ },
1908
1925
  "trigger_event": {
1909
1926
  "oneOf": [
1910
1927
  {
@@ -2517,12 +2534,6 @@
2517
2534
  {
2518
2535
  "type": "string"
2519
2536
  },
2520
- {
2521
- "type": "number"
2522
- },
2523
- {
2524
- "type": "boolean"
2525
- },
2526
2537
  {
2527
2538
  "$ref": "#/components/schemas/EqualsIgnoreCaseCondition"
2528
2539
  },
@@ -2564,14 +2575,7 @@
2564
2575
  "anything-but": {
2565
2576
  "type": "array",
2566
2577
  "items": {
2567
- "oneOf": [
2568
- {
2569
- "type": "string"
2570
- },
2571
- {
2572
- "type": "integer"
2573
- }
2574
- ]
2578
+ "type": "string"
2575
2579
  }
2576
2580
  }
2577
2581
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/automation-client",
3
- "version": "2.8.8",
3
+ "version": "2.9.0",
4
4
  "description": "Client library for epilot automation API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",