@epilot/automation-client 2.5.4 → 2.5.6

package/dist/openapi.d.ts

@@ -490,6 +490,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -527,6 +541,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
         }
         export interface AutomationActionExecutionState {
             execution_status?: ExecutionStatus;
@@ -653,6 +681,10 @@ declare namespace Components {
              * 123
              */
             org_id?: string;
+            /**
+             * Determines if the flow is a system generated flow
+             */
+            system_flow?: boolean;
         }
         /**
          * example:
@@ -684,6 +716,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -722,6 +768,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
         }
         export interface CartCheckoutConfig {
             /**
@@ -797,6 +857,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -850,6 +924,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
         }
         export interface CreateDocumentConfig {
             template_id?: string;
@@ -1131,6 +1219,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -1286,6 +1388,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
         }
         export interface MapEntityConfig {
             mapping_config?: MappingConfigRef;
@@ -1494,6 +1610,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -1541,6 +1671,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
         }
         export interface SendEmailConfig {
             email_template_id?: string;
@@ -1716,6 +1860,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -1766,6 +1924,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
         }
         export interface TriggerWebhookConfig {
             entity_sources?: string[];
@@ -1793,6 +1965,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
             execution_status?: ExecutionStatus;
             started_at?: string;
             updated_at?: string;
@@ -1862,6 +2048,20 @@ declare namespace Components {
              * Flag indicating whether the action was created automatically or manually
              */
             created_automatically?: 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;
+                };
+            };
         }
         /**
          * example:

package/dist/openapi.json

@@ -494,6 +494,10 @@
             "example": "123",
             "description": "Organization the automation flow belongs to",
             "readOnly": true
+          },
+          "system_flow": {
+            "type": "boolean",
+            "description": "Determines if the flow is a system generated flow"
           }
         },
         "required": [
@@ -621,6 +625,21 @@
           "created_automatically": {
             "description": "Flag indicating whether the action was created automatically or manually",
             "type": "boolean"
+          },
+          "reason": {
+            "type": "object",
+            "properties": {
+              "message": {
+                "type": "string",
+                "description": "Why the action has to be skipped/failed",
+                "example": "There are no registered portal users for the given emails, hence skipping the action"
+              },
+              "payload": {
+                "type": "object",
+                "additionalProperties": true,
+                "description": "Extra metadata about the skipping reason - such as a certain condition not met, etc."
+              }
+            }
           }
         }
       },

package/package.json

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