@epilot/automation-client 2.16.1 → 2.16.4

package/dist/openapi.d.ts

@@ -126,32 +126,6 @@ declare namespace Components {
                 types?: (("CreateMeterReading" | "UpdateMeterReading" | "DocDownloadedFromPortal" | "PortalUserResetPassword" | "PortalUserResetForgotPassword" | "SelfAssignmentFromPortal") | string)[];
             };
         }
-        export interface AdvancedCustomActionConfig {
-            /**
-             * Name of the custom action
-             */
-            name?: string;
-            /**
-             * Description of the custom action
-             */
-            description?: string;
-            /**
-             * The ID of the app to fetch configuration from the app API
-             * example:
-             * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
-             */
-            app_id?: string;
-            /**
-             * The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component
-             * example:
-             * 2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88
-             */
-            component_id?: string;
-            type: "advanced";
-            advanced_settings?: {
-                [name: string]: any;
-            };
-        }
         export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerWebhookAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction;
         export type AnyActionConfig = /**
          * example:
@@ -352,7 +326,7 @@ declare namespace Components {
          *   }
          * }
          */
-        SendEmailActionConfig | /* Creates an order entity with prices from journey */ CartCheckoutActionConfig | CustomActionConfig | AutomationActionConfig;
+        SendEmailActionConfig | /* Creates an order entity with prices from journey */ CartCheckoutActionConfig | CustomAction | AutomationActionConfig;
         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`
@@ -911,64 +885,6 @@ declare namespace Components {
              */
             id?: string; // uuid
         }
-        export interface BaseCustomActionConfig {
-            /**
-             * Name of the custom action
-             */
-            name?: string;
-            /**
-             * Description of the custom action
-             */
-            description?: string;
-            /**
-             * The ID of the app to fetch configuration from the app API
-             * example:
-             * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
-             */
-            app_id?: string;
-            /**
-             * The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component
-             * example:
-             * 2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88
-             */
-            component_id?: string;
-        }
-        export interface BasicCustomActionConfig {
-            /**
-             * Name of the custom action
-             */
-            name?: string;
-            /**
-             * Description of the custom action
-             */
-            description?: string;
-            /**
-             * The ID of the app to fetch configuration from the app API
-             * example:
-             * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
-             */
-            app_id?: string;
-            /**
-             * The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component
-             * example:
-             * 2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88
-             */
-            component_id?: string;
-            type: "basic";
-            basic_settings?: {
-                /**
-                 * URL to call
-                 */
-                url?: string;
-                headers?: {
-                    [name: string]: any;
-                };
-                /**
-                 * SSM Reference to the auth token to use for the request
-                 */
-                auth_token_ref?: string;
-            };
-        }
         export interface BulkTriggerJob {
             job_id: /**
              * Job ID for tracking the status of bulk trigger automation executions
@@ -1386,7 +1302,33 @@ declare namespace Components {
             AutomationActionId;
             name?: string;
             type?: "custom-action";
-            config?: BasicCustomActionConfig | AdvancedCustomActionConfig;
+            config?: {
+                [name: string]: any;
+                /**
+                 * The name of the custom action
+                 * example:
+                 * Credit Check
+                 */
+                name?: string;
+                /**
+                 * The description of the custom action
+                 * example:
+                 * Check if the customer has a credit limit
+                 */
+                description?: string;
+                /**
+                 * The ID of the app to fetch configuration from the app API
+                 * example:
+                 * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
+                 */
+                app_id?: string;
+                /**
+                 * The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component
+                 * example:
+                 * 2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88
+                 */
+                component_id?: string;
+            };
             /**
              * Whether to stop execution in a failed state if this action fails
              */
@@ -1434,55 +1376,6 @@ declare namespace Components {
             error_output?: ErrorOutput;
             retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
         }
-        export interface CustomActionConfig {
-            id?: /**
-             * example:
-             * 9ec3711b-db63-449c-b894-54d5bb622a8f
-             */
-            AutomationActionId;
-            flow_action_id?: /**
-             * example:
-             * 9ec3711b-db63-449c-b894-54d5bb622a8f
-             */
-            AutomationActionId;
-            name?: string;
-            type?: "custom-action";
-            config?: BasicCustomActionConfig | AdvancedCustomActionConfig;
-            /**
-             * 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;
-        }
         export type DiffAdded = FilterConditionOnEvent;
         export type DiffDeleted = FilterConditionOnEvent;
         export type DiffUpdated = FilterConditionOnEvent;
@@ -3602,7 +3495,6 @@ 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 AdvancedCustomActionConfig = Components.Schemas.AdvancedCustomActionConfig;
 export type AnyAction = Components.Schemas.AnyAction;
 export type AnyActionConfig = Components.Schemas.AnyActionConfig;
 export type AnyTrigger = Components.Schemas.AnyTrigger;
@@ -3620,8 +3512,6 @@ export type AutomationExecutionId = Components.Schemas.AutomationExecutionId;
 export type AutomationFlow = Components.Schemas.AutomationFlow;
 export type AutomationFlowId = Components.Schemas.AutomationFlowId;
 export type AutomationTrigger = Components.Schemas.AutomationTrigger;
-export type BaseCustomActionConfig = Components.Schemas.BaseCustomActionConfig;
-export type BasicCustomActionConfig = Components.Schemas.BasicCustomActionConfig;
 export type BulkTriggerJob = Components.Schemas.BulkTriggerJob;
 export type BulkTriggerRequest = Components.Schemas.BulkTriggerRequest;
 export type CartCheckoutAction = Components.Schemas.CartCheckoutAction;
@@ -3634,7 +3524,6 @@ export type CreateDocumentAction = Components.Schemas.CreateDocumentAction;
 export type CreateDocumentActionConfig = Components.Schemas.CreateDocumentActionConfig;
 export type CreateDocumentConfig = Components.Schemas.CreateDocumentConfig;
 export type CustomAction = Components.Schemas.CustomAction;
-export type CustomActionConfig = Components.Schemas.CustomActionConfig;
 export type DiffAdded = Components.Schemas.DiffAdded;
 export type DiffDeleted = Components.Schemas.DiffDeleted;
 export type DiffUpdated = Components.Schemas.DiffUpdated;

package/dist/openapi.json

@@ -874,7 +874,7 @@
             "$ref": "#/components/schemas/CartCheckoutActionConfig"
           },
           {
-            "$ref": "#/components/schemas/CustomActionConfig"
+            "$ref": "#/components/schemas/CustomAction"
           },
           {
             "$ref": "#/components/schemas/AutomationActionConfig"
@@ -2005,33 +2005,10 @@
           }
         ]
       },
-      "BaseCustomActionConfig": {
-        "type": "object",
-        "properties": {
-          "name": {
-            "type": "string",
-            "description": "Name of the custom action"
-          },
-          "description": {
-            "type": "string",
-            "description": "Description of the custom action"
-          },
-          "app_id": {
-            "type": "string",
-            "description": "The ID of the app to fetch configuration from the app API",
-            "example": "c451c26a-cc7a-4c1c-92bf-1c6246cbfe88"
-          },
-          "component_id": {
-            "type": "string",
-            "description": "The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component",
-            "example": "2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88"
-          }
-        }
-      },
-      "BasicCustomActionConfig": {
+      "CustomAction": {
         "allOf": [
           {
-            "$ref": "#/components/schemas/BaseCustomActionConfig"
+            "$ref": "#/components/schemas/AutomationAction"
           },
           {
             "type": "object",
@@ -2039,121 +2016,31 @@
               "type": {
                 "type": "string",
                 "enum": [
-                  "basic"
+                  "custom-action"
                 ]
               },
-              "basic_settings": {
+              "config": {
                 "type": "object",
                 "properties": {
-                  "url": {
+                  "name": {
                     "type": "string",
-                    "description": "URL to call"
+                    "description": "The name of the custom action",
+                    "example": "Credit Check"
                   },
-                  "headers": {
-                    "type": "object",
-                    "additionalProperties": true
-                  },
-                  "auth_token_ref": {
+                  "description": {
                     "type": "string",
-                    "description": "SSM Reference to the auth token to use for the request"
-                  }
-                }
-              }
-            },
-            "required": [
-              "type"
-            ]
-          }
-        ]
-      },
-      "AdvancedCustomActionConfig": {
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/BaseCustomActionConfig"
-          },
-          {
-            "type": "object",
-            "properties": {
-              "type": {
-                "type": "string",
-                "enum": [
-                  "advanced"
-                ]
-              },
-              "advanced_settings": {
-                "type": "object",
-                "additionalProperties": true
-              }
-            },
-            "required": [
-              "type"
-            ]
-          }
-        ]
-      },
-      "CustomActionConfig": {
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/AutomationActionConfig"
-          },
-          {
-            "type": "object",
-            "properties": {
-              "type": {
-                "type": "string",
-                "enum": [
-                  "custom-action"
-                ]
-              },
-              "config": {
-                "oneOf": [
-                  {
-                    "$ref": "#/components/schemas/BasicCustomActionConfig"
+                    "description": "The description of the custom action",
+                    "example": "Check if the customer has a credit limit"
                   },
-                  {
-                    "$ref": "#/components/schemas/AdvancedCustomActionConfig"
-                  }
-                ],
-                "discriminator": {
-                  "propertyName": "type",
-                  "mapping": {
-                    "basic": "#/components/schemas/BasicCustomActionConfig",
-                    "advanced": "#/components/schemas/AdvancedCustomActionConfig"
-                  }
-                }
-              }
-            }
-          }
-        ]
-      },
-      "CustomAction": {
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/AutomationAction"
-          },
-          {
-            "type": "object",
-            "properties": {
-              "type": {
-                "type": "string",
-                "enum": [
-                  "custom-action"
-                ]
-              },
-              "config": {
-                "oneOf": [
-                  {
-                    "$ref": "#/components/schemas/BasicCustomActionConfig"
+                  "app_id": {
+                    "type": "string",
+                    "description": "The ID of the app to fetch configuration from the app API",
+                    "example": "c451c26a-cc7a-4c1c-92bf-1c6246cbfe88"
                   },
-                  {
-                    "$ref": "#/components/schemas/AdvancedCustomActionConfig"
-                  }
-                ],
-                "discriminator": {
-                  "propertyName": "type",
-                  "mapping": {
-                    "basic": "#/components/schemas/BasicCustomActionConfig",
-                    "advanced": "#/components/schemas/AdvancedCustomActionConfig"
+                  "component_id": {
+                    "type": "string",
+                    "description": "The ID of the component from the app. As the app can potentially have multiple custom actions, this ID is used to identify the component",
+                    "example": "2f1c26a-cc7a-4c1c-92bf-1c6246cbfe88"
                   }
                 }
               }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/automation-client",
-  "version": "2.16.1",
+  "version": "2.16.4",
   "description": "Client library for epilot automation API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,7 +24,7 @@
     "test": "jest",
     "typescript": "tsc",
     "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js ../../../backend/automation-api/lambda/ApiHandlerFunction/openapi.yml",
+    "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",
     "build": "tsc && npm run build:patch && npm run bundle-definition",
     "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",