@epilot/automation-client 2.17.0 → 2.17.1-rc.1

package/dist/openapi-runtime.json

@@ -226,4 +226,4 @@
       "url": "https://automation.sls.epilot.io"
     }
   ]
-}
+}

package/dist/openapi.d.ts

@@ -126,7 +126,7 @@ declare namespace Components {
                 types?: (("CreateMeterReading" | "UpdateMeterReading" | "DocDownloadedFromPortal" | "PortalUserResetPassword" | "PortalUserResetForgotPassword" | "SelfAssignmentFromPortal") | string)[];
             };
         }
-        export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerShareEntityAction | TriggerWebhookAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction;
+        export type AnyAction = MapEntityAction | TriggerWorkflowAction | TriggerShareEntityAction | TriggerWebhookAction | ERPAction | CreateDocumentAction | SendEmailAction | /* Creates an order entity with prices from journey */ CartCheckoutAction | CustomAction | AutomationAction;
         export type AnyActionConfig = /**
          * example:
          * {
@@ -297,6 +297,21 @@ declare namespace Components {
          * }
          */
         TriggerWebhookActionConfig | /**
+         * example:
+         * {
+         *   "id": "2520gja-2sgmsaga-0asg-822jgal",
+         *   "name": "Inform ERP",
+         *   "type": "inform-erp",
+         *   "config": {
+         *     "entity_sources": [
+         *       "contact",
+         *       "account"
+         *     ],
+         *     "target_webhook_id": "25jg9ag2ga"
+         *   }
+         * }
+         */
+        ERPActionConfig | /**
          * example:
          * {
          *   "id": "08g988-ojt2jtaga-292h-8978gsaga",
@@ -945,15 +960,46 @@ declare namespace Components {
              */
             execution_summary: /* Execution item for bulk trigger automation. It maps each entity to its automation execution id & status */ ExecItem[];
         }
-        export interface BulkTriggerRequest {
+        export type BulkTriggerRequest = {
             flow_id: /**
              * example:
              * 7791b04a-16d2-44a2-9af9-2d59c25c512f
              */
             AutomationFlowId;
-            entities_refs?: EntityRef[];
-            entities_query?: string;
-        }
+            entities_refs: EntityRef[];
+        } | {
+            flow_id: /**
+             * example:
+             * 7791b04a-16d2-44a2-9af9-2d59c25c512f
+             */
+            AutomationFlowId;
+            entities_query: string;
+        } | {
+            flow_id: /**
+             * example:
+             * 7791b04a-16d2-44a2-9af9-2d59c25c512f
+             */
+            AutomationFlowId;
+            entities_filter: /**
+             * A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
+             * example:
+             * [
+             *   {
+             *     "term": {
+             *       "_schema": "contact"
+             *     }
+             *   },
+             *   {
+             *     "terms": {
+             *       "status": [
+             *         "active"
+             *       ]
+             *     }
+             *   }
+             * ]
+             */
+            EntitySearchFilter;
+        };
         /**
          * Creates an order entity with prices from journey
          */
