@epilot/automation-client 2.25.0 → 2.27.0-rc.1

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",
@@ -2718,6 +2732,73 @@ declare namespace Components {
              */
             version?: number;
         }
+        export interface MoveThreadAction {
+            id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            flow_action_id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            name?: string;
+            type?: "move-thread";
+            config?: MoveThreadConfig;
+            /**
+             * 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;
+        }
+        export interface MoveThreadConfig {
+            /**
+             * ID of the inbox where the thread should be moved to
+             */
+            target_inbox_id?: string;
+        }
         export interface NumericCondition {
             numeric?: (string | number)[];
         }
@@ -3115,6 +3196,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";
             /**
@@ -4542,6 +4762,8 @@ export type MappingAttribute = Components.Schemas.MappingAttribute;
 export type MappingAttributeMode = Components.Schemas.MappingAttributeMode;
 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 NumericCondition = Components.Schemas.NumericCondition;
 export type OperationNode = Components.Schemas.OperationNode;
 export type OperationObjectNode = Components.Schemas.OperationObjectNode;
@@ -4568,6 +4790,9 @@ 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;

package/dist/openapi.json

@@ -1236,6 +1236,9 @@
           {
             "$ref": "#/components/schemas/InformERPAction"
           },
+          {
+            "$ref": "#/components/schemas/TriggerEventAction"
+          },
           {
             "$ref": "#/components/schemas/CreateDocumentAction"
           },
@@ -1273,6 +1276,9 @@
           {
             "$ref": "#/components/schemas/InformERPActionConfig"
           },
+          {
+            "$ref": "#/components/schemas/TriggerEventActionConfig"
+          },
           {
             "$ref": "#/components/schemas/CreateDocumentActionConfig"
           },
@@ -2032,6 +2038,35 @@
           "value_json"
         ]
       },
+      "MoveThreadAction": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AutomationAction"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": [
+                  "move-thread"
+                ]
+              },
+              "config": {
+                "$ref": "#/components/schemas/MoveThreadConfig"
+              }
+            }
+          }
+        ]
+      },
+      "MoveThreadConfig": {
+        "type": "object",
+        "properties": {
+          "target_inbox_id": {
+            "type": "string",
+            "description": "ID of the inbox where the thread should be moved to"
+          }
+        }
+      },
       "SendEmailActionConfig": {
         "allOf": [
           {
@@ -2670,6 +2705,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": [
           {
@@ -4617,9 +4721,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.25.0",
+  "version": "2.27.0-rc.1",
   "description": "Client library for epilot automation API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,6 +21,18 @@
     "sdk",
     "automation"
   ],
+  "scripts": {
+    "test": "jest",
+    "typescript": "tsc",
+    "bundle-definition": "webpack",
+    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/automation.yaml",
+    "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
+    "build": "tsc && npm run build:patch && npm run bundle-definition",
+    "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
+    "build:watch": "npm run build && tsc -w",
+    "prepublishOnly": "npm run typegen && npm run build",
+    "lint": "pnpm exec eslint src"
+  },
   "files": [
     "*.js",
     "*.d.ts",
@@ -63,16 +75,5 @@
     "webpack-cli": "^4.4.0",
     "whatwg-url": "^11.0.0"
   },
-  "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7",
-  "scripts": {
-    "test": "jest",
-    "typescript": "tsc",
-    "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/automation.yaml",
-    "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
-    "build": "tsc && npm run build:patch && npm run bundle-definition",
-    "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
-    "build:watch": "npm run build && tsc -w",
-    "lint": "pnpm exec eslint src"
-  }
-}
+  "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
+}

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2025 epilot GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.