@epilot/automation-client 2.17.3 → 2.18.1

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={914: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(240));t.default=r.default},240: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":{}}}}},"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}(914),n=exports;for(var r in o)n[r]=o[r];o.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={914: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(240));t.default=r.default},240: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":{}}},"/v1/automation/executions/{execution_id}/{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}(914),n=exports;for(var r in o)n[r]=o[r];o.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -205,6 +205,24 @@
         },
         "responses": {}
       }
+    },
+    "/v1/automation/executions/{execution_id}/{schedule_id}": {
+      "delete": {
+        "operationId": "cancelSchedule",
+        "parameters": [
+          {
+            "name": "execution_id",
+            "in": "path",
+            "required": true
+          },
+          {
+            "name": "schedule_id",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "responses": {}
+      }
     }
   },
   "components": {

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`
@@ -745,6 +766,7 @@ declare namespace Components {
              */
             OrganizationId;
             flow_id: /**
+             * ID of the Automation Flow
              * example:
              * 7791b04a-16d2-44a2-9af9-2d59c25c512f
              */
@@ -776,7 +798,7 @@ declare namespace Components {
              * 2
              */
             version?: number;
-            trigger_event?: TriggerEventManual | TriggerEventEntityActivity | TriggerEventEntityOperation;
+            trigger_event?: TriggerEventManual | TriggerEventEntityActivity | TriggerEventEntityOperation | TriggerEventFlowAutomationTask;
         }
         /**
          * example:
@@ -785,6 +807,7 @@ declare namespace Components {
         export type AutomationExecutionId = string;
         export interface AutomationFlow {
             id?: /**
+             * ID of the Automation Flow
              * example:
              * 7791b04a-16d2-44a2-9af9-2d59c25c512f
              */
@@ -833,7 +856,7 @@ declare namespace Components {
             /**
              * The actions (nodes) of the automation flow
              */
-            actions: AnyActionConfig[];
+            actions: AnyAction[];
             /**
              * Number of automation executions that ran
              * example:
@@ -893,6 +916,7 @@ declare namespace Components {
             _manifest?: string /* uuid */[] | null;
         }
         /**
+         * ID of the Automation Flow
          * example:
          * 7791b04a-16d2-44a2-9af9-2d59c25c512f
          */
@@ -917,6 +941,7 @@ declare namespace Components {
              */
             OrganizationId;
             flow_id: /**
+             * ID of the Automation Flow
              * example:
              * 7791b04a-16d2-44a2-9af9-2d59c25c512f
              */
@@ -924,15 +949,17 @@ declare namespace Components {
             /**
              * Status of the bulk trigger automation job
              * * approval: Waiting for user approval to start the bulk trigger automation
-             * * starting: Starting automation executions
-             * * in_progress: Automation execution are currently running
+             * * querying_entities: Loading entities in batches
+             * * entities_loaded: All entities have been loaded and stored
+             * * executing: Automation execution are currently running
+             * * monitoring: All executions have been started, now monitoring their completion
              * * send_report: Automation executions finished running. Report is being created & sent to the user who initiated the bulk trigger automation
              * * finished: Automation executions finished running. Some may have failed. Check the status of each entity.
              * * failed: Bulk trigger automation execution failed. Some executions might have started. Check the status of each entity.
              * * cancelled: Bulk trigger automation execution was cancelled
              *
              */
-            status: "approval" | "starting" | "in_progress" | "send_report" | "finished" | "failed" | "cancelled";
+            status: "approval" | "querying_entities" | "entities_loaded" | "executing" | "monitoring" | "send_report" | "finished" | "failed" | "cancelled";
             /**
              * User ID who created the bulk trigger automation job
              * example:
@@ -955,13 +982,68 @@ declare namespace Components {
              * Entity ID of the report file entity
              */
             report_file_entity_id?: string;
+            /**
+             * Query configuration for loading entities
+             */
+            entity_query?: {
+                type: "refs" | "query" | "filter";
+                data: EntityRef[] | string | /**
+                 * A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
+                 * example:
+                 * [
+                 *   {
+                 *     "term": {
+                 *       "_schema": "contact"
+                 *     }
+                 *   },
+                 *   {
+                 *     "terms": {
+                 *       "status": [
+                 *         "active"
+                 *       ]
+                 *     }
+                 *   }
+                 * ]
+                 */
+                EntitySearchFilter;
+            };
+            /**
+             * Pagination state for entity loading
+             */
+            pagination_state?: {
+                /**
+                 * Number of entities per page
+                 */
+                page_size?: number;
+                /**
+                 * Number of pages processed so far
+                 */
+                pages_processed?: number;
+                /**
+                 * Total number of entities processed so far
+                 */
+                total_processed?: number;
+                /**
+                 * Stable query ID for pagination
+                 */
+                stable_query_id?: string;
+                /**
+                 * Last sort value used for pagination
+                 */
+                search_after?: (string | number)[];
+                /**
+                 * Whether there are more entities to load
+                 */
+                has_more?: boolean;
+            };
             /**
              * List of entities & their automation execution id & status
              */
-            execution_summary: /* Execution item for bulk trigger automation. It maps each entity to its automation execution id & status */ ExecItem[];
+            execution_summary?: /* Execution item for bulk trigger automation. It maps each entity to its automation execution id & status */ ExecItem[];
         }
         export type BulkTriggerRequest = {
             flow_id: /**
+             * ID of the Automation Flow
              * example:
              * 7791b04a-16d2-44a2-9af9-2d59c25c512f
              */
@@ -969,6 +1051,7 @@ declare namespace Components {
             entities_refs: EntityRef[];
         } | {
             flow_id: /**
+             * ID of the Automation Flow
              * example:
              * 7791b04a-16d2-44a2-9af9-2d59c25c512f
              */
@@ -976,6 +1059,7 @@ declare namespace Components {
             entities_query: string;
         } | {
             flow_id: /**
+             * ID of the Automation Flow
              * example:
              * 7791b04a-16d2-44a2-9af9-2d59c25c512f
              */
@@ -1000,6 +1084,23 @@ declare namespace Components {
              */
             EntitySearchFilter;
         };
+        /**
+         * 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
          */
@@ -1888,13 +1989,159 @@ declare namespace Components {
              */
             error?: string;
         }
-        export type ExecutionStatus = "pending" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot";
+        export type ExecutionStatus = "pending" | "starting" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled" | "hot";
         export interface ExistsCondition {
             exists?: boolean;
         }
         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:
@@ -1903,14 +2150,7 @@ declare namespace Components {
             id?: string; // uuid
             type: "flows_trigger";
             configuration: {
-                /**
-                 * ID of the flow that triggers the automation
-                 */
                 source_id: string; // uuid
-                /**
-                 * Certain flows can be triggered automatically by a journey, this is the ID of that journey
-                 */
-                journey_id?: string; // uuid
             };
         }
         export interface FrontendSubmitTrigger {
@@ -2750,10 +2990,19 @@ declare namespace Components {
              */
             EntityId;
             flow_id: /**
+             * ID of the Automation Flow
              * example:
              * 7791b04a-16d2-44a2-9af9-2d59c25c512f
              */
             AutomationFlowId;
+            /**
+             * ID of the Flow Execution
+             */
+            flow_execution_id?: string;
+            /**
+             * ID of the automated flow action
+             */
+            flow_automation_task_id?: string; // UUID
         }
         export interface SuffixCondition {
             suffix?: string;
@@ -2808,6 +3057,30 @@ declare namespace Components {
             ActivityId;
             operation_type: EntityOperation;
         }
+        export interface TriggerEventFlowAutomationTask {
+            type?: "flow_automation_task";
+            /**
+             * example:
+             * 123
+             */
+            org_id: string;
+            entity_id: /**
+             * example:
+             * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+             */
+            EntityId;
+            /**
+             * example:
+             * wfwAJoT_cK
+             */
+            flow_execution_id: string;
+            /**
+             * example:
+             * 2fa221ec-3aac-4655-ab8f-c062eca44a3
+             */
+            flow_automation_task_id: string; // UUID
+            caller?: ApiCallerContext;
+        }
         export interface TriggerEventManual {
             type?: "manual";
             /**
@@ -3314,6 +3587,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 {
@@ -3331,6 +3637,7 @@ declare namespace Paths {
     namespace DeleteFlow {
         namespace Parameters {
             export type FlowId = /**
+             * ID of the Automation Flow
              * example:
              * 7791b04a-16d2-44a2-9af9-2d59c25c512f
              */
@@ -3453,6 +3760,7 @@ declare namespace Paths {
     namespace GetFlow {
         namespace Parameters {
             export type FlowId = /**
+             * ID of the Automation Flow
              * example:
              * 7791b04a-16d2-44a2-9af9-2d59c25c512f
              */
@@ -3517,6 +3825,7 @@ declare namespace Paths {
     namespace PutFlow {
         namespace Parameters {
             export type FlowId = /**
+             * ID of the Automation Flow
              * example:
              * 7791b04a-16d2-44a2-9af9-2d59c25c512f
              */
@@ -3796,6 +4105,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 {
@@ -3960,6 +4279,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ResumeExecutionWithToken.Responses.$200>
   }
+  ['/v1/automation/executions/{execution_id}/{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>
@@ -3988,6 +4319,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;
@@ -4018,6 +4350,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;
@@ -4060,6 +4395,7 @@ export type SuffixCondition = Components.Schemas.SuffixCondition;
 export type TriggerCondition = Components.Schemas.TriggerCondition;
 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 TriggerShareEntityAction = Components.Schemas.TriggerShareEntityAction;
 export type TriggerShareEntityActionConfig = Components.Schemas.TriggerShareEntityActionConfig;

package/dist/openapi.json

@@ -273,6 +273,241 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/GetExecutionsResp"
+                },
+                "examples": {
+                  "manual_trigger": {
+                    "summary": "Manual trigger execution",
+                    "value": {
+                      "total": 1,
+                      "results": [
+                        {
+                          "id": "9baf184f-bc81-4128-bca3-d974c90a12c4",
+                          "execution_status": "success",
+                          "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
+                          "org_id": "123",
+                          "flow_id": "7791b04a-16d2-44a2-9af9-2d59c25c512f",
+                          "flow_name": "Handle contact form",
+                          "created_at": "2023-01-01T10:00:00Z",
+                          "updated_at": "2023-01-01T10:05:00Z",
+                          "actions": [],
+                          "version": 1,
+                          "trigger_event": {
+                            "type": "manual",
+                            "org_id": "123",
+                            "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
+                            "caller": {
+                              "EpilotAuth": {
+                                "claims": {
+                                  "userId": "10006129",
+                                  "email": "user@epilot.cloud"
+                                },
+                                "userId": "10006129",
+                                "organizationId": "123"
+                              }
+                            }
+                          }
+                        }
+                      ]
+                    }
+                  },
+                  "entity_operation_trigger": {
+                    "summary": "Entity operation trigger execution",
+                    "value": {
+                      "total": 1,
+                      "results": [
+                        {
+                          "id": "8cdf274e-ab70-4029-9ca2-c863b80a11c3",
+                          "execution_status": "in_progress",
+                          "entity_id": "f4e4fcbd-cbcc-4496-bf5f-60c6ce2c621e",
+                          "activity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
+                          "org_id": "123",
+                          "flow_id": "8e2e067e-3c63-4b1a-8e02-6150a3d1fd89",
+                          "flow_name": "Contact updated automation",
+                          "created_at": "2023-01-01T12:00:00Z",
+                          "updated_at": "2023-01-01T12:02:00Z",
+                          "actions": [],
+                          "version": 1,
+                          "trigger_event": {
+                            "type": "entity_operation",
+                            "entity_id": "f4e4fcbd-cbcc-4496-bf5f-60c6ce2c621e",
+                            "org_id": "123",
+                            "activity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
+                            "operation_type": "updateEntity"
+                          }
+                        }
+                      ]
+                    }
+                  },
+                  "entity_activity_trigger": {
+                    "summary": "Entity activity trigger execution",
+                    "value": {
+                      "total": 1,
+                      "results": [
+                        {
+                          "id": "7bde163d-9a5f-3f18-8b92-d752a79a10b2",
+                          "execution_status": "failed",
+                          "entity_id": "c2b1a9d8-7e6f-5040-3029-180716253f4e",
+                          "activity_id": "b3c4d5e6-f7a8-9012-3456-789012bcdef0",
+                          "org_id": "123",
+                          "flow_id": "6d1d956d-2b52-4a0a-9e01-5049a2c0ee78",
+                          "flow_name": "Document upload handler",
+                          "created_at": "2023-01-01T14:00:00Z",
+                          "updated_at": "2023-01-01T14:01:30Z",
+                          "actions": [],
+                          "version": 1,
+                          "trigger_event": {
+                            "type": "entity_activity",
+                            "org_id": "123",
+                            "activity_id": "b3c4d5e6-f7a8-9012-3456-789012bcdef0",
+                            "activity_type": "DocUploadedFromPortal",
+                            "entity_id": "c2b1a9d8-7e6f-5040-3029-180716253f4e"
+                          }
+                        }
+                      ]
+                    }
+                  },
+                  "flow_automation_task_trigger": {
+                    "summary": "Flow automation task trigger execution",
+                    "value": {
+                      "total": 1,
+                      "results": [
+                        {
+                          "id": "5ade051c-8a4e-2e07-7a81-c641968a0fa1",
+                          "execution_status": "paused",
+                          "entity_id": "d3c2b1a0-8f7e-6d5c-4b3a-291807364e5f",
+                          "org_id": "123",
+                          "flow_id": "9f0f178f-4c74-5b2b-af12-6160b3d1ee89",
+                          "flow_name": "Journey completion follow-up",
+                          "created_at": "2023-01-01T16:00:00Z",
+                          "updated_at": "2023-01-01T16:03:00Z",
+                          "actions": [],
+                          "version": 1,
+                          "resume_token": "eyJraWQiOiJrZXkifQ==",
+                          "trigger_event": {
+                            "type": "flow_automation_task",
+                            "org_id": "123",
+                            "entity_id": "d3c2b1a0-8f7e-6d5c-4b3a-291807364e5f",
+                            "flow_execution_id": "wfwAJoT_cK",
+                            "flow_automation_task_id": "2fa221ec-3aac-4655-ab8f-c062eca44a3",
+                            "caller": {
+                              "EpilotAuth": {
+                                "claims": {
+                                  "userId": "10006129",
+                                  "email": "user@epilot.cloud"
+                                },
+                                "userId": "10006129",
+                                "organizationId": "123"
+                              }
+                            }
+                          }
+                        }
+                      ]
+                    }
+                  },
+                  "mixed_execution_statuses": {
+                    "summary": "Multiple executions with different trigger types and statuses",
+                    "value": {
+                      "total": 4,
+                      "results": [
+                        {
+                          "id": "1aef262e-9b5f-4f29-8c93-e763b90b21d3",
+                          "execution_status": "success",
+                          "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
+                          "org_id": "123",
+                          "flow_id": "7791b04a-16d2-44a2-9af9-2d59c25c512f",
+                          "flow_name": "Send welcome email",
+                          "created_at": "2023-01-01T09:00:00Z",
+                          "updated_at": "2023-01-01T09:02:00Z",
+                          "actions": [],
+                          "version": 2,
+                          "trigger_event": {
+                            "type": "manual",
+                            "org_id": "123",
+                            "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
+                            "caller": {
+                              "EpilotAuth": {
+                                "claims": {
+                                  "userId": "10006129",
+                                  "email": "admin@epilot.cloud"
+                                },
+                                "userId": "10006129",
+                                "organizationId": "123"
+                              }
+                            }
+                          }
+                        },
+                        {
+                          "id": "2bef373f-ac60-5039-9da4-f874ca1c32e4",
+                          "execution_status": "in_progress",
+                          "entity_id": "f4e4fcbd-cbcc-4496-bf5f-60c6ce2c621e",
+                          "activity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
+                          "org_id": "123",
+                          "flow_id": "8e2e067e-3c63-4b1a-8e02-6150a3d1fd89",
+                          "flow_name": "Update CRM system",
+                          "created_at": "2023-01-01T10:30:00Z",
+                          "updated_at": "2023-01-01T10:31:00Z",
+                          "actions": [],
+                          "version": 1,
+                          "trigger_event": {
+                            "type": "entity_operation",
+                            "entity_id": "f4e4fcbd-cbcc-4496-bf5f-60c6ce2c621e",
+                            "org_id": "123",
+                            "activity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
+                            "operation_type": "createEntity"
+                          }
+                        },
+                        {
+                          "id": "3cef484g-bd71-6149-ae04-0985db2d43f5",
+                          "execution_status": "failed",
+                          "entity_id": "c2b1a9d8-7e6f-5040-3029-180716253f4e",
+                          "activity_id": "b3c4d5e6-f7a8-9012-3456-789012bcdef0",
+                          "org_id": "123",
+                          "flow_id": "6d1d956d-2b52-4a0a-9e01-5049a2c0ee78",
+                          "flow_name": "Generate invoice",
+                          "created_at": "2023-01-01T11:15:00Z",
+                          "updated_at": "2023-01-01T11:16:30Z",
+                          "actions": [],
+                          "version": 1,
+                          "trigger_event": {
+                            "type": "entity_activity",
+                            "org_id": "123",
+                            "activity_id": "b3c4d5e6-f7a8-9012-3456-789012bcdef0",
+                            "activity_type": "CreateMeterReading",
+                            "entity_id": "c2b1a9d8-7e6f-5040-3029-180716253f4e"
+                          }
+                        },
+                        {
+                          "id": "4def595h-ce82-7259-bf15-1a96ec3e54g6",
+                          "execution_status": "scheduled",
+                          "entity_id": "d3c2b1a0-8f7e-6d5c-4b3a-291807364e5f",
+                          "org_id": "123",
+                          "flow_id": "9f0f178f-4c74-5b2b-af12-6160b3d1ee89",
+                          "flow_name": "Scheduled reminder",
+                          "created_at": "2023-01-01T12:45:00Z",
+                          "updated_at": "2023-01-01T12:45:00Z",
+                          "actions": [],
+                          "version": 1,
+                          "trigger_event": {
+                            "type": "flow_automation_task",
+                            "org_id": "123",
+                            "entity_id": "d3c2b1a0-8f7e-6d5c-4b3a-291807364e5f",
+                            "flow_execution_id": "xgxBKpU_dL",
+                            "flow_automation_task_id": "3gb332fd-4bbd-5766-bc9g-d173fdb55b4",
+                            "caller": {
+                              "EpilotAuth": {
+                                "claims": {
+                                  "userId": "10006130",
+                                  "email": "scheduler@epilot.cloud"
+                                },
+                                "userId": "10006130",
+                                "organizationId": "123"
+                              }
+                            }
+                          }
+                        }
+                      ]
+                    }
+                  }
                 }
               }
             }
@@ -618,6 +853,53 @@
           }
         }
       }
+    },
+    "/v1/automation/executions/{execution_id}/{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": {
@@ -631,6 +913,7 @@
     "schemas": {
       "AutomationFlowId": {
         "type": "string",
+        "description": "ID of the Automation Flow",
         "example": "7791b04a-16d2-44a2-9af9-2d59c25c512f",
         "readOnly": true
       },
@@ -712,7 +995,7 @@
             "type": "array",
             "description": "The actions (nodes) of the automation flow",
             "items": {
-              "$ref": "#/components/schemas/AnyActionConfig"
+              "$ref": "#/components/schemas/AnyAction"
             },
             "readOnly": true
           },
@@ -869,6 +1152,9 @@
           },
           {
             "$ref": "#/components/schemas/AutomationAction"
+          },
+          {
+            "$ref": "#/components/schemas/FlowExecutionCancelAction"
           }
         ]
       },
@@ -903,6 +1189,9 @@
           },
           {
             "$ref": "#/components/schemas/AutomationActionConfig"
+          },
+          {
+            "$ref": "#/components/schemas/FlowExecutionCancelActionConfig"
           }
         ]
       },
@@ -2266,6 +2555,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": {
@@ -2551,6 +2939,9 @@
               },
               {
                 "$ref": "#/components/schemas/TriggerEventEntityOperation"
+              },
+              {
+                "$ref": "#/components/schemas/TriggerEventFlowAutomationTask"
               }
             ]
           }
@@ -2589,6 +2980,42 @@
           "entity_id"
         ]
       },
+      "TriggerEventFlowAutomationTask": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "flow_automation_task"
+            ]
+          },
+          "org_id": {
+            "type": "string",
+            "example": "123"
+          },
+          "entity_id": {
+            "$ref": "#/components/schemas/EntityId"
+          },
+          "flow_execution_id": {
+            "type": "string",
+            "example": "wfwAJoT_cK"
+          },
+          "flow_automation_task_id": {
+            "type": "string",
+            "format": "UUID",
+            "example": "2fa221ec-3aac-4655-ab8f-c062eca44a3"
+          },
+          "caller": {
+            "$ref": "#/components/schemas/ApiCallerContext"
+          }
+        },
+        "required": [
+          "org_id",
+          "entity_id",
+          "flow_execution_id",
+          "flow_automation_task_id"
+        ]
+      },
       "TriggerEventEntityActivity": {
         "type": "object",
         "properties": {
@@ -2714,6 +3141,7 @@
         "type": "string",
         "enum": [
           "pending",
+          "starting",
           "in_progress",
           "paused",
           "success",
@@ -2750,6 +3178,15 @@
           },
           "flow_id": {
             "$ref": "#/components/schemas/AutomationFlowId"
+          },
+          "flow_execution_id": {
+            "type": "string",
+            "description": "ID of the Flow Execution"
+          },
+          "flow_automation_task_id": {
+            "type": "string",
+            "format": "UUID",
+            "description": "ID of the automated flow action"
           }
         },
         "required": [
@@ -2855,8 +3292,7 @@
           "status",
           "created_by",
           "created_at",
-          "updated_at",
-          "execution_summary"
+          "updated_at"
         ],
         "properties": {
           "job_id": {
@@ -2870,11 +3306,13 @@
           },
           "status": {
             "type": "string",
-            "description": "Status of the bulk trigger automation job\n* approval: Waiting for user approval to start the bulk trigger automation\n* starting: Starting automation executions\n* in_progress: Automation execution are currently running\n* send_report: Automation executions finished running. Report is being created & sent to the user who initiated the bulk trigger automation\n* finished: Automation executions finished running. Some may have failed. Check the status of each entity.\n* failed: Bulk trigger automation execution failed. Some executions might have started. Check the status of each entity.\n* cancelled: Bulk trigger automation execution was cancelled\n",
+            "description": "Status of the bulk trigger automation job\n* approval: Waiting for user approval to start the bulk trigger automation\n* querying_entities: Loading entities in batches\n* entities_loaded: All entities have been loaded and stored\n* executing: Automation execution are currently running\n* monitoring: All executions have been started, now monitoring their completion\n* send_report: Automation executions finished running. Report is being created & sent to the user who initiated the bulk trigger automation\n* finished: Automation executions finished running. Some may have failed. Check the status of each entity.\n* failed: Bulk trigger automation execution failed. Some executions might have started. Check the status of each entity.\n* cancelled: Bulk trigger automation execution was cancelled\n",
             "enum": [
               "approval",
-              "starting",
-              "in_progress",
+              "querying_entities",
+              "entities_loaded",
+              "executing",
+              "monitoring",
               "send_report",
               "finished",
               "failed",
@@ -2908,6 +3346,80 @@
             "type": "string",
             "description": "Entity ID of the report file entity"
           },
+          "entity_query": {
+            "type": "object",
+            "description": "Query configuration for loading entities",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "refs",
+                  "query",
+                  "filter"
+                ]
+              },
+              "data": {
+                "oneOf": [
+                  {
+                    "type": "array",
+                    "items": {
+                      "$ref": "#/components/schemas/EntityRef"
+                    }
+                  },
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "$ref": "#/components/schemas/EntitySearchFilter"
+                  }
+                ]
+              }
+            },
+            "required": [
+              "type",
+              "data"
+            ]
+          },
+          "pagination_state": {
+            "type": "object",
+            "description": "Pagination state for entity loading",
+            "properties": {
+              "page_size": {
+                "type": "integer",
+                "description": "Number of entities per page"
+              },
+              "pages_processed": {
+                "type": "integer",
+                "description": "Number of pages processed so far"
+              },
+              "total_processed": {
+                "type": "integer",
+                "description": "Total number of entities processed so far"
+              },
+              "stable_query_id": {
+                "type": "string",
+                "description": "Stable query ID for pagination"
+              },
+              "search_after": {
+                "type": "array",
+                "description": "Last sort value used for pagination",
+                "items": {
+                  "oneOf": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "type": "number"
+                    }
+                  ]
+                }
+              },
+              "has_more": {
+                "type": "boolean",
+                "description": "Whether there are more entities to load"
+              }
+            }
+          },
           "execution_summary": {
             "type": "array",
             "description": "List of entities & their automation execution id & status",
@@ -2989,13 +3501,7 @@
                 "properties": {
                   "source_id": {
                     "type": "string",
-                    "format": "uuid",
-                    "description": "ID of the flow that triggers the automation"
-                  },
-                  "journey_id": {
-                    "type": "string",
-                    "format": "uuid",
-                    "description": "Certain flows can be triggered automatically by a journey, this is the ID of that journey"
+                    "format": "uuid"
                   }
                 },
                 "required": [

package/package.json

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