@@ -1383,6 +1429,139 @@ declare namespace Components {
         export type DiffAdded = FilterConditionOnEvent;
         export type DiffDeleted = FilterConditionOnEvent;
         export type DiffUpdated = FilterConditionOnEvent;
+        export interface ERPAction {
+            id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            flow_action_id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            name?: string;
+            type?: "inform-erp";
+            config?: ERPConfig;
+            /**
+             * 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;
+        }
+        /**
+         * example:
+         * {
+         *   "id": "2520gja-2sgmsaga-0asg-822jgal",
+         *   "name": "Inform ERP",
+         *   "type": "inform-erp",
+         *   "config": {
+         *     "entity_sources": [
+         *       "contact",
+         *       "account"
+         *     ],
+         *     "target_webhook_id": "25jg9ag2ga"
+         *   }
+         * }
+         */
+        export interface ERPActionConfig {
+            id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            flow_action_id?: /**
+             * example:
+             * 9ec3711b-db63-449c-b894-54d5bb622a8f
+             */
+            AutomationActionId;
+            name?: string;
+            type?: "inform-erp";
+            config?: ERPConfig;
+            /**
+             * 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 interface ERPConfig {
+            entity_sources?: string[];
+            target_webhook_id?: string;
+            /**
+             * Whether to wait for the request to finish before continuing automation execution
+             */
+            sync?: boolean;
+        }
         /**
          * example:
          * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
@@ -1418,7 +1597,7 @@ declare namespace Components {
                 schema?: string;
             };
         }
-        export type EntityOperation = "createEntity" | "updateEntity" | "deleteEntity";
+        export type EntityOperation = "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity";
         /**
          * - 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`
@@ -1632,6 +1811,166 @@ declare namespace Components {
             EntityId;
             entity_schema: string;
         }
+        /**
+         * A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
+         * example:
+         * [
+         *   {
+         *     "term": {
+         *       "_schema": "contact"
+         *     }
+         *   },
+         *   {
+         *     "terms": {
+         *       "status": [
+         *         "active"
+         *       ]
+         *     }
+         *   }
+         * ]
+         */
+        export type EntitySearchFilter = {
+            /**
+             * Returns documents that contain an exact term in a provided field.
+             *
+             * To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
+             *
+             * You likely DO NOT want to use this filter on text fields and want to target its .keyword instead.
+             *
+             * example:
+             * {
+             *   "_schema": "contact"
+             * }
+             */
+            term?: {
+                [name: string]: /* A filter field value. */ EntitySearchFilterValue;
+            };
+            /**
+             * Returns documents that contain one of the exact terms in a provided field. See term filter for more info.
+             * example:
+             * {
+             *   "status": [
+             *     "active"
+             *   ]
+             * }
+             */
+            terms?: {
+                [name: string]: /* A filter field value. */ EntitySearchFilterValue[];
+            };
+            /**
+             * Returns documents based on their IDs.
+             * example:
+             * {
+             *   "values": [
+             *     "550e8400-e29b-41d4-a716-446655440000"
+             *   ]
+             * }
+             */
+            ids?: {
+                values?: string[];
+            };
+            /**
+             * Returns documents with fields that have terms within a certain range.
+             * example:
+             * {
+             *   "_created_at": {
+             *     "gte": "2021-01-01T00:00:00.000Z",
+             *     "lte": "2021-01-31T23:59:59.999Z"
+             *   }
+             * }
+             */
+            range?: {
+                [name: string]: {
+                    gt?: /* A filter field value. */ EntitySearchFilterValue;
+                    gte?: /* A filter field value. */ EntitySearchFilterValue;
+                    lt?: /* A filter field value. */ EntitySearchFilterValue;
+                    lte?: /* A filter field value. */ EntitySearchFilterValue;
+                    /**
+                     * The date format used to parse date values.
+                     */
+                    format?: string;
+                    /**
+                     * Indicates how the range query matches values for range fields.
+                     */
+                    relation?: "INTERSECTS" | "CONTAINS" | "WITHIN";
+                    /**
+                     * Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC.
+                     */
+                    time_zone?: string;
+                };
+            };
+            /**
+             * Returns documents that have a value in the specified field.
+             * example:
+             * {
+             *   "field": "_tags"
+             * }
+             */
+            exists?: {
+                field: string;
+            };
+            $and?: /**
+             * A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
+             * example:
+             * [
+             *   {
+             *     "term": {
+             *       "_schema": "contact"
+             *     }
+             *   },
+             *   {
+             *     "terms": {
+             *       "status": [
+             *         "active"
+             *       ]
+             *     }
+             *   }
+             * ]
+             */
+            EntitySearchFilter;
+            $or?: /**
+             * A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
+             * example:
+             * [
+             *   {
+             *     "term": {
+             *       "_schema": "contact"
+             *     }
+             *   },
+             *   {
+             *     "terms": {
+             *       "status": [
+             *         "active"
+             *       ]
+             *     }
+             *   }
+             * ]
+             */
+            EntitySearchFilter;
+            $not?: /**
+             * A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
+             * example:
+             * [
+             *   {
+             *     "term": {
+             *       "_schema": "contact"
+             *     }
+             *   },
+             *   {
+             *     "terms": {
+             *       "status": [
+             *         "active"
+             *       ]
+             *     }
+             *   }
+             * ]
+             */
+            EntitySearchFilter;
+        }[];
+        /**
+         * A filter field value.
+         */
+        export type EntitySearchFilterValue = /* A filter field value. */ (string | null) | number | boolean;
         export interface EqualsIgnoreCaseCondition {
             "equals-ignore-case"?: string;
         }
@@ -3655,12 +3994,17 @@ export type CustomAction = Components.Schemas.CustomAction;
 export type DiffAdded = Components.Schemas.DiffAdded;
 export type DiffDeleted = Components.Schemas.DiffDeleted;
 export type DiffUpdated = Components.Schemas.DiffUpdated;
+export type ERPAction = Components.Schemas.ERPAction;
+export type ERPActionConfig = Components.Schemas.ERPActionConfig;
+export type ERPConfig = Components.Schemas.ERPConfig;
 export type EntityId = Components.Schemas.EntityId;
 export type EntityItemSnapshot = Components.Schemas.EntityItemSnapshot;
 export type EntityManualTrigger = Components.Schemas.EntityManualTrigger;
 export type EntityOperation = Components.Schemas.EntityOperation;
 export type EntityOperationTrigger = Components.Schemas.EntityOperationTrigger;
 export type EntityRef = Components.Schemas.EntityRef;
+export type EntitySearchFilter = Components.Schemas.EntitySearchFilter;
+export type EntitySearchFilterValue = Components.Schemas.EntitySearchFilterValue;
 export type EqualsIgnoreCaseCondition = Components.Schemas.EqualsIgnoreCaseCondition;
 export type ErrorCode = Components.Schemas.ErrorCode;
 export type ErrorDetail = Components.Schemas.ErrorDetail;

package/dist/openapi.json

@@ -330,9 +330,15 @@
               },
               "example": {
                 "flow_id": "8e2e067e-3c63-4b1a-8e02-6150a3d1fd89",
-                "entity_ids": [
-                  "7791b04a-16d2-44a2-9af9-2d59c25c512f",
-                  "b35a6c51-2a15-4ef1-9623-20db37b0744f"
+                "entities_refs": [
+                  {
+                    "entity_schema": "opportunity",
+                    "entity_id": "7791b04a-16d2-44a2-9af9-2d59c25c512f"
+                  },
+                  {
+                    "entity_schema": "opportunity",
+                    "entity_id": "b35a6c51-2a15-4ef1-9623-20db37b0744f"
+                  }
                 ]
               }
             }
@@ -846,6 +852,9 @@
           {
             "$ref": "#/components/schemas/TriggerWebhookAction"
           },
+          {
+            "$ref": "#/components/schemas/ERPAction"
+          },
           {
             "$ref": "#/components/schemas/CreateDocumentAction"
           },
@@ -877,6 +886,9 @@
           {
             "$ref": "#/components/schemas/TriggerWebhookActionConfig"
           },
+          {
+            "$ref": "#/components/schemas/ERPActionConfig"
+          },
           {
             "$ref": "#/components/schemas/CreateDocumentActionConfig"
           },
@@ -2183,6 +2195,77 @@
           }
         }
       },
