@epilot/automation-client 1.4.1 → 1.5.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 +113 -53
  3. package/package.json +1 -1
  4. package/src/openapi.d.ts +113 -53
package/dist/openapi.d.ts CHANGED
@@ -9,6 +9,67 @@ import type {
9
9
 
10
10
  declare namespace Components {
11
11
  namespace Schemas {
12
+ /**
13
+ * example:
14
+ * {
15
+ * "target": {
16
+ * "schema": "contact",
17
+ * "tag": "primary",
18
+ * "key": "address",
19
+ * "value_json": "{\"_tags\": [\"billing\"],\"city\":\"steps[0][Adresse][city]\",\"country\":\"steps[0][Adresse][countryCode]\",\"postal_code\":\"steps[0][Adresse][zipCode]\",\"street\":\"steps[0][Adresse][streetName]\",\"street_number\":\"steps[0][Adresse][houseNumber]\",\"additional_info\":\"steps[0][Adresse][addressExtention]\"}",
20
+ * "target_unique": [
21
+ * "country",
22
+ * "city",
23
+ * "postal_code",
24
+ * "street",
25
+ * "street_number"
26
+ * ]
27
+ * },
28
+ * "reference": {
29
+ * "schema": "opportunity",
30
+ * "key": "billing_address"
31
+ * }
32
+ * }
33
+ */
34
+ export interface AddressMapper {
35
+ target: {
36
+ /**
37
+ * schema & tag identify the target entity for the address.
38
+ */
39
+ schema: string;
40
+ /**
41
+ * schema & tag identify the target entity for the address.
42
+ */
43
+ tag: string;
44
+ /**
45
+ * target field for where to store this address.
46
+ */
47
+ key: string;
48
+ /**
49
+ * stringified JSON for how to map address data
50
+ */
51
+ value_json: string;
52
+ /**
53
+ * Array of keys which should be used when checking for uniqueness. Eg: [country, city, postal_code]
54
+ *
55
+ */
56
+ target_unique?: string[];
57
+ };
58
+ reference: {
59
+ /**
60
+ * Schema of the entity where the reference will be stored.
61
+ */
62
+ schema: string;
63
+ /**
64
+ * Field location to store the reference.
65
+ */
66
+ key: string;
67
+ /**
68
+ * Optional relation labels to give meaning to this reference.
69
+ */
70
+ labels?: string[];
71
+ };
72
+ }
12
73
  export type AnyAction = /**
13
74
  * example:
14
75
  * {
@@ -66,7 +127,7 @@ declare namespace Components {
66
127
  * }
67
128
  * }
68
129
  */
69
- MapEntityAction | /**
130
+ MapEntityAction | FillEntityAction | /**
70
131
  * example:
71
132
  * {
72
133
  * "id": "08g988-ojt2jtaga-292h-8978gsaga",
@@ -418,6 +479,57 @@ declare namespace Components {
418
479
  error_reason: string;
419
480
  }
420
481
  export type ExecutionStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled";
482
+ export interface FillEntityAction {
483
+ id?: /**
484
+ * example:
485
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
486
+ */
487
+ AutomationActionId;
488
+ flow_action_id?: /**
489
+ * example:
490
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
491
+ */
492
+ AutomationActionId;
493
+ name?: string;
494
+ type?: string;
495
+ config: FillEntityConfig;
496
+ execution_status?: ExecutionStatus;
497
+ started_at?: string;
498
+ updated_at?: string;
499
+ /**
500
+ * Flag indicating whether the action was created automatically or manually
501
+ */
502
+ created_automatically?: boolean;
503
+ outputs?: {
504
+ [name: string]: any;
505
+ };
506
+ error_output?: ErrorOutput;
507
+ }
508
+ export interface FillEntityConfig {
509
+ mappings: /**
510
+ * example:
511
+ * {
512
+ * "target": {
513
+ * "schema": "contact",
514
+ * "tag": "primary",
515
+ * "key": "address",
516
+ * "value_json": "{\"_tags\": [\"billing\"],\"city\":\"steps[0][Adresse][city]\",\"country\":\"steps[0][Adresse][countryCode]\",\"postal_code\":\"steps[0][Adresse][zipCode]\",\"street\":\"steps[0][Adresse][streetName]\",\"street_number\":\"steps[0][Adresse][houseNumber]\",\"additional_info\":\"steps[0][Adresse][addressExtention]\"}",
517
+ * "target_unique": [
518
+ * "country",
519
+ * "city",
520
+ * "postal_code",
521
+ * "street",
522
+ * "street_number"
523
+ * ]
524
+ * },
525
+ * "reference": {
526
+ * "schema": "opportunity",
527
+ * "key": "billing_address"
528
+ * }
529
+ * }
530
+ */
531
+ AddressMapper[];
532
+ }
421
533
  export interface FrontendSubmitTrigger {
422
534
  type: "frontend_submission";
423
535
  configuration: {
@@ -526,21 +638,6 @@ declare namespace Components {
526
638
  target_unique?: string[];
527
639
  mapping_attributes?: MappingAttribute[];
528
640
  relation_attributes?: RelationAttribute[];
529
- reference_attributes?: /**
530
- * example:
531
- * {
532
- * "target": {
533
- * "key": "addresses"
534
- * },
535
- * "source": {
536
- * "schema": "contact",
537
- * "tag": "primary",
538
- * "key": "address",
539
- * "value_tag": "billing"
540
- * }
541
- * }
542
- */
543
- ReferenceAttribute[];
544
641
  }
545
642
  export type MappingAttribute = SetValueMapper | CopyValueMapper | AppendValueMapper;
546
643
  /**
@@ -584,43 +681,6 @@ declare namespace Components {
584
681
  * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
585
682
  */
586
683
  export type OrganizationId = string;
587
- /**
588
- * example:
589
- * {
590
- * "target": {
591
- * "key": "addresses"
592
- * },
593
- * "source": {
594
- * "schema": "contact",
595
- * "tag": "primary",
596
- * "key": "address",
597
- * "value_tag": "billing"
598
- * }
599
- * }
600
- */
601
- export interface ReferenceAttribute {
602
- target: {
603
- key: string;
604
- };
605
- source: {
606
- /**
607
- * Schema of source object. eg contact
608
- */
609
- schema: string;
610
- /**
611
- * identifier tag of source object. eg primary
612
- */
613
- tag: string;
614
- /**
615
- * location of source data. eg address
616
- */
617
- key: string;
618
- /**
619
- * identifier tag of source data. eg billing
620
- */
621
- value_tag: string;
622
- };
623
- }
624
684
  export interface RelationAttribute {
625
685
  target: string;
626
686
  target_tags: string[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/automation-client",
3
- "version": "1.4.1",
3
+ "version": "1.5.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
@@ -9,6 +9,67 @@ import type {
9
9
 
10
10
  declare namespace Components {
11
11
  namespace Schemas {
12
+ /**
13
+ * example:
14
+ * {
15
+ * "target": {
16
+ * "schema": "contact",
17
+ * "tag": "primary",
18
+ * "key": "address",
19
+ * "value_json": "{\"_tags\": [\"billing\"],\"city\":\"steps[0][Adresse][city]\",\"country\":\"steps[0][Adresse][countryCode]\",\"postal_code\":\"steps[0][Adresse][zipCode]\",\"street\":\"steps[0][Adresse][streetName]\",\"street_number\":\"steps[0][Adresse][houseNumber]\",\"additional_info\":\"steps[0][Adresse][addressExtention]\"}",
20
+ * "target_unique": [
21
+ * "country",
22
+ * "city",
23
+ * "postal_code",
24
+ * "street",
25
+ * "street_number"
26
+ * ]
27
+ * },
28
+ * "reference": {
29
+ * "schema": "opportunity",
30
+ * "key": "billing_address"
31
+ * }
32
+ * }
33
+ */
34
+ export interface AddressMapper {
35
+ target: {
36
+ /**
37
+ * schema & tag identify the target entity for the address.
38
+ */
39
+ schema: string;
40
+ /**
41
+ * schema & tag identify the target entity for the address.
42
+ */
43
+ tag: string;
44
+ /**
45
+ * target field for where to store this address.
46
+ */
47
+ key: string;
48
+ /**
49
+ * stringified JSON for how to map address data
50
+ */
51
+ value_json: string;
52
+ /**
53
+ * Array of keys which should be used when checking for uniqueness. Eg: [country, city, postal_code]
54
+ *
55
+ */
56
+ target_unique?: string[];
57
+ };
58
+ reference: {
59
+ /**
60
+ * Schema of the entity where the reference will be stored.
61
+ */
62
+ schema: string;
63
+ /**
64
+ * Field location to store the reference.
65
+ */
66
+ key: string;
67
+ /**
68
+ * Optional relation labels to give meaning to this reference.
69
+ */
70
+ labels?: string[];
71
+ };
72
+ }
12
73
  export type AnyAction = /**
13
74
  * example:
14
75
  * {
@@ -66,7 +127,7 @@ declare namespace Components {
66
127
  * }
67
128
  * }
68
129
  */
69
- MapEntityAction | /**
130
+ MapEntityAction | FillEntityAction | /**
70
131
  * example:
71
132
  * {
72
133
  * "id": "08g988-ojt2jtaga-292h-8978gsaga",
@@ -418,6 +479,57 @@ declare namespace Components {
418
479
  error_reason: string;
419
480
  }
420
481
  export type ExecutionStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled";
482
+ export interface FillEntityAction {
483
+ id?: /**
484
+ * example:
485
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
486
+ */
487
+ AutomationActionId;
488
+ flow_action_id?: /**
489
+ * example:
490
+ * 9ec3711b-db63-449c-b894-54d5bb622a8f
491
+ */
492
+ AutomationActionId;
493
+ name?: string;
494
+ type?: string;
495
+ config: FillEntityConfig;
496
+ execution_status?: ExecutionStatus;
497
+ started_at?: string;
498
+ updated_at?: string;
499
+ /**
500
+ * Flag indicating whether the action was created automatically or manually
501
+ */
502
+ created_automatically?: boolean;
503
+ outputs?: {
504
+ [name: string]: any;
505
+ };
506
+ error_output?: ErrorOutput;
507
+ }
508
+ export interface FillEntityConfig {
509
+ mappings: /**
510
+ * example:
511
+ * {
512
+ * "target": {
513
+ * "schema": "contact",
514
+ * "tag": "primary",
515
+ * "key": "address",
516
+ * "value_json": "{\"_tags\": [\"billing\"],\"city\":\"steps[0][Adresse][city]\",\"country\":\"steps[0][Adresse][countryCode]\",\"postal_code\":\"steps[0][Adresse][zipCode]\",\"street\":\"steps[0][Adresse][streetName]\",\"street_number\":\"steps[0][Adresse][houseNumber]\",\"additional_info\":\"steps[0][Adresse][addressExtention]\"}",
517
+ * "target_unique": [
518
+ * "country",
519
+ * "city",
520
+ * "postal_code",
521
+ * "street",
522
+ * "street_number"
523
+ * ]
524
+ * },
525
+ * "reference": {
526
+ * "schema": "opportunity",
527
+ * "key": "billing_address"
528
+ * }
529
+ * }
530
+ */
531
+ AddressMapper[];
532
+ }
421
533
  export interface FrontendSubmitTrigger {
422
534
  type: "frontend_submission";
423
535
  configuration: {
@@ -526,21 +638,6 @@ declare namespace Components {
526
638
  target_unique?: string[];
527
639
  mapping_attributes?: MappingAttribute[];
528
640
  relation_attributes?: RelationAttribute[];
529
- reference_attributes?: /**
530
- * example:
531
- * {
532
- * "target": {
533
- * "key": "addresses"
534
- * },
535
- * "source": {
536
- * "schema": "contact",
537
- * "tag": "primary",
538
- * "key": "address",
539
- * "value_tag": "billing"
540
- * }
541
- * }
542
- */
543
- ReferenceAttribute[];
544
641
  }
545
642
  export type MappingAttribute = SetValueMapper | CopyValueMapper | AppendValueMapper;
546
643
  /**
@@ -584,43 +681,6 @@ declare namespace Components {
584
681
  * e3d3ebac-baab-4395-abf4-50b5bf1f8b74
585
682
  */
586
683
  export type OrganizationId = string;
587
- /**
588
- * example:
589
- * {
590
- * "target": {
591
- * "key": "addresses"
592
- * },
593
- * "source": {
594
- * "schema": "contact",
595
- * "tag": "primary",
596
- * "key": "address",
597
- * "value_tag": "billing"
598
- * }
599
- * }
600
- */
601
- export interface ReferenceAttribute {
602
- target: {
603
- key: string;
604
- };
605
- source: {
606
- /**
607
- * Schema of source object. eg contact
608
- */
609
- schema: string;
610
- /**
611
- * identifier tag of source object. eg primary
612
- */
613
- tag: string;
614
- /**
615
- * location of source data. eg address
616
- */
617
- key: string;
618
- /**
619
- * identifier tag of source data. eg billing
620
- */
621
- value_tag: string;
622
- };
623
- }
624
684
  export interface RelationAttribute {
625
685
  target: string;
626
686
  target_tags: string[];