@epilot/automation-client 2.26.0 → 2.27.0

package/dist/openapi.d.ts

@@ -126,7 +126,7 @@ declare namespace Components {
                 types?: (("CreateMeterReading" | "UpdateMeterReading" | "DocDownloadedFromPortal" | "PortalUserResetPassword" | "PortalUserResetForgotPassword" | "SelfAssignmentFromPortal") | string)[];
             };
         }
-        export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerShareEntityAction | TriggerWebhookAction | InformERPAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction | FlowExecutionCancelAction;
+        export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerShareEntityAction | TriggerWebhookAction | InformERPAction | TriggerEventAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction | FlowExecutionCancelAction;
         export type AnyActionConfig = /**
          * example:
          * {
@@ -312,6 +312,20 @@ declare namespace Components {
          * }
          */
         InformERPActionConfig | /**
+         * example:
+         * {
+         *   "id": "2520gja-2sgmsaga-0asg-822jgal",
+         *   "name": "Trigger Event",
+         *   "type": "trigger-event",
+         *   "config": {
+         *     "event_name": "my_custom_event",
+         *     "event_inputs": {
+         *       "key": "value"
+         *     }
+         *   }
+         * }
+         */
+        TriggerEventActionConfig | /**
          * example:
          * {
          *   "id": "08g988-ojt2jtaga-292h-8978gsaga",
@@ -479,7 +493,7 @@ declare namespace Components {
          *       ```
          *
          */
-        EntityOperationTrigger | ActivityTrigger | EntityManualTrigger | ReceivedEmailTrigger | FlowsTrigger;
+        EntityOperationTrigger | ActivityTrigger | EntityManualTrigger | ReceivedEmailTrigger | NewEmailThreadTrigger | FlowsTrigger;
         export interface AnythingButCondition {
             "anything-but"?: string[];
         }
@@ -806,7 +820,7 @@ declare namespace Components {
              * 2
              */
             version?: number;
-            trigger_event?: TriggerEventManual | TriggerEventEntityActivity | TriggerEventEntityOperation | TriggerEventFlowAutomationTask;
+            trigger_event?: TriggerEventManual | TriggerEventEntityActivity | TriggerEventEntityOperation | TriggerEventFlowAutomationTask | TriggerEventMessaging;
             workflow_context?: WorkflowExecutionContext;
         }
         /**
@@ -2785,6 +2799,17 @@ declare namespace Components {
              */
             target_inbox_id?: string;
         }
+        export interface NewEmailThreadTrigger {
+            /**
+             * example:
+             * 12d4f45a-1883-4841-a94c-5928cb338a94
+             */
+            id?: string; // uuid
+            type: "new_email_thread";
+            configuration: {
+                direction?: "INBOUND" | "OUTBOUND" | "BOTH";
+            };
+        }
         export interface NumericCondition {
             numeric?: (string | number)[];
         }
