@epilot/automation-client
Advanced tools
Comparing version 1.8.2 to 1.8.3
@@ -100,41 +100,94 @@ /* eslint-disable */ | ||
* { | ||
* "target": "email", | ||
* "mode": "append_if_exists", | ||
* "source": "billing_contact", | ||
* "value_json": "{\n \"email\": \"billing_contact.email\"\n}" | ||
* "target_path": "_tags", | ||
* "operation": { | ||
* "_append": [ | ||
* "primary", | ||
* "payer" | ||
* ], | ||
* "_uniq": true | ||
* } | ||
* }, | ||
* { | ||
* "target": "_tags", | ||
* "mode": "set_value", | ||
* "value": [ | ||
* "primary", | ||
* "payer" | ||
* ] | ||
* "target_path": "email", | ||
* "operation": { | ||
* "_append": [ | ||
* { | ||
* "email": { | ||
* "_copy": "billing_contact.email" | ||
* } | ||
* } | ||
* ] | ||
* } | ||
* }, | ||
* { | ||
* "target": "first_name", | ||
* "mode": "copy_if_exists", | ||
* "source": "billing_contact.first_name" | ||
* "target_path": "first_name", | ||
* "operation": { | ||
* "_copy": "billing_contact.first_name" | ||
* } | ||
* }, | ||
* { | ||
* "target": "last_name", | ||
* "mode": "copy_if_exists", | ||
* "source": "billing_contact.last_name" | ||
* "target_path": "last_name", | ||
* "operation": { | ||
* "_copy": "billing_contact.last_name" | ||
* } | ||
* }, | ||
* { | ||
* "target": "contact_type", | ||
* "mode": "set_value", | ||
* "value": "customer" | ||
* "target_path": "contact_type", | ||
* "operation": { | ||
* "_set": "customer" | ||
* } | ||
* }, | ||
* { | ||
* "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 \"_tags\": [\"billing\", \"primary\"]\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 \"_tags\": [\"delivery\", \"secondary\"]\n}" | ||
* "target_path": "address", | ||
* "operation": { | ||
* "_append": [ | ||
* { | ||
* "_tags": [ | ||
* "billing", | ||
* "primary" | ||
* ], | ||
* "street_name": { | ||
* "_copy": "billing_contact.street_name" | ||
* }, | ||
* "street_number": { | ||
* "_copy": "billing_contact.street_number" | ||
* }, | ||
* "city": { | ||
* "_copy": "billing_contact.city" | ||
* }, | ||
* "postal_code": { | ||
* "_copy": "billing_contact.postal_code" | ||
* }, | ||
* "country": { | ||
* "_copy": "billing_contact.country" | ||
* } | ||
* }, | ||
* { | ||
* "_tags": [ | ||
* "delivery" | ||
* ], | ||
* "street_name": { | ||
* "_copy": "delivery_contact.street_name" | ||
* }, | ||
* "street_number": { | ||
* "_copy": "delivery_contact.street_number" | ||
* }, | ||
* "city": { | ||
* "_copy": "delivery_contact.city" | ||
* }, | ||
* "postal_code": { | ||
* "_copy": "delivery_contact.postal_code" | ||
* }, | ||
* "country": { | ||
* "_copy": "delivery_contact.country" | ||
* } | ||
* } | ||
* ], | ||
* "_uniq": [ | ||
* "street_name", | ||
* "street_number", | ||
* "postal_code", | ||
* "country" | ||
* ] | ||
* } | ||
* } | ||
@@ -234,5 +287,3 @@ * ] | ||
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. | ||
* - 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. | ||
* | ||
@@ -309,2 +360,6 @@ */ | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -326,6 +381,2 @@ [name: string]: any; | ||
AutomationExecutionId; | ||
/** | ||
* example: | ||
* success | ||
*/ | ||
execution_status?: ExecutionStatus; | ||
@@ -424,3 +475,3 @@ entity_id: /** | ||
name?: string; | ||
type?: string; | ||
type?: "cart-checkout"; | ||
config?: CartCheckoutConfig; | ||
@@ -434,2 +485,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -442,3 +497,16 @@ [name: string]: any; | ||
relation_attributes?: RelationAttribute[]; | ||
mapping_attributes?: MappingAttribute[]; | ||
mapping_attributes?: (/** | ||
* example: | ||
* { | ||
* "target_path": "_tags", | ||
* "operation": { | ||
* "_append": [ | ||
* "new", | ||
* "tags" | ||
* ], | ||
* "_uniq": true | ||
* } | ||
* } | ||
*/ | ||
MappingAttributeV2 | MappingAttribute)[]; | ||
} | ||
@@ -448,5 +516,3 @@ export type Comparison = "equals" | "any_of" | "not_empty" | "is_empty"; | ||
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. | ||
* - 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. | ||
* | ||
@@ -495,3 +561,3 @@ */ | ||
name?: string; | ||
type?: string; | ||
type?: "create-document"; | ||
config?: CreateDocumentConfig; | ||
@@ -505,2 +571,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -560,3 +630,3 @@ [name: string]: any; | ||
name?: string; | ||
type?: string; | ||
type?: "fill-entity"; | ||
config: FillEntityConfig; | ||
@@ -570,2 +640,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -644,41 +718,94 @@ [name: string]: any; | ||
* { | ||
* "target": "email", | ||
* "mode": "append_if_exists", | ||
* "source": "billing_contact", | ||
* "value_json": "{\n \"email\": \"billing_contact.email\"\n}" | ||
* "target_path": "_tags", | ||
* "operation": { | ||
* "_append": [ | ||
* "primary", | ||
* "payer" | ||
* ], | ||
* "_uniq": true | ||
* } | ||
* }, | ||
* { | ||
* "target": "_tags", | ||
* "mode": "set_value", | ||
* "value": [ | ||
* "primary", | ||
* "payer" | ||
* ] | ||
* "target_path": "email", | ||
* "operation": { | ||
* "_append": [ | ||
* { | ||
* "email": { | ||
* "_copy": "billing_contact.email" | ||
* } | ||
* } | ||
* ] | ||
* } | ||
* }, | ||
* { | ||
* "target": "first_name", | ||
* "mode": "copy_if_exists", | ||
* "source": "billing_contact.first_name" | ||
* "target_path": "first_name", | ||
* "operation": { | ||
* "_copy": "billing_contact.first_name" | ||
* } | ||
* }, | ||
* { | ||
* "target": "last_name", | ||
* "mode": "copy_if_exists", | ||
* "source": "billing_contact.last_name" | ||
* "target_path": "last_name", | ||
* "operation": { | ||
* "_copy": "billing_contact.last_name" | ||
* } | ||
* }, | ||
* { | ||
* "target": "contact_type", | ||
* "mode": "set_value", | ||
* "value": "customer" | ||
* "target_path": "contact_type", | ||
* "operation": { | ||
* "_set": "customer" | ||
* } | ||
* }, | ||
* { | ||
* "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 \"_tags\": [\"billing\", \"primary\"]\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 \"_tags\": [\"delivery\", \"secondary\"]\n}" | ||
* "target_path": "address", | ||
* "operation": { | ||
* "_append": [ | ||
* { | ||
* "_tags": [ | ||
* "billing", | ||
* "primary" | ||
* ], | ||
* "street_name": { | ||
* "_copy": "billing_contact.street_name" | ||
* }, | ||
* "street_number": { | ||
* "_copy": "billing_contact.street_number" | ||
* }, | ||
* "city": { | ||
* "_copy": "billing_contact.city" | ||
* }, | ||
* "postal_code": { | ||
* "_copy": "billing_contact.postal_code" | ||
* }, | ||
* "country": { | ||
* "_copy": "billing_contact.country" | ||
* } | ||
* }, | ||
* { | ||
* "_tags": [ | ||
* "delivery" | ||
* ], | ||
* "street_name": { | ||
* "_copy": "delivery_contact.street_name" | ||
* }, | ||
* "street_number": { | ||
* "_copy": "delivery_contact.street_number" | ||
* }, | ||
* "city": { | ||
* "_copy": "delivery_contact.city" | ||
* }, | ||
* "postal_code": { | ||
* "_copy": "delivery_contact.postal_code" | ||
* }, | ||
* "country": { | ||
* "_copy": "delivery_contact.country" | ||
* } | ||
* } | ||
* ], | ||
* "_uniq": [ | ||
* "street_name", | ||
* "street_number", | ||
* "postal_code", | ||
* "country" | ||
* ] | ||
* } | ||
* } | ||
@@ -701,3 +828,3 @@ * ] | ||
name?: string; | ||
type?: string; | ||
type?: "map-entity"; | ||
config?: MapEntityActionConfig; | ||
@@ -711,2 +838,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -729,3 +860,16 @@ [name: string]: any; | ||
*/ | ||
mapping_attributes?: MappingAttribute[]; | ||
mapping_attributes?: (/** | ||
* example: | ||
* { | ||
* "target_path": "_tags", | ||
* "operation": { | ||
* "_append": [ | ||
* "new", | ||
* "tags" | ||
* ], | ||
* "_uniq": true | ||
* } | ||
* } | ||
*/ | ||
MappingAttributeV2 | MappingAttribute)[]; | ||
/** | ||
@@ -739,3 +883,3 @@ * Relation mappings | ||
*/ | ||
linkback_relation_attribute?: string | boolean; | ||
linkback_relation_attribute?: string; | ||
/** | ||
@@ -748,5 +892,3 @@ * Relation tags (labels) to include in main entity linkback relation attribute | ||
/** | ||
* - 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. | ||
* - 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. | ||
* | ||
@@ -757,5 +899,53 @@ */ | ||
* example: | ||
* { | ||
* "target_path": "_tags", | ||
* "operation": { | ||
* "_append": [ | ||
* "new", | ||
* "tags" | ||
* ], | ||
* "_uniq": true | ||
* } | ||
* } | ||
*/ | ||
export interface MappingAttributeV2 { | ||
/** | ||
* Target JSON path for the attribute to set | ||
*/ | ||
target_path?: string; | ||
operation: /* Mapping operation nodes are either primitive values or operation node objects */ OperationNode; | ||
} | ||
/** | ||
* Mapping operation nodes are either primitive values or operation node objects | ||
*/ | ||
export type OperationNode = /* Mapping operation nodes are either primitive values or operation node objects */ OperationObjectNode | /* Represents any primitive JSON value */ PrimitiveJSONValue; | ||
export interface OperationObjectNode { | ||
[name: string]: any; | ||
_set?: /* Represents any primitive JSON value */ PrimitiveJSONValue; | ||
/** | ||
* Append to array | ||
*/ | ||
_append?: any; | ||
/** | ||
* Unique array | ||
*/ | ||
_uniq?: /* Unique array */ boolean | string[]; | ||
/** | ||
* Copy JSONPath value from source entity context | ||
* example: | ||
* contact.first_name | ||
*/ | ||
_copy?: string; | ||
} | ||
/** | ||
* example: | ||
* e3d3ebac-baab-4395-abf4-50b5bf1f8b74 | ||
*/ | ||
export type OrganizationId = string; | ||
/** | ||
* Represents any primitive JSON value | ||
*/ | ||
export type PrimitiveJSONValue = /* Represents any primitive JSON value */ string | boolean | number | { | ||
[name: string]: any; | ||
} | any[]; | ||
export interface RelationAttribute { | ||
@@ -836,3 +1026,3 @@ /** | ||
name?: string; | ||
type?: string; | ||
type?: "send-email"; | ||
config?: SendEmailActionConfig; | ||
@@ -846,2 +1036,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -875,3 +1069,3 @@ [name: string]: any; | ||
* example: | ||
* .* | ||
*/ | ||
@@ -905,9 +1099,6 @@ filename_regex?: string; | ||
}[]; | ||
required?: any; | ||
} | ||
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. | ||
* - 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. | ||
* | ||
@@ -977,3 +1168,3 @@ */ | ||
name?: string; | ||
type?: string; | ||
type?: "trigger-webhook"; | ||
config?: TriggerWebhookActionConfig; | ||
@@ -987,2 +1178,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -1043,3 +1238,3 @@ [name: string]: any; | ||
name?: string; | ||
type?: string; | ||
type?: "trigger-workflow"; | ||
config?: TriggerWorkflowConfig; | ||
@@ -1053,2 +1248,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -1055,0 +1254,0 @@ [name: string]: any; |
{ | ||
"name": "@epilot/automation-client", | ||
"version": "1.8.2", | ||
"version": "1.8.3", | ||
"description": "API Client for epilot automation API", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
@@ -100,41 +100,94 @@ /* eslint-disable */ | ||
* { | ||
* "target": "email", | ||
* "mode": "append_if_exists", | ||
* "source": "billing_contact", | ||
* "value_json": "{\n \"email\": \"billing_contact.email\"\n}" | ||
* "target_path": "_tags", | ||
* "operation": { | ||
* "_append": [ | ||
* "primary", | ||
* "payer" | ||
* ], | ||
* "_uniq": true | ||
* } | ||
* }, | ||
* { | ||
* "target": "_tags", | ||
* "mode": "set_value", | ||
* "value": [ | ||
* "primary", | ||
* "payer" | ||
* ] | ||
* "target_path": "email", | ||
* "operation": { | ||
* "_append": [ | ||
* { | ||
* "email": { | ||
* "_copy": "billing_contact.email" | ||
* } | ||
* } | ||
* ] | ||
* } | ||
* }, | ||
* { | ||
* "target": "first_name", | ||
* "mode": "copy_if_exists", | ||
* "source": "billing_contact.first_name" | ||
* "target_path": "first_name", | ||
* "operation": { | ||
* "_copy": "billing_contact.first_name" | ||
* } | ||
* }, | ||
* { | ||
* "target": "last_name", | ||
* "mode": "copy_if_exists", | ||
* "source": "billing_contact.last_name" | ||
* "target_path": "last_name", | ||
* "operation": { | ||
* "_copy": "billing_contact.last_name" | ||
* } | ||
* }, | ||
* { | ||
* "target": "contact_type", | ||
* "mode": "set_value", | ||
* "value": "customer" | ||
* "target_path": "contact_type", | ||
* "operation": { | ||
* "_set": "customer" | ||
* } | ||
* }, | ||
* { | ||
* "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 \"_tags\": [\"billing\", \"primary\"]\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 \"_tags\": [\"delivery\", \"secondary\"]\n}" | ||
* "target_path": "address", | ||
* "operation": { | ||
* "_append": [ | ||
* { | ||
* "_tags": [ | ||
* "billing", | ||
* "primary" | ||
* ], | ||
* "street_name": { | ||
* "_copy": "billing_contact.street_name" | ||
* }, | ||
* "street_number": { | ||
* "_copy": "billing_contact.street_number" | ||
* }, | ||
* "city": { | ||
* "_copy": "billing_contact.city" | ||
* }, | ||
* "postal_code": { | ||
* "_copy": "billing_contact.postal_code" | ||
* }, | ||
* "country": { | ||
* "_copy": "billing_contact.country" | ||
* } | ||
* }, | ||
* { | ||
* "_tags": [ | ||
* "delivery" | ||
* ], | ||
* "street_name": { | ||
* "_copy": "delivery_contact.street_name" | ||
* }, | ||
* "street_number": { | ||
* "_copy": "delivery_contact.street_number" | ||
* }, | ||
* "city": { | ||
* "_copy": "delivery_contact.city" | ||
* }, | ||
* "postal_code": { | ||
* "_copy": "delivery_contact.postal_code" | ||
* }, | ||
* "country": { | ||
* "_copy": "delivery_contact.country" | ||
* } | ||
* } | ||
* ], | ||
* "_uniq": [ | ||
* "street_name", | ||
* "street_number", | ||
* "postal_code", | ||
* "country" | ||
* ] | ||
* } | ||
* } | ||
@@ -234,5 +287,3 @@ * ] | ||
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. | ||
* - 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. | ||
* | ||
@@ -309,2 +360,6 @@ */ | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -326,6 +381,2 @@ [name: string]: any; | ||
AutomationExecutionId; | ||
/** | ||
* example: | ||
* success | ||
*/ | ||
execution_status?: ExecutionStatus; | ||
@@ -424,3 +475,3 @@ entity_id: /** | ||
name?: string; | ||
type?: string; | ||
type?: "cart-checkout"; | ||
config?: CartCheckoutConfig; | ||
@@ -434,2 +485,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -442,3 +497,16 @@ [name: string]: any; | ||
relation_attributes?: RelationAttribute[]; | ||
mapping_attributes?: MappingAttribute[]; | ||
mapping_attributes?: (/** | ||
* example: | ||
* { | ||
* "target_path": "_tags", | ||
* "operation": { | ||
* "_append": [ | ||
* "new", | ||
* "tags" | ||
* ], | ||
* "_uniq": true | ||
* } | ||
* } | ||
*/ | ||
MappingAttributeV2 | MappingAttribute)[]; | ||
} | ||
@@ -448,5 +516,3 @@ export type Comparison = "equals" | "any_of" | "not_empty" | "is_empty"; | ||
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. | ||
* - 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. | ||
* | ||
@@ -495,3 +561,3 @@ */ | ||
name?: string; | ||
type?: string; | ||
type?: "create-document"; | ||
config?: CreateDocumentConfig; | ||
@@ -505,2 +571,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -560,3 +630,3 @@ [name: string]: any; | ||
name?: string; | ||
type?: string; | ||
type?: "fill-entity"; | ||
config: FillEntityConfig; | ||
@@ -570,2 +640,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -644,41 +718,94 @@ [name: string]: any; | ||
* { | ||
* "target": "email", | ||
* "mode": "append_if_exists", | ||
* "source": "billing_contact", | ||
* "value_json": "{\n \"email\": \"billing_contact.email\"\n}" | ||
* "target_path": "_tags", | ||
* "operation": { | ||
* "_append": [ | ||
* "primary", | ||
* "payer" | ||
* ], | ||
* "_uniq": true | ||
* } | ||
* }, | ||
* { | ||
* "target": "_tags", | ||
* "mode": "set_value", | ||
* "value": [ | ||
* "primary", | ||
* "payer" | ||
* ] | ||
* "target_path": "email", | ||
* "operation": { | ||
* "_append": [ | ||
* { | ||
* "email": { | ||
* "_copy": "billing_contact.email" | ||
* } | ||
* } | ||
* ] | ||
* } | ||
* }, | ||
* { | ||
* "target": "first_name", | ||
* "mode": "copy_if_exists", | ||
* "source": "billing_contact.first_name" | ||
* "target_path": "first_name", | ||
* "operation": { | ||
* "_copy": "billing_contact.first_name" | ||
* } | ||
* }, | ||
* { | ||
* "target": "last_name", | ||
* "mode": "copy_if_exists", | ||
* "source": "billing_contact.last_name" | ||
* "target_path": "last_name", | ||
* "operation": { | ||
* "_copy": "billing_contact.last_name" | ||
* } | ||
* }, | ||
* { | ||
* "target": "contact_type", | ||
* "mode": "set_value", | ||
* "value": "customer" | ||
* "target_path": "contact_type", | ||
* "operation": { | ||
* "_set": "customer" | ||
* } | ||
* }, | ||
* { | ||
* "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 \"_tags\": [\"billing\", \"primary\"]\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 \"_tags\": [\"delivery\", \"secondary\"]\n}" | ||
* "target_path": "address", | ||
* "operation": { | ||
* "_append": [ | ||
* { | ||
* "_tags": [ | ||
* "billing", | ||
* "primary" | ||
* ], | ||
* "street_name": { | ||
* "_copy": "billing_contact.street_name" | ||
* }, | ||
* "street_number": { | ||
* "_copy": "billing_contact.street_number" | ||
* }, | ||
* "city": { | ||
* "_copy": "billing_contact.city" | ||
* }, | ||
* "postal_code": { | ||
* "_copy": "billing_contact.postal_code" | ||
* }, | ||
* "country": { | ||
* "_copy": "billing_contact.country" | ||
* } | ||
* }, | ||
* { | ||
* "_tags": [ | ||
* "delivery" | ||
* ], | ||
* "street_name": { | ||
* "_copy": "delivery_contact.street_name" | ||
* }, | ||
* "street_number": { | ||
* "_copy": "delivery_contact.street_number" | ||
* }, | ||
* "city": { | ||
* "_copy": "delivery_contact.city" | ||
* }, | ||
* "postal_code": { | ||
* "_copy": "delivery_contact.postal_code" | ||
* }, | ||
* "country": { | ||
* "_copy": "delivery_contact.country" | ||
* } | ||
* } | ||
* ], | ||
* "_uniq": [ | ||
* "street_name", | ||
* "street_number", | ||
* "postal_code", | ||
* "country" | ||
* ] | ||
* } | ||
* } | ||
@@ -701,3 +828,3 @@ * ] | ||
name?: string; | ||
type?: string; | ||
type?: "map-entity"; | ||
config?: MapEntityActionConfig; | ||
@@ -711,2 +838,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -729,3 +860,16 @@ [name: string]: any; | ||
*/ | ||
mapping_attributes?: MappingAttribute[]; | ||
mapping_attributes?: (/** | ||
* example: | ||
* { | ||
* "target_path": "_tags", | ||
* "operation": { | ||
* "_append": [ | ||
* "new", | ||
* "tags" | ||
* ], | ||
* "_uniq": true | ||
* } | ||
* } | ||
*/ | ||
MappingAttributeV2 | MappingAttribute)[]; | ||
/** | ||
@@ -739,3 +883,3 @@ * Relation mappings | ||
*/ | ||
linkback_relation_attribute?: string | boolean; | ||
linkback_relation_attribute?: string; | ||
/** | ||
@@ -748,5 +892,3 @@ * Relation tags (labels) to include in main entity linkback relation attribute | ||
/** | ||
* - 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. | ||
* - 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. | ||
* | ||
@@ -757,5 +899,53 @@ */ | ||
* example: | ||
* { | ||
* "target_path": "_tags", | ||
* "operation": { | ||
* "_append": [ | ||
* "new", | ||
* "tags" | ||
* ], | ||
* "_uniq": true | ||
* } | ||
* } | ||
*/ | ||
export interface MappingAttributeV2 { | ||
/** | ||
* Target JSON path for the attribute to set | ||
*/ | ||
target_path?: string; | ||
operation: /* Mapping operation nodes are either primitive values or operation node objects */ OperationNode; | ||
} | ||
/** | ||
* Mapping operation nodes are either primitive values or operation node objects | ||
*/ | ||
export type OperationNode = /* Mapping operation nodes are either primitive values or operation node objects */ OperationObjectNode | /* Represents any primitive JSON value */ PrimitiveJSONValue; | ||
export interface OperationObjectNode { | ||
[name: string]: any; | ||
_set?: /* Represents any primitive JSON value */ PrimitiveJSONValue; | ||
/** | ||
* Append to array | ||
*/ | ||
_append?: any; | ||
/** | ||
* Unique array | ||
*/ | ||
_uniq?: /* Unique array */ boolean | string[]; | ||
/** | ||
* Copy JSONPath value from source entity context | ||
* example: | ||
* contact.first_name | ||
*/ | ||
_copy?: string; | ||
} | ||
/** | ||
* example: | ||
* e3d3ebac-baab-4395-abf4-50b5bf1f8b74 | ||
*/ | ||
export type OrganizationId = string; | ||
/** | ||
* Represents any primitive JSON value | ||
*/ | ||
export type PrimitiveJSONValue = /* Represents any primitive JSON value */ string | boolean | number | { | ||
[name: string]: any; | ||
} | any[]; | ||
export interface RelationAttribute { | ||
@@ -836,3 +1026,3 @@ /** | ||
name?: string; | ||
type?: string; | ||
type?: "send-email"; | ||
config?: SendEmailActionConfig; | ||
@@ -846,2 +1036,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -875,3 +1069,3 @@ [name: string]: any; | ||
* example: | ||
* .* | ||
*/ | ||
@@ -905,9 +1099,6 @@ filename_regex?: string; | ||
}[]; | ||
required?: any; | ||
} | ||
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. | ||
* - 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. | ||
* | ||
@@ -977,3 +1168,3 @@ */ | ||
name?: string; | ||
type?: string; | ||
type?: "trigger-webhook"; | ||
config?: TriggerWebhookActionConfig; | ||
@@ -987,2 +1178,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -1043,3 +1238,3 @@ [name: string]: any; | ||
name?: string; | ||
type?: string; | ||
type?: "trigger-workflow"; | ||
config?: TriggerWorkflowConfig; | ||
@@ -1053,2 +1248,6 @@ execution_status?: ExecutionStatus; | ||
created_automatically?: boolean; | ||
/** | ||
* example: | ||
* {} | ||
*/ | ||
outputs?: { | ||
@@ -1055,0 +1254,0 @@ [name: string]: any; |
Sorry, the diff of this file is too big to display
633834
3370