+      "ERPActionConfig": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AutomationActionConfig"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": [
+                  "inform-erp"
+                ]
+              },
+              "config": {
+                "$ref": "#/components/schemas/ERPConfig"
+              }
+            }
+          }
+        ],
+        "example": {
+          "id": "2520gja-2sgmsaga-0asg-822jgal",
+          "name": "Inform ERP",
+          "type": "inform-erp",
+          "config": {
+            "entity_sources": [
+              "contact",
+              "account"
+            ],
+            "target_webhook_id": "25jg9ag2ga"
+          }
+        }
+      },
+      "ERPAction": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/AutomationAction"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": [
+                  "inform-erp"
+                ]
+              },
+              "config": {
+                "$ref": "#/components/schemas/ERPConfig"
+              }
+            }
+          }
+        ]
+      },
+      "ERPConfig": {
+        "type": "object",
+        "properties": {
+          "entity_sources": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "target_webhook_id": {
+            "type": "string"
+          },
+          "sync": {
+            "type": "boolean",
+            "description": "Whether to wait for the request to finish before continuing automation execution",
+            "default": false
+          }
+        }
+      },
       "ConditionStatement": {
         "type": "object",
         "properties": {
@@ -2694,23 +2777,58 @@
         ]
       },
       "BulkTriggerRequest": {
-        "type": "object",
-        "properties": {
-          "flow_id": {
-            "$ref": "#/components/schemas/AutomationFlowId"
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "flow_id": {
+                "$ref": "#/components/schemas/AutomationFlowId"
+              },
+              "entities_refs": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/EntityRef"
+                }
+              }
+            },
+            "required": [
+              "flow_id",
+              "entities_refs"
+            ],
+            "additionalProperties": false
           },
-          "entities_refs": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/EntityRef"
-            }
+          {
+            "type": "object",
+            "properties": {
+              "flow_id": {
+                "$ref": "#/components/schemas/AutomationFlowId"
+              },
+              "entities_query": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "flow_id",
+              "entities_query"
+            ],
+            "additionalProperties": false
           },
