@epilot/automation-client 2.28.0 → 2.30.0

package/dist/client.d.ts

@@ -1,3 +1,3 @@
-import { Client } from './openapi';
+import type { Client } from './openapi';
 export declare const getClient: () => Client;
 export declare const createClient: () => Client;

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={330: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(466));t.default=r.default},466: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"},{"name":"include_flows","in":"query"}],"responses":{}},"post":{"operationId":"createFlow","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/flows:batchGet":{"post":{"operationId":"batchGetFlows","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"},{"name":"include_flows","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}/schedules/{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}(330),n=exports;for(var r in o)n[r]=o[r];o.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={330(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(466));t.default=r.default},466(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"},{"name":"include_flows","in":"query"}],"responses":{}},"post":{"operationId":"createFlow","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/automation/flows:batchGet":{"post":{"operationId":"batchGetFlows","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"},{"name":"include_flows","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}/schedules/{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}(330),n=exports;for(var r in o)n[r]=o[r];o.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();

package/dist/openapi.d.ts

@@ -1,5 +1,3 @@
-/* eslint-disable */
-
 import type {
   OpenAPIClient,
   Parameters,
@@ -598,6 +596,77 @@ declare namespace Components {
              */
             target_unique?: string[];
         }
+        export interface AssignThreadAction {
+            id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            flow_action_id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            name?: string;
+            type?: "assign-thread";
+            config?: AssignThreadConfig;
+            /**
+             * 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;
+        }
+        export interface AssignThreadConfig {
+            /**
+             * Assignees to remove from the thread, if they exist
+             */
+            remove?: string[];
+            /**
+             * Assignees to add to the thread
+             */
+            add?: string[];
+        }
         /**
          * example:
          * [
@@ -937,7 +1006,6 @@ declare namespace Components {
              * Source blueprint/manifest ID used when automation is created via blueprints.
              */
             _manifest?: string /* uuid */[] | null;
-            workflow_context?: /* For automation that are connected to workflows V2, this field tracks various information about the workflow. */ WorkflowContext;
         }
         /**
          * ID of the Automation Flow
@@ -2241,11 +2309,7 @@ declare namespace Components {
              */
             id?: string; // uuid
             type: "flows_trigger";
-            configuration: {
-                /**
-                 * The ID of the workflow v2 that triggers this automation
-                 */
-                source_id: string; // uuid
+            configuration?: {
                 /**
                  * When Journeys are linked to Workflows V2 as Journey Automations, this field will contain the ID of the Journey
                  */
@@ -3892,20 +3956,6 @@ declare namespace Components {
         export interface WildcardCondition {
             wildcard?: string;
         }
-        /**
-         * For automation that are connected to workflows V2, this field tracks various information about the workflow.
-         */
-        export interface WorkflowContext {
-            /**
-             * The ID of the workflow this automation is connected to
-             */
-            workflow_id: string; // uuid
-            /**
-             * The ID of the task in the workflow that this automation is connected to
-             */
-            task_id?: string; // uuid
-            workflow_role: /* The role this automation plays in the workflow. */ WorkflowContextRole;
-        }
         /**
          * The role this automation plays in the workflow.
          */
@@ -4733,6 +4783,8 @@ export type AnythingButCondition = Components.Schemas.AnythingButCondition;
 export type ApiCallerContext = Components.Schemas.ApiCallerContext;
 export type ApiSubmissionTrigger = Components.Schemas.ApiSubmissionTrigger;
 export type AppendValueMapper = Components.Schemas.AppendValueMapper;
+export type AssignThreadAction = Components.Schemas.AssignThreadAction;
+export type AssignThreadConfig = Components.Schemas.AssignThreadConfig;
 export type AssignUsersToStep = Components.Schemas.AssignUsersToStep;
 export type AutomationAction = Components.Schemas.AutomationAction;
 export type AutomationActionConfig = Components.Schemas.AutomationActionConfig;
@@ -4843,6 +4895,5 @@ export type TriggerWorkflowActionConfig = Components.Schemas.TriggerWorkflowActi
 export type TriggerWorkflowCondition = Components.Schemas.TriggerWorkflowCondition;
 export type TriggerWorkflowConfig = Components.Schemas.TriggerWorkflowConfig;
 export type WildcardCondition = Components.Schemas.WildcardCondition;
-export type WorkflowContext = Components.Schemas.WorkflowContext;
 export type WorkflowContextRole = Components.Schemas.WorkflowContextRole;
 export type WorkflowExecutionContext = Components.Schemas.WorkflowExecutionContext;

package/dist/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Automation API",
     "description": "API Backend for epilot Automation Workflows feature",
-    "version": "1.3.0"
+    "version": "1.4.0"
   },
   "tags": [
     {
@@ -1131,9 +1131,6 @@
               "example": "123e4567-e89b-12d3-a456-426614174000"
             },
             "nullable": true
-          },
-          "workflow_context": {
-            "$ref": "#/components/schemas/WorkflowContext"
           }
         },
         "required": [
@@ -1142,29 +1139,6 @@
           "actions"
         ]
       },
