@epilot/automation-client 2.18.7 → 2.18.9

package/dist/openapi.d.ts

@@ -792,6 +792,14 @@ declare namespace Components {
              * eyJraWQiOiJrZXkifQ==
              */
             ResumeToken;
+            trigger_context?: /**
+             * Additional contextual data for a bulk trigger automation. This would normally include additional entity IDs you'd need after a listener picks up an event.
+             * example:
+             * {
+             *   "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
+             * }
+             */
+            TriggerContext;
             /**
              * Version of the flow
              * example:
@@ -972,6 +980,14 @@ declare namespace Components {
              * Time when the bulk trigger automation executions job was approved
              */
             approved_at?: string; // date-time
+            trigger_context?: /**
+             * Additional contextual data for a bulk trigger automation. This would normally include additional entity IDs you'd need after a listener picks up an event.
+             * example:
+             * {
+             *   "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
+             * }
+             */
+            TriggerContext;
             /**
              * Task token to approve/cancel the bulk automation job
              * example:
@@ -1049,6 +1065,14 @@ declare namespace Components {
              */
             AutomationFlowId;
             entities_refs: EntityRef[];
+            trigger_context?: /**
+             * Additional contextual data for a bulk trigger automation. This would normally include additional entity IDs you'd need after a listener picks up an event.
+             * example:
+             * {
+             *   "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
+             * }
+             */
+            TriggerContext;
         } | {
             flow_id: /**
              * ID of the Automation Flow
@@ -1057,6 +1081,14 @@ declare namespace Components {
              */
             AutomationFlowId;
             entities_query: string;
+            trigger_context?: /**
+             * Additional contextual data for a bulk trigger automation. This would normally include additional entity IDs you'd need after a listener picks up an event.
+             * example:
+             * {
+             *   "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
+             * }
+             */
+            TriggerContext;
         } | {
             flow_id: /**
              * ID of the Automation Flow
@@ -1083,6 +1115,14 @@ declare namespace Components {
              * ]
              */
             EntitySearchFilter;
+            trigger_context?: /**
+             * Additional contextual data for a bulk trigger automation. This would normally include additional entity IDs you'd need after a listener picks up an event.
+             * example:
+             * {
+             *   "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
+             * }
+             */
+            TriggerContext;
         };
         /**
          * A reason for cancelling a flow execution
@@ -1942,7 +1982,7 @@ declare namespace Components {
         export interface EqualsIgnoreCaseCondition {
             "equals-ignore-case"?: string;
         }
-        export type ErrorCode = "MAPPING_ERROR" | "REFRESH_RELATIONS_ERROR" | "DUPLICATE_ENTITY_ERROR" | "TRIGGER_WORKFLOW_ERROR" | "TIMEOUT_ERROR" | "BAD_CONFIG" | "INTERNAL_ERROR" | "TRIGGER_WEBHOOK_ERROR" | "TEMPLATE_ERROR" | "INVALID_PAYLOAD" | "INVALID_SCHEDULE_CONFIG" | "CUSTOM_ACTION_ERROR";
+        export type ErrorCode = "MAPPING_ERROR" | "REFRESH_RELATIONS_ERROR" | "DUPLICATE_ENTITY_ERROR" | "TRIGGER_WORKFLOW_ERROR" | "TIMEOUT_ERROR" | "BAD_CONFIG" | "INTERNAL_ERROR" | "TRIGGER_WEBHOOK_ERROR" | "TEMPLATE_ERROR" | "INVALID_PAYLOAD" | "INVALID_SCHEDULE_CONFIG" | "CUSTOM_ACTION_ERROR" | "ORDER_CREATION_ERROR" | "DOCUMENT_GENERATION_ERROR" | "BULK_EMAIL_ERROR" | "SHARING_ERROR" | "CANCEL_FLOW_EXECUTION_ERROR";
         export interface ErrorDetail {
             explanation: string;
             context?: string;
@@ -3019,6 +3059,16 @@ declare namespace Components {
             comparison: Comparison;
             value?: string | number | string[] | number[];
         }
+        /**
+         * Additional contextual data for a bulk trigger automation. This would normally include additional entity IDs you'd need after a listener picks up an event.
+         * example:
+         * {
+         *   "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
+         * }
+         */
+        export interface TriggerContext {
+            [name: string]: string;
+        }
         export interface TriggerEventEntityActivity {
             type?: "entity_activity";
             /**
@@ -4395,6 +4445,7 @@ export type SetValueMapper = Components.Schemas.SetValueMapper;
 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 TriggerEventEntityActivity = Components.Schemas.TriggerEventEntityActivity;
 export type TriggerEventEntityOperation = Components.Schemas.TriggerEventEntityOperation;
 export type TriggerEventFlowAutomationTask = Components.Schemas.TriggerEventFlowAutomationTask;

package/dist/openapi.json

@@ -574,7 +574,10 @@
                     "entity_schema": "opportunity",
                     "entity_id": "b35a6c51-2a15-4ef1-9623-20db37b0744f"
                   }
-                ]
+                ],
+                "trigger_context": {
+                  "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
+                }
               }
             }
           }
@@ -1336,7 +1339,12 @@
           "TEMPLATE_ERROR",
           "INVALID_PAYLOAD",
           "INVALID_SCHEDULE_CONFIG",
-          "CUSTOM_ACTION_ERROR"
+          "CUSTOM_ACTION_ERROR",
+          "ORDER_CREATION_ERROR",
+          "DOCUMENT_GENERATION_ERROR",
+          "BULK_EMAIL_ERROR",
+          "SHARING_ERROR",
+          "CANCEL_FLOW_EXECUTION_ERROR"
         ]
       },
       "ErrorDetail": {
@@ -2925,6 +2933,9 @@
           "resume_token": {
             "$ref": "#/components/schemas/ResumeToken"
           },
+          "trigger_context": {
+            "$ref": "#/components/schemas/TriggerContext"
+          },
           "version": {
             "type": "number",
             "description": "Version of the flow",
@@ -3227,13 +3238,15 @@
                 "items": {
                   "$ref": "#/components/schemas/EntityRef"
                 }
+              },
+              "trigger_context": {
+                "$ref": "#/components/schemas/TriggerContext"
               }
             },
             "required": [
               "flow_id",
               "entities_refs"
-            ],
-            "additionalProperties": false
+            ]
           },
           {
             "type": "object",
@@ -3243,13 +3256,15 @@
               },
               "entities_query": {
                 "type": "string"
+              },
+              "trigger_context": {
+                "$ref": "#/components/schemas/TriggerContext"
               }
             },
             "required": [
               "flow_id",
               "entities_query"
-            ],
-            "additionalProperties": false
+            ]
           },
           {
             "type": "object",
@@ -3259,13 +3274,15 @@
               },
               "entities_filter": {
                 "$ref": "#/components/schemas/EntitySearchFilter"
+              },
+              "trigger_context": {
+                "$ref": "#/components/schemas/TriggerContext"
               }
             },
             "required": [
               "flow_id",
               "entities_filter"
-            ],
-            "additionalProperties": false
+            ]
           }
         ]
       },
@@ -3338,6 +3355,9 @@
             "description": "Time when the bulk trigger automation executions job was approved",
             "format": "date-time"
           },
+          "trigger_context": {
+            "$ref": "#/components/schemas/TriggerContext"
+          },
           "task_token": {
             "type": "string",
             "description": "Task token to approve/cancel the bulk automation job",
@@ -3473,6 +3493,16 @@
         "type": "string",
         "example": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74"
       },
+      "TriggerContext": {
+        "type": "object",
+        "additionalProperties": {
+          "type": "string"
+        },
+        "description": "Additional contextual data for a bulk trigger automation. This would normally include additional entity IDs you'd need after a listener picks up an event.",
+        "example": {
+          "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
+        }
+      },
       "AutomationTrigger": {
         "type": "object",
         "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/automation-client",
-  "version": "2.18.7",
+  "version": "2.18.9",
   "description": "Client library for epilot automation API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
     "test": "jest",
     "typescript": "tsc",
     "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/automation.yaml",
+    "openapi": "node ../../scripts/update-openapi.js ../../../backend/automation-api/lambda/ApiHandlerFunction/openapi.yml",
     "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",