@epilot/automation-client 0.5.0 → 0.5.1

package/dist/openapi.d.ts

@@ -9,53 +9,11 @@ import {
 
 declare namespace Components {
   namespace Schemas {
+    export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerWebhookAction | AutomationAction;
     export interface AutomationAction {
       id?: AutomationActionId;
-      /**
-       * example:
-       * Create Contact
-       */
       name?: string;
-      /**
-       * example:
-       * entity_mapping
-       */
       type?: string;
-      /**
-       * example:
-       * {
-       *   "target_schema": "contact",
-       *   "mapping_attributes": [
-       *     {
-       *       "target": "email",
-       *       "mode": "upsert_match",
-       *       "source": "billing_contact.email"
-       *     },
-       *     {
-       *       "target": "first_name",
-       *       "mode": "copy_if_exists",
-       *       "source": "billing_contact.first_name"
-       *     },
-       *     {
-       *       "target": "last_name",
-       *       "mode": "copy_if_exists",
-       *       "source": "billing_contact.last_name"
-       *     },
-       *     {
-       *       "target": "addresses",
-       *       "mode": "append_if_exists",
-       *       "source": "billing_contact",
-       *       "value_json": "{\n  \"street_name\": \"{{billing_contact.street_name}}\",\n  \"street_number\": \"{{billing_contact.street_number}}\",\n  \"city\": \"{{billing_contact.city}}\",\n  \"postal_code\": \"{{billing_contact.postal_code}}\",\n  \"country\": \"{{billing_contact.country}}\",\n}"
-       *     },
-       *     {
-       *       "target": "addresses",
-       *       "mode": "append_if_exists",
-       *       "source": "delivery_contact",
-       *       "value_json": "{\n  \"street_name\": \"{{delivery_contact.street_name}}\",\n  \"street_number\": \"{{delivery_contact.street_number}}\",\n  \"city\": \"{{delivery_contact.city}}\",\n  \"postal_code\": \"{{delivery_contact.postal_code}}\",\n  \"country\": \"{{delivery_contact.country}}\",\n}"
-       *     }
-       *   ]
-       * }
-       */
       config?: {
         [name: string]: any;
       };
@@ -73,6 +31,7 @@ declare namespace Components {
        */
       status?: "pending" | "in_progress" | "success" | "failed" | "cancelled";
       entity_id?: EntityId;
+      org_id?: OrganizationId;
       flow_id?: AutomationFlowId;
       /**
        * example:
@@ -107,51 +66,8 @@ declare namespace Components {
           [name: string]: any;
         };
         id?: AutomationActionId;
-        /**
-         * example:
-         * Create Contact
-         */
         name?: string;
-        /**
-         * example:
-         * entity_mapping
-         */
         type?: string;
-        /**
-         * example:
-         * {
-         *   "target_schema": "contact",
-         *   "mapping_attributes": [
-         *     {
-         *       "target": "email",
-         *       "mode": "upsert_match",
-         *       "source": "billing_contact.email"
-         *     },
-         *     {
-         *       "target": "first_name",
-         *       "mode": "copy_if_exists",
-         *       "source": "billing_contact.first_name"
-         *     },
-         *     {
-         *       "target": "last_name",
-         *       "mode": "copy_if_exists",
-         *       "source": "billing_contact.last_name"
-         *     },
-         *     {
-         *       "target": "addresses",
-         *       "mode": "append_if_exists",
-         *       "source": "billing_contact",
-         *       "value_json": "{\n  \"street_name\": \"{{billing_contact.street_name}}\",\n  \"street_number\": \"{{billing_contact.street_number}}\",\n  \"city\": \"{{billing_contact.city}}\",\n  \"postal_code\": \"{{billing_contact.postal_code}}\",\n  \"country\": \"{{billing_contact.country}}\",\n}"
-         *     },
-         *     {
-         *       "target": "addresses",
-         *       "mode": "append_if_exists",
-         *       "source": "delivery_contact",
-         *       "value_json": "{\n  \"street_name\": \"{{delivery_contact.street_name}}\",\n  \"street_number\": \"{{delivery_contact.street_number}}\",\n  \"city\": \"{{delivery_contact.city}}\",\n  \"postal_code\": \"{{delivery_contact.postal_code}}\",\n  \"country\": \"{{delivery_contact.country}}\",\n}"
-         *     }
-         *   ]
-         * }
-         */
         config?: {
           [name: string]: any;
         };
@@ -169,32 +85,14 @@ declare namespace Components {
        * Handle contact form
        */
       flow_name?: string;
-      triggers?: {
-        on: "entity_create" | "entity_update" | "entity_delete" | "journey_submit" | "frontend_submit";
-        /**
-         * example:
-         * {
-         *   "entity_schema": "contact"
-         * }
-         */
-        config: {
-          [name: string]: any;
-        };
-      }[];
-      /**
-       * List of conditions to be met for the automation to be triggered
-       */
-      trigger_conditions?: {
-        source?: string;
-        comparison?: "not_empty" | "is_empty" | "contains" | "equals";
-      }[];
+      trigger?: EntityOperationTrigger;
       /**
        * The entity schema
        * example:
        * submission
        */
-      entity?: AutomationFlowId;
-      actions?: AutomationAction[];
+      entity?: string;
+      actions?: AnyAction[];
       created_at?: string; // date-time
       updated_at?: string; // date-time
     }
@@ -208,6 +106,196 @@ declare namespace Components {
      * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
      */
     export type EntityId = string;
+    export interface EntityOperationTrigger {
+      type?: "entity_operation";
+      configuration?: {
+        /**
+         * example:
+         * submission
+         */
+        schema?: string;
+        operations?: ("createEntity" | "updateEntity" | "deleteEntity")[];
+        /**
+         * example:
+         * [
+         *   {
+         *     "source": "source_type",
+         *     "comparison": "equals",
+         *     "value": "journey"
+         *   },
+         *   {
+         *     "source": "source_id",
+         *     "comparison": "array_in",
+         *     "value": [
+         *       "c69b3f50-0c9b-11ec-b2e4-8724b261c6ab",
+         *       "6053c022-d50a-4b8d-9dcd-3b31213af36b"
+         *     ]
+         *   }
+         * ]
+         */
+        conditions?: {
+          source?: string;
+          comparison?: "not_empty" | "is_empty" | "equals" | "contains" | "array_in";
+        }[];
+      };
+    }
+    export interface FrontendSubmitTrigger {
+      type?: "frontend_submit";
+      configuration?: {
+        /**
+         * example:
+         * 99
+         */
+        frontend_id?: string;
+      };
+    }
+    export interface JourneySubmitTrigger {
+      type?: "journey_submit";
+      configuration?: {
+        journey_id?: string; // uuid
+      };
+    }
+    /**
+     * example:
+     * {
+     *   "id": "2520gja-2sgmsaga-0asg-822jgal",
+     *   "name": "Map Entity",
+     *   "type": "map-entity",
+     *   "config": {
+     *     "target_schema": "contact",
+     *     "target_unique": [
+     *       "email.email"
+     *     ],
+     *     "mapping_attributes": [
+     *       {
+     *         "target": "email",
+     *         "mode": "copy_if_exists",
+     *         "source": "billing_contact.email"
+     *       },
+     *       {
+     *         "target": "first_name",
+     *         "mode": "copy_if_exists",
+     *         "source": "billing_contact.first_name"
+     *       },
+     *       {
+     *         "target": "last_name",
+     *         "mode": "copy_if_exists",
+     *         "source": "billing_contact.last_name"
+     *       },
+     *       {
+     *         "target": "addresses",
+     *         "mode": "append_if_exists",
+     *         "source": "billing_contact",
+     *         "value_json": "{\n  \"street_name\": \"{{billing_contact.street_name}}\",\n  \"street_number\": \"{{billing_contact.street_number}}\",\n  \"city\": \"{{billing_contact.city}}\",\n  \"postal_code\": \"{{billing_contact.postal_code}}\",\n  \"country\": \"{{billing_contact.country}}\",\n}"
+     *       },
+     *       {
+     *         "target": "addresses",
+     *         "mode": "append_if_exists",
+     *         "source": "delivery_contact",
+     *         "value_json": "{\n  \"street_name\": \"{{delivery_contact.street_name}}\",\n  \"street_number\": \"{{delivery_contact.street_number}}\",\n  \"city\": \"{{delivery_contact.city}}\",\n  \"postal_code\": \"{{delivery_contact.postal_code}}\",\n  \"country\": \"{{delivery_contact.country}}\",\n}"
+     *       }
+     *     ]
+     *   }
+     * }
+     */
+    export interface MapEntityAction {
+      id?: AutomationActionId;
+      name?: string;
+      type?: string;
+      config?: MapEntityActionConfig;
+      outputs?: {
+        [name: string]: any;
+      };
+    }
+    export interface MapEntityActionConfig {
+      target_schema?: string;
+      target_unique?: string[];
+      mapping_attributes?: MappingAttribute[];
+    }
+    export interface MappingAttribute {
+      target?: string;
+      mode?: "copy_if_exists" | "append_if_exists";
+      source?: string;
+      value_json?: string;
+    }
+    /**
+     * example:
+     * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
+     */
+    export type OrganizationId = string;
+    export interface StartExecutionRequest {
+      entity_id?: EntityId;
+      flow_id?: AutomationFlowId;
+    }
+    /**
+     * example:
+     * {
+     *   "id": "2520gja-2sgmsaga-0asg-822jgal",
+     *   "name": "Trigger Webhook",
+     *   "type": "trigger-webhook",
+     *   "config": {
+     *     "entity_sources": [
+     *       "contact",
+     *       "account"
+     *     ],
+     *     "target_webhook_id": "25jg9ag2ga"
+     *   }
+     * }
+     */
+    export interface TriggerWebhookAction {
+      id?: AutomationActionId;
+      name?: string;
+      type?: string;
+      config?: TriggerWebhookActionConfig;
+      outputs?: {
+        [name: string]: any;
+      };
+    }
+    export interface TriggerWebhookActionConfig {
+      entity_sources?: string[];
+      target_webhook_id?: string;
+    }
+    /**
+     * example:
+     * {
+     *   "id": "08g988-ojt2jtaga-292h-8978gsaga",
+     *   "name": "Trigger Workflow",
+     *   "type": "trigger-workflow",
+     *   "config": {
+     *     "target_workflow": "mfptvUMH",
+     *     "add_context": [
+     *       "contact"
+     *     ],
+     *     "assign_steps": {
+     *       "First Step Daniel": [
+     *         10010729
+     *       ],
+     *       "call me": [
+     *         10010728,
+     *         10010729
+     *       ]
+     *     }
+     *   }
+     * }
+     */
+    export interface TriggerWorkflowAction {
+      id?: AutomationActionId;
+      name?: string;
+      type?: string;
+      config?: TriggerWorkflowConfig;
+      outputs?: {
+        workflow?: {
+          [name: string]: any;
+        };
+      };
+    }
+    export interface TriggerWorkflowConfig {
+      target_workflow?: string;
+      add_context?: string[];
+      assign_steps?: {
+        [name: string]: any;
+      };
+    }
   }
 }
 declare namespace Paths {
@@ -285,7 +373,7 @@ declare namespace Paths {
     }
     export type RequestBody = Components.Schemas.AutomationFlow;
     namespace Responses {
-      export type $201 = Components.Schemas.AutomationFlow;
+      export type $200 = Components.Schemas.AutomationFlow;
     }
   }
   namespace SearchFlows {
@@ -315,10 +403,7 @@ declare namespace Paths {
     }
   }
   namespace StartExecution {
-    export interface RequestBody {
-      entity_id?: Components.Schemas.EntityId;
-      flow_id?: Components.Schemas.AutomationFlowId;
-    }
+    export type RequestBody = Components.Schemas.StartExecutionRequest;
     namespace Responses {
       export type $201 = Components.Schemas.AutomationExecution;
     }
@@ -365,7 +450,7 @@ export interface OperationMethods {
     parameters?: Parameters<Paths.PutFlow.PathParameters> | null,
     data?: Paths.PutFlow.RequestBody,
     config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.PutFlow.Responses.$201>
+  ): OperationResponse<Paths.PutFlow.Responses.$200>
   /**
    * deleteFlow - deleteFlow
    * 
@@ -461,7 +546,7 @@ export interface PathsDictionary {
       parameters?: Parameters<Paths.PutFlow.PathParameters> | null,
       data?: Paths.PutFlow.RequestBody,
       config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.PutFlow.Responses.$201>
+    ): OperationResponse<Paths.PutFlow.Responses.$200>
     /**
      * deleteFlow - deleteFlow
      * 

package/package.json

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