-      "WorkflowContext": {
-        "type": "object",
-        "description": "For automation that are connected to workflows V2, this field tracks various information about the workflow.",
-        "required": [
-          "workflow_id",
-          "workflow_role"
-        ],
-        "properties": {
-          "workflow_id": {
-            "type": "string",
-            "format": "uuid",
-            "description": "The ID of the workflow this automation is connected to"
-          },
-          "task_id": {
-            "type": "string",
-            "format": "uuid",
-            "description": "The ID of the task in the workflow that this automation is connected to"
-          },
-          "workflow_role": {
-            "$ref": "#/components/schemas/WorkflowContextRole"
-          }
-        }
-      },
       "WorkflowContextRole": {
         "type": "string",
         "description": "The role this automation plays in the workflow.",
@@ -2061,6 +2035,26 @@
           }
         ]
       },
+      "AssignThreadAction": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AutomationAction"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": [
+                  "assign-thread"
+                ]
+              },
+              "config": {
+                "$ref": "#/components/schemas/AssignThreadConfig"
+              }
+            }
+          }
+        ]
+      },
       "MoveThreadConfig": {
         "type": "object",
         "properties": {
@@ -2070,6 +2064,25 @@
           }
         }
       },
+      "AssignThreadConfig": {
+        "type": "object",
+        "properties": {
+          "remove": {
+            "type": "array",
+            "description": "Assignees to remove from the thread, if they exist",
+            "items": {
+              "type": "string"
+            }
+          },
+          "add": {
+            "type": "array",
+            "description": "Assignees to add to the thread",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
       "SendEmailActionConfig": {
         "allOf": [
           {
@@ -3836,25 +3849,16 @@
               "configuration": {
                 "type": "object",
                 "properties": {
-                  "source_id": {
-                    "type": "string",
-                    "format": "uuid",
-                    "description": "The ID of the workflow v2 that triggers this automation"
-                  },
                   "journey_id": {
                     "type": "string",
                     "format": "uuid",
                     "description": "When Journeys are linked to Workflows V2 as Journey Automations, this field will contain the ID of the Journey"
                   }
-                },
-                "required": [
-                  "source_id"
-                ]
+                }
               }
             },
             "required": [
-              "type",
-              "configuration"
+              "type"
             ]
           }
         ]
@@ -4247,6 +4251,7 @@
       },
       "EntityOperation": {
         "type": "string",
+        "nullable": true,
         "enum": [
           "createEntity",
           "updateEntity",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/automation-client",
-  "version": "2.28.0",
+  "version": "2.30.0",
   "description": "Client library for epilot automation API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,16 +22,16 @@
     "automation"
   ],
   "scripts": {
-    "test": "jest",
+    "test": "vitest",
     "typescript": "tsc",
     "bundle-definition": "webpack",
     "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/automation.yaml",
-    "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
+    "typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
     "build": "tsc && npm run build:patch && npm run bundle-definition",
     "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
     "build:watch": "npm run build && tsc -w",
     "prepublishOnly": "npm run typegen && npm run build",
-    "lint": "pnpm exec eslint src"
+    "lint": "biome check src"
   },
   "files": [
     "*.js",
@@ -59,15 +59,12 @@
   "devDependencies": {
     "@oclif/command": "^1.8.18",
     "@oclif/errors": "^1.3.6",
-    "@types/jest": "^26.0.20",
     "axios": "^1.11.0",
     "copy-webpack-plugin": "^7.0.0",
-    "jest": "^29.6.2",
     "json-loader": "^0.5.7",
     "node-fetch": "^3.2.10",
     "openapi-client-axios": "^7.8.0",
     "openapicmd": "^2.7.0",
-    "ts-jest": "^29.4.1",
     "ts-loader": "^8.0.14",
     "ts-node": "^10.9.1",
     "typescript": "^4.1.3",
@@ -76,4 +73,4 @@
     "whatwg-url": "^11.0.0"
   },
   "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
-}
+}