@epilot/automation-client 2.9.8 → 2.9.9

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={914:function(e,t,o){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var i=r(o(240));t.default=i.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"}]},"post":{"operationId":"createFlow","requestBody":{"content":{"application/json":{}}}}},"/v1/automation/flows/{flow_id}":{"get":{"operationId":"getFlow","parameters":[{"name":"flow_id","in":"path","required":true}]},"put":{"operationId":"putFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteFlow","parameters":[{"name":"flow_id","in":"path","required":true}]}},"/v1/automation/executions":{"get":{"operationId":"getExecutions","parameters":[{"name":"entity_id","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"}]},"post":{"operationId":"startExecution","requestBody":{"content":{"application/json":{}}}}},"/v1/automation/executions/{execution_id}":{"get":{"operationId":"getExecution","parameters":[{"name":"execution_id","in":"path","required":true}]},"delete":{"operationId":"cancelExecution","parameters":[{"name":"execution_id","in":"path","required":true}]}},"/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":{}}}}}},"components":{},"servers":[{"url":"https://automation.sls.epilot.io"}]}')}},t={},o=function o(r){var i=t[r];if(void 0!==i)return i.exports;var n=t[r]={exports:{}};return e[r].call(n.exports,n,n.exports,o),n.exports}(914),r=exports;for(var i in o)r[i]=o[i];o.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={914:function(e,t,o){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var i=r(o(240));t.default=i.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"}]},"post":{"operationId":"createFlow","requestBody":{"content":{"application/json":{}}}}},"/v1/automation/flows/{flow_id}":{"get":{"operationId":"getFlow","parameters":[{"name":"flow_id","in":"path","required":true}]},"put":{"operationId":"putFlow","parameters":[{"name":"flow_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteFlow","parameters":[{"name":"flow_id","in":"path","required":true}]}},"/v1/automation/executions":{"get":{"operationId":"getExecutions","parameters":[{"name":"entity_id","in":"query"},{"name":"size","in":"query"},{"name":"from","in":"query"}]},"post":{"operationId":"startExecution","requestBody":{"content":{"application/json":{}}}}},"/v1/automation/executions/{execution_id}":{"get":{"operationId":"getExecution","parameters":[{"name":"execution_id","in":"path","required":true}]},"delete":{"operationId":"cancelExecution","parameters":[{"name":"execution_id","in":"path","required":true}]}},"/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":{}}}}},"/v1/automation/public/executions:resume":{"post":{"operationId":"resumeExecutionWithToken","requestBody":{"content":{"application/json":{}}}}}},"components":{},"servers":[{"url":"https://automation.sls.epilot.io"}]}')}},t={},o=function o(r){var i=t[r];if(void 0!==i)return i.exports;var n=t[r]={exports:{}};return e[r].call(n.exports,n,n.exports,o),n.exports}(914),r=exports;for(var i in o)r[i]=o[i];o.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -144,6 +144,16 @@
           }
         }
       }
+    },
+    "/v1/automation/public/executions:resume": {
+      "post": {
+        "operationId": "resumeExecutionWithToken",
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        }
+      }
     }
   },
   "components": {},

package/dist/openapi.d.ts

@@ -669,6 +669,12 @@ declare namespace Components {
             AutomationActionId;
             conditions?: ActionCondition[];
             actions: AnyAction[];
+            resume_token?: /**
+             * A unique token to resume a paused automation execution
+             * example:
+             * eyJraWQiOiJrZXkifQ==
+             */
+            ResumeToken;
             /**
              * Version of the flow
              * example:
@@ -940,7 +946,7 @@ declare namespace Components {
                 id?: string;
                 schema?: string;
                 attribute?: string;
-                attributeType?: "string" | "text" | "number" | "boolean" | "date" | "tag" | "country" | "email" | "phone" | "product" | "price" | "status" | "relation";
+                attributeType?: "string" | "text" | "number" | "boolean" | "date" | "datetime" | "tag" | "country" | "email" | "phone" | "product" | "price" | "status" | "relation" | "multiselect" | "select" | "radio" | "relation_user";
             };
             operation?: "equals" | "not_equals" | "any_of" | "none_of" | "contains" | "not_contains" | "starts_with" | "ends_with" | "greater_than" | "less_than" | "greater_than_or_equals" | "less_than_or_equals" | "is_empty" | "is_not_empty";
             values?: string[];
@@ -1346,7 +1352,7 @@ declare namespace Components {
                 details?: ErrorDetail[];
             };
         }
-        export type ExecutionStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled" | "skipped";
+        export type ExecutionStatus = "pending" | "in_progress" | "paused" | "success" | "failed" | "cancelled" | "skipped";
         export interface ExistsCondition {
             exists?: boolean;
         }
@@ -1784,6 +1790,20 @@ declare namespace Components {
             };
             mode: "append" | "prepend" | "set";
         }
+        export interface ResumeReq {
+            resume_token: /**
+             * A unique token to resume a paused automation execution
+             * example:
+             * eyJraWQiOiJrZXkifQ==
+             */
+            ResumeToken;
+        }
+        /**
+         * A unique token to resume a paused automation execution
+         * example:
+         * eyJraWQiOiJrZXkifQ==
+         */
+        export type ResumeToken = string;
         export interface RetryReq {
             retry_strategy?: /* different behaviors for retrying failed execution actions. */ RetryStrategy;
         }
