@epilot/automation-client 2.19.0 → 2.21.0

package/dist/openapi.d.ts

@@ -126,7 +126,7 @@ declare namespace Components {
                 types?: (("CreateMeterReading" | "UpdateMeterReading" | "DocDownloadedFromPortal" | "PortalUserResetPassword" | "PortalUserResetForgotPassword" | "SelfAssignmentFromPortal") | string)[];
             };
         }
-        export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerShareEntityAction | TriggerWebhookAction | InformERPAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction;
+        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`
@@ -1063,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
          */
@@ -1958,6 +1996,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:
@@ -4082,6 +4266,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 +4297,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;

package/dist/openapi.json

@@ -1105,6 +1105,9 @@
           },
           {
             "$ref": "#/components/schemas/AutomationAction"
+          },
+          {
+            "$ref": "#/components/schemas/FlowExecutionCancelAction"
           }
         ]
       },
@@ -1139,6 +1142,9 @@
           },
           {
             "$ref": "#/components/schemas/AutomationActionConfig"
+          },
+          {
+            "$ref": "#/components/schemas/FlowExecutionCancelActionConfig"
           }
         ]
       },
@@ -2502,6 +2508,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": {

package/package.json

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