@@ -3182,6 +3207,145 @@ declare namespace Components {
         export interface TriggerContext {
             [name: string]: string;
         }
+        export interface TriggerEventAction {
+            id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            flow_action_id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            name?: string;
+            type?: "trigger-event";
+            config?: /* Configuration for triggering an event catalog event */ TriggerEventConfig;
+            /**
+             * 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;
+                };
+            };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
+            /**
+             * Schedule Id which indicates the schedule of the action
+             */
+            schedule_id?: string;
+            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;
+        }
+        /**
+         * example:
+         * {
+         *   "id": "2520gja-2sgmsaga-0asg-822jgal",
+         *   "name": "Trigger Event",
+         *   "type": "trigger-event",
+         *   "config": {
+         *     "event_name": "my_custom_event",
+         *     "event_inputs": {
+         *       "key": "value"
+         *     }
+         *   }
+         * }
+         */
+        export interface TriggerEventActionConfig {
+            id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            flow_action_id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            name?: string;
+            type?: "trigger-event";
+            config?: /* Configuration for triggering an event catalog event */ TriggerEventConfig;
+            /**
+             * 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;
+                };
+            };
+            /**
+             * Condition Id to be checked before executing the action
+             */
+            condition_id?: string;
+            /**
+             * Schedule Id which indicates the schedule of the action
+             */
+            schedule_id?: string;
+        }
+        /**
+         * Configuration for triggering an event catalog event
+         */
+        export interface TriggerEventConfig {
+            /**
+             * The event catalog event name to trigger
+             */
+            event_name: string;
+            /**
+             * Inputs to be passed to trigger the event
+             */
+            event_inputs?: {
+                [name: string]: any;
+            };
+        }
         export interface TriggerEventEntityActivity {
             type?: "entity_activity";
             /**
@@ -3258,6 +3422,21 @@ declare namespace Components {
             EntityId;
             caller?: ApiCallerContext;
         }
+        export interface TriggerEventMessaging {
+            type?: "new_email_thread";
+            /**
+             * example:
+             * 123
+             */
+            org_id: string;
+            thread_id: string;
+            message_id: string;
+            entity_id: /**
+             * example:
+             * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+             */
+            EntityId;
+        }
         export interface TriggerShareEntityAction {
             id?: /**
              * example:
@@ -4611,6 +4790,7 @@ export type MappingAttributeV2 = Components.Schemas.MappingAttributeV2;
 export type MappingConfigRef = Components.Schemas.MappingConfigRef;
 export type MoveThreadAction = Components.Schemas.MoveThreadAction;
 export type MoveThreadConfig = Components.Schemas.MoveThreadConfig;
+export type NewEmailThreadTrigger = Components.Schemas.NewEmailThreadTrigger;
 export type NumericCondition = Components.Schemas.NumericCondition;
 export type OperationNode = Components.Schemas.OperationNode;
 export type OperationObjectNode = Components.Schemas.OperationObjectNode;
@@ -4637,10 +4817,14 @@ export type StartExecutionRequest = Components.Schemas.StartExecutionRequest;
 export type SuffixCondition = Components.Schemas.SuffixCondition;
 export type TriggerCondition = Components.Schemas.TriggerCondition;
 export type TriggerContext = Components.Schemas.TriggerContext;
+export type TriggerEventAction = Components.Schemas.TriggerEventAction;
+export type TriggerEventActionConfig = Components.Schemas.TriggerEventActionConfig;
+export type TriggerEventConfig = Components.Schemas.TriggerEventConfig;
 export type TriggerEventEntityActivity = Components.Schemas.TriggerEventEntityActivity;
 export type TriggerEventEntityOperation = Components.Schemas.TriggerEventEntityOperation;
 export type TriggerEventFlowAutomationTask = Components.Schemas.TriggerEventFlowAutomationTask;
 export type TriggerEventManual = Components.Schemas.TriggerEventManual;
+export type TriggerEventMessaging = Components.Schemas.TriggerEventMessaging;
 export type TriggerShareEntityAction = Components.Schemas.TriggerShareEntityAction;
 export type TriggerShareEntityActionConfig = Components.Schemas.TriggerShareEntityActionConfig;
 export type TriggerShareEntityConfig = Components.Schemas.TriggerShareEntityConfig;

package/dist/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Automation API",
     "description": "API Backend for epilot Automation Workflows feature",
-    "version": "1.0.0"
+    "version": "1.2.0"
   },
   "tags": [
     {
@@ -1214,6 +1214,9 @@
           {
             "$ref": "#/components/schemas/ReceivedEmailTrigger"
           },
+          {
+            "$ref": "#/components/schemas/NewEmailThreadTrigger"
+          },
           {
             "$ref": "#/components/schemas/FlowsTrigger"
           }
@@ -1236,6 +1239,9 @@
           {
             "$ref": "#/components/schemas/InformERPAction"
           },
+          {
+            "$ref": "#/components/schemas/TriggerEventAction"
+          },
           {
             "$ref": "#/components/schemas/CreateDocumentAction"
           },
@@ -1273,6 +1279,9 @@
           {
             "$ref": "#/components/schemas/InformERPActionConfig"
           },
+          {
+            "$ref": "#/components/schemas/TriggerEventActionConfig"
+          },
           {
             "$ref": "#/components/schemas/CreateDocumentActionConfig"
           },
@@ -2699,6 +2708,75 @@
           }
         }
       },
+      "TriggerEventActionConfig": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AutomationActionConfig"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": [
+                  "trigger-event"
+                ]
+              },
+              "config": {
+                "$ref": "#/components/schemas/TriggerEventConfig"
+              }
+            }
+          }
+        ],
+        "example": {
+          "id": "2520gja-2sgmsaga-0asg-822jgal",
+          "name": "Trigger Event",
+          "type": "trigger-event",
+          "config": {
+            "event_name": "my_custom_event",
+            "event_inputs": {
+              "key": "value"
+            }
+          }
+        }
+      },
+      "TriggerEventAction": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AutomationAction"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": [
+                  "trigger-event"
+                ]
+              },
+              "config": {
+                "$ref": "#/components/schemas/TriggerEventConfig"
+              }
+            }
+          }
+        ]
+      },
+      "TriggerEventConfig": {
+        "type": "object",
+        "description": "Configuration for triggering an event catalog event",
+        "properties": {
+          "event_name": {
+            "type": "string",
+            "description": "The event catalog event name to trigger"
+          },
+          "event_inputs": {
+            "type": "object",
+            "additionalProperties": true,
+            "description": "Inputs to be passed to trigger the event"
+          }
+        },
+        "required": [
+          "event_name"
+        ]
+      },
       "FlowExecutionCancelActionConfig": {
         "allOf": [
           {
@@ -3097,6 +3175,9 @@
               },
               {
                 "$ref": "#/components/schemas/TriggerEventFlowAutomationTask"
+              },
+              {
+                "$ref": "#/components/schemas/TriggerEventMessaging"
               }
             ]
           },
@@ -3242,6 +3323,36 @@
           "activity_type"
         ]
       },
+      "TriggerEventMessaging": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "new_email_thread"
+            ]
+          },
+          "org_id": {
+            "type": "string",
+            "example": "123"
+          },
+          "thread_id": {
+            "type": "string"
+          },
+          "message_id": {
+            "type": "string"
+          },
+          "entity_id": {
+            "$ref": "#/components/schemas/EntityId"
+          }
+        },
+        "required": [
+          "org_id",
+          "thread_id",
+          "message_id",
+          "entity_id"
+        ]
+      },
       "TriggerEventEntityOperation": {
         "type": "object",
         "properties": {
@@ -3843,6 +3954,41 @@
           }
         ]
       },
+      "NewEmailThreadTrigger": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AutomationTrigger"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "new_email_thread"
+                ]
+              },
+              "configuration": {
+                "type": "object",
+                "properties": {
+                  "direction": {
+                    "type": "string",
+                    "enum": [
+                      "INBOUND",
+                      "OUTBOUND",
+                      "BOTH"
+                    ]
+                  }
+                }
+              }
+            },
+            "required": [
+              "type",
+              "configuration"
+            ]
+          }
+        ]
+      },
       "ReceivedEmailTrigger": {
         "allOf": [
           {
@@ -4646,9 +4792,6 @@
     }
   },
   "servers": [
-    {
-      "url": "https://automation.sls.epilot.io"
-    },
     {
       "url": "https://automation.sls.epilot.io"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/automation-client",
-  "version": "2.26.0",
+  "version": "2.27.0",
   "description": "Client library for epilot automation API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -76,4 +76,4 @@
     "whatwg-url": "^11.0.0"
   },
   "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
-}
+}