@epilot/automation-client 2.20.0 → 2.22.0

package/dist/client.js

@@ -15,7 +15,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createClient = exports.getClient = void 0;
-var lambda_powertools_correlation_ids_1 = __importDefault(require("@dazn/lambda-powertools-correlation-ids"));
 var openapi_client_axios_1 = __importDefault(require("openapi-client-axios"));
 var definition_1 = __importDefault(require("./definition"));
 var client;
@@ -30,7 +29,7 @@ var createClient = function () {
     var _a;
     var api = new openapi_client_axios_1.default({ definition: definition_1.default, quick: true });
     var apiClient = api.initSync();
-    apiClient.defaults.headers.common = __assign(__assign({}, ((_a = apiClient.defaults.headers.common) !== null && _a !== void 0 ? _a : {})), (lambda_powertools_correlation_ids_1.default.get() || {}));
+    apiClient.defaults.headers.common = __assign({}, ((_a = apiClient.defaults.headers.common) !== null && _a !== void 0 ? _a : {}));
     return apiClient;
 };
 exports.createClient = createClient;

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={187:function(e,t,o){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var r=n(o(466));t.default=r.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/automation/flows":{"get":{"operationId":"searchFlows","parameters":[{"name":"schema","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"},{"name":"trigger_source_id","in":"query"}],"responses":{}},"post":{"operationId":"createFlow","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/flows/{flow_id}":{"get":{"operationId":"getFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"responses":{}}},"/v1/automation/executions":{"get":{"operationId":"getExecutions","parameters":[{"name":"entity_id","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"}],"responses":{}},"post":{"operationId":"startExecution","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/bulk-jobs":{"post":{"operationId":"bulkTriggerExecutions","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/bulk-jobs/{job_id}":{"get":{"operationId":"getBulkJob","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}},"patch":{"operationId":"patchBulkJob","parameters":[{"name":"job_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/{execution_id}":{"get":{"operationId":"getExecution","parameters":[{"name":"execution_id","in":"path","required":true}],"responses":{}},"delete":{"operationId":"cancelExecution","parameters":[{"name":"execution_id","in":"path","required":true}],"responses":{}}},"/v1/automation/executions/{execution_id}/{action_id}/retrigger":{"post":{"operationId":"retriggerAction","parameters":[{"name":"execution_id","in":"path","required":true},{"name":"action_id","in":"path","required":true}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v1/automation/public/executions:resume":{"post":{"operationId":"resumeExecutionWithToken","requestBody":{"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"NotFoundError":{"content":{"application/json":{}}},"ForbiddenError":{"content":{"application/json":{}}}}}}')}},t={},o=function o(n){var r=t[n];if(void 0!==r)return r.exports;var i=t[n]={exports:{}};return e[n].call(i.exports,i,i.exports,o),i.exports}(187),n=exports;for(var r in o)n[r]=o[r];o.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={330:function(e,t,o){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var r=n(o(466));t.default=r.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/automation/flows":{"get":{"operationId":"searchFlows","parameters":[{"name":"schema","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"},{"name":"trigger_source_id","in":"query"},{"name":"include_flows","in":"query"}],"responses":{}},"post":{"operationId":"createFlow","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/flows/{flow_id}":{"get":{"operationId":"getFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"responses":{}}},"/v1/automation/executions":{"get":{"operationId":"getExecutions","parameters":[{"name":"entity_id","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"},{"name":"include_flows","in":"query"}],"responses":{}},"post":{"operationId":"startExecution","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/bulk-jobs":{"post":{"operationId":"bulkTriggerExecutions","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/bulk-jobs/{job_id}":{"get":{"operationId":"getBulkJob","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}},"patch":{"operationId":"patchBulkJob","parameters":[{"name":"job_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/{execution_id}":{"get":{"operationId":"getExecution","parameters":[{"name":"execution_id","in":"path","required":true}],"responses":{}},"delete":{"operationId":"cancelExecution","parameters":[{"name":"execution_id","in":"path","required":true}],"responses":{}}},"/v1/automation/executions/{execution_id}/{action_id}/retrigger":{"post":{"operationId":"retriggerAction","parameters":[{"name":"execution_id","in":"path","required":true},{"name":"action_id","in":"path","required":true}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v1/automation/public/executions:resume":{"post":{"operationId":"resumeExecutionWithToken","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/executions/{execution_id}/schedules/{schedule_id}":{"delete":{"operationId":"cancelSchedule","parameters":[{"name":"execution_id","in":"path","required":true},{"name":"schedule_id","in":"path","required":true}],"responses":{}}}},"components":{"responses":{"NotFoundError":{"content":{"application/json":{}}},"ForbiddenError":{"content":{"application/json":{}}}}},"servers":[{"url":"https://automation.sls.epilot.io"}]}')}},t={},o=function o(n){var r=t[n];if(void 0!==r)return r.exports;var i=t[n]={exports:{}};return e[n].call(i.exports,i,i.exports,o),i.exports}(330),n=exports;for(var r in o)n[r]=o[r];o.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -24,6 +24,10 @@
           {
             "name": "trigger_source_id",
             "in": "query"
+          },
+          {
+            "name": "include_flows",
+            "in": "query"
           }
         ],
         "responses": {}
@@ -93,6 +97,10 @@
           {
             "name": "from",
             "in": "query"
+          },
+          {
+            "name": "include_flows",
+            "in": "query"
           }
         ],
         "responses": {}
@@ -205,6 +213,24 @@
         },
         "responses": {}
       }
+    },
+    "/v1/automation/executions/{execution_id}/schedules/{schedule_id}": {
+      "delete": {
+        "operationId": "cancelSchedule",
+        "parameters": [
+          {
+            "name": "execution_id",
+            "in": "path",
+            "required": true
+          },
+          {
+            "name": "schedule_id",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "responses": {}
+      }
     }
   },
   "components": {
@@ -220,5 +246,10 @@
         }
       }
     }
-  }
+  },
+  "servers": [
+    {
+      "url": "https://automation.sls.epilot.io"
+    }
+  ]
 }

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;
+        export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerShareEntityAction | TriggerWebhookAction | InformERPAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction | FlowExecutionCancelAction;
         export type AnyActionConfig = /**
          * example:
          * {
@@ -341,7 +341,28 @@ declare namespace Components {
          *   }
          * }
          */
-        SendEmailActionConfig | /* Creates an order entity with prices from journey */ CartCheckoutActionConfig | CustomAction | AutomationActionConfig;
+        SendEmailActionConfig | /* Creates an order entity with prices from journey */ CartCheckoutActionConfig | CustomAction | AutomationActionConfig | /**
+         * example:
+         * {
+         *   "id": "2520gja-2sgmsaga-0asg-822jgal",
+         *   "name": "Cancel Flow Execution",
+         *   "type": "cancel-flow-execution",
+         *   "config": {
+         *     "selected_reasons": [
+         *       {
+         *         "id": "_6kITMwkv_0Uo4i7fO7Ja",
+         *         "title": "when you are done! that's when you close it."
+         *       },
+         *       {
+         *         "id": "qgK9sGbKoS7NxlAbNReVn",
+         *         "title": "Client didn't want our services"
+         *       }
+         *     ],
+         *     "extra_description": "Test cancellation"
+         *   }
+         * }
+         */
+        FlowExecutionCancelActionConfig;
         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`
@@ -771,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:
@@ -778,6 +807,7 @@ declare namespace Components {
              */
             version?: number;
             trigger_event?: TriggerEventManual | TriggerEventEntityActivity | TriggerEventEntityOperation | TriggerEventFlowAutomationTask;
+            workflow_context?: WorkflowExecutionContext;
         }
         /**
          * example:
@@ -893,6 +923,7 @@ declare namespace Components {
              * Source blueprint/manifest ID used when automation is created via blueprints.
              */
             _manifest?: string /* uuid */[] | null;
+            workflow_context?: /* For automation that are connected to workflows V2, this field tracks various information about the workflow. */ WorkflowContext;
         }
         /**
          * ID of the Automation Flow
@@ -951,6 +982,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:
@@ -1028,6 +1067,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
@@ -1036,6 +1083,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
@@ -1062,7 +1117,32 @@ 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
+         */
+        export interface CancellationReason {
+            /**
+             * Unique identifier for the cancellation reason
+             * example:
+             * _6kITMwkv_0Uo4i7fO7Ja
+             */
+            id: string;
+            /**
+             * Human-readable title for the cancellation reason
+             * example:
+             * Process completed successfully
+             */
+            title: string;
+        }
         /**
          * Creates an order entity with prices from journey
          */
@@ -1904,7 +1984,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";
+        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" | "METER_READING_NOT_FOUND" | "ENTITY_NOT_FOUND";
         export interface ErrorDetail {
             explanation: string;
             context?: string;
@@ -1958,6 +2038,152 @@ declare namespace Components {
         export type FilterConditionOnEvent = OrCondition | {
             [name: string]: (string | EqualsIgnoreCaseCondition | AnythingButCondition | NumericCondition | ExistsCondition | PrefixCondition | SuffixCondition | WildcardCondition)[];
         };
+        export interface FlowExecutionCancelAction {
+            id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            flow_action_id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            name?: string;
+            type?: "cancel-flow-execution";
+            config?: /* Configuration for cancelling a flow execution with selected reasons */ FlowExecutionCancelConfig;
+            /**
+             * 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": "Cancel Flow Execution",
+         *   "type": "cancel-flow-execution",
+         *   "config": {
+         *     "selected_reasons": [
+         *       {
+         *         "id": "_6kITMwkv_0Uo4i7fO7Ja",
+         *         "title": "when you are done! that's when you close it."
+         *       },
+         *       {
+         *         "id": "qgK9sGbKoS7NxlAbNReVn",
+         *         "title": "Client didn't want our services"
+         *       }
+         *     ],
+         *     "extra_description": "Test cancellation"
+         *   }
+         * }
+         */
+        export interface FlowExecutionCancelActionConfig {
+            id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            flow_action_id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            name?: string;
+            type?: "cancel-flow-execution";
+            config?: /* Configuration for cancelling a flow execution with selected reasons */ FlowExecutionCancelConfig;
+            /**
+             * 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 cancelling a flow execution with selected reasons
+         */
+        export interface FlowExecutionCancelConfig {
+            /**
+             * List of reasons selected for this specific cancellation
+             */
+            selected_reasons?: /* A reason for cancelling a flow execution */ CancellationReason[];
+            /**
+             * Additional description or notes for the cancellation
+             * example:
+             * Process completed successfully
+             */
+            extra_description?: string;
+        }
         export interface FlowsTrigger {
             /**
              * example:
@@ -2811,14 +3037,15 @@ declare namespace Components {
              * 7791b04a-16d2-44a2-9af9-2d59c25c512f
              */
             AutomationFlowId;
+            workflow_context?: WorkflowExecutionContext;
             /**
-             * ID of the Flow Execution
+             * Use workflow_context.workflow_exec_id instead
              */
             flow_execution_id?: string;
             /**
-             * ID of the automated flow action
+             * Use workflow_context.workflow_exec_task_id instead
              */
-            flow_automation_task_id?: string; // UUID
+            flow_automation_task_id?: string;
         }
         export interface SuffixCondition {
             suffix?: string;
@@ -2835,6 +3062,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";
             /**
@@ -3355,6 +3592,29 @@ declare namespace Components {
         export interface WildcardCondition {
             wildcard?: string;
         }
+        /**
+         * For automation that are connected to workflows V2, this field tracks various information about the workflow.
+         */
+        export interface WorkflowContext {
+            /**
+             * The ID of the workflow this automation is connected to
+             */
+            workflow_id: string; // uuid
+            /**
+             * The ID of the task in the workflow that this automation is connected to
+             */
+            task_id?: string; // uuid
+            workflow_role: /* The role this automation plays in the workflow. */ WorkflowContextRole;
+        }
+        /**
+         * The role this automation plays in the workflow.
+         */
+        export type WorkflowContextRole = "trigger_workflow" | "run_task_automation";
+        export interface WorkflowExecutionContext {
+            workflow_exec_id: string;
+            workflow_exec_task_id?: string;
+            workflow_role: /* The role this automation plays in the workflow. */ WorkflowContextRole;
+        }
     }
 }
 declare namespace Paths {
@@ -3403,6 +3663,39 @@ declare namespace Paths {
             Components.Responses.NotFoundError;
         }
     }
+    namespace CancelSchedule {
+        namespace Parameters {
+            export type ExecutionId = /**
+             * example:
+             * 9baf184f-bc81-4128-bca3-d974c90a12c4
+             */
+            Components.Schemas.AutomationExecutionId;
+            export type ScheduleId = string;
+        }
+        export interface PathParameters {
+            execution_id: Parameters.ExecutionId;
+            schedule_id: Parameters.ScheduleId;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.ActionSchedule;
+            export type $403 = /**
+             * example:
+             * {
+             *   "status": 403,
+             *   "error": "Forbidden"
+             * }
+             */
+            Components.Responses.ForbiddenError;
+            export type $404 = /**
+             * example:
+             * {
+             *   "status": 404,
+             *   "error": "Not Found"
+             * }
+             */
+            Components.Responses.NotFoundError;
+        }
+    }
     namespace CreateFlow {
         export type RequestBody = Components.Schemas.AutomationFlow;
         namespace Responses {
@@ -3521,12 +3814,14 @@ declare namespace Paths {
              */
             Components.Schemas.EntityId;
             export type From = number;
+            export type IncludeFlows = boolean;
             export type Size = number;
         }
         export interface QueryParameters {
             entity_id?: Parameters.EntityId;
             size?: Parameters.Size;
             from?: Parameters.From;
+            include_flows?: Parameters.IncludeFlows;
         }
         namespace Responses {
             export type $200 = Components.Schemas.GetExecutionsResp;
@@ -3696,6 +3991,7 @@ declare namespace Paths {
     namespace SearchFlows {
         namespace Parameters {
             export type From = number;
+            export type IncludeFlows = boolean;
             /**
              * example:
              * submission
@@ -3721,6 +4017,7 @@ declare namespace Paths {
              * 600945fe-212e-4b97-acf7-391d64648384
              */
             Parameters.TriggerSourceId;
+            include_flows?: Parameters.IncludeFlows;
         }
         namespace Responses {
             export type $200 = Components.Schemas.SearchAutomationsResp;
@@ -3889,6 +4186,16 @@ export interface OperationMethods {
     data?: Paths.ResumeExecutionWithToken.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ResumeExecutionWithToken.Responses.$200>
+  /**
+   * cancelSchedule - cancelSchedule
+   * 
+   * Cancel a scheduled automation
+   */
+  'cancelSchedule'(
+    parameters?: Parameters<Paths.CancelSchedule.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CancelSchedule.Responses.$200>
 }
 
 export interface PathsDictionary {
@@ -4053,6 +4360,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ResumeExecutionWithToken.Responses.$200>
   }
+  ['/v1/automation/executions/{execution_id}/schedules/{schedule_id}']: {
+    /**
+     * cancelSchedule - cancelSchedule
+     * 
+     * Cancel a scheduled automation
+     */
+    'delete'(
+      parameters?: Parameters<Paths.CancelSchedule.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CancelSchedule.Responses.$200>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
@@ -4082,6 +4401,7 @@ export type AutomationFlowId = Components.Schemas.AutomationFlowId;
 export type AutomationTrigger = Components.Schemas.AutomationTrigger;
 export type BulkTriggerJob = Components.Schemas.BulkTriggerJob;
 export type BulkTriggerRequest = Components.Schemas.BulkTriggerRequest;
+export type CancellationReason = Components.Schemas.CancellationReason;
 export type CartCheckoutAction = Components.Schemas.CartCheckoutAction;
 export type CartCheckoutActionConfig = Components.Schemas.CartCheckoutActionConfig;
 export type CartCheckoutConfig = Components.Schemas.CartCheckoutConfig;
@@ -4112,6 +4432,9 @@ export type ExecItem = Components.Schemas.ExecItem;
 export type ExecutionStatus = Components.Schemas.ExecutionStatus;
 export type ExistsCondition = Components.Schemas.ExistsCondition;
 export type FilterConditionOnEvent = Components.Schemas.FilterConditionOnEvent;
+export type FlowExecutionCancelAction = Components.Schemas.FlowExecutionCancelAction;
+export type FlowExecutionCancelActionConfig = Components.Schemas.FlowExecutionCancelActionConfig;
+export type FlowExecutionCancelConfig = Components.Schemas.FlowExecutionCancelConfig;
 export type FlowsTrigger = Components.Schemas.FlowsTrigger;
 export type FrontendSubmitTrigger = Components.Schemas.FrontendSubmitTrigger;
 export type GetExecutionsResp = Components.Schemas.GetExecutionsResp;
@@ -4152,6 +4475,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;
@@ -4167,3 +4491,6 @@ export type TriggerWorkflowActionConfig = Components.Schemas.TriggerWorkflowActi
 export type TriggerWorkflowCondition = Components.Schemas.TriggerWorkflowCondition;
 export type TriggerWorkflowConfig = Components.Schemas.TriggerWorkflowConfig;
 export type WildcardCondition = Components.Schemas.WildcardCondition;
+export type WorkflowContext = Components.Schemas.WorkflowContext;
+export type WorkflowContextRole = Components.Schemas.WorkflowContextRole;
+export type WorkflowExecutionContext = Components.Schemas.WorkflowExecutionContext;

package/dist/openapi.json

@@ -69,6 +69,15 @@
               "type": "string",
               "example": "600945fe-212e-4b97-acf7-391d64648384"
             }
+          },
+          {
+            "name": "include_flows",
+            "in": "query",
+            "description": "Include flow automations in the response",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
           }
         ],
         "responses": {
@@ -261,6 +270,15 @@
               "type": "integer",
               "default": 0
             }
+          },
+          {
+            "name": "include_flows",
+            "in": "query",
+            "description": "Include flow automations in the response",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
           }
         ],
         "tags": [
@@ -574,7 +592,10 @@
                     "entity_schema": "opportunity",
                     "entity_id": "b35a6c51-2a15-4ef1-9623-20db37b0744f"
                   }
-                ]
+                ],
+                "trigger_context": {
+                  "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
+                }
               }
             }
           }
@@ -853,6 +874,53 @@
           }
         }
       }
+    },
+    "/v1/automation/executions/{execution_id}/schedules/{schedule_id}": {
+      "delete": {
+        "operationId": "cancelSchedule",
+        "summary": "cancelSchedule",
+        "description": "Cancel a scheduled automation",
+        "parameters": [
+          {
+            "name": "execution_id",
+            "in": "path",
+            "schema": {
+              "$ref": "#/components/schemas/AutomationExecutionId"
+            },
+            "required": true
+          },
+          {
+            "name": "schedule_id",
+            "in": "path",
+            "schema": {
+              "type": "string"
+            },
+            "required": true,
+            "description": "ID of the schedule to cancel"
+          }
+        ],
+        "tags": [
+          "executions"
+        ],
+        "responses": {
+          "200": {
+            "description": "The schedule was successfully cancelled",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ActionSchedule"
+                }
+              }
+            }
+          },
+          "403": {
+            "$ref": "#/components/responses/ForbiddenError"
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
+          }
+        }
+      }
     }
   },
   "components": {
@@ -1020,6 +1088,9 @@
               "example": "123e4567-e89b-12d3-a456-426614174000"
             },
             "nullable": true
+          },
+          "workflow_context": {
+            "$ref": "#/components/schemas/WorkflowContext"
           }
         },
         "required": [
@@ -1028,6 +1099,37 @@
           "actions"
         ]
       },
+      "WorkflowContext": {
+        "type": "object",
+        "description": "For automation that are connected to workflows V2, this field tracks various information about the workflow.",
+        "required": [
+          "workflow_id",
+          "workflow_role"
+        ],
+        "properties": {
+          "workflow_id": {
+            "type": "string",
+            "format": "uuid",
+            "description": "The ID of the workflow this automation is connected to"
+          },
+          "task_id": {
+            "type": "string",
+            "format": "uuid",
+            "description": "The ID of the task in the workflow that this automation is connected to"
+          },
+          "workflow_role": {
+            "$ref": "#/components/schemas/WorkflowContextRole"
+          }
+        }
+      },
+      "WorkflowContextRole": {
+        "type": "string",
+        "description": "The role this automation plays in the workflow.",
+        "enum": [
+          "trigger_workflow",
+          "run_task_automation"
+        ]
+      },
       "SearchAutomationsResp": {
         "type": "object",
         "properties": {
@@ -1105,6 +1207,9 @@
           },
           {
             "$ref": "#/components/schemas/AutomationAction"
+          },
+          {
+            "$ref": "#/components/schemas/FlowExecutionCancelAction"
           }
         ]
       },
@@ -1139,6 +1244,9 @@
           },
           {
             "$ref": "#/components/schemas/AutomationActionConfig"
+          },
+          {
+            "$ref": "#/components/schemas/FlowExecutionCancelActionConfig"
           }
         ]
       },
@@ -1282,7 +1390,15 @@
           "TRIGGER_WEBHOOK_ERROR",
           "TEMPLATE_ERROR",
           "INVALID_PAYLOAD",
-          "INVALID_SCHEDULE_CONFIG"
+          "INVALID_SCHEDULE_CONFIG",
+          "CUSTOM_ACTION_ERROR",
+          "ORDER_CREATION_ERROR",
+          "DOCUMENT_GENERATION_ERROR",
+          "BULK_EMAIL_ERROR",
+          "SHARING_ERROR",
+          "CANCEL_FLOW_EXECUTION_ERROR",
+          "METER_READING_NOT_FOUND",
+          "ENTITY_NOT_FOUND"
         ]
       },
       "ErrorDetail": {
@@ -2502,6 +2618,105 @@
           }
         }
       },
+      "FlowExecutionCancelActionConfig": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AutomationActionConfig"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": [
+                  "cancel-flow-execution"
+                ]
+              },
+              "config": {
+                "$ref": "#/components/schemas/FlowExecutionCancelConfig"
+              }
+            }
+          }
+        ],
+        "example": {
+          "id": "2520gja-2sgmsaga-0asg-822jgal",
+          "name": "Cancel Flow Execution",
+          "type": "cancel-flow-execution",
+          "config": {
+            "selected_reasons": [
+              {
+                "id": "_6kITMwkv_0Uo4i7fO7Ja",
+                "title": "when you are done! that's when you close it."
+              },
+              {
+                "id": "qgK9sGbKoS7NxlAbNReVn",
+                "title": "Client didn't want our services"
+              }
+            ],
+            "extra_description": "Test cancellation"
+          }
+        }
+      },
+      "FlowExecutionCancelAction": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AutomationAction"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": [
+                  "cancel-flow-execution"
+                ]
+              },
+              "config": {
+                "$ref": "#/components/schemas/FlowExecutionCancelConfig"
+              }
+            }
+          }
+        ]
+      },
+      "FlowExecutionCancelConfig": {
+        "type": "object",
+        "description": "Configuration for cancelling a flow execution with selected reasons",
+        "properties": {
+          "selected_reasons": {
+            "type": "array",
+            "description": "List of reasons selected for this specific cancellation",
+            "items": {
+              "$ref": "#/components/schemas/CancellationReason"
+            }
+          },
+          "extra_description": {
+            "type": "string",
+            "description": "Additional description or notes for the cancellation",
+            "example": "Process completed successfully"
+          }
+        },
+        "required": [
+          "configured_reasons"
+        ]
+      },
+      "CancellationReason": {
+        "type": "object",
+        "description": "A reason for cancelling a flow execution",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier for the cancellation reason",
+            "example": "_6kITMwkv_0Uo4i7fO7Ja"
+          },
+          "title": {
+            "type": "string",
+            "description": "Human-readable title for the cancellation reason",
+            "example": "Process completed successfully"
+          }
+        },
+        "required": [
+          "id",
+          "title"
+        ]
+      },
       "ConditionStatement": {
         "type": "object",
         "properties": {
@@ -2772,6 +2987,9 @@
           "resume_token": {
             "$ref": "#/components/schemas/ResumeToken"
           },
+          "trigger_context": {
+            "$ref": "#/components/schemas/TriggerContext"
+          },
           "version": {
             "type": "number",
             "description": "Version of the flow",
@@ -2792,6 +3010,9 @@
                 "$ref": "#/components/schemas/TriggerEventFlowAutomationTask"
               }
             ]
+          },
+          "workflow_context": {
+            "$ref": "#/components/schemas/WorkflowExecutionContext"
           }
         },
         "required": [
@@ -2803,6 +3024,24 @@
           "actions"
         ]
       },
+      "WorkflowExecutionContext": {
+        "type": "object",
+        "required": [
+          "workflow_exec_id",
+          "workflow_role"
+        ],
+        "properties": {
+          "workflow_exec_id": {
+            "type": "string"
+          },
+          "workflow_exec_task_id": {
+            "type": "string"
+          },
+          "workflow_role": {
+            "$ref": "#/components/schemas/WorkflowContextRole"
+          }
+        }
+      },
       "TriggerEventManual": {
         "type": "object",
         "properties": {
@@ -3027,14 +3266,18 @@
           "flow_id": {
             "$ref": "#/components/schemas/AutomationFlowId"
           },
+          "workflow_context": {
+            "$ref": "#/components/schemas/WorkflowExecutionContext"
+          },
           "flow_execution_id": {
             "type": "string",
-            "description": "ID of the Flow Execution"
+            "deprecated": true,
+            "description": "Use workflow_context.workflow_exec_id instead"
           },
           "flow_automation_task_id": {
             "type": "string",
-            "format": "UUID",
-            "description": "ID of the automated flow action"
+            "deprecated": true,
+            "description": "Use workflow_context.workflow_exec_task_id instead"
           }
         },
         "required": [
@@ -3074,13 +3317,15 @@
                 "items": {
                   "$ref": "#/components/schemas/EntityRef"
                 }
+              },
+              "trigger_context": {
+                "$ref": "#/components/schemas/TriggerContext"
               }
             },
             "required": [
               "flow_id",
               "entities_refs"
-            ],
-            "additionalProperties": false
+            ]
           },
           {
             "type": "object",
@@ -3090,13 +3335,15 @@
               },
               "entities_query": {
                 "type": "string"
+              },
+              "trigger_context": {
+                "$ref": "#/components/schemas/TriggerContext"
               }
             },
             "required": [
               "flow_id",
               "entities_query"
-            ],
-            "additionalProperties": false
+            ]
           },
           {
             "type": "object",
@@ -3106,13 +3353,15 @@
               },
               "entities_filter": {
                 "$ref": "#/components/schemas/EntitySearchFilter"
+              },
+              "trigger_context": {
+                "$ref": "#/components/schemas/TriggerContext"
               }
             },
             "required": [
               "flow_id",
               "entities_filter"
-            ],
-            "additionalProperties": false
+            ]
           }
         ]
       },
@@ -3185,6 +3434,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",
@@ -3320,6 +3572,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": {
@@ -4256,5 +4518,10 @@
         }
       }
     }
-  }
+  },
+  "servers": [
+    {
+      "url": "https://automation.sls.epilot.io"
+    }
+  ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/automation-client",
-  "version": "2.20.0",
+  "version": "2.22.0",
   "description": "Client library for epilot automation API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,13 +25,13 @@
     "test": "jest",
     "typescript": "tsc",
     "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js /Users/sureshs/workspace/automation-api/lambda/ApiHandlerFunction/openapi.yml",
+    "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": "../../node_modules/eslint/bin/eslint.js src"
+    "lint": "pnpm exec eslint src"
   },
   "files": [
     "*.js",
@@ -50,7 +50,6 @@
     "axios": "^1.6.2"
   },
   "dependencies": {
-    "@dazn/lambda-powertools-correlation-ids": "^1.28.1",
     "buffer": "^6.0.3",
     "https-browserify": "^1.0.0",
     "stream-http": "^3.1.1",
@@ -66,8 +65,8 @@
     "jest": "^26.6.3",
     "json-loader": "^0.5.7",
     "node-fetch": "^3.2.10",
-    "openapi-client-axios": "^7.5.1",
-    "openapicmd": "^2.6.2",
+    "openapi-client-axios": "^7.6.0",
+    "openapicmd": "^2.7.0",
     "ts-jest": "^26.5.0",
     "ts-loader": "^8.0.14",
     "ts-node": "^10.9.1",