@epilot/automation-client 1.3.2 → 1.4.0

package/dist/openapi.d.ts

@@ -146,6 +146,34 @@ declare namespace Components {
          * }
          */
         SendEmailAction | AutomationAction;
+        export interface AppendValueMapper {
+            mode: /**
+             * - copy_if_exists - it replaces the target attribute with the source value
+             * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
+             * - set_value - it sets a value to a predefined value. Must be used together with value property.
+             *
+             */
+            MappingAttributeMode;
+            /**
+             * JSON like target path for the attribute. Eg. last_name
+             */
+            target: string;
+            /**
+             * JSON source path for the value to be extracted from. Eg: steps[1].['Product Info'].price
+             *
+             */
+            source?: string;
+            /**
+             * To be provided only when mapping json objects into a target attribute. Eg array of addresses.
+             *
+             */
+            value_json: string;
+            /**
+             * Array of keys which should be used when checking for uniqueness. Eg: [country, city, postal_code]
+             *
+             */
+            target_unique?: string[];
+        }
         /**
          * example:
          * [
@@ -291,6 +319,24 @@ declare namespace Components {
          */
         export type AutomationFlowId = string;
         export type Comparison = "equals" | "any_of" | "not_empty" | "is_empty";
+        export interface CopyValueMapper {
+            mode: /**
+             * - copy_if_exists - it replaces the target attribute with the source value
+             * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
+             * - set_value - it sets a value to a predefined value. Must be used together with value property.
+             *
+             */
+            MappingAttributeMode;
+            /**
+             * JSON like target path for the attribute. Eg. last_name
+             */
+            target: string;
+            /**
+             * JSON source path for the value to be extracted from. Eg: steps[1].['Product Info'].price
+             *
+             */
+            source: string;
+        }
         /**
          * example:
          * {
@@ -480,49 +526,70 @@ declare namespace Components {
             target_unique?: string[];
             mapping_attributes?: MappingAttribute[];
             relation_attributes?: RelationAttribute[];
-            reference_attributes?: ReferenceAttribute[];
-        }
-        export interface MappingAttribute {
-            /**
-             * JSON like target path for the attribute. Eg. last_name
-             */
-            target: string;
-            /**
-             * - copy_if_exists - it replaces the target attribute with the source value
-             * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
-             * - set_value - it sets a value to a predefined value. Must be used together with value property.
-             *
-             */
-            mode: "copy_if_exists" | "append_if_exists" | "set_value";
-            /**
-             * JSON source path for the value to be extracted from. Eg: steps[1].['Product Info'].price
-             *
-             */
-            source: string;
-            /**
-             * To be provided only when mapping json objects into a target attribute. Eg array of addresses.
-             *
-             */
-            value_json?: string;
-            /**
-             * Any value to be set: string, number, string[], number[], JSON object, etc. It will override existing values, if any.
-             *
+            reference_attributes?: /**
+             * example:
+             * {
+             *   "target": {
+             *     "key": "addresses"
+             *   },
+             *   "source": {
+             *     "schema": "contact",
+             *     "tag": "primary",
+             *     "key": "address",
+             *     "value_tag": "billing"
+             *   }
+             * }
              */
-            value?: any;
+            ReferenceAttribute[];
         }
+        export type MappingAttribute = SetValueMapper | CopyValueMapper | AppendValueMapper;
+        /**
+         * - copy_if_exists - it replaces the target attribute with the source value
+         * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
+         * - set_value - it sets a value to a predefined value. Must be used together with value property.
+         *
+         */
+        export type MappingAttributeMode = "copy_if_exists" | "append_if_exists" | "set_value";
         /**
          * example:
          * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
          */
         export type OrganizationId = string;