@@ -1920,6 +1940,13 @@ declare namespace Components {
              * When true, it lets to send only the email by skip creating the thread & message entities.
              */
             skip_creating_entities?: boolean;
+            /**
+             * Pause automation execution after sending email to wait for a confirmation link to be clicked.
+             *
+             * The email template should contain a confirmation link using the variable `{{confirmation_url}}`
+             *
+             */
+            wait_for_confirmation?: boolean;
             /**
              * Include extra file attachments in sent email.
              * Attachments in email template will be sent regardless of this configuration.
@@ -2482,6 +2509,15 @@ declare namespace Paths {
             export type $200 = Components.Schemas.AutomationFlow;
         }
     }
+    namespace ResumeExecutionWithToken {
+        export type RequestBody = Components.Schemas.ResumeReq;
+        namespace Responses {
+            export interface $200 {
+            }
+            export interface $400 {
+            }
+        }
+    }
     namespace RetriggerAction {
         namespace Parameters {
             export type ActionId = /**
@@ -2647,6 +2683,21 @@ export interface OperationMethods {
     data?: Paths.RetriggerAction.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.RetriggerAction.Responses.$200>
+  /**
+   * resumeExecutionWithToken - resumeExecutionWithToken
+   * 
+   * Resume a paused automation execution using a unique resume token.
+   * 
+   * This public API is normally called when a user lands on a confirmation page via email link.
+   * 
+   * Example link: https://automation.epilot.io/confirm-email?token=eyJraWQiOiJrZXkifQ...
+   * 
+   */
+  'resumeExecutionWithToken'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.ResumeExecutionWithToken.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ResumeExecutionWithToken.Responses.$200>
 }
 
 export interface PathsDictionary {
@@ -2760,6 +2811,23 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.RetriggerAction.Responses.$200>
   }
+  ['/v1/automation/public/executions:resume']: {
+    /**
+     * resumeExecutionWithToken - resumeExecutionWithToken
+     * 
+     * Resume a paused automation execution using a unique resume token.
+     * 
+     * This public API is normally called when a user lands on a confirmation page via email link.
+     * 
+     * Example link: https://automation.epilot.io/confirm-email?token=eyJraWQiOiJrZXkifQ...
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.ResumeExecutionWithToken.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ResumeExecutionWithToken.Responses.$200>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>

package/dist/openapi.json

@@ -402,6 +402,35 @@
           }
         }
       }
+    },
+    "/v1/automation/public/executions:resume": {
+      "post": {
+        "operationId": "resumeExecutionWithToken",
+        "summary": "resumeExecutionWithToken",
+        "description": "Resume a paused automation execution using a unique resume token.\n\nThis public API is normally called when a user lands on a confirmation page via email link.\n\nExample link: https://automation.epilot.io/confirm-email?token=eyJraWQiOiJrZXkifQ...\n",
+        "tags": [
+          "executions"
+        ],
+        "security": [],
+        "requestBody": {
+          "description": "Retry request details.",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ResumeReq"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "execution resumed with success"
+          },
+          "400": {
+            "description": "execution could not be resumed"
+          }
+        }
+      }
     }
   },
   "components": {
@@ -1407,6 +1436,11 @@
             "description": "When true, it lets to send only the email by skip creating the thread & message entities.",
             "default": false
           },
+          "wait_for_confirmation": {
+            "type": "boolean",
+            "description": "Pause automation execution after sending email to wait for a confirmation link to be clicked.\n\nThe email template should contain a confirmation link using the variable `{{confirmation_url}}`\n",
+            "default": false
+          },
           "attachments": {
             "type": "array",
             "description": "Include extra file attachments in sent email.\nAttachments in email template will be sent regardless of this configuration.\n",
@@ -1811,6 +1845,7 @@
                   "number",
                   "boolean",
                   "date",
+                  "datetime",
                   "tag",
                   "country",
                   "email",
@@ -1818,7 +1853,11 @@
                   "product",
                   "price",
                   "status",
-                  "relation"
+                  "relation",
+                  "multiselect",
+                  "select",
+                  "radio",
+                  "relation_user"
                 ]
               }
             }
@@ -1937,6 +1976,9 @@
               "$ref": "#/components/schemas/AnyAction"
             }
           },
+          "resume_token": {
+            "$ref": "#/components/schemas/ResumeToken"
+          },
           "version": {
             "type": "number",
             "description": "Version of the flow",
@@ -2116,6 +2158,7 @@
         "enum": [
           "pending",
           "in_progress",
+          "paused",
           "success",
           "failed",
           "cancelled",
@@ -2797,6 +2840,23 @@
             "$ref": "#/components/schemas/RetryStrategy"
           }
         }
+      },
+      "ResumeToken": {
+        "type": "string",
+        "description": "A unique token to resume a paused automation execution",
+        "example": "eyJraWQiOiJrZXkifQ=="
+      },
+      "ResumeReq": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "resume_token": {
+            "$ref": "#/components/schemas/ResumeToken"
+          }
+        },
+        "required": [
+          "resume_token"
+        ]
       }
     }
   },

package/package.json

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