@epilot/automation-client 2.16.2 → 2.16.4

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={914: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(240));t.default=r.default},240: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"}],"responses":{}},"post":{"operationId":"createFlow","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"}],"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":{}}}},"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}(914),n=exports;for(var r in o)n[r]=o[r];o.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={914: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(240));t.default=r.default},240: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"}],"responses":{}},"post":{"operationId":"createFlow","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"}],"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":{}}}},"components":{"responses":{"NotFoundError":{"content":{"application/json":{}}},"ForbiddenError":{"content":{"application/json":{}}}}}}')}},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}(914),n=exports;for(var r in o)n[r]=o[r];o.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -220,10 +220,5 @@
         }
       }
     }
-  },
-  "servers": [
-    {
-      "url": "https://automation.sls.epilot.io"
-    }
-  ]
+  }
 }

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`
@@ -469,7 +443,7 @@ declare namespace Components {
          *       ```
          *
          */
-        EntityOperationTrigger | ActivityTrigger | EntityManualTrigger | ReceivedEmailTrigger | FlowsTrigger;
+        EntityOperationTrigger | ActivityTrigger | EntityManualTrigger | ReceivedEmailTrigger;
         export interface AnythingButCondition {
             "anything-but"?: string[];
         }
@@ -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;
@@ -1792,17 +1685,6 @@ declare namespace Components {
         export type FilterConditionOnEvent = OrCondition | {
             [name: string]: (string | EqualsIgnoreCaseCondition | AnythingButCondition | NumericCondition | ExistsCondition | PrefixCondition | SuffixCondition | WildcardCondition)[];
         };
-        export interface FlowsTrigger {
-            /**
-             * example:
-             * 12d4f45a-1883-4841-a94c-5928cb338a94
-             */
-            id?: string; // uuid
-            type: "flows_trigger";
-            configuration: {
-                source_id: string; // uuid
-            };
-        }
         export interface FrontendSubmitTrigger {
             /**
              * example:
@@ -3613,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;
@@ -3631,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;
@@ -3645,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;
@@ -3664,7 +3542,6 @@ export type ExecItem = Components.Schemas.ExecItem;
 export type ExecutionStatus = Components.Schemas.ExecutionStatus;
 export type ExistsCondition = Components.Schemas.ExistsCondition;
 export type FilterConditionOnEvent = Components.Schemas.FilterConditionOnEvent;
-export type FlowsTrigger = Components.Schemas.FlowsTrigger;
 export type FrontendSubmitTrigger = Components.Schemas.FrontendSubmitTrigger;
 export type GetExecutionsResp = Components.Schemas.GetExecutionsResp;
 export type JobId = Components.Schemas.JobId;

package/dist/openapi.json

@@ -822,9 +822,6 @@
           },
           {
             "$ref": "#/components/schemas/ReceivedEmailTrigger"
-          },
-          {
-            "$ref": "#/components/schemas/FlowsTrigger"
           }
         ]
       },
@@ -877,7 +874,7 @@
             "$ref": "#/components/schemas/CartCheckoutActionConfig"
           },
           {
-            "$ref": "#/components/schemas/CustomActionConfig"
+            "$ref": "#/components/schemas/CustomAction"
           },
           {
             "$ref": "#/components/schemas/AutomationActionConfig"
@@ -2008,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",
@@ -2042,121 +2016,31 @@
               "type": {
                 "type": "string",
                 "enum": [
-                  "basic"
+                  "custom-action"
                 ]
               },
-              "basic_settings": {
+              "config": {
                 "type": "object",
                 "properties": {
-                  "url": {
+                  "name": {
                     "type": "string",
-                    "description": "URL to call"
-                  },
-                  "headers": {
-                    "type": "object",
-                    "additionalProperties": true
+                    "description": "The name of the custom action",
+                    "example": "Credit Check"
                   },
-                  "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"
                   }
                 }
               }
@@ -2904,40 +2788,6 @@
           }
         }
       },
-      "FlowsTrigger": {
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/AutomationTrigger"
-          },
-          {
-            "type": "object",
-            "properties": {
-              "type": {
-                "type": "string",
-                "enum": [
-                  "flows_trigger"
-                ]
-              },
-              "configuration": {
-                "type": "object",
-                "properties": {
-                  "source_id": {
-                    "type": "string",
-                    "format": "uuid"
-                  }
-                },
-                "required": [
-                  "source_id"
-                ]
-              }
-            },
-            "required": [
-              "type",
-              "configuration"
-            ]
-          }
-        ]
-      },
       "JourneySubmitTrigger": {
         "allOf": [
           {
@@ -3657,10 +3507,5 @@
         }
       }
     }
-  },
-  "servers": [
-    {
-      "url": "https://automation.sls.epilot.io"
-    }
-  ]
+  }
 }

package/package.json

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