-          "entities_query": {
-            "type": "string"
+          {
+            "type": "object",
+            "properties": {
+              "flow_id": {
+                "$ref": "#/components/schemas/AutomationFlowId"
+              },
+              "entities_filter": {
+                "$ref": "#/components/schemas/EntitySearchFilter"
+              }
+            },
+            "required": [
+              "flow_id",
+              "entities_filter"
+            ],
+            "additionalProperties": false
           }
-        },
-        "required": [
-          "flow_id"
         ]
       },
       "EntityRef": {
@@ -3227,7 +3345,180 @@
         "enum": [
           "createEntity",
           "updateEntity",
-          "deleteEntity"
+          "deleteEntity",
+          "softDeleteEntity",
+          "restoreEntity"
+        ]
+      },
+      "EntitySearchFilter": {
+        "type": "array",
+        "description": "A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.",
+        "items": {
+          "type": "object",
+          "minProperties": 1,
+          "maxProperties": 1,
+          "properties": {
+            "term": {
+              "description": "Returns documents that contain an exact term in a provided field.\n\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.\n\nYou likely DO NOT want to use this filter on text fields and want to target its .keyword instead.\n",
+              "externalDocs": {
+                "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html"
+              },
+              "type": "object",
+              "minProperties": 1,
+              "maxProperties": 1,
+              "additionalProperties": {
+                "$ref": "#/components/schemas/EntitySearchFilterValue"
+              },
+              "example": {
+                "_schema": "contact"
+              }
+            },
+            "terms": {
+              "description": "Returns documents that contain one of the exact terms in a provided field. See term filter for more info.",
+              "externalDocs": {
+                "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html"
+              },
+              "type": "object",
+              "minProperties": 1,
+              "maxProperties": 1,
+              "additionalProperties": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/EntitySearchFilterValue"
+                }
+              },
+              "example": {
+                "status": [
+                  "active"
+                ]
+              }
+            },
+            "ids": {
+              "description": "Returns documents based on their IDs.",
+              "externalDocs": {
+                "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html"
+              },
+              "type": "object",
+              "properties": {
+                "values": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              },
+              "example": {
+                "values": [
+                  "550e8400-e29b-41d4-a716-446655440000"
+                ]
+              }
+            },
+            "range": {
+              "description": "Returns documents with fields that have terms within a certain range.",
+              "externalDocs": {
+                "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html"
+              },
+              "type": "object",
+              "minProperties": 1,
+              "maxProperties": 1,
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "gt": {
+                    "$ref": "#/components/schemas/EntitySearchFilterValue"
+                  },
+                  "gte": {
+                    "$ref": "#/components/schemas/EntitySearchFilterValue"
+                  },
+                  "lt": {
+                    "$ref": "#/components/schemas/EntitySearchFilterValue"
+                  },
+                  "lte": {
+                    "$ref": "#/components/schemas/EntitySearchFilterValue"
+                  },
+                  "format": {
+                    "type": "string",
+                    "description": "The date format used to parse date values."
+                  },
+                  "relation": {
+                    "type": "string",
+                    "enum": [
+                      "INTERSECTS",
+                      "CONTAINS",
+                      "WITHIN"
+                    ],
+                    "description": "Indicates how the range query matches values for range fields."
+                  },
+                  "time_zone": {
+                    "type": "string",
+                    "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC."
+                  }
+                }
+              },
+              "example": {
+                "_created_at": {
+                  "gte": "2021-01-01T00:00:00.000Z",
+                  "lte": "2021-01-31T23:59:59.999Z"
+                }
+              }
+            },
+            "exists": {
+              "description": "Returns documents that have a value in the specified field.",
+              "externalDocs": {
+                "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html"
+              },
+              "type": "object",
+              "properties": {
+                "field": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "field"
+              ],
+              "example": {
+                "field": "_tags"
+              }
+            },
+            "$and": {
+              "$ref": "#/components/schemas/EntitySearchFilter"
+            },
+            "$or": {
+              "$ref": "#/components/schemas/EntitySearchFilter"
+            },
+            "$not": {
+              "$ref": "#/components/schemas/EntitySearchFilter"
+            }
+          }
+        },
+        "example": [
+          {
+            "term": {
+              "_schema": "contact"
+            }
+          },
+          {
+            "terms": {
+              "status": [
+                "active"
+              ]
+            }
+          }
+        ]
+      },
+      "EntitySearchFilterValue": {
+        "description": "A filter field value.",
+        "oneOf": [
+          {
+            "type": "string",
+            "nullable": true
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "boolean"
+          }
         ]
       },
       "EntityManualTrigger": {

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@epilot/automation-client",
-  "version": "2.17.0",
+  "version": "2.17.1-rc.1",
   "description": "Client library for epilot automation API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "epilot GmbH",
   "license": "MIT",
+  "private": false,
   "repository": {
     "type": "git",
     "url": "git+https://github.com/epilot-dev/sdk-js.git",