@epilot/automation-client 2.12.1 → 2.13.0

package/dist/openapi.d.ts

@@ -35,6 +35,29 @@ declare namespace Components {
              */
             ConditionStatement[];
         }
+        export interface ActionSchedule {
+            /**
+             * Schedule Id
+             */
+            id: string;
+            /**
+             * The id of the configured scheduler which will be added on automation triggered
+             */
+            scheduleId?: string;
+            source: /* The source of the schedule_at timestamp that will be used to schedule the action */ ActionScheduleSource;
+        }
+        /**
+         * The source of the schedule_at timestamp that will be used to schedule the action
+         */
+        export interface ActionScheduleSource {
+            /**
+             * The iGd of the action or trigger
+             */
+            id: string;
+            origin: "trigger" | "action";
+            schema: string;
+            attribute: string;
+        }
         /**
          * example:
          * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
@@ -549,6 +572,10 @@ declare namespace Components {
              * 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;
@@ -608,6 +635,10 @@ declare namespace Components {
              * Condition Id to be checked before executing the action
              */
             condition_id?: string;
+            /**
+             * Schedule Id which indicates the schedule of the action
+             */
+            schedule_id?: string;
         }
         export interface AutomationActionExecutionState {
             execution_status?: ExecutionStatus;
@@ -669,6 +700,7 @@ declare namespace Components {
              */
             AutomationActionId;
             conditions?: ActionCondition[];
+            schedules?: ActionSchedule[];
             actions: AnyAction[];
             resume_token?: /**
              * A unique token to resume a paused automation execution
@@ -721,6 +753,7 @@ declare namespace Components {
              */
             entity_schema?: string;
             conditions?: ActionCondition[];
+            schedules?: ActionSchedule[];
             /**
              * The actions (nodes) of the automation flow
              */
@@ -793,14 +826,16 @@ declare namespace Components {
             AutomationFlowId;
             /**
              * Status of the bulk trigger automation job
-             * * APPROVAL: Waiting for user approval to start the bulk trigger automation
-             * * IN_PROGRESS: Bulk trigger automation execution is in progress
-             * * SUCCESS: Bulk trigger automation execution is completed successfully
-             * * FAILED: Bulk trigger automation execution is failed
-             * * CANCELLED: Bulk trigger automation execution was cancelled
+             * * approval: Waiting for user approval to start the bulk trigger automation
+             * * starting: Starting automation executions
+             * * in_progress: Automation execution are currently running
+             * * 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" | "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELLED";
+            status: "approval" | "starting" | "in_progress" | "send_report" | "finished" | "failed" | "cancelled";
             /**
              * User ID who created the bulk trigger automation job
              * example:
@@ -820,54 +855,13 @@ declare namespace Components {
              */
             task_token?: string;
             /**
-             * List of entity ids that are waiting for triggering automation
+             * Entity ID of the report file entity
              */
-            pending?: {
-                entity_id: /**
-                 * example:
-                 * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
-                 */
-                EntityId;
-            }[];
+            report_file_entity_id?: string;
             /**
-             * List of entity ids and automation execution ids that were triggered successfully
+             * List of entities & their automation execution id & status
              */
-            triggered?: {
-                entity_id: /**
-                 * example:
-                 * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
-                 */
-                EntityId;
-                execution_id: /**
-                 * example:
-                 * 9baf184f-bc81-4128-bca3-d974c90a12c4
-                 */
-                AutomationExecutionId;
-            }[];
-            /**
-             * List of entity ids that were skipped or failed
-             */
-            failed?: {
-                entity_id: /**
-                 * example:
-                 * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
-                 */
-                EntityId;
-                /**
-                 * Error message for the failed automation execution
-                 */
-                error: string;
-            }[];
-            /**
-             * List of entity ids that were cancelled from triggering automation
-             */
-            cancelled?: {
-                entity_id: /**
-                 * example:
-                 * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
-                 */
-                EntityId;
-            }[];
+            execution_summary: /* Execution item for bulk trigger automation. It maps each entity to its automation execution id & status */ ExecItem[];
         }
         export interface BulkTriggerRequest {
             flow_id: /**
@@ -929,6 +923,10 @@ declare namespace Components {
              * 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;
@@ -989,6 +987,10 @@ declare namespace Components {
              * Condition Id to be checked before executing the action
              */
             condition_id?: string;
+            /**
+             * Schedule Id which indicates the schedule of the action
+             */
+            schedule_id?: string;
         }
         export interface CartCheckoutConfig {
             /**
@@ -1050,9 +1052,12 @@ declare namespace Components {
              */
             id?: string; // uuid
             source?: {
+                /**
+                 * The id of the action or trigger
+                 */
+                id?: string;
                 origin?: "trigger" | "action";
                 originType?: "entity" | "workflow" | "journey_block";
-                id?: string;
                 schema?: string;
                 attribute?: string;
                 attributeType?: "string" | "text" | "number" | "boolean" | "date" | "datetime" | "tags" | "country" | "email" | "phone" | "product" | "price" | "status" | "relation" | "multiselect" | "select" | "radio" | "relation_user" | "purpose" | "label";
@@ -1122,6 +1127,10 @@ declare namespace Components {
              * 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;
@@ -1197,6 +1206,10 @@ declare namespace Components {
              * Condition Id to be checked before executing the action
              */
             condition_id?: string;
+            /**
+             * Schedule Id which indicates the schedule of the action
+             */
+            schedule_id?: string;
         }
         export interface CreateDocumentConfig {
             template_id?: string;
@@ -1463,7 +1476,27 @@ declare namespace Components {
                 details?: ErrorDetail[];
             };
         }
-        export type ExecutionStatus = "pending" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped";
+        /**
+         * Execution item for bulk trigger automation. It maps each entity to its automation execution id & status
+         */
+        export interface ExecItem {
+            entity_id: /**
+             * example:
+             * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+             */
+            EntityId;
+            execution_id?: /**
+             * example:
+             * 9baf184f-bc81-4128-bca3-d974c90a12c4
+             */
+            AutomationExecutionId;
+            execution_status: ExecutionStatus;
+            /**
+             * Error message for the failed automation execution
+             */
+            error?: string;
+        }
+        export type ExecutionStatus = "pending" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped" | "scheduled";
         export interface ExistsCondition {
             exists?: boolean;
         }
@@ -1550,6 +1583,10 @@ declare namespace Components {
              * 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;
@@ -1727,6 +1764,10 @@ declare namespace Components {
              * Condition Id to be checked before executing the action
              */
             condition_id?: string;
+            /**
+             * Schedule Id which indicates the schedule of the action
+             */
+            schedule_id?: string;
         }
         export interface MapEntityConfig {
             mapping_config?: MappingConfigRef;
@@ -1984,6 +2025,10 @@ declare namespace Components {
              * 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;
@@ -2053,6 +2098,10 @@ declare namespace Components {
              * Condition Id to be checked before executing the action
              */
             condition_id?: string;
+            /**
+             * Schedule Id which indicates the schedule of the action
+             */
+            schedule_id?: string;
         }
         export interface SendEmailConfig {
             email_template_id?: string;
@@ -2260,6 +2309,10 @@ declare namespace Components {
              * 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;
@@ -2332,6 +2385,10 @@ declare namespace Components {
              * Condition Id to be checked before executing the action
              */
             condition_id?: string;
+            /**
+             * Schedule Id which indicates the schedule of the action
+             */
+            schedule_id?: string;
         }
         export interface TriggerWebhookConfig {
             entity_sources?: string[];
@@ -2385,6 +2442,10 @@ declare namespace Components {
              * 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;
@@ -2476,6 +2537,10 @@ declare namespace Components {
              * Condition Id to be checked before executing the action
              */
             condition_id?: string;
+            /**
+             * Schedule Id which indicates the schedule of the action
+             */
+            schedule_id?: string;
         }
         /**
          * example:
@@ -3061,6 +3126,8 @@ export interface PathsDictionary {
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
 export type ActionCondition = Components.Schemas.ActionCondition;
+export type ActionSchedule = Components.Schemas.ActionSchedule;
+export type ActionScheduleSource = Components.Schemas.ActionScheduleSource;
 export type ActivityId = Components.Schemas.ActivityId;
 export type ActivityTrigger = Components.Schemas.ActivityTrigger;
 export type AnyAction = Components.Schemas.AnyAction;
@@ -3103,6 +3170,7 @@ export type EqualsIgnoreCaseCondition = Components.Schemas.EqualsIgnoreCaseCondi
 export type ErrorCode = Components.Schemas.ErrorCode;
 export type ErrorDetail = Components.Schemas.ErrorDetail;
 export type ErrorOutput = Components.Schemas.ErrorOutput;
+export type ExecItem = Components.Schemas.ExecItem;
 export type ExecutionStatus = Components.Schemas.ExecutionStatus;
 export type ExistsCondition = Components.Schemas.ExistsCondition;
 export type FilterConditionOnEvent = Components.Schemas.FilterConditionOnEvent;

package/dist/openapi.json

@@ -615,6 +615,12 @@
               "$ref": "#/components/schemas/ActionCondition"
             }
           },
+          "schedules": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ActionSchedule"
+            }
+          },
           "actions": {
             "type": "array",
             "description": "The actions (nodes) of the automation flow",
@@ -814,6 +820,10 @@
           "condition_id": {
             "type": "string",
             "description": "Condition Id to be checked before executing the action"
+          },
+          "schedule_id": {
+            "type": "string",
+            "description": "Schedule Id which indicates the schedule of the action"
           }
         }
       },
@@ -1942,6 +1952,10 @@
           "source": {
             "type": "object",
             "properties": {
+              "id": {
+                "type": "string",
+                "description": "The id of the action or trigger"
+              },
               "origin": {
                 "type": "string",
                 "enum": [
@@ -1957,9 +1971,6 @@
                   "journey_block"
                 ]
               },
-              "id": {
-                "type": "string"
-              },
               "schema": {
                 "type": "string"
               },
@@ -2063,6 +2074,55 @@
           }
         }
       },
+      "ActionScheduleSource": {
+        "type": "object",
+        "description": "The source of the schedule_at timestamp that will be used to schedule the action",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "The iGd of the action or trigger"
+          },
+          "origin": {
+            "type": "string",
+            "enum": [
+              "trigger",
+              "action"
+            ]
+          },
+          "schema": {
+            "type": "string"
+          },
+          "attribute": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "origin",
+          "schema",
+          "attribute"
+        ]
+      },
+      "ActionSchedule": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Schedule Id"
+          },
+          "scheduleId": {
+            "type": "string",
+            "description": "The id of the configured scheduler which will be added on automation triggered"
+          },
+          "source": {
+            "$ref": "#/components/schemas/ActionScheduleSource"
+          }
+        },
+        "required": [
+          "id",
+          "source"
+        ]
+      },
       "AutomationExecutionId": {
         "type": "string",
         "example": "9baf184f-bc81-4128-bca3-d974c90a12c4"
@@ -2112,6 +2172,12 @@
               "$ref": "#/components/schemas/ActionCondition"
             }
           },
+          "schedules": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ActionSchedule"
+            }
+          },
           "actions": {
             "type": "array",
             "items": {
@@ -2304,7 +2370,8 @@
           "success",
           "failed",
           "cancelled",
-          "skipped"
+          "skipped",
+          "scheduled"
         ]
       },
       "GetExecutionsResp": {
@@ -2388,7 +2455,8 @@
           "status",
           "created_by",
           "created_at",
-          "updated_at"
+          "updated_at",
+          "execution_summary"
         ],
         "properties": {
           "job_id": {
@@ -2402,13 +2470,15 @@
           },
           "status": {
             "type": "string",
-            "description": "Status of the bulk trigger automation job\n* APPROVAL: Waiting for user approval to start the bulk trigger automation\n* IN_PROGRESS: Bulk trigger automation execution is in progress\n* SUCCESS: Bulk trigger automation execution is completed successfully\n* FAILED: Bulk trigger automation execution is failed\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* 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",
             "enum": [
-              "APPROVAL",
-              "IN_PROGRESS",
-              "SUCCESS",
-              "FAILED",
-              "CANCELLED"
+              "approval",
+              "starting",
+              "in_progress",
+              "send_report",
+              "finished",
+              "failed",
+              "cancelled"
             ]
           },
           "created_by": {
@@ -2434,74 +2504,39 @@
             "description": "Task token to approve/cancel the bulk automation job",
             "example": "8c086140-f33e-4bb7-a993-50c0f2402c7b"
           },
-          "pending": {
-            "type": "array",
-            "description": "List of entity ids that are waiting for triggering automation",
-            "items": {
-              "type": "object",
-              "required": [
-                "entity_id"
-              ],
-              "properties": {
-                "entity_id": {
-                  "$ref": "#/components/schemas/EntityId"
-                }
-              }
-            }
+          "report_file_entity_id": {
+            "type": "string",
+            "description": "Entity ID of the report file entity"
           },
-          "triggered": {
+          "execution_summary": {
             "type": "array",
-            "description": "List of entity ids and automation execution ids that were triggered successfully",
+            "description": "List of entities & their automation execution id & status",
             "items": {
-              "type": "object",
-              "required": [
-                "entity_id",
-                "execution_id"
-              ],
-              "properties": {
-                "entity_id": {
-                  "$ref": "#/components/schemas/EntityId"
-                },
-                "execution_id": {
-                  "$ref": "#/components/schemas/AutomationExecutionId"
-                }
-              }
+              "$ref": "#/components/schemas/ExecItem"
             }
+          }
+        }
+      },
+      "ExecItem": {
+        "type": "object",
+        "description": "Execution item for bulk trigger automation. It maps each entity to its automation execution id & status",
+        "required": [
+          "entity_id",
+          "execution_status"
+        ],
+        "properties": {
+          "entity_id": {
+            "$ref": "#/components/schemas/EntityId"
           },
-          "failed": {
-            "type": "array",
-            "description": "List of entity ids that were skipped or failed",
-            "items": {
-              "type": "object",
-              "required": [
-                "entity_id",
-                "error"
-              ],
-              "properties": {
-                "entity_id": {
-                  "$ref": "#/components/schemas/EntityId"
-                },
-                "error": {
-                  "type": "string",
-                  "description": "Error message for the failed automation execution"
-                }
-              }
-            }
+          "execution_id": {
+            "$ref": "#/components/schemas/AutomationExecutionId"
           },
-          "cancelled": {
-            "type": "array",
-            "description": "List of entity ids that were cancelled from triggering automation",
-            "items": {
-              "type": "object",
-              "required": [
-                "entity_id"
-              ],
-              "properties": {
-                "entity_id": {
-                  "$ref": "#/components/schemas/EntityId"
-                }
-              }
-            }
+          "execution_status": {
+            "$ref": "#/components/schemas/ExecutionStatus"
+          },
+          "error": {
+            "type": "string",
+            "description": "Error message for the failed automation execution"
           }
         }
       },

package/package.json

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