@epilot/automation-client 2.9.0 → 2.9.2

package/dist/openapi.d.ts

@@ -9,6 +9,14 @@ import type {
 
 declare namespace Components {
     namespace Schemas {
+        export interface ActionCondition {
+            id?: string;
+            /**
+             * Result of the condition evaluation
+             */
+            evaluationResult?: boolean;
+            conditions?: Condition[];
+        }
         /**
          * example:
          * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
@@ -225,7 +233,7 @@ declare namespace Components {
          *   }
          * }
          */
-        SendEmailActionConfig | /* Creates an order entity with prices from journey */ CartCheckoutActionConfig | AutomationActionConfig | ConditionActionConfig;
+        SendEmailActionConfig | /* Creates an order entity with prices from journey */ CartCheckoutActionConfig | AutomationActionConfig;
         export type AnyTrigger = FrontendSubmitTrigger | JourneySubmitTrigger | ApiSubmissionTrigger | /**
          * - If provides filter_config, executes an automation based on the filtered configuration when an entity event occurs.
          * - 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 {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -564,6 +576,10 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
         }
         export interface AutomationActionExecutionState {
             execution_status?: ExecutionStatus;
@@ -624,20 +640,8 @@ declare namespace Components {
              * 9ec3711b-db63-449c-b894-54d5bb622a8f
              */
             AutomationActionId;
+            conditions?: ActionCondition[];
             actions: AnyAction[];
-            /**
-             * The edges between actions which define the flow order
-             */
-            edges?: /**
-             * example:
-             * {
-             *   "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
-             *   "start": "3567cabc-587f-4ba2-8752-1f3da0100d1f",
-             *   "end": "4e29af6c-9824-461c-bcfb-505840a949ba",
-             *   "condition_output": true
-             * }
-             */
-            Edge[];
             /**
              * Version of the flow
              * example:
@@ -682,23 +686,11 @@ declare namespace Components {
              * submission
              */
             entity_schema?: string;
+            conditions?: ActionCondition[];
             /**
              * The actions (nodes) of the automation flow
              */
             actions: AnyActionConfig[];
-            /**
-             * The edges between actions which define the flow order
-             */
-            edges?: /**
-             * example:
-             * {
-             *   "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
-             *   "start": "3567cabc-587f-4ba2-8752-1f3da0100d1f",
-             *   "end": "4e29af6c-9824-461c-bcfb-505840a949ba",
-             *   "condition_output": true
-             * }
-             */
-            Edge[];
             /**
              * Number of automation executions that ran
              * example:
@@ -784,6 +776,10 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -840,6 +836,10 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
         }
         export interface CartCheckoutConfig {
             /**
@@ -877,51 +877,11 @@ declare namespace Components {
             target_unique?: string[];
         }
         export type Comparison = "equals" | "any_of" | "not_empty" | "is_empty";
-        export interface ConditionActionConfig {
-            id?: /**
-             * example:
-             * 9ec3711b-db63-449c-b894-54d5bb622a8f
-             */
-            AutomationActionId;
-            flow_action_id?: /**
-             * example:
-             * 9ec3711b-db63-449c-b894-54d5bb622a8f
-             */
-            AutomationActionId;
-            name?: string;
-            type?: "condition";
-            config?: ConditionConfig;
-            /**
-             * Whether to stop execution in a failed state if this action fails
-             */
-            allow_failure?: boolean;
-            /**
-             * Flag indicating whether the action was created automatically or manually
-             */
-            created_automatically?: boolean;
-            /**
-             * Flag indicating whether the same action can be in bulk in a single execution. e.g; send-email / map-entity
-             */
-            is_bulk_action?: boolean;
-            reason?: {
-                /**
-                 * Why the action has to be skipped/failed
-                 * example:
-                 * There are no registered portal users for the given emails, hence skipping the action
-                 */
-                message?: string;
-                /**
-                 * Extra metadata about the skipping reason - such as a certain condition not met, etc.
-                 */
-                payload?: {
-                    [name: string]: any;
-                };
-            };
-        }
-        export interface ConditionConfig {
+        export interface Condition {
             source?: {
-                id?: string;
                 type?: string;
+                id?: string;
+                schema?: string;
                 attribute?: string;
             };
             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";
@@ -983,6 +943,10 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -1054,6 +1018,10 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
         }
         export interface CreateDocumentConfig {
             template_id?: string;
@@ -1062,30 +1030,6 @@ declare namespace Components {
         export type DiffAdded = FilterConditionOnEvent;
         export type DiffDeleted = FilterConditionOnEvent;
         export type DiffUpdated = FilterConditionOnEvent;
-        /**
-         * example:
-         * {
-         *   "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
-         *   "start": "3567cabc-587f-4ba2-8752-1f3da0100d1f",
-         *   "end": "4e29af6c-9824-461c-bcfb-505840a949ba",
-         *   "condition_output": true
-         * }
-         */
-        export interface Edge {
-            id: string;
-            /**
-             * The action id from which the edge starts
-             */
-            start: string;
-            /**
-             * The action id to which the edge ends
-             */
-            end: string;
-            /**
-             * The condition output of the edge (binary)
-             */
-            condition_output?: boolean;
-        }
         /**
          * example:
          * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
@@ -1401,6 +1345,10 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -1574,6 +1522,10 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
         }
         export interface MapEntityConfig {
             mapping_config?: MappingConfigRef;
@@ -1800,6 +1752,10 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -1865,6 +1821,10 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
         }
         export interface SendEmailConfig {
             email_template_id?: string;
@@ -2061,6 +2021,10 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -2129,6 +2093,10 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
         }
         export interface TriggerWebhookConfig {
             entity_sources?: string[];
@@ -2178,6 +2146,10 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -2265,6 +2237,10 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
         }
         /**
          * example:

package/dist/openapi.json

@@ -455,6 +455,12 @@
             "type": "string",
             "example": "submission"
           },
+          "conditions": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ActionCondition"
+            }
+          },
           "actions": {
             "type": "array",
             "description": "The actions (nodes) of the automation flow",
@@ -463,13 +469,6 @@
             },
             "readOnly": true
           },
-          "edges": {
-            "type": "array",
-            "description": "The edges between actions which define the flow order",
-            "items": {
-              "$ref": "#/components/schemas/Edge"
-            }
-          },
           "runs": {
             "type": "number",
             "example": 7,
@@ -519,37 +518,6 @@
           "actions"
         ]
       },
-      "Edge": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string"
-          },
-          "start": {
-            "type": "string",
-            "description": "The action id from which the edge starts"
-          },
-          "end": {
-            "type": "string",
-            "description": "The action id to which the edge ends"
-          },
-          "condition_output": {
-            "type": "boolean",
-            "description": "The condition output of the edge (binary)"
-          }
-        },
-        "required": [
-          "id",
-          "start",
-          "end"
-        ],
-        "example": {
-          "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
-          "start": "3567cabc-587f-4ba2-8752-1f3da0100d1f",
-          "end": "4e29af6c-9824-461c-bcfb-505840a949ba",
-          "condition_output": true
-        }
-      },
       "SearchAutomationsResp": {
         "type": "object",
         "properties": {
@@ -640,9 +608,6 @@
           },
           {
             "$ref": "#/components/schemas/AutomationActionConfig"
-          },
-          {
-            "$ref": "#/components/schemas/ConditionActionConfig"
           }
         ]
       },
@@ -691,6 +656,10 @@
                 "description": "Extra metadata about the skipping reason - such as a certain condition not met, etc."
               }
             }
+          },
+          "condition_id": {
+            "type": "string",
+            "description": "Condition Id to be checked before executing the action"
           }
         }
       },
@@ -1799,16 +1768,19 @@
           }
         }
       },
-      "ConditionConfig": {
+      "Condition": {
         "type": "object",
         "properties": {
           "source": {
             "type": "object",
             "properties": {
+              "type": {
+                "type": "string"
+              },
               "id": {
                 "type": "string"
               },
-              "type": {
+              "schema": {
                 "type": "string"
               },
               "attribute": {
@@ -1841,25 +1813,23 @@
           }
         }
       },
-      "ConditionActionConfig": {
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/AutomationActionConfig"
+      "ActionCondition": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
           },
-          {
-            "type": "object",
-            "properties": {
-              "type": {
-                "enum": [
-                  "condition"
-                ]
-              },
-              "config": {
-                "$ref": "#/components/schemas/ConditionConfig"
-              }
+          "evaluationResult": {
+            "type": "boolean",
+            "description": "Result of the condition evaluation"
+          },
+          "conditions": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Condition"
             }
           }
-        ]
+        }
       },
       "AutomationExecutionId": {
         "type": "string",
@@ -1904,17 +1874,16 @@
           "current_action_id": {
             "$ref": "#/components/schemas/AutomationActionId"
           },
-          "actions": {
+          "conditions": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/AnyAction"
+              "$ref": "#/components/schemas/ActionCondition"
             }
           },
-          "edges": {
+          "actions": {
             "type": "array",
-            "description": "The edges between actions which define the flow order",
             "items": {
-              "$ref": "#/components/schemas/Edge"
+              "$ref": "#/components/schemas/AnyAction"
             }
           },
           "version": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/automation-client",
-  "version": "2.9.0",
+  "version": "2.9.2",
   "description": "Client library for epilot automation API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",