@epilot/automation-client 2.12.2 → 2.13.1

package/dist/openapi.d.ts

@@ -39,17 +39,24 @@ declare namespace Components {
             /**
              * Schedule Id
              */
-            id?: string;
+            id: string;
             /**
-             * The id of the configured scheduler
+             * The id of the configured scheduler which will be added on automation triggered
              */
-            scheduleId?: string;
+            configuredSchedulerId?: 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 source of the schedule_at timestamp that will be used to schedule the action
+             * The iGd of the action or trigger
              */
-            source?: {
-                [key: string]: any;
-            };
+            id: string;
+            origin: "trigger" | "action";
+            schema: string;
+            attribute: string;
         }
         /**
          * example:
@@ -819,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:
@@ -846,54 +855,9 @@ declare namespace Components {
              */
             task_token?: string;
             /**
-             * List of entity ids that are waiting for triggering automation
-             */
-            pending?: {
-                entity_id: /**
-                 * example:
-                 * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
-                 */
-                EntityId;
-            }[];
-            /**
-             * 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: /**
@@ -1494,7 +1458,7 @@ declare namespace Components {
         export interface EqualsIgnoreCaseCondition {
             "equals-ignore-case"?: string;
         }
-        export type ErrorCode = "MAPPING_ERROR" | "REFRESH_RELATIONS_ERROR" | "DUPLICATE_ENTITY_ERROR" | "TRIGGER_WORKFLOW_ERROR" | "TIMEOUT_ERROR" | "BAD_CONFIG" | "INTERNAL_ERROR" | "TRIGGER_WEBHOOK_ERROR" | "TEMPLATE_ERROR" | "INVALID_PAYLOAD";
+        export type ErrorCode = "MAPPING_ERROR" | "REFRESH_RELATIONS_ERROR" | "DUPLICATE_ENTITY_ERROR" | "TRIGGER_WORKFLOW_ERROR" | "TIMEOUT_ERROR" | "BAD_CONFIG" | "INTERNAL_ERROR" | "TRIGGER_WEBHOOK_ERROR" | "TEMPLATE_ERROR" | "INVALID_PAYLOAD" | "INVALID_SCHEDULE_CONFIG";
         export interface ErrorDetail {
             explanation: string;
             context?: string;
@@ -1508,6 +1472,26 @@ declare namespace Components {
                 details?: ErrorDetail[];
             };
         }
+        /**
+         * 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;
@@ -2603,6 +2587,7 @@ declare namespace Components {
              * ]
              */
             AssignUsersToStep[];
+            filter_with_purposes?: boolean;
         }
         export interface WildcardCondition {
             wildcard?: string;
@@ -3138,6 +3123,7 @@ 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;
@@ -3180,6 +3166,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

@@ -909,7 +909,8 @@
           "INTERNAL_ERROR",
           "TRIGGER_WEBHOOK_ERROR",
           "TEMPLATE_ERROR",
-          "INVALID_PAYLOAD"
+          "INVALID_PAYLOAD",
+          "INVALID_SCHEDULE_CONFIG"
         ]
       },
       "ErrorDetail": {
@@ -1804,6 +1805,9 @@
             "items": {
               "$ref": "#/components/schemas/AssignUsersToStep"
             }
+          },
+          "filter_with_purposes": {
+            "type": "boolean"
           }
         }
       },
@@ -2071,6 +2075,35 @@
           }
         }
       },
+      "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": {
@@ -2078,32 +2111,18 @@
             "type": "string",
             "description": "Schedule Id"
           },
-          "scheduleId": {
+          "configuredSchedulerId": {
             "type": "string",
-            "description": "The id of the configured scheduler"
+            "description": "The id of the configured scheduler which will be added on automation triggered"
           },
           "source": {
-            "type": "object",
-            "description": "The source of the schedule_at timestamp that will be used to schedule the action",
-            "id": {
-              "type": "string",
-              "description": "The iGd of the action or trigger"
-            },
-            "origin": {
-              "type": "string",
-              "enum": [
-                "trigger",
-                "action"
-              ]
-            },
-            "schema": {
-              "type": "string"
-            },
-            "attribute": {
-              "type": "string"
-            }
+            "$ref": "#/components/schemas/ActionScheduleSource"
           }
-        }
+        },
+        "required": [
+          "id",
+          "source"
+        ]
       },
       "AutomationExecutionId": {
         "type": "string",
@@ -2437,7 +2456,8 @@
           "status",
           "created_by",
           "created_at",
-          "updated_at"
+          "updated_at",
+          "execution_summary"
         ],
         "properties": {
           "job_id": {
@@ -2451,13 +2471,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": {
@@ -2483,74 +2505,35 @@
             "description": "Task token to approve/cancel the bulk automation job",
             "example": "8c086140-f33e-4bb7-a993-50c0f2402c7b"
           },
-          "pending": {
+          "execution_summary": {
             "type": "array",
-            "description": "List of entity ids that are waiting for triggering automation",
+            "description": "List of entities & their automation execution id & status",
             "items": {
-              "type": "object",
-              "required": [
-                "entity_id"
-              ],
-              "properties": {
-                "entity_id": {
-                  "$ref": "#/components/schemas/EntityId"
-                }
-              }
+              "$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"
           },
-          "triggered": {
-            "type": "array",
-            "description": "List of entity ids and automation execution ids that were triggered successfully",
-            "items": {
-              "type": "object",
-              "required": [
-                "entity_id",
-                "execution_id"
-              ],
-              "properties": {
-                "entity_id": {
-                  "$ref": "#/components/schemas/EntityId"
-                },
-                "execution_id": {
-                  "$ref": "#/components/schemas/AutomationExecutionId"
-                }
-              }
-            }
+          "execution_id": {
+            "$ref": "#/components/schemas/AutomationExecutionId"
           },
-          "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_status": {
+            "$ref": "#/components/schemas/ExecutionStatus"
           },
-          "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"
-                }
-              }
-            }
+          "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.2",
+  "version": "2.13.1",
   "description": "Client library for epilot automation API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",