@epilot/entity-client 3.0.1 → 3.0.4

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 (5) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi.d.ts +97 -2
  3. package/dist/openapi.json +27 -5
  4. package/package-lock.json +18779 -0
  5. package/package.json +1 -1
package/dist/openapi.d.ts CHANGED
@@ -201,6 +201,10 @@ declare namespace Components {
201
201
  * Setting to `true` disables editing the attribute on the entity builder UI
202
202
  */
203
203
  entity_builder_disable_edit?: boolean;
204
+ /**
205
+ * Setting to `true` prevents the attribute from being modified / deleted
206
+ */
207
+ protected?: boolean;
204
208
  type?: "relation_address";
205
209
  has_primary?: boolean;
206
210
  }
@@ -275,6 +279,10 @@ declare namespace Components {
275
279
  * Setting to `true` disables editing the attribute on the entity builder UI
276
280
  */
277
281
  entity_builder_disable_edit?: boolean;
282
+ /**
283
+ * Setting to `true` prevents the attribute from being modified / deleted
284
+ */
285
+ protected?: boolean;
278
286
  }
279
287
  /**
280
288
  * example:
@@ -378,6 +386,10 @@ declare namespace Components {
378
386
  * Setting to `true` disables editing the attribute on the entity builder UI
379
387
  */
380
388
  entity_builder_disable_edit?: boolean;
389
+ /**
390
+ * Setting to `true` prevents the attribute from being modified / deleted
391
+ */
392
+ protected?: boolean;
381
393
  type?: "boolean";
382
394
  }
383
395
  /**
@@ -444,6 +456,10 @@ declare namespace Components {
444
456
  * Setting to `true` disables editing the attribute on the entity builder UI
445
457
  */
446
458
  entity_builder_disable_edit?: boolean;
459
+ /**
460
+ * Setting to `true` prevents the attribute from being modified / deleted
461
+ */
462
+ protected?: boolean;
447
463
  type?: "computed";
448
464
  }
449
465
  /**
@@ -510,6 +526,10 @@ declare namespace Components {
510
526
  * Setting to `true` disables editing the attribute on the entity builder UI
511
527
  */
512
528
  entity_builder_disable_edit?: boolean;
529
+ /**
530
+ * Setting to `true` prevents the attribute from being modified / deleted
531
+ */
532
+ protected?: boolean;
513
533
  type: "consent";
514
534
  topic: string;
515
535
  identifiers?: string[];
@@ -578,6 +598,10 @@ declare namespace Components {
578
598
  * Setting to `true` disables editing the attribute on the entity builder UI
579
599
  */
580
600
  entity_builder_disable_edit?: boolean;
601
+ /**
602
+ * Setting to `true` prevents the attribute from being modified / deleted
603
+ */
604
+ protected?: boolean;
581
605
  type?: "country";
582
606
  }
583
607
  /**
@@ -644,6 +668,10 @@ declare namespace Components {
644
668
  * Setting to `true` disables editing the attribute on the entity builder UI
645
669
  */
646
670
  entity_builder_disable_edit?: boolean;
671
+ /**
672
+ * Setting to `true` prevents the attribute from being modified / deleted
673
+ */
674
+ protected?: boolean;
647
675
  type: "currency";
648
676
  /**
649
677
  * An array of currency configurations with a country code (ISO-4217)
@@ -719,6 +747,10 @@ declare namespace Components {
719
747
  * Setting to `true` disables editing the attribute on the entity builder UI
720
748
  */
721
749
  entity_builder_disable_edit?: boolean;
750
+ /**
751
+ * Setting to `true` prevents the attribute from being modified / deleted
752
+ */
753
+ protected?: boolean;
722
754
  type?: "date" | "datetime";
723
755
  }