+        /**
+         * example:
+         * {
+         *   "target": {
+         *     "key": "addresses"
+         *   },
+         *   "source": {
+         *     "schema": "contact",
+         *     "tag": "primary",
+         *     "key": "address",
+         *     "value_tag": "billing"
+         *   }
+         * }
+         */
         export interface ReferenceAttribute {
             target: {
                 key: string;
-                path: string;
             };
             source: {
+                /**
+                 * Schema of source object. eg contact
+                 */
                 schema: string;
+                /**
+                 * identifier tag of source object. eg primary
+                 */
                 tag: string;
+                /**
+                 * location of source data. eg address
+                 */
+                key: string;
+                /**
+                 * identifier tag of source data. eg billing
+                 */
+                value_tag: string;
             };
         }
         export interface RelationAttribute {
@@ -580,6 +647,24 @@ declare namespace Components {
             email_template_id?: string;
             language_code?: "de" | "en";
         }
+        export interface SetValueMapper {
+            mode: /**
+             * - copy_if_exists - it replaces the target attribute with the source value
+             * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
+             * - set_value - it sets a value to a predefined value. Must be used together with value property.
+             *
+             */
+            MappingAttributeMode;
+            /**
+             * JSON like target path for the attribute. Eg. last_name
+             */
+            target: string;
+            /**
+             * Any value to be set: string, number, string[], number[], JSON object, etc. It will override existing values, if any.
+             *
+             */
+            value: any;
+        }
         export interface StartExecutionRequest {
             entity_id?: /**
              * example:

package/package.json

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

package/src/openapi.d.ts

@@ -146,6 +146,34 @@ declare namespace Components {
          * }
          */
         SendEmailAction | AutomationAction;
+        export interface AppendValueMapper {
+            mode: /**
+             * - copy_if_exists - it replaces the target attribute with the source value
+             * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
+             * - set_value - it sets a value to a predefined value. Must be used together with value property.
+             *
+             */
+            MappingAttributeMode;
+            /**
+             * JSON like target path for the attribute. Eg. last_name
+             */
+            target: string;
+            /**
+             * JSON source path for the value to be extracted from. Eg: steps[1].['Product Info'].price
+             *
+             */
+            source?: string;
+            /**
+             * To be provided only when mapping json objects into a target attribute. Eg array of addresses.
+             *
+             */
+            value_json: string;
+            /**
+             * Array of keys which should be used when checking for uniqueness. Eg: [country, city, postal_code]
+             *
+             */
+            target_unique?: string[];
+        }
         /**
          * example:
          * [
@@ -291,6 +319,24 @@ declare namespace Components {
          */
         export type AutomationFlowId = string;
         export type Comparison = "equals" | "any_of" | "not_empty" | "is_empty";
+        export interface CopyValueMapper {
+            mode: /**
+             * - copy_if_exists - it replaces the target attribute with the source value
+             * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
+             * - set_value - it sets a value to a predefined value. Must be used together with value property.
+             *
+             */
+            MappingAttributeMode;
+            /**
+             * JSON like target path for the attribute. Eg. last_name
+             */
+            target: string;
+            /**
+             * JSON source path for the value to be extracted from. Eg: steps[1].['Product Info'].price
+             *
+             */
+            source: string;
+        }
         /**
          * example:
          * {
@@ -480,49 +526,70 @@ declare namespace Components {
             target_unique?: string[];
             mapping_attributes?: MappingAttribute[];
             relation_attributes?: RelationAttribute[];
-            reference_attributes?: ReferenceAttribute[];
-        }
-        export interface MappingAttribute {
-            /**
-             * JSON like target path for the attribute. Eg. last_name
-             */
-            target: string;
-            /**
-             * - copy_if_exists - it replaces the target attribute with the source value
-             * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
-             * - set_value - it sets a value to a predefined value. Must be used together with value property.
-             *
-             */
-            mode: "copy_if_exists" | "append_if_exists" | "set_value";
-            /**
-             * JSON source path for the value to be extracted from. Eg: steps[1].['Product Info'].price
-             *
-             */
-            source: string;
-            /**
-             * To be provided only when mapping json objects into a target attribute. Eg array of addresses.
-             *
-             */
-            value_json?: string;
-            /**
-             * Any value to be set: string, number, string[], number[], JSON object, etc. It will override existing values, if any.
-             *
+            reference_attributes?: /**
+             * example:
+             * {
+             *   "target": {
+             *     "key": "addresses"
+             *   },
+             *   "source": {
+             *     "schema": "contact",
+             *     "tag": "primary",
+             *     "key": "address",
+             *     "value_tag": "billing"
+             *   }
+             * }
              */
-            value?: any;
+            ReferenceAttribute[];
         }
+        export type MappingAttribute = SetValueMapper | CopyValueMapper | AppendValueMapper;
+        /**
+         * - copy_if_exists - it replaces the target attribute with the source value
+         * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
+         * - set_value - it sets a value to a predefined value. Must be used together with value property.
+         *
+         */
+        export type MappingAttributeMode = "copy_if_exists" | "append_if_exists" | "set_value";
         /**
          * example:
          * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
          */
         export type OrganizationId = string;
+        /**
+         * example:
+         * {
+         *   "target": {
+         *     "key": "addresses"
+         *   },
+         *   "source": {
+         *     "schema": "contact",
+         *     "tag": "primary",
+         *     "key": "address",
+         *     "value_tag": "billing"
+         *   }
+         * }
+         */
         export interface ReferenceAttribute {
             target: {
                 key: string;
-                path: string;
             };
             source: {
+                /**
+                 * Schema of source object. eg contact
+                 */
                 schema: string;
+                /**
+                 * identifier tag of source object. eg primary
+                 */
                 tag: string;
+                /**
+                 * location of source data. eg address
+                 */
+                key: string;
+                /**
+                 * identifier tag of source data. eg billing
+                 */
+                value_tag: string;
             };
         }
         export interface RelationAttribute {
@@ -580,6 +647,24 @@ declare namespace Components {
             email_template_id?: string;
             language_code?: "de" | "en";
         }
+        export interface SetValueMapper {
+            mode: /**
+             * - copy_if_exists - it replaces the target attribute with the source value
+             * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
+             * - set_value - it sets a value to a predefined value. Must be used together with value property.
+             *
+             */
+            MappingAttributeMode;
+            /**
+             * JSON like target path for the attribute. Eg. last_name
+             */
+            target: string;
+            /**
+             * Any value to be set: string, number, string[], number[], JSON object, etc. It will override existing values, if any.
+             *
+             */
+            value: any;
+        }
         export interface StartExecutionRequest {
             entity_id?: /**
              * example: