@epilot/automation-client 1.8.2 → 1.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/openapi.d.ts CHANGED
@@ -97,45 +97,98 @@ declare namespace Components {
97
97
  * ],
98
98
  * "mapping_attributes": [
99
99
  * {
100
- * "target": "email",
101
- * "mode": "append_if_exists",
102
- * "source": "billing_contact",
103
- * "value_json": "{\n \"email\": \"billing_contact.email\"\n}"
104
- * },
105
- * {
106
- * "target": "_tags",
107
- * "mode": "set_value",
108
- * "value": [
109
- * "primary",
110
- * "payer"
111
- * ]
100
+ * "target_path": "_tags",
101
+ * "operation": {
102
+ * "_append": [
103
+ * "primary",
104
+ * "payer"
105
+ * ],
106
+ * "_uniq": true
107
+ * }
112
108
  * },
113
109
  * {
114
- * "target": "first_name",
115
- * "mode": "copy_if_exists",
116
- * "source": "billing_contact.first_name"
110
+ * "target_path": "email",
111
+ * "operation": {
112
+ * "_append": [
113
+ * {
114
+ * "email": {
115
+ * "_copy": "billing_contact.email"
116
+ * }
117
+ * }
118
+ * ]
119
+ * }
117
120
  * },
118
121
  * {
119
- * "target": "last_name",
120
- * "mode": "copy_if_exists",
121
- * "source": "billing_contact.last_name"
122
+ * "target_path": "first_name",
123
+ * "operation": {
124
+ * "_copy": "billing_contact.first_name"
125
+ * }
122
126
  * },
123
127
  * {
124
- * "target": "contact_type",
125
- * "mode": "set_value",
126
- * "value": "customer"
128
+ * "target_path": "last_name",
129
+ * "operation": {
130
+ * "_copy": "billing_contact.last_name"
131
+ * }
127
132
  * },
128
133
  * {
129
- * "target": "addresses",
130
- * "mode": "append_if_exists",
131
- * "source": "billing_contact",
132
- * "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}"
134
+ * "target_path": "contact_type",
135
+ * "operation": {
136
+ * "_set": "customer"
137
+ * }
133
138
  * },
134
139
  * {
135
- * "target": "addresses",
136
- * "mode": "append_if_exists",
137
- * "source": "delivery_contact",
138
- * "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}"
140
+ * "target_path": "address",
141
+ * "operation": {
142
+ * "_append": [
143
+ * {
144
+ * "_tags": [
145
+ * "billing",
146
+ * "primary"
147
+ * ],
148
+ * "street_name": {
149
+ * "_copy": "billing_contact.street_name"
150
+ * },
151
+ * "street_number": {
152
+ * "_copy": "billing_contact.street_number"
153
+ * },
154
+ * "city": {
155
+ * "_copy": "billing_contact.city"
156
+ * },
157
+ * "postal_code": {
158
+ * "_copy": "billing_contact.postal_code"
159
+ * },
160
+ * "country": {
161
+ * "_copy": "billing_contact.country"
162
+ * }
163
+ * },
164
+ * {
165
+ * "_tags": [
166
+ * "delivery"
167
+ * ],
168
+ * "street_name": {
169
+ * "_copy": "delivery_contact.street_name"
170
+ * },
171
+ * "street_number": {
172
+ * "_copy": "delivery_contact.street_number"
173
+ * },
174
+ * "city": {
175
+ * "_copy": "delivery_contact.city"
176
+ * },
177
+ * "postal_code": {
178
+ * "_copy": "delivery_contact.postal_code"
179
+ * },
180
+ * "country": {
181
+ * "_copy": "delivery_contact.country"
182
+ * }
183
+ * }
184
+ * ],
185
+ * "_uniq": [
186
+ * "street_name",
187
+ * "street_number",
188
+ * "postal_code",
189
+ * "country"
190
+ * ]
191
+ * }
139
192
  * }
140
193
  * ]
141
194
  * }
@@ -230,9 +283,7 @@ declare namespace Components {
230
283
  }
231
284
  export interface AppendValueMapper {
232
285
  mode: /**
233
- * - copy_if_exists - it replaces the target attribute with the source value
234
- * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
235
- * - set_value - it sets a value to a predefined value. Must be used together with value property.
286
+ * - 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.
236
287
  *
237
288
  */
238
289
  MappingAttributeMode;
@@ -304,6 +355,10 @@ declare namespace Components {
304
355
  * Flag indicating whether the action was created automatically or manually
305
356
  */
306
357
  created_automatically?: boolean;
358
+ /**
359
+ * example:
360
+ * {}
361
+ */
307
362
  outputs?: {
308
363
  [name: string]: any;
309
364
  };
@@ -320,10 +375,6 @@ declare namespace Components {
320
375
  * 9baf184f-bc81-4128-bca3-d974c90a12c4
321
376
  */
322
377
  AutomationExecutionId;
323
- /**
324
- * example:
325
- * success
326
- */
327
378
  execution_status?: ExecutionStatus;
328
379
  entity_id: /**
329
380
  * example:
@@ -417,7 +468,7 @@ declare namespace Components {
417
468
  */
418
469
  AutomationActionId;
419
470
  name?: string;
420
- type?: string;
471
+ type?: "cart-checkout";
421
472
  config?: CartCheckoutConfig;
422
473
  execution_status?: ExecutionStatus;
423
474
  started_at?: string;
@@ -426,6 +477,10 @@ declare namespace Components {
426
477
  * Flag indicating whether the action was created automatically or manually
427
478
  */
428
479
  created_automatically?: boolean;
480
+ /**
481
+ * example:
482
+ * {}
483
+ */
429
484
  outputs?: {
430
485
  [name: string]: any;
431
486
  };
@@ -433,14 +488,25 @@ declare namespace Components {
433
488
  }
434
489
  export interface CartCheckoutConfig {
435
490
  relation_attributes?: RelationAttribute[];
436
- mapping_attributes?: MappingAttribute[];
491
+ mapping_attributes?: (/**
492
+ * example:
493
+ * {
494
+ * "target_path": "_tags",
495
+ * "operation": {
496
+ * "_append": [
497
+ * "new",
498
+ * "tags"
499
+ * ],
500
+ * "_uniq": true
501
+ * }
502
+ * }
503
+ */
504
+ MappingAttributeV2 | MappingAttribute)[];
437
505
  }
438
506
  export type Comparison = "equals" | "any_of" | "not_empty" | "is_empty";
439
507
  export interface CopyValueMapper {
440
508
  mode: /**
441
- * - copy_if_exists - it replaces the target attribute with the source value
442
- * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
443
- * - set_value - it sets a value to a predefined value. Must be used together with value property.
509
+ * - 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.
444
510
  *
445
511
  */
446
512
  MappingAttributeMode;
@@ -484,7 +550,7 @@ declare namespace Components {
484
550
  */
485
551
  AutomationActionId;
486
552
  name?: string;
487
- type?: string;
553
+ type?: "create-document";
488
554
  config?: CreateDocumentConfig;
489
555
  execution_status?: ExecutionStatus;
490
556
  started_at?: string;
@@ -493,6 +559,10 @@ declare namespace Components {
493
559
  * Flag indicating whether the action was created automatically or manually
494
560
  */
495
561
  created_automatically?: boolean;
562
+ /**
563
+ * example:
564
+ * {}
565
+ */
496
566
  outputs?: {
497
567
  [name: string]: any;
498
568
  };
@@ -547,7 +617,7 @@ declare namespace Components {
547
617
  */
548
618
  AutomationActionId;
549
619
  name?: string;
550
- type?: string;
620
+ type?: "fill-entity";
551
621
  config: FillEntityConfig;
552
622
  execution_status?: ExecutionStatus;
553
623
  started_at?: string;
@@ -556,6 +626,10 @@ declare namespace Components {
556
626
  * Flag indicating whether the action was created automatically or manually
557
627
  */
558
628
  created_automatically?: boolean;
629
+ /**
630
+ * example:
631
+ * {}
632
+ */
559
633
  outputs?: {
560
634
  [name: string]: any;
561
635
  };
@@ -629,45 +703,98 @@ declare namespace Components {
629
703
  * ],
630
704
  * "mapping_attributes": [
631
705
  * {
632
- * "target": "email",
633
- * "mode": "append_if_exists",
634
- * "source": "billing_contact",
635
- * "value_json": "{\n \"email\": \"billing_contact.email\"\n}"
636
- * },
637
- * {
638
- * "target": "_tags",
639
- * "mode": "set_value",
640
- * "value": [
641
- * "primary",
642
- * "payer"
643
- * ]
706
+ * "target_path": "_tags",
707
+ * "operation": {
708
+ * "_append": [
709
+ * "primary",
710
+ * "payer"
711
+ * ],
712
+ * "_uniq": true
713
+ * }
644
714
  * },
645
715
  * {
646
- * "target": "first_name",
647
- * "mode": "copy_if_exists",
648
- * "source": "billing_contact.first_name"
716
+ * "target_path": "email",
717
+ * "operation": {
718
+ * "_append": [
719
+ * {
720
+ * "email": {
721
+ * "_copy": "billing_contact.email"
722
+ * }
723
+ * }
724
+ * ]
725
+ * }
649
726
  * },
650
727
  * {
651
- * "target": "last_name",
652
- * "mode": "copy_if_exists",
653
- * "source": "billing_contact.last_name"
728
+ * "target_path": "first_name",
729
+ * "operation": {
730
+ * "_copy": "billing_contact.first_name"
731
+ * }
654
732
  * },
655
733
  * {
656
- * "target": "contact_type",
657
- * "mode": "set_value",
658
- * "value": "customer"
734
+ * "target_path": "last_name",
735
+ * "operation": {
736
+ * "_copy": "billing_contact.last_name"
737
+ * }
659
738
  * },
660
739
  * {
661
- * "target": "addresses",
662
- * "mode": "append_if_exists",
663
- * "source": "billing_contact",
664
- * "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}"
740
+ * "target_path": "contact_type",
741
+ * "operation": {
742
+ * "_set": "customer"
743
+ * }
665
744
  * },
666
745
  * {
667
- * "target": "addresses",
668
- * "mode": "append_if_exists",
669
- * "source": "delivery_contact",
670
- * "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}"
746
+ * "target_path": "address",
747
+ * "operation": {
748
+ * "_append": [
749
+ * {
750
+ * "_tags": [
751
+ * "billing",
752
+ * "primary"
753
+ * ],
754
+ * "street_name": {
755
+ * "_copy": "billing_contact.street_name"
756
+ * },
757
+ * "street_number": {
758
+ * "_copy": "billing_contact.street_number"
759
+ * },
760
+ * "city": {
761
+ * "_copy": "billing_contact.city"
762
+ * },
763
+ * "postal_code": {
764
+ * "_copy": "billing_contact.postal_code"
765
+ * },
766
+ * "country": {
767
+ * "_copy": "billing_contact.country"
768
+ * }
769
+ * },
770
+ * {
771
+ * "_tags": [
772
+ * "delivery"
773
+ * ],
774
+ * "street_name": {
775
+ * "_copy": "delivery_contact.street_name"
776
+ * },
777
+ * "street_number": {
778
+ * "_copy": "delivery_contact.street_number"
779
+ * },
780
+ * "city": {
781
+ * "_copy": "delivery_contact.city"
782
+ * },
783
+ * "postal_code": {
784
+ * "_copy": "delivery_contact.postal_code"
785
+ * },
786
+ * "country": {
787
+ * "_copy": "delivery_contact.country"
788
+ * }
789
+ * }
790
+ * ],
791
+ * "_uniq": [
792
+ * "street_name",
793
+ * "street_number",
794
+ * "postal_code",
795
+ * "country"
796
+ * ]
797
+ * }
671
798
  * }
672
799
  * ]
673
800
  * }
@@ -685,7 +812,7 @@ declare namespace Components {
685
812
  */
686
813
  AutomationActionId;
687
814
  name?: string;
688
- type?: string;
815
+ type?: "map-entity";
689
816
  config?: MapEntityActionConfig;
690
817
  execution_status?: ExecutionStatus;
691
818
  started_at?: string;
@@ -694,6 +821,10 @@ declare namespace Components {
694
821
  * Flag indicating whether the action was created automatically or manually
695
822
  */
696
823
  created_automatically?: boolean;
824
+ /**
825
+ * example:
826
+ * {}
827
+ */
697
828
  outputs?: {
698
829
  [name: string]: any;
699
830
  };
@@ -711,7 +842,20 @@ declare namespace Components {
711
842
  /**
712
843
  * Attribute mappings
713
844
  */
714
- mapping_attributes?: MappingAttribute[];
845
+ mapping_attributes?: (/**
846
+ * example:
847
+ * {
848
+ * "target_path": "_tags",
849
+ * "operation": {
850
+ * "_append": [
851
+ * "new",
852
+ * "tags"
853
+ * ],
854
+ * "_uniq": true
855
+ * }
856
+ * }
857
+ */
858
+ MappingAttributeV2 | MappingAttribute)[];
715
859
  /**
716
860
  * Relation mappings
717
861
  */
@@ -720,7 +864,7 @@ declare namespace Components {
720
864
  * Relation attribute on the main entity where the target entity will be linked. Set to false to disable linkback
721
865
  *
722
866
  */
723
- linkback_relation_attribute?: string | boolean;
867
+ linkback_relation_attribute?: string;
724
868
  /**
725
869
  * Relation tags (labels) to include in main entity linkback relation attribute
726
870
  */
@@ -728,17 +872,63 @@ declare namespace Components {
728
872
  }
729
873
  export type MappingAttribute = SetValueMapper | CopyValueMapper | AppendValueMapper;
730
874
  /**
731
- * - copy_if_exists - it replaces the target attribute with the source value
732
- * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
733
- * - set_value - it sets a value to a predefined value. Must be used together with value property.
875
+ * - 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.
734
876
  *
735
877
  */
736
878
  export type MappingAttributeMode = "copy_if_exists" | "append_if_exists" | "set_value";
879
+ /**
880
+ * example:
881
+ * {
882
+ * "target_path": "_tags",
883
+ * "operation": {
884
+ * "_append": [
885
+ * "new",
886
+ * "tags"
887
+ * ],
888
+ * "_uniq": true
889
+ * }
890
+ * }
891
+ */
892
+ export interface MappingAttributeV2 {
893
+ /**
894
+ * Target JSON path for the attribute to set
895
+ */
896
+ target_path?: string;
897
+ operation: /* Mapping operation nodes are either primitive values or operation node objects */ OperationNode;
898
+ }
899
+ /**
900
+ * Mapping operation nodes are either primitive values or operation node objects
901
+ */
902
+ export type OperationNode = /* Mapping operation nodes are either primitive values or operation node objects */ OperationObjectNode | /* Represents any primitive JSON value */ PrimitiveJSONValue;
903
+ export interface OperationObjectNode {
904
+ [name: string]: any;
905
+ _set?: /* Represents any primitive JSON value */ PrimitiveJSONValue;
906
+ /**
907
+ * Append to array
908
+ */
909
+ _append?: any;
910
+ /**
911
+ * Unique array
912
+ */
913
+ _uniq?: /* Unique array */ boolean | string[];
914
+ /**
915
+ * Copy JSONPath value from source entity context
916
+ * example:
917
+ * contact.first_name
918
+ */
919
+ _copy?: string;
920
+ }
737
921
  /**
738
922
  * example:
739
923
  * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
740
924
  */
741
925
  export type OrganizationId = string;
926
+ /**
927
+ * Represents any primitive JSON value
928
+ */
929
+ export type PrimitiveJSONValue = /* Represents any primitive JSON value */ string | boolean | number | {
930
+ [name: string]: any;
931
+ } | any[];
742
932
  export interface RelationAttribute {
743
933
  /**
744
934
  * Target attribute to store the relation in
@@ -814,7 +1004,7 @@ declare namespace Components {
814
1004
  */
815
1005
  AutomationActionId;
816
1006
  name?: string;
817
- type?: string;
1007
+ type?: "send-email";
818
1008
  config?: SendEmailActionConfig;
819
1009
  execution_status?: ExecutionStatus;
820
1010
  started_at?: string;
@@ -823,6 +1013,10 @@ declare namespace Components {
823
1013
  * Flag indicating whether the action was created automatically or manually
824
1014
  */
825
1015
  created_automatically?: boolean;
1016
+ /**
1017
+ * example:
1018
+ * {}
1019
+ */
826
1020
  outputs?: {
827
1021
  [name: string]: any;
828
1022
  };
@@ -851,7 +1045,7 @@ declare namespace Components {
851
1045
  /**
852
1046
  * Match by filename. Regex syntax supported
853
1047
  * example:
854
- * .*\.pdf
1048
+ * .*
855
1049
  */
856
1050
  filename_regex?: string;
857
1051
  /**
@@ -880,13 +1074,10 @@ declare namespace Components {
880
1074
  self?: boolean;
881
1075
  };
882
1076
  }[];
883
- required?: any;
884
1077
  }
885
1078
  export interface SetValueMapper {
886
1079
  mode: /**
887
- * - copy_if_exists - it replaces the target attribute with the source value
888
- * - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute.
889
- * - set_value - it sets a value to a predefined value. Must be used together with value property.
1080
+ * - 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.
890
1081
  *
891
1082
  */
892
1083
  MappingAttributeMode;
@@ -951,7 +1142,7 @@ declare namespace Components {
951
1142
  */
952
1143
  AutomationActionId;
953
1144
  name?: string;
954
- type?: string;
1145
+ type?: "trigger-webhook";
955
1146
  config?: TriggerWebhookActionConfig;
956
1147
  execution_status?: ExecutionStatus;
957
1148
  started_at?: string;
@@ -960,6 +1151,10 @@ declare namespace Components {
960
1151
  * Flag indicating whether the action was created automatically or manually
961
1152
  */
962
1153
  created_automatically?: boolean;
1154
+ /**
1155
+ * example:
1156
+ * {}
1157
+ */
963
1158
  outputs?: {
964
1159
  [name: string]: any;
965
1160
  };
@@ -1015,7 +1210,7 @@ declare namespace Components {
1015
1210
  */
1016
1211
  AutomationActionId;
1017
1212
  name?: string;
1018
- type?: string;
1213
+ type?: "trigger-workflow";
1019
1214
  config?: TriggerWorkflowConfig;
1020
1215
  execution_status?: ExecutionStatus;
1021
1216
  started_at?: string;
@@ -1024,6 +1219,10 @@ declare namespace Components {
1024
1219
  * Flag indicating whether the action was created automatically or manually
1025
1220
  */
1026
1221
  created_automatically?: boolean;
1222
+ /**
1223
+ * example:
1224
+ * {}
1225
+ */
1027
1226
  outputs?: {
1028
1227
  [name: string]: any;
1029
1228
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/automation-client",
3
- "version": "1.8.2",
3
+ "version": "1.8.3",
4
4
  "description": "API Client for epilot automation API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",