724
756
  export interface Entity {
@@ -796,6 +828,21 @@ declare namespace Components {
796
828
  * Specific to Activity pilot
797
829
  */
798
830
  header?: boolean;
831
+ /**
832
+ * Require a permission to display UI hook
833
+ */
834
+ requiredPermission?: {
835
+ /**
836
+ * example:
837
+ * note:view
838
+ */
839
+ action: string;
840
+ /**
841
+ * example:
842
+ * 123
843
+ */
844
+ resource?: string;
845
+ };
799
846
  }[];
800
847
  /**
801
848
  * This capability should only be active when the feature flag is enabled
@@ -1403,6 +1450,10 @@ declare namespace Components {
1403
1450
  * Setting to `true` disables editing the attribute on the entity builder UI
1404
1451
  */
1405
1452
  entity_builder_disable_edit?: boolean;
1453
+ /**
1454
+ * Setting to `true` prevents the attribute from being modified / deleted
1455
+ */
1456
+ protected?: boolean;
1406
1457
  type: "image" | "file";
1407
1458
  multiple?: boolean;
1408
1459
  /**
@@ -1635,6 +1686,10 @@ declare namespace Components {
1635
1686
  * Setting to `true` disables editing the attribute on the entity builder UI
1636
1687
  */
1637
1688
  entity_builder_disable_edit?: boolean;
1689
+ /**
1690
+ * Setting to `true` prevents the attribute from being modified / deleted
1691
+ */
1692
+ protected?: boolean;
1638
1693
  type?: "internal";
1639
1694
  }
1640
1695
  /**
@@ -1701,6 +1756,10 @@ declare namespace Components {
1701
1756
  * Setting to `true` disables editing the attribute on the entity builder UI
1702
1757
  */
1703
1758
  entity_builder_disable_edit?: boolean;
1759
+ /**
1760
+ * Setting to `true` prevents the attribute from being modified / deleted
1761
+ */
1762
+ protected?: boolean;
1704
1763
  type?: "link";
1705
1764
  }
1706
1765
  /**
@@ -1767,6 +1826,10 @@ declare namespace Components {
1767
1826
  * Setting to `true` disables editing the attribute on the entity builder UI
1768
1827
  */
1769
1828
  entity_builder_disable_edit?: boolean;
1829
+ /**
1830
+ * Setting to `true` prevents the attribute from being modified / deleted
1831
+ */
1832
+ protected?: boolean;
1770
1833
  type?: "number";
1771
1834
  format?: string;
1772
1835
  }
@@ -1834,6 +1897,10 @@ declare namespace Components {
1834
1897
  * Setting to `true` disables editing the attribute on the entity builder UI
1835
1898
  */
1836
1899
  entity_builder_disable_edit?: boolean;
1900
+ /**
1901
+ * Setting to `true` prevents the attribute from being modified / deleted
1902
+ */
1903
+ protected?: boolean;
1837
1904
  type?: "ordered_list";
1838
1905
  }
1839
1906
  /**
@@ -1900,6 +1967,10 @@ declare namespace Components {
1900
1967
  * Setting to `true` disables editing the attribute on the entity builder UI
1901
1968
  */
1902
1969
  entity_builder_disable_edit?: boolean;
1970
+ /**
1971
+ * Setting to `true` prevents the attribute from being modified / deleted
1972
+ */
1973
+ protected?: boolean;
1903
1974
  type?: "partner_status";
1904
1975
  }
1905
1976
  /**
@@ -1981,8 +2052,12 @@ declare namespace Components {
1981
2052
  * Setting to `true` disables editing the attribute on the entity builder UI
1982
2053
  */
1983
2054
  entity_builder_disable_edit?: boolean;
2055
+ /**
2056
+ * Setting to `true` prevents the attribute from being modified / deleted
2057
+ */
2058
+ protected?: boolean;
1984
2059
  type?: "relation";
1985
- relation_type?: "belongs_to" | "has_many";
2060
+ relation_type?: "has_many" | "has_one";
1986
2061
  delete_mode?: "cascade";
1987
2062
  relation_affinity_mode?: "weak" | "strong";
1988
2063
  /**
@@ -2108,10 +2183,14 @@ declare namespace Components {
2108
2183
  * Setting to `true` disables editing the attribute on the entity builder UI
2109
2184
  */
2110
2185
  entity_builder_disable_edit?: boolean;
2186
+ /**
2187
+ * Setting to `true` prevents the attribute from being modified / deleted
2188
+ */
2189
+ protected?: boolean;
2111
2190
  repeatable?: boolean;
2112
2191
  has_primary?: boolean;
2113
2192
  relation_affinity_mode?: "weak" | "strong";
2114
- type?: "string" | "phone" | "email" | "address" | "relation";
2193
+ type?: "string" | "phone" | "email" | "address" | "relation" | "payment";
2115
2194
  /**
2116
2195
  * when enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.
2117
2196
  */
@@ -2205,6 +2284,10 @@ declare namespace Components {
2205
2284
  * Setting to `true` disables editing the attribute on the entity builder UI
2206
2285
  */
2207
2286
  entity_builder_disable_edit?: boolean;
2287
+ /**
2288
+ * Setting to `true` prevents the attribute from being modified / deleted
2289
+ */
2290
+ protected?: boolean;
2208
2291
  type?: "select" | "radio";
2209
2292
  options?: ((string | null) | {
2210
2293
  value: string;
@@ -2288,6 +2371,10 @@ declare namespace Components {
2288
2371
  * Setting to `true` disables editing the attribute on the entity builder UI
2289
2372
  */
2290
2373
  entity_builder_disable_edit?: boolean;
2374
+ /**
2375
+ * Setting to `true` prevents the attribute from being modified / deleted
2376
+ */
2377
+ protected?: boolean;
2291
2378
  type?: "tags";
2292
2379
  options?: string[];
2293
2380
  suggestions?: string[];
@@ -2356,6 +2443,10 @@ declare namespace Components {
2356
2443
  * Setting to `true` disables editing the attribute on the entity builder UI
2357
2444
  */
2358
2445
  entity_builder_disable_edit?: boolean;
2446
+ /**
2447
+ * Setting to `true` prevents the attribute from being modified / deleted
2448
+ */
2449
+ protected?: boolean;
2359
2450
  type?: "string";
2360
2451
  multiline?: boolean;
2361
2452
  }
@@ -2423,6 +2514,10 @@ declare namespace Components {
2423
2514
  * Setting to `true` disables editing the attribute on the entity builder UI
2424
2515
  */
2425
2516
  entity_builder_disable_edit?: boolean;
2517
+ /**
2518
+ * Setting to `true` prevents the attribute from being modified / deleted
2519
+ */
2520
+ protected?: boolean;
2426
2521
  type?: "relation_user";
2427
2522
  multiple?: boolean;
2428
2523
  }
package/dist/openapi.json CHANGED
@@ -1581,6 +1581,11 @@
1581
1581
  "description": "Setting to `true` disables editing the attribute on the entity builder UI",
1582
1582
  "type": "boolean",
1583
1583
  "default": false
1584
+ },
1585
+ "protected": {
1586
+ "description": "Setting to `true` prevents the attribute from being modified / deleted",
1587
+ "type": "boolean",
1588
+ "default": true
1584
1589
  }
1585
1590
  },
1586
1591
  "required": [
@@ -1787,8 +1792,7 @@
1787
1792
  }
1788
1793
  },
1789
1794
  "required": [
1790
- "type",
1791
- "attachments"
1795
+ "type"
1792
1796
  ]
1793
1797
  }
1794
1798
  ]
@@ -1885,8 +1889,8 @@
1885
1889
  "relation_type": {
1886
1890
  "type": "string",
1887
1891
  "enum": [
1888
- "belongs_to",
1889
- "has_many"
1892
+ "has_many",
1893
+ "has_one"
1890
1894
  ]
1891
1895
  },
1892
1896
  "delete_mode": {
@@ -2030,7 +2034,8 @@
2030
2034
  "phone",
2031
2035
  "email",
2032
2036
  "address",
2033
- "relation"
2037
+ "relation",
2038
+ "payment"
2034
2039
  ]
2035
2040
  },
2036
2041
  "enable_relation_picker": {
@@ -2295,6 +2300,23 @@
2295
2300
  "header": {
2296
2301
  "type": "boolean",
2297
2302
  "description": "Specific to Activity pilot"
2303
+ },
2304
+ "requiredPermission": {
2305
+ "type": "object",
2306
+ "description": "Require a permission to display UI hook",
2307
+ "properties": {
2308
+ "action": {
2309
+ "type": "string",
2310
+ "example": "note:view"
2311
+ },
2312
+ "resource": {
2313
+ "type": "string",
2314
+ "example": 123
2315
+ }
2316
+ },
2317
+ "required": [
2318
+ "action"
2319
+ ]
2298
2320
  }
2299
2321
  },
2300
2322
  "required": [