@epilot/automation-client 1.6.1 → 1.7.0

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.
Files changed (4) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi.d.ts +92 -38
  3. package/package.json +1 -1
  4. package/src/openapi.d.ts +92 -38
package/dist/openapi.d.ts CHANGED
@@ -79,7 +79,17 @@ declare namespace Components {
79
79
  * "config": {
80
80
  * "target_schema": "contact",
81
81
  * "target_unique": [
82
- * "email.email"
82
+ * "email.0.email"
83
+ * ],
84
+ * "relation_attributes": [
85
+ * {
86
+ * "target": "company",
87
+ * "mode": "append",
88
+ * "source_filter": {
89
+ * "schema": "account",
90
+ * "limit": 1
91
+ * }
92
+ * }
83
93
  * ],
84
94
  * "mapping_attributes": [
85
95
  * {
@@ -206,7 +216,7 @@ declare namespace Components {
206
216
  * }
207
217
  * }
208
218
  */
209
- SendEmailAction | AutomationAction;
219
+ SendEmailAction | CartCheckoutAction | AutomationAction;
210
220
  export interface ApiSubmissionTrigger {
211
221
  type: "api_submission";
212
222
  configuration: {
@@ -226,7 +236,7 @@ declare namespace Components {
226
236
  */
227
237
  target: string;
228
238
  /**
229
- * JSON source path for the value to be extracted from. Eg: steps[1].['Product Info'].price
239
+ * JSON source path for the value to be extracted from the main entity. Eg: steps[1].['Product Info'].price
230
240
  *
231
241
  */
232
242
  source?: string;
@@ -385,6 +395,36 @@ declare namespace Components {
385
395
  * 7791b04a-16d2-44a2-9af9-2d59c25c512f
386
396
  */
387
397
  export type AutomationFlowId = string;
398
+ export interface CartCheckoutAction {
399
+ id?: /**
400
+ * example:
401
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
402
+ */
403
+ AutomationActionId;
404
+ flow_action_id?: /**
405
+ * example:
406
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
407
+ */
408
+ AutomationActionId;
409
+ name?: string;
410
+ type?: string;
411
+ config?: CartCheckoutConfig;
412
+ execution_status?: ExecutionStatus;
413
+ started_at?: string;
414
+ updated_at?: string;
415
+ /**
416
+ * Flag indicating whether the action was created automatically or manually
417
+ */
418
+ created_automatically?: boolean;
419
+ outputs?: {
420
+ [name: string]: any;
421
+ };
422
+ error_output?: ErrorOutput;
423
+ }
424
+ export interface CartCheckoutConfig {
425
+ relation_attributes?: RelationAttribute[];
426
+ mapping_attributes?: MappingAttribute[];
427
+ }
388
428
  export type Comparison = "equals" | "any_of" | "not_empty" | "is_empty";
389
429
  export interface CopyValueMapper {
390
430
  mode: /**
@@ -399,7 +439,7 @@ declare namespace Components {
399
439
  */
400
440
  target: string;
401
441
  /**
402
- * JSON source path for the value to be extracted from. Eg: steps[1].['Product Info'].price
442
+ * JSON source path for the value to be extracted from the main entity. Eg: steps[1].['Product Info'].price
403
443
  *
404
444
  */
405
445
  source: string;
@@ -565,7 +605,17 @@ declare namespace Components {
565
605
  * "config": {
566
606
  * "target_schema": "contact",
567
607
  * "target_unique": [
568
- * "email.email"
608
+ * "email.0.email"
609
+ * ],
610
+ * "relation_attributes": [
611
+ * {
612
+ * "target": "company",
613
+ * "mode": "append",
614
+ * "source_filter": {
615
+ * "schema": "account",
616
+ * "limit": 1
617
+ * }
618
+ * }
569
619
  * ],
570
620
  * "mapping_attributes": [
571
621
  * {
@@ -653,47 +703,51 @@ declare namespace Components {
653
703
  *
654
704
  */
655
705
  export type MappingAttributeMode = "copy_if_exists" | "append_if_exists" | "set_value";
656
- export interface OrderCheckoutAction {
657
- id?: /**
658
- * example:
659
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
660
- */
661
- AutomationActionId;
662
- flow_action_id?: /**
663
- * example:
664
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
665
- */
666
- AutomationActionId;
667
- name?: string;
668
- type?: string;
669
- config?: OrderCheckoutConfig;
670
- execution_status?: ExecutionStatus;
671
- started_at?: string;
672
- updated_at?: string;
673
- /**
674
- * Flag indicating whether the action was created automatically or manually
675
- */
676
- created_automatically?: boolean;
677
- outputs?: {
678
- [name: string]: any;
679
- };
680
- error_output?: ErrorOutput;
681
- }
682
- export interface OrderCheckoutConfig {
683
- relation_attributes?: RelationAttribute[];
684
- }
685
706
  /**
686
707
  * example:
687
708
  * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
688
709
  */
689
710
  export type OrganizationId = string;
690
711
  export interface RelationAttribute {
712
+ /**
713
+ * Target attribute to store the relation in
714
+ */
691
715
  target: string;
692
- target_tags: string[];
693
- related_to: {
694
- schema: string;
695
- tag?: string;
716
+ /**
717
+ * Relation tags (labels) to set for the stored relations
718
+ */
719
+ target_tags?: string[];
720
+ /**
721
+ * A filter to identify which source entities to pick as relations from main entity
722
+ */
723
+ source_filter?: {
724
+ /**
725
+ * Limit relations to maximum number (default, all matched relations)
726
+ */
727
+ limit?: number;
728
+ /**
729
+ * Filter by specific schema
730
+ */
731
+ schema?: string;
732
+ /**
733
+ * Filter by a specific relation attribute on the main entity
734
+ */
735
+ attribute?: string;
736
+ /**
737
+ * Filter by relation tag (label) on the main entity
738
+ */
696
739
  relation_tag?: string;
740
+ /**
741
+ * Filter by a specific tag on the related entity
742
+ */
743
+ tag?: string;
744
+ /**
745
+ * Picks main entity as relation (overrides other filters)
746
+ */
747
+ self?: boolean;
748
+ };
749
+ related_to?: {
750
+ [name: string]: any;
697
751
  };
698
752
  mode: "append" | "set";
699
753
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/automation-client",
3
- "version": "1.6.1",
3
+ "version": "1.7.0",
4
4
  "description": "API Client for epilot automation API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/openapi.d.ts CHANGED
@@ -79,7 +79,17 @@ declare namespace Components {
79
79
  * "config": {
80
80
  * "target_schema": "contact",
81
81
  * "target_unique": [
82
- * "email.email"
82
+ * "email.0.email"
83
+ * ],
84
+ * "relation_attributes": [
85
+ * {
86
+ * "target": "company",
87
+ * "mode": "append",
88
+ * "source_filter": {
89
+ * "schema": "account",
90
+ * "limit": 1
91
+ * }
92
+ * }
83
93
  * ],
84
94
  * "mapping_attributes": [
85
95
  * {
@@ -206,7 +216,7 @@ declare namespace Components {
206
216
  * }
207
217
  * }
208
218
  */
209
- SendEmailAction | AutomationAction;
219
+ SendEmailAction | CartCheckoutAction | AutomationAction;
210
220
  export interface ApiSubmissionTrigger {
211
221
  type: "api_submission";
212
222
  configuration: {
@@ -226,7 +236,7 @@ declare namespace Components {
226
236
  */
227
237
  target: string;
228
238
  /**
229
- * JSON source path for the value to be extracted from. Eg: steps[1].['Product Info'].price
239
+ * JSON source path for the value to be extracted from the main entity. Eg: steps[1].['Product Info'].price
230
240
  *
231
241
  */
232
242
  source?: string;
@@ -385,6 +395,36 @@ declare namespace Components {
385
395
  * 7791b04a-16d2-44a2-9af9-2d59c25c512f
386
396
  */
387
397
  export type AutomationFlowId = string;
398
+ export interface CartCheckoutAction {
399
+ id?: /**
400
+ * example:
401
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
402
+ */
403
+ AutomationActionId;
404
+ flow_action_id?: /**
405
+ * example:
406
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
407
+ */
408
+ AutomationActionId;
409
+ name?: string;
410
+ type?: string;
411
+ config?: CartCheckoutConfig;
412
+ execution_status?: ExecutionStatus;
413
+ started_at?: string;
414
+ updated_at?: string;
415
+ /**
416
+ * Flag indicating whether the action was created automatically or manually
417
+ */
418
+ created_automatically?: boolean;
419
+ outputs?: {
420
+ [name: string]: any;
421
+ };
422
+ error_output?: ErrorOutput;
423
+ }
424
+ export interface CartCheckoutConfig {
425
+ relation_attributes?: RelationAttribute[];
426
+ mapping_attributes?: MappingAttribute[];
427
+ }
388
428
  export type Comparison = "equals" | "any_of" | "not_empty" | "is_empty";
389
429
  export interface CopyValueMapper {
390
430
  mode: /**
@@ -399,7 +439,7 @@ declare namespace Components {
399
439
  */
400
440
  target: string;
401
441
  /**
402
- * JSON source path for the value to be extracted from. Eg: steps[1].['Product Info'].price
442
+ * JSON source path for the value to be extracted from the main entity. Eg: steps[1].['Product Info'].price
403
443
  *
404
444
  */
405
445
  source: string;
@@ -565,7 +605,17 @@ declare namespace Components {
565
605
  * "config": {
566
606
  * "target_schema": "contact",
567
607
  * "target_unique": [
568
- * "email.email"
608
+ * "email.0.email"
609
+ * ],
610
+ * "relation_attributes": [
611
+ * {
612
+ * "target": "company",
613
+ * "mode": "append",
614
+ * "source_filter": {
615
+ * "schema": "account",
616
+ * "limit": 1
617
+ * }
618
+ * }
569
619
  * ],
570
620
  * "mapping_attributes": [
571
621
  * {
@@ -653,47 +703,51 @@ declare namespace Components {
653
703
  *
654
704
  */
655
705
  export type MappingAttributeMode = "copy_if_exists" | "append_if_exists" | "set_value";
656
- export interface OrderCheckoutAction {
657
- id?: /**
658
- * example:
659
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
660
- */
661
- AutomationActionId;
662
- flow_action_id?: /**
663
- * example:
664
- * 9ec3711b-db63-449c-b894-54d5bb622a8f
665
- */
666
- AutomationActionId;
667
- name?: string;
668
- type?: string;
669
- config?: OrderCheckoutConfig;
670
- execution_status?: ExecutionStatus;
671
- started_at?: string;
672
- updated_at?: string;
673
- /**
674
- * Flag indicating whether the action was created automatically or manually
675
- */
676
- created_automatically?: boolean;
677
- outputs?: {
678
- [name: string]: any;
679
- };
680
- error_output?: ErrorOutput;
681
- }
682
- export interface OrderCheckoutConfig {
683
- relation_attributes?: RelationAttribute[];
684
- }
685
706
  /**
686
707
  * example:
687
708
  * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
688
709
  */
689
710
  export type OrganizationId = string;
690
711
  export interface RelationAttribute {
712
+ /**
713
+ * Target attribute to store the relation in
714
+ */
691
715
  target: string;
692
- target_tags: string[];
693
- related_to: {
694
- schema: string;
695
- tag?: string;
716
+ /**
717
+ * Relation tags (labels) to set for the stored relations
718
+ */
719
+ target_tags?: string[];
720
+ /**
721
+ * A filter to identify which source entities to pick as relations from main entity
722
+ */
723
+ source_filter?: {
724
+ /**
725
+ * Limit relations to maximum number (default, all matched relations)
726
+ */
727
+ limit?: number;
728
+ /**
729
+ * Filter by specific schema
730
+ */
731
+ schema?: string;
732
+ /**
733
+ * Filter by a specific relation attribute on the main entity
734
+ */
735
+ attribute?: string;
736
+ /**
737
+ * Filter by relation tag (label) on the main entity
738
+ */
696
739
  relation_tag?: string;
740
+ /**
741
+ * Filter by a specific tag on the related entity
742
+ */
743
+ tag?: string;
744
+ /**
745
+ * Picks main entity as relation (overrides other filters)
746
+ */
747
+ self?: boolean;
748
+ };
749
+ related_to?: {
750
+ [name: string]: any;
697
751
  };
698
752
  mode: "append" | "set";
699
753
  }