@epilot/automation-client 2.8.9 → 2.9.1

package/dist/openapi.d.ts

@@ -25,7 +25,7 @@ declare namespace Components {
                 types?: (("CreateMeterReading" | "UpdateMeterReading" | "DocDownloadedFromPortal" | "PortalUserResetPassword" | "PortalUserResetForgotPassword") | string)[];
             };
         }
-        export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerWebhookAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | AutomationAction;
+        export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerWebhookAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | AutomationAction | ConditionAction;
         export type AnyActionConfig = /**
          * example:
          * {
@@ -344,7 +344,7 @@ declare namespace Components {
          */
         EntityOperationTrigger | ActivityTrigger | EntityManualTrigger | ReceivedEmailTrigger;
         export interface AnythingButCondition {
-            "anything-but"?: (string | number)[];
+            "anything-but"?: string[];
         }
         export interface ApiCallerContext {
             [name: string]: any;
@@ -625,6 +625,25 @@ declare namespace Components {
              */
             AutomationActionId;
             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:
+             * 2
+             */
+            version?: number;
             trigger_event?: TriggerEventManual | TriggerEventEntityActivity | TriggerEventEntityOperation;
         }
         /**
@@ -858,6 +877,60 @@ declare namespace Components {
             target_unique?: string[];
         }
         export type Comparison = "equals" | "any_of" | "not_empty" | "is_empty";
+        export interface ConditionAction {
+            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;
+                };
+            };
+            execution_status?: ExecutionStatus;
+            started_at?: string;
+            updated_at?: string;
+            /**
+             * example:
+             * {}
+             */
+            outputs?: {
+                [name: string]: any;
+            };
+            error_output?: ErrorOutput;
+            retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
+            actions?: AnyAction[];
+        }
         export interface ConditionActionConfig {
             id?: /**
              * example:
@@ -898,12 +971,13 @@ declare namespace Components {
                     [name: string]: any;
                 };
             };
+            actions?: AnyActionConfig[];
         }
         export interface ConditionConfig {
             source?: {
                 id?: string;
                 type?: string;
-                attributes?: 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";
             values?: string[];
@@ -1320,7 +1394,7 @@ declare namespace Components {
             exists?: boolean;
         }
         export type FilterConditionOnEvent = OrCondition | {
-            [name: string]: (string | number | boolean | EqualsIgnoreCaseCondition | AnythingButCondition | NumericCondition | ExistsCondition | PrefixCondition | SuffixCondition | WildcardCondition)[];
+            [name: string]: (string | EqualsIgnoreCaseCondition | AnythingButCondition | NumericCondition | ExistsCondition | PrefixCondition | SuffixCondition | WildcardCondition)[];
         };
         export interface FrontendSubmitTrigger {
             type: "frontend_submission";

package/dist/openapi.json

@@ -615,6 +615,9 @@
           },
           {
             "$ref": "#/components/schemas/AutomationAction"
+          },
+          {
+            "$ref": "#/components/schemas/ConditionAction"
           }
         ]
       },
@@ -1811,7 +1814,7 @@
               "type": {
                 "type": "string"
               },
-              "attributes": {
+              "attribute": {
                 "type": "string"
               }
             }
@@ -1841,6 +1844,32 @@
           }
         }
       },
+      "ConditionAction": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AutomationAction"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": [
+                  "condition"
+                ]
+              },
+              "actions": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/AnyAction"
+                }
+              },
+              "config": {
+                "$ref": "#/components/schemas/ConditionConfig"
+              }
+            }
+          }
+        ]
+      },
       "ConditionActionConfig": {
         "allOf": [
           {
@@ -1854,6 +1883,12 @@
                   "condition"
                 ]
               },
+              "actions": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/AnyActionConfig"
+                }
+              },
               "config": {
                 "$ref": "#/components/schemas/ConditionConfig"
               }
@@ -1910,6 +1945,18 @@
               "$ref": "#/components/schemas/AnyAction"
             }
           },
+          "edges": {
+            "type": "array",
+            "description": "The edges between actions which define the flow order",
+            "items": {
+              "$ref": "#/components/schemas/Edge"
+            }
+          },
+          "version": {
+            "type": "number",
+            "description": "Version of the flow",
+            "example": 2
+          },
           "trigger_event": {
             "oneOf": [
               {
@@ -2522,12 +2569,6 @@
                   {
                     "type": "string"
                   },
-                  {
-                    "type": "number"
-                  },
-                  {
-                    "type": "boolean"
-                  },
                   {
                     "$ref": "#/components/schemas/EqualsIgnoreCaseCondition"
                   },
@@ -2569,14 +2610,7 @@
           "anything-but": {
             "type": "array",
             "items": {
-              "oneOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "integer"
-                }
-              ]
+              "type": "string"
             }
           }
         }

package